Keitimų žurnalas

Keitimų žurnalas (angl. žarg. Changelog). Specialus projekto dokumentas, kuriame įrašomi duomenys apie projekte atliktus pakeitimus. Toks žurnalas gali būti generuojamas automatiškai (Vikipedija jį turi kiekvienam puslapiui, po „Istorija“ nuoroda) arba rašomas dokumentus keičiančių žmonių. Kadangi žmonės paprastai daug tiksliau ir aiškiau aprašo pakeitimus, ranka rašomo žurnalo atsakingi projektai neatsisako ir esant galimybėms pakeitimus automatiškai dokumentuoti. Ranka rašytas ir automatiškai generuotas žurnalas kai kada lyginami tarpusavyje, taip aptinkant atsitiktinius, negalvotus atlikti pakeitimus. Keitimų žurnalas yra vienas svarbiausių darbo dokumentų.

Pagrindinės darbo žurnalo taisyklės yra šios:

1. Rašyti reikia kas pakeista, o ne kodėl. Pakeitimų priežastis turi būti nurodyta kituose dokumentuose ir, jei reikia, keičiamo dokumento komentaruose.
2. Keičiant dokumento kodo dalį, reikia tiksliai nurodyti pakeitimo vietą. Jei autoriui atrodo, jog pakeitimų pernelyg daug juos smulkiai vardinti, apsiribojama žodžiu „perrašyta“ (angl rewritten).
3. Jei dokumentui tiesiog pridedama nauja struktūrinė dalis, gana parašyti „nauja dalis“ („naujas objektas“, „naujas “ ir pan).
4. Jei žurnalas bendras daugeliui įvairiuose aplankuose esančių dokumentų, reikia nurodyti visą kelią į dokumentą.
5. Visi projekto nariai rašo žurnalą viena kalba (tarptautiniuose projektuose paprastai anglų).
6. Jei pakeitimu ištaisoma klaida buvo aprašyta klaidos raporte, būtina nurodyti šio raporto numerį.
7. Pakeitimo autoriumi įrašomas jį pasiūlęs o ne techniškai pakeitimą atlikęs žmogus.

Pavyzdys

Darbo žurnalo įrašo pavyzdys. Nurodyta data, autorius, jo adresas, pakeistas dokumentas (aplankas java, jame aplankas lang, jame dokumentas Match) ir pakeista dokumento dalis (metodas sqrt).

 2005-11-10 Mike Pukuotukas <[e-mail]> * java/lang/Match (sqrt): Patikrinti, ar argumentas neneigiamas. 

Nuorodos

• – atviro kodo projektuose taikomos keitimų žurnalo rašymo taisyklės 2011-12-23 iš Wayback Machine projekto..