---
title: Changelog s obrázky a dokumentace, která drží krok s aplikací
description: CHANGELOG.md i návody ve složce docs ukazují obrazovky z přijatých běhů. Když se obrazovka změní, Kaloko řekne, kterou sekci přepsat.
seo_title: Vizuální changelog a živá dokumentace z přijatých běhů
seo_description: Changelog se screenshoty před a po a návody, jejichž obrázky nezastarají. Návrh napíše agent z přijatých běhů v Kaloku.
query: vizuální changelog a živá dokumentace se screenshoty
kind: use-case
order: 14
updated: 2026-10-04
demo: false
---
Podpora se ptá, co se v releasu změnilo. Odpovědí je seznam názvů pull requestů, kterým nikdo mimo tým nerozumí, a nápověda pořád ukazuje pokladnu o dvě verze starší. Přijaté běhy přitom obsahují každou obrazovku releasu, takže je changelog i dokumentace mohou ukázat.

## Co nás pálí

Screenshoty v dokumentaci někdo jednou nafotí ručně a s dalším releasem zastarají. Release notes se píšou z commitů. Že návod popisuje tlačítko, které se přestěhovalo, se zjistí, až napíše zákazník.

## Co se změní s Kalokem

Obrázek v Markdownu místo souboru jmenuje krok: `![Platba](kaloko:checkout/payment)` ukáže nejnovější přijatý screenshot toho kroku, `?version=2.4.0` screenshot z daného releasu. Changelog i návody zůstávají ve vašem repozitáři; Kaloko z odkazů udělá obrázky a ukáže je jako stránky, které pošlete klientům, podpoře nebo marketingu.

## Jak to funguje

1. **Jednou nastavte**: `npx kaloko init --docs=changelog` přidá `CHANGELOG.md` a blok konfigurace; `--docs=full` navíc založí složky `docs/` pro tutoriály, návody, referenci a vysvětlení, každou se šablonou.
2. **Nechte připravit záznam**: `kaloko changelog draft` napíše sekci Unreleased z pull requestů zamergovaných od posledního releasu a přidá obrázky před a po u obrazovek, které přijaté běhy ukazují jinak. `--apply` ji zapíše do `CHANGELOG.md`; agent pak řádky přepíše pro lidi.
3. **Zapište release**: `kaloko release 2.4.0` udělá z Unreleased verzi, uloží k ní obrázky a vypíše stránku changelogu. S release-please, changesets nebo semantic-release přidá `kaloko ci github --release` workflow, které to udělá u každého vydaného releasu.
4. **Udržujte návody aktuální**: `kaloko docs publish` pošle složku s dokumentací do Kaloka. Když pak přijatý běh ukáže jinou obrazovku, u sekce stojí „Obrazovka se změnila ve verzi 2.4 — zkontrolujte text.“ a `kaloko docs check` ji vypíše spolu s rozbitými odkazy a chybějícími překlady; v CI skončí kódem 1.
5. **Vyvezte, kam potřebujete**: `kaloko export --format md|docusaurus|vitepress|mkdocs|html|pdf|json` zapíše dokumentaci i changelog s obrázky jako soubory pro váš vlastní web s dokumentací.

## Skilly a prompty

```
Připrav přes Kaloko záznam do changelogu pro tento release, přepiš řádky pro naše zákazníky a nech obrázky před a po.
```

Očekávaný výsledek: sekce Unreleased rozdělená na Added, Changed, Fixed, Removed, jedna změna na řádek, s odkazy na kroky pod řádky, které ukazují. Dokud to neřeknete, nic se nezapíše.

```
Spusť kaloko docs check a oprav každou sekci, jejíž obrazovka se od napsání změnila; změny přelož i do angličtiny.
```

Očekávaný výsledek: zastaralé sekce přepsané podle nových obrazovek, překlady vedle originálů aktualizované a čistý `kaloko docs check`.

## Co dostanete

- Stránku changelogu s posuvníkem mezi před a po, v jazyce a velikosti obrazovky čtenáře, u každého obrázku odkaz na jeho flow na plachtě.
- Návody, které jde projít jako průvodce krok za krokem, s výběrem verze, vyhledáváním a přepínáním jazyka.
- V každém plánu: changelog, nejnovější dokumentaci a export do Markdownu nebo JSON. Od plánu Business: dokumentaci po verzích se zastaralými sekcemi, exporty pro statické weby, HTML a PDF, e‑mail „Co je nového“ u každého releasu, čtenáře z domény vaší firmy a veřejný changelog s feedem.

## Podívejte se, jak to vypadá u nás

Changelog i nápovědu Kaloka vedeme stejně a obojí je veřejné. [Changelog Kaloka](https://kaloko.app/p/sinfin/kaloko/changelog?lang=cs) (anglicky) ukazuje naše vydání s obrázky před a po z běhů, které jsme před vydáním schválili. [Nápověda Kaloka](https://kaloko.app/p/sinfin/kaloko/docs?lang=cs) je složka s dokumentací v našem repozitáři s odkazy na kroky; když přepnete jazyk nebo velikost obrazovky, obrázky se přizpůsobí.

## Otázky

### Musíme dokumentaci přestěhovat do Kaloka?

Ne. Markdown zůstává ve vašem repozitáři a web s dokumentací si nechá vlastní build; export pusťte do jeho složky nebo v jeho CI.

### Co když CHANGELOG.md už píše nástroj pro release?

Kaloko si záznam od nástroje přečte a soubor nikdy nepřepisuje. Svůj návrh pak dejte do pull requestu nebo do release notes.

### Přečtou si klienti changelog bez účtu?

V plánech Business a Enterprise ho admin může otevřít čtenářům z vašich ověřených domén nebo zveřejnit na veřejné adrese s Atom feedem. Hosté projektu čtou changelog svého produktu vždy.
