Jeden záznam changelogu popisuje jednu potvrzenou změnu: verzi, datum nasazení, dotčené uživatele, stav před a po změně a potřebný krok. Šablona se týká již nasazené funkce, nikoli prvního uvedení produktu.
Získejte fakta o jedné změně
Od vlastníka funkce potvrďte název, identifikátor vydání, skutečný čas nasazení a rozsah uživatelů. Plánovaný termín není datum účinnosti. U omezeného přístupu pojmenujte dotčenou skupinu.
Interní tiket pomáhá dohledat rozhodnutí, ale uživateli nenahradí popis funkce. Záznam musí být srozumitelný bez interních poznámek.
Zapište verzi a datum
Použijte identifikátor, který produkt skutečně používá. Nevymýšlejte číslo pro článek. Jestliže produkt používá SemVer, vykládejte verzi podle jeho pravidel a deklarovaného veřejného API. Jiné systémy mohou číslům dávat jiný význam.
Datum pište jednoznačně, například YYYY-MM-DD. Je-li čas důležitý, přidejte pásmo. Datum psaní může být jiné. U postupného nasazení popište začátek a aktuální rozsah, ne přístup všech současně.
Vysvětlete předchozí a nové chování
Napište, co uživatel viděl před změnou a co po ní. Uveďte dotčenou skupinu, hranice a požadovaný krok. Pokud žádná akce není nutná, výslovně to řekněte.
Změna filtru sama nedokazuje vyšší prodeje ani určitou úsporu času. Popište doložené chování. Ceny a fakturace zůstávají v příslušné dokumentaci.
Příklad jednoho záznamu
Tento fiktivní příklad nepopisuje vydání Semly.
- Funkce: filtrování seznamu dokumentů.
- Vydání: 2.4.1 podle systému příkladového produktu.
- Účinnost: 2026-10-12.
- Před změnou: druhý filtr zrušil první.
- Po změně: seznam uplatní oba zvolené filtry.
- Rozsah: uživatelé seznamu dokumentů ve verzi 2.4.1.
- Akce: po aktualizaci obnovit otevřený seznam.
- Omezení: uložené šablony filtrů se nemění.
Omezení brání domněnce, že se změnily i šablony. Ve skutečném záznamu doplňte ověřený odkaz na dokumentaci. Pokud neexistuje, vysvětlete krok bez vymyšlené adresy.
Ověřte záznam před uložením
Porovnejte verzi, datum, rozsah a chování s potvrzením produktového týmu. Zkontrolujte proveditelnost kroku a aktuálnost odkazů.
Čtenář bez znalosti tiketu musí pochopit co a kdy se změnilo. Nezávislé funkce rozdělte do samostatných záznamů vydání, ale nevytvářejte více článků o téže změně.
Zachovejte význam v překladech
Překlad nemění identifikátor, čas, rozsah ani omezení. Další jazyk nepotvrzuje dostupnost na dalším trhu.
Při opravě textu zachovejte skutečné datum nasazení a označte redakční opravu zvlášť. Nejde o nové nasazení.
Zdroj k číslování
SemVer se týká deklarovaného veřejného API. Není povinným systémem pro každou SaaS aplikaci.
