LionNet

Programowanie, sieci komputerowe, informatyka.

Jak robić dobry changelog?


Jeśli zastanawiasz się jak przygotować dobry, ustandaryzowany i czytelny changelog Twojej aplikacji to w tym wpisie najdziesz to czego szukasz.

Changelog

Dziennik zmian jest dokumentem często robionym po macoszemu, z założeniem że i tak nikt go nie przeczyta i nikomu się nie przyda. A to duży błąd. Dobrze przygotowany changelog pomaga. I to bardzo. Dzięki niemu szybko ustalisz co nowego zostało dodane w danej wersji, co zostało naprawione, usunięte lub zastąpione. Łatwiej również będzie Ci zaspokoić ciekawość kolegów z działu handlowego lub samych klientów podsyłając im gotowy i czytelny dla nich dokument. Zyskasz na czasie. Nie będziesz musiał wszystkie pamiętać lub sprawdzać bezpośrednio w kodzie bądź repozytorium.

Jak robić dobry changelog?

Pisanie changeloga to proces ciągły. Dobrze by było gdyby każdy bez chwili zastanowienia wiedział jak opisać swoją zmianę. Na szczęście ktoś pomyślał za Nas i nie musimy wymyślać koła od nowa. Projekt Keep a CHANGELOG powstał, jak sama nazwa wskazuje, by ułatwić wszystkim utrzymywanie ustandaryzowanego, czytelnego dziennika zmian. Projekt ten definiuje kilka zasad które są łatwe do zapamiętania i wdrożenia:

Po co robić changelog?

Te kilka prostych zasad powoduje że changelog staje się czytelny dla wszystkich jego użytkowników. Dodatkowo, dzięki zastosowaniu Markdown, może łatwo zostać skonwertowany do HTML bądź PDF co pozwoli na jego przedstawienie klientowi w bardziej biznesowej formie. Taki przygotowany w Markdown changelog ładnie będzie także wyglądał na GitHubie. Dziennik zmian, podobnie jak np. roadmap i inne około-projektowe dokumenty, może wzbogacić Twój projekt i warto poświęcić mu klika chwil. Zwróci Ci się to!

comments powered by Disqus