Samad sammud, iga versiooniga
Tehnikakirjutajatel on rutiinid. Kui uus versioon välja tuleb, on sammud peaaegu iga kord identsed. Loe muudatuste logi. Tuvasta kasutajale nähtavad muudatused. Koosta versiooniuuenduste mustand. Kontrolli, kas mõnel olemasoleval dokumentatsiooni lehel viidatakse muudetud käitumisele. Uuenda need lehed. Vaata kõik üle. Avalda.
See ei ole keeruline töö. Aga see on korduv ja see võtab aega. Kvartaalne versioon võib tähendada tundi muudatuste logi lugemist, kaht tundi mustandi koostamist ja veel tundi olemasolevate dokumentide kontrolli mõjutatud lehtede osas. Korruta see nelja versiooniga aastas, või kaheteistkümnega kui väljastad kuuselt, ja mehaaniline osa koguneb kiiresti. Tegelik probleem ei ole see, et ükski samm oleks raske. See on see, et sama järjekorra käsitsi tegemine, iga kord, jätab ruumi vahelejäänud sammudele ja ebaühtlastele tulemustele.
Flows muudab kontroll-lehe automatiseerimiseks
Ritemark Flows laseb sul määrata agendi ülesannete jada, mis jookseb ühe tervikuna. Selle asemel, et avada AI-külgpaneel ja tippida juhiseid iga sammu jaoks, ehitad voo üks kord ja käivitad selle iga kord, kui versioon välja tuleb.
Dokumentatsiooni versiooni voog võib välja näha nii: esimene samm, loe muudatuste logi fail ja eralda kasutajale nähtavad muudatused. Teine samm, genereeri versiooniuuenduste mustand kasutades malli ja eelmisi uuendusi tooni sobitamiseks. Kolmas samm, skaneeri olemasolevat dokumentatsiooni kausta artiklite osas, mis viitavad muudetud funktsioonidele või lõpppunktidele. Neljas samm, koosta kokkuvõte, milliseid dokumente on vaja uuendada ja mis täpselt muutus.
Seadistad selle üks kord Flows redaktoris. Iga samm suunab oma väljundi järgmisesse. Kui v3.4 välja tuleb, viskad muudatuste logi oma projektikausta, käivitad voo ja saad versiooniuuenduste mustandi pluss mõjuaruande olemasolevatele dokumentidele. Mehaaniline töö juhtub automaatselt. Sina kulutad oma aja ülevaatamisele ja redigeerimisele, nendele osadele, kus inimese otsustus tegelikult loeb.
Versiooni dokumentatsiooni voo ehitamine
Näiteks võiks tehnikakirjutaja fintech-ettevõttes seadistada versioonidokumentatsiooni voo nii.
Ta loob voo nelja sammuga. Esimene samm loeb uue muudatuste logi ja kategoriseerib iga kirje kasutajale nähtavaks või sisemiseks. Teine samm võtab ainult kasutajale nähtavad kirjed ja koostab versiooniuuendused, lugedes mallifaili ja kaht viimast versiooniuuendust stiili eeskujuks. Kolmas samm võtab muudetud funktsioonide nimekirja ja otsib dokumentatsioonikausta igast failist nende funktsioonide mainimisi. Neljas samm koondab kõik ühte raportisse: siin on sinu versiooniuuenduste mustand ja siin on olemasolevad dokumendid, mis vajavad tähelepanu.
Oletame, et tema versioonidokumentatsioon võtab umbes neli tundi kuuversiooni kohta. Voog jookseb mõne minutiga ja annab talle ülevaatamiseks mustandi, nii et tema aeg kulub lugemisele ja parandamisele, mitte sorteerimisele. Ta teeb ikka otsuseid, sõnastab asju ümber, lisab konteksti, mida muudatuste logi ei kajasta. Aga sorteerimine, ristviitamine ja esimese mustandi kirjutamine toimuvad, ilma et ta peaks iga sammu käsitsi tegema.
Korduvad protsessid, mitte ühekordsed päringud
Vahe juhiste tippimise AI-külgpaneeli ja voo ehitamise vahel on vahe ühekordse ülesande ja korduva protsessi vahel. Vestluses antud juhised töötavad suurepäraselt ad hoc küsimuste ja uurimise jaoks. Aga kui teed sama dokumentatsiooni järjekorda iga versiooniga, on samade promptide tippimine iga kord raisatud pingutus.
Flows salvestab järjekorra. See tagab, et iga samm jookseb järjekorras, iga kord, järjekindlate juhistega. Ükski samm ei jää vahele, sest sul oli kiire. Pole ebaühtlust, sest sõnastasid prompti sel kuul veidi teisiti. Voog jookseb samal viisil, olgu see sinu esimene versioon või neljakümnes.
Hakka Ritemarkiga kirjutama.
Tasuta ja avatud lähtekoodiga.