AI για Τεχνικούς Συγγραφείς

Η τεχνική γραφή είναι εν μέρει αυτοματοποιημένη εδώ και πολύ καιρό. Η τεκμηρίωση αναφοράς δημιουργείται συνήθως από σχόλια κώδικα ή προδιαγραφές API με εργαλεία όπως το Swagger UI, το Redoc και το Sphinx autodoc. Αυτό που προσθέτει η γενετική τεχνητή νοημοσύνη είναι η πεζογραφία: εννοιολογικές επεξηγήσεις, σεμινάρια, παραδείγματα, σημειώσεις έκδοσης και πρώτα προσχέδια γραμμένα από έγγραφα απαιτήσεων προϊόντος ή σημειώσεις μηχανικής. Πολλές ομάδες εργάζονται σε ένα μοντέλο doc-as-code. Η τεκμηρίωση ζει ως Markdown ή reStructuredText στο Git, οι αλλαγές περνούν από αιτήματα έλξης και η συνεχής ενοποίηση δημιουργεί τον ιστότοπο με μια δημιουργία στατικών τοποθεσιών όπως το Docusaurus, το MkDocs ή το Sphinx. Αυτή η ρύθμιση ταιριάζει καλά στην τεχνητή νοημοσύνη. Τα πρόχειρα φτάνουν ως αλλαγές με δυνατότητα αναθεώρησης, οι αυτοματοποιημένοι έλεγχοι εκτελούνται σε κάθε δέσμευση και οι ενημερώσεις εγγράφων μπορούν να συνδεθούν με τις αλλαγές κώδικα που τα προκάλεσαν. Για συνέπεια στο στυλ, τα ντετερμινιστικά εργαλεία και η τεχνητή νοημοσύνη αλληλοσυμπληρώνονται. Ένα linter όπως το Vale επιβάλλει κανόνες από έναν οδηγό στυλ, για παράδειγμα τον οδηγό στυλ τεκμηρίωσης προγραμματιστή του Google ή τον Οδηγό στυλ γραφής Microsoft, και δίνει το ίδιο αποτέλεσμα κάθε φορά. Η τεχνητή νοημοσύνη είναι καλύτερη στο να προτείνει πιο σαφείς φράσεις, αλλά είναι λιγότερο προβλέψιμη. Ο κύριος κίνδυνος είναι η σίγουρη ανακρίβεια. Ένα μοντέλο μπορεί να εφεύρει ένα τελικό σημείο, μια προεπιλεγμένη τιμή ή μια σημαία γραμμής εντολών που φαίνεται εύλογη. Μπορεί επίσης να περιγράψει πώς συμπεριφέρθηκε ένα προϊόν στα δεδομένα εκπαίδευσης και όχι πώς συμπεριφέρεται τώρα. Κάθε παραγόμενο δείγμα κώδικα και παράμετρος χρειάζεται έλεγχο σε σχέση με το πραγματικό σύστημα. Μια κοινή παρανόηση είναι ότι η τεχνητή νοημοσύνη καθιστά τους τεχνικούς συγγραφείς περιττούς. Τα δύσκολα μέρη της δουλειάς είναι να γνωρίζουμε τι είναι αλήθεια, να αποφασίζουμε τι χρειάζονται οι χρήστες και να οργανώνουμε πληροφορίες ώστε να μπορούν να τις βρουν. Πλαίσια όπως το Diátaxis, το οποίο διαχωρίζει σεμινάρια, οδηγούς με οδηγίες, αναφορές και επεξηγήσεις, αντικατοπτρίζουν αυτό το δομικό έργο. Οι ρόλοι μετατοπίζονται προς την αρχιτεκτονική πληροφοριών, την επαλήθευση, τη στρατηγική περιεχομένου και τη γραφή για τους αναγνώστες τεχνητής νοημοσύνης. Η πρόταση llms.txt από το 2024, για παράδειγμα, προτείνει ένα αρχείο που οδηγεί τα μοντέλα γλώσσας στη βασική τεκμηρίωση ενός ιστότοπου.