Versiooniuuenduste koostamine muudatuste logist

Muudatuste logi tõlgendamise probleem

Iga versioonitsükkel lõpeb ühtmoodi. Arendus ühendab viimase pull requesti, build läheb roheliseks ja keegi viskab muudatuste logi dokumentatsiooni kanalisse. See näeb välja umbes nii: "Refaktoorisime auth middleware'i PKCE voo toetamiseks. Parandatud race condition webhook retry loogikas. Uuendatud redis klient versioonile 4.7.0. Lisatud batch endpoint /v2/users jaoks."

Neli muudatust. Üks neist on kliendile oluline. Kaks on sisemised. Üks on sõltuvuse uuendus, mis ei huvita kedagi väljaspool arendusmeeskonda. Sinu ülesanne tehnikakirjutajana on välja selgitada, mis on mis, kirjutada kliendile suunatud muudatused arusaadavasse keelde ja avaldada versiooniuuendused enne turundusteadet. Sul on kaks tundi.

Raske osa ei ole kirjutamine ise. See on tõlgendamine. Arendajate muudatuste logid kirjeldavad, mis koodis muutus. Versiooniuuendused kirjeldavad, mis kasutaja jaoks muutus. Need on kaks täiesti erinevat asja ja nende vahel silla ehitamine nõuab nii tehnilise muudatuse kui kasutajale avaldatava mõju mõistmist.

AI agent, mis loeb mõlemaid pooli

Ritemark annab sulle tööruumi, kus muudatuste logi ja versiooniuuenduste mall asuvad kõrvuti markdown-failidena. AI agent külgpaneelis saab mõlemaid lugeda.

Ava oma versiooniuuenduste projekti kaust Ritemarkis. Sul on arendusmeeskonna toores muudatuste logi, versiooniuuenduste mall standardse struktuuriga (uued funktsioonid, parandused, veaparandused) ja eelmised versiooniuuendused tooni võrdluseks. Käivita agent ja ütle talle: "Loe v3.2 muudatuste logi. Tuvasta iga kasutajale nähtav muudatus. Koosta versiooniuuendused järgides malli release-notes-template.md failist. Sobita toon v3.1 versiooniuuendustega."

Agent loeb muudatuste logi, loeb malli, loeb eelmised versiooniuuendused ja koostab mustandi. Ta eraldab sisemised muudatused kasutajale nähtavatest. Ta kirjutab "Lisatud batch endpoint /v2/users jaoks" ümber nii: "Nüüd saab mitut kasutajat korraga luua, uuendada või kustutada ühe API-päringuga." PKCE muudatusest saab "Lisatud PKCE autentimise voo tugi, mis parandab turvalisust mobiili- ja üheleherakendustes."

Näide ühest versioonitsüklist

Oletame näiteks, et kirjutaja SaaS-platvormil proovib seda 47-realise kvartaalse muudatuste logiga.

Ta avab muudatuste logi koos malli ja eelmiste versiooniuuendustega Ritemarkis. Ta palub agendil kategoriseerida iga kirje kasutajale nähtavaks või sisemiseks, seejärel koostada versiooniuuendused ainult kasutajale nähtavate muudatuste kohta.

Agent tuvastab 47-st näiteks 19 kasutajale nähtavat muudatust. Ta grupeerib need uuteks funktsioonideks, parandusteks ja veaparandusteks. Ta koostab iga kirje lihtsas keeles, viidates eelmistele versiooniuuendustele, et need sobiksid ettevõtte häälega.

Kirjutaja aeg kulub mustandi ülevaatamisele ja redigeerimisele, mitte nullist kirjutamisele. Ülevaatamine on see väärtuslik osa, kus tema hinnang ja tootetundmine teevad uuendused paremaks. Esimene läbimine, sorteerimine ja ümberkirjutamine, on täpselt selline töö, mida AI agent teeb hästi, kui ta näeb kogu konteksti.

Miks kontekst muudab kõik

Muudatuste logi kleepimine vestlusaknasse ja küsimus "kirjuta see klientidele ümber" annab sulle üldise tulemuse. AI ei tea sinu malli, tooni, sihtrühma ega seda, kuidas sa eelmisi sarnaseid muudatusi käsitlesid.

Ritemarki agent loeb kogu sinu projektikaustat. Ta näeb malli, eelmisi uuendusi, stiilimustreid. Mustand, mille ta koostab, ei ole üldine ümbertöötlus. See on esimene läbimine, mis juba vastab sinu formaadile ja häälele. Sa redigeerid tugevalt lähtekohalt, mitte tühja lehe pealt.