Dokumentatsiooni hooldamise lõks
Tehnikakirjutajad tunnevad seda tunnet. Uus versioon tuleb välja. Muudatuste logi loetleb 30 muudatust. Kaksteist neist mõjutavad API dokumentatsiooni. Viis mõjutavad alustamisjuhendit. Kaks nõuavad täiesti uusi lehekülgi. Ja sa pead leidma iga koha olemasolevas dokumentatsioonis, kus vana käitumine on kirjeldatud, uuendama seda, veenduma, et miski ei lähe vastuollu, ja tegema seda enne, kui versiooniteavitus välja läheb.
Enamik kirjutajaid töötab dokumentatsiooniplatvormil nagu GitBook, Docusaurus või Confluence. Sisu on laiali kümnetel lehekülgedel. Iga viite leidmine muudetud lõpp-punktile tähendab sadade failide läbiotsimist. Ja kui küsid AI-lt abi, kleebid korraga ühe lehe sisse, sest AI tööriist ei näe ülejäänud dokumentatsiooni.
AI agent, mis loeb kogu sinu dokumentatsioonikausta
Ritemark on markdown-redaktor, mille tööruumi on AI agent sisse ehitatud. Sinu dokumentatsioonifailid elavad kaustas sinu masinas. Agent saab lugeda iga faili selles kaustas.
Ava oma API dokumentatsiooni projekt Ritemarkis. Sul on 40 lõpp-punkti lehekülge, alustamisjuhend, autentimise dokumendid ja muudatuste logi. Ava terminaal, käivita Claude Code ja ütle: "Loe v2.5 muudatuste logi ja tuvasta iga dokumentatsiooni lehekülg, mis vajab uuendamist."
Agent skaneerib muudatuste logi, ristviitab seda olemasoleva dokumentatsiooniga ja annab sulle nimekirja. Mitte oletus ühe faili põhjal, mille kleebisid. Tegelik ristviide kogu sinu dokumentatsiooni kogumiga.
Dokumentatsiooni uuendamine pärast versiooni väljalaset
Siin on, milline töövoog välja näeb, kui v2.5 välja tuleb.
Avad muudatuste logi faili ja API dokumentatsiooni kausta Ritemarkis. Käivitad AI agendi terminaalis.
"Loe v2.5 muudatuste logi. Iga murrangulise muudatuse kohta leia mõjutatud dokumentatsiooni lehekülg ja koosta uuendus. Hoia olemasolevat tooni ja vormindust."
Agent loeb muudatuste logi, siis loeb iga mõjutatud dokumentatsiooni lehe. Ta koostab uuendused, mis vastavad sinu olemasolevale stiilile, sest ta näeb sinu olemasolevat stiili. Mitte üldine ümbertöötlus, vaid sihitud muudatused konkreetsetele jaotistele.
Vaatad iga uuenduse visuaalses redaktoris üle. Aktsepteeri, muuda või lükka tagasi. Agent tegi ristviitamise ja mustandi koostamise. Sina teed kvaliteedikontrolli. Töö, mis varem võttis terve päeva, võtab nüüd hommiku.
Uue funktsiooni dokumentatsioon spetsifikatsioonist
Tootemeeskond saatis välja funktsiooni koos tehnilise spetsifikatsiooniga. Sa pead selle vormistama kasutajale suunatud dokumentatsiooniks.
Viska spetsifikatsioon oma dokumentatsiooni projektikausta. Ava uus markdown-fail dokumentatsiooni lehe jaoks. Ütle agendile: "Loe webhook funktsiooni tehniline spetsifikatsioon. Kirjuta kasutajale suunatud dokumentatsioon, järgides sama struktuuri kui meie olemasolevad lõpp-punkti dokumendid. Lisa koodinäited Pythonis ja JavaScriptis."
Agent loeb spetsifikatsiooni, loeb kaks-kolm olemasolevat lõpp-punkti lehekülge, et mõista sinu dokumentatsiooni mustreid, ja genereerib esimese mustandi. See vastab sinu pealkirjade struktuurile, koodinäidete stiilile, selgitamise mustritele. Sa muudad mustandi, lisad nüansse, mida spetsifikatsioon ei kata, ja sul on uus dokumentatsiooni leht, mis sobib sujuvalt ülejäänuga.
Järjepidevuse kontroll kogu dokumentatsioonis
Dokumentatsiooni triiv on reaalne. Kuude jooksul kasutavad erinevad kirjutajad erinevaid termineid sama mõiste jaoks. Näited jäävad aegunuks. Ristviited lähevad katki.
"Skaneeri kõik API lõpp-punkti lehed. Loetle ebajärjekindlused selles, kuidas me kirjeldame autentimist. Märgi koodinäited, mis viitavad v1 APIle."
Agent loeb iga lõpp-punkti lehe, võrdleb terminoloogiat ja mustreid ning raporteerib, mida leiab. Sa saad konkreetse nimekirja parandatavatest ebajärjekindlustest, mitte ebamäärast kahtlust, et midagi on valesti.
Markdown-dokumendid gitis, mitte suletud platvormil
Sinu dokumentatsioon elab markdown-failidena git-repositooriumis. Versioonikontrollitud. Saab muudatusi jälgida. Saab pull requestides üle vaadata. Iga CI/CD torustik saab need ehitada dokumentatsioonisaidiks.
Pole suletud platvormi lukustust. Pole eksporditud formaati, mis kaotab struktuuri. Pole "peame dokumentatsiooni migreerima" projekti iga kahe aasta tagant. Lihtsalt markdown-failid, mis on loetavad olnud aastast 2004 ja on loetavad aastal 2034.