Το Markdown ως πηγαίος κώδικας: Μια νέα προσέγγιση στη διαχείριση της πρόθεσης
Πρωτότυπος τίτλος: "Markdown in /src" (από perrygeo)
Καθώς η παραγωγική τεχνητή νοημοσύνη (Generative AI) μεταβάλλει τον τρόπο συγγραφής λογισμικού, το Markdown αναδεικνύεται σε πρωτογενή πηγή αλήθειας. Η πρόταση του Carson Gross είναι η ενσωμάτωση τεκμηριωμένων αρχιτεκτονικών προδιαγραφών απευθείας στον κατάλογο /src, διασφαλίζοντας τη διατήρηση της πρόθεσης (intent) του συστήματος πέρα από τις εφήμερες συνεδρίες prompting.
Η μετατόπιση της πηγής αλήθειας
Στο σύγχρονο περιβάλλον ανάπτυξης, η χρήση των LLMs για τη δημιουργία κώδικα έχει καταστήσει τις εφήμερες συνεδρίες prompting το de facto σημείο όπου γεννιέται η λογική του συστήματος. Ωστόσο, αυτή η πρακτική οδηγεί σε απώλεια της αρχιτεκτονικής γνώσης, καθώς η 'πηγή αλήθειας' παραμένει εγκλωβισμένη σε ιστορικά συνομιλιών ή αποσπασματικά wikis. Η πρόταση για μεταφορά του Markdown στον κατάλογο /src στοχεύει στην αποκατάσταση αυτής της συνέχειας.
Το Markdown ως first-class citizen στον κώδικα
Αντιμετωπίζοντας το Markdown ως πηγαίο κώδικα, επωφελούμαστε από τη δυνατότητα ελέγχου εκδόσεων (version control), τη δυνατότητα για diffs και την ευκολία ανάγνωσης τόσο από ανθρώπους όσο και από agents. Η τοποθέτηση αρχείων Markdown δίπλα στον κώδικα που περιγράφουν, εξαλείφει το πρόβλημα της 'τεκμηρίωσης από απόσταση' (specification at a distance), διασφαλίζοντας ότι η πρόθεση του συστήματος παραμένει ευθυγραμμισμένη με την υλοποίηση.
Διαχωρισμός ρόλων: Markdown vs Tests
Ενώ τα tests αποτελούν την αυτοματοποιημένη επιβεβαίωση της ορθότητας, δεν μπορούν να υποκαταστήσουν την περιγραφική ισχύ του Markdown. Το Markdown λειτουργεί ως το επίπεδο προδιαγραφών (specification layer), ενώ τα tests λειτουργούν ως το επίπεδο επαλήθευσης. Η ιδανική ροή εργασίας περιλαμβάνει τη συγγραφή του Markdown στον κατάλογο /src/md, από το οποίο στη συνέχεια αντλούνται οι απαιτήσεις για την παραγωγή κώδικα και των αντίστοιχων test suites.
Προτεινόμενη δομή και διακυβέρνηση
Η διατήρηση ενός καθαρού /src/md απαιτεί πειθαρχία. Ο κατάλογος αυτός δεν πρέπει να αποτελεί προϊόν αυτόματης παραγωγής από agents, αλλά να επιμελείται από ανθρώπους. Μια προτεινόμενη δομή περιλαμβάνει υποκαταλόγους για features, data, api και infrastructure, δημιουργώντας έναν χάρτη που καθοδηγεί την ανάπτυξη και διευκολύνει το onboarding νέων μελών στην ομάδα.
Ανακαλύψτε καινοτόμα open-source εργαλεία και κρυμμένα διαμάντια ανοιχτού κώδικα.