Příklady changelogu

1. Rutinní SaaS vydání

Běžný případ: hrstka uživateli viditelných změn, žádná migrace, žádné drama. Je krátký, protože vydání bylo malé, a odolávání nutkání ho nafouknout je většina té dovednosti.

## 20. srpna 2026

### Nové
- Uložená zobrazení v inboxu. Připni filtr jednou a znovu ho
  použij z bočního panelu.

### Vylepšeno
- Úloha exportu nyní hlásí postup místo toho, aby vypadala
  zaseknutá na velkých účtech.

### Opraveno
- Pozvaní členové už nevidí prázdný přehled před prvním
  přihlášením.

2. API vydání se zastaráním

Čtenář changelogu API hledá jednu věc: zda se jeho integrace chystá rozbít a kolik má času. Dej to nahoru a přidej datum.

## Acme API 4.2 - 20. srpna 2026

### Zásadní změny
- `?page=` byl odstraněn ve všech endpointech seznamů. Použij
  hodnotu `nextCursor` z předchozí odpovědi.
  `?page=` vrací 400 po 1. říjnu 2026.
  Kroky migrace: acme.example/docs/pagination

### Nové
- Webhooky lze omezit na jeden projekt.

### Vylepšeno
- Endpointy seznamů odpovídají přibližně čtyřikrát rychleji na
  účtech s více než 10 000 záznamy.

3. Mobilní vydání

Obchody s aplikacemi zobrazují zkrácené pole novinek a recenze může držet build celé dny. Obě skutečnosti formují záznam.

## iOS 3.4.0 - 20. srpna 2026

Offline režim. Otevírej, čti a piš návrhy bez připojení;
vše se synchronizuje, jakmile jsi zpět online.

### Také v tomto vydání
- Rychlejší spuštění na starších zařízeních.
- Opraven pád při otevření sdíleného odkazu z Mail.

4. Bezpečnostní oprava

Jediný záznam, kde je méně řečí správně. Uživatelé musí vědět, že by měli aktualizovat; nikdo jiný nepotřebuje popis dostatečně přesný na to, aby zaútočil na verzi, kterou ještě neaktualizoval.

## 20. srpna 2026

### Zabezpečení
- Posílili jsme způsob ověřování tokenů relace. Účty na
  samostatně hostovaných instalacích by měly aktualizovat na
  4.2.1 nebo novější. Nahlášeno zodpovědně; žádný důkaz zneužití.
  Podrobnosti: acme.example/security/2026-08

5. Jak vypadá špatný příklad

Každý řádek zde je skutečný co do tvaru, a každý řádek je chyba:

## v2.3.7

- Sloučen PR #482 z feature/inbox-refactor
- Aktualizován lodash 4.17.20 -> 4.17.21
- Opravena souběžnost v MembershipCache.resolve()
- Různé opravy chyb a vylepšení
- Refaktorován model SavedView (díky, Dave!)

Co mají dobré společné

• Popisují výsledek, ne implementaci. Čtenář, který nikdy neviděl kód, stále pozná, jestli se ho záznam týká.
• Vynechávají věci. Aktualizace závislostí, refaktoringy, změny CI a interní přejmenování chybí, a tato nepřítomnost je to, co udržuje zbytek čitelný.
• Dávají nákladnou věc jako první. Pokud se něco rozbije, je to první nadpis, s datem.
• Jsou datovány způsobem, který čtenář může použít: číslo verze tam, kde uživatelé mohou vidět verze, datum tam, kde nemohou.
• Jsou záměrně nudné. Žádné vykřičníky, žádná marketingová přídavná jména, žádné „jsme nadšeni, že můžeme oznámit“. Lidé čtoucí changelog hledají informace a budou se zlobit na cokoliv, co jim stojí v cestě.

Časté otázky

Jaký formát by měl changelog používat?

keepachangelog.com je nejblíže standardu a názvy jeho sekcí (Added, Changed, Deprecated, Removed, Fixed, Security) jsou široce uznávané. Záleží to mnohem méně než na formulaci uvnitř sekcí. Konzistentní formát s vágními záznamy je horší než volný formát s konkrétními.

Jak často bychom měli publikovat?

V jakémkoliv rytmu, který odpovídá tvým vydáním, a konzistentně. Publikování na vydání je nejjednodušší pravidlo. Seskupení měsíce vydání do jednoho příspěvku ztěžuje pozdější nalezení každé jednotlivé změny, což je právě chvíle, kdy většina lidí changelog skutečně čte.

Měl by changelog žít na našem webu, nebo na stránce třetí strany?

Na tvém webu, pokud můžeš, protože tam se hromadí provoz a hodnota vyhledávání, a protože changelog na cizí doméně je jeden odkaz od tvého produktu místo jeho součásti. To je argument pro poskytování jako feed, který si sám vykresluješ, místo hostované stránky, na kterou odkazuješ.

Čtou uživatelé changelogy skutečně?

Malá část je čte pravidelně a mnohem větší část je hledá ve chvíli, kdy se pod nimi něco změní. Ta druhá skupina je důvod psát symptom místo příčiny: hledají to, co se jim stalo, svými vlastními slovy.

Další čtení: changelog vs. poznámky k vydání, a Keep a Changelog, skutečně zavedený.