Jak vytvořit stránku changelogu: položky, štítky, RSS a „Co je nového“

Stránka changelogu je seznam změn ve vašem produktu, seřazený od nejnovějších, psaný pro lidi, kteří produkt používají. Abyste ji postavili, potřebujete položky s datem, jasným názvem, krátkým vysvětlením a štítkem (Nové, Vylepšeno, Opraveno), stránku, která je vypisuje, samostatnou URL pro každou položku a ideálně RSS kanál a způsob, jak uživatelům říct, že je něco nového. Je to jedna z nejjednodušších věcí, které můžete postavit. Hlavní rozhodnutí je, kde položky žijí: jako soubory na webu, nebo v databázi s administrační stránkou.

Proč má changelog smysl

Changelog ukazuje zákazníkům a zájemcům, že produkt se udržuje. Dává podpoře a obchodu odkaz, který mohou poslat, když se někdo zeptá „umí to už X?“. Je to také místo, kde uzavřete zpětnou vazbu: když se vyžádaná funkce dostane do produktu, položka v changelogu je to, na co lidem ukážete. Pokud provozujete portál pro zpětnou vazbu od zákazníků, odkazujte vyřízené požadavky přímo na jejich položky.

Changelog není vaše interní historie commitů. „Refaktorován servis fakturace“ uživateli nic neříká. „Faktury nyní zobrazují DIČ vaší firmy“ ano.

Co stránka potřebuje

Obsah každé položky

Stránky

• Přehled changelogu: od nejnovějších, s filtry podle štítků a jednoduchým stránkováním nebo tlačítkem „načíst další“.
• Stránka položky: jedna položka na jedné URL, aby ji šlo odkázat a sdílet.
• RSS nebo Atom kanál: umožní lidem a nástrojům sledovat změny bez e-mailu.
• Administrační stránka (jen u verze s databází): psaní, náhled, plánování a publikování položek.

Extras v aplikaci

• Odznak „Co je nového“: tečka u položky menu, když jsou položky, které uživatel neviděl. Uložte datum poslední položky, kterou otevřel, pro každého uživatele nebo v prohlížeči.
• Souhrn e-mailem: shrnutí zasílané uživatelům, kteří se k němu přihlásili. To potřebuje odesílatele e-mailů; viz jak posílat e-maily z aplikace.

Hlavní rozhodnutí: soubory, nebo databáze

Položky jako soubory na webu

Každá položka je soubor Markdown v projektu. Publikování položky znamená přidat soubor a znovu nasadit. Je to nejjednodušší a nejodolnější přístup: žádná databáze, žádné přihlášení do administrace, nic k zabezpečení, a stránky lze předrenderovat, takže se rychle načtou a vyhledávače je dobře čtou.

Hodí se pro týmy, kde lidé píšící položky umějí požádat AI tvůrce nebo upravit soubor.

Položky v databázi s administrační stránkou

Položky žijí v tabulce a soukromá administrační stránka umožňuje komukoli z týmu psát, zobrazit náhled, plánovat a publikovat. Hodí se pro týmy, kde aktualizace píše marketing nebo podpora, nebo když chcete plánované publikování či položky pro různé publikum (například zobrazit funkce pro firemní zákazníky jen firemním zákazníkům).

Cena je víc práce na stavbu i údržbu: přihlášení do administrace, nahrávání obrázků a zajištění, aby veřejné stránky byly stále čitelné pro vyhledávače, což stránka načítající položky jen v prohlížeči nemusí být.

Psaní položek, které lidé čtou

• Začněte přínosem. „Export reportů do Excelu“ je lepší než „nový modul exportu“.
• Řekněte, pro koho to je. Všechny tarify, jen Pro, zavádí se tento týden.
• Ukažte to. Jeden snímek obrazovky nebo krátký klip.
• Seskupujte drobné opravy. Týdenní položka „Opravy a vylepšení“ s odrážkami udrží stránku od zahlcení.
• Buďte upřímní u odstranění. Pokud něco mizí, řekněte kdy a co použít místo toho.

Příklad prvního promptu

Přidej na náš web veřejný changelog na adrese /changelog. Každá položka je soubor Markdown s názvem, datem, štítkem (Nové, Vylepšeno nebo Opraveno), volitelným úvodním obrázkem a textem. Přehledová stránka vypisuje položky od nejnovějších s datem, štítkem a prvním odstavcem, má tlačítka filtrů podle štítků a zobrazuje 10 položek na stránku. Každá položka má vlastní stránku na /changelog/<slug> s řádným titulkem stránky a popisem pro vyhledávače. Přidej RSS kanál na /changelog/rss.xml. Vytvoř tři ukázkové položky. Odpovídej existujícímu designu webu, zachovej čitelnost na telefonu a předrenderuj stránky, aby se načítaly rychle.

Pro verzi s databází nahraď první větu takto: „Ukládej položky do databáze se stavem koncept/publikováno a datem zveřejnění a přidej administrační stránku chráněnou heslem pro psaní, náhled a publikování.“

Postup stavby

1. Rozhodněte, zda soubory, nebo databáze, podle tabulky výše.
2. Postavte přehled a stránky položek s několika ukázkovými položkami.
3. Přidejte štítky a filtry.
4. Přidejte RSS kanál a odkaz na něj ze stránky.
5. Nastavte titulky stránek, popisy a položky v mapě stránek pro každou položku. Náš návod SEO pro weby vytvořené s AI pokrývá základy.
6. Administrační stránka a přihlášení, pokud jste zvolili variantu s databází.
7. Odznak „Co je nového“ ve vaší aplikaci.
8. Napište skutečné položky za posledních několik měsíců, aby stránka nespustila prázdná.

Časté chyby

• Kopírování zpráv z commitů. Pište pro uživatele, ne pro vývojáře.
• Jedna obří stránka bez URL pro jednotlivé položky. Nikdo nemůže odkázat na konkrétní změnu a vyhledávače vidí jednu stránku místo mnoha.
• Aktualizace se zastaví po měsíci. Changelog naposledy aktualizovaný před rokem naznačuje opuštěný produkt. Nastavte tempo, které dokážete udržet.
• Načítání položek jen v prohlížeči. Vyhledávače a náhledy odkazů mohou vidět prázdnou stránku. Předrenderujte nebo renderujte na serveru.
• Míchání incidentů. Výpadky patří na stránku se stavem služeb, ne do changelogu.

Kdy je lepší hotový nástroj pro changelog

Existují hostované nástroje pro changelog a aktualizace produktu a některé přicházejí v balíku s nástěnkami zpětné vazby nebo widgety v aplikaci. Stojí za to, pokud chcete vyskakovací okno v aplikaci, cílení na publikum a analytiku bez jejich stavby, nebo pokud váš tým už platí nástroj, který to obsahuje. Software pro blog nebo centrum nápovědy může mít vhodný formát už teď.

Vlastní changelog dává smysl, když ho chcete na své doméně, ve svém designu a plně indexovatelný. U jednoduchého seznamu datovaných příspěvků to není mnoho práce.

Stavba s Mythexem

V Mythexu můžete agenta požádat, aby přidal changelog do existujícího projektu, nebo ho postavil jako samostatný malý web, a vidíte ho v živém náhledu během stavby. Verze založená na souborech nepotřebuje databázi. Pokud zvolíte administrační verzi, agent přidá vyhrazenou databázi Postgres, jakmile je potřeba ukládat položky (nebo napište /database), a snímky obrazovky půjdou do úložiště souborů projektu. Přihlášení do administrace přidáte vlastním přístupem k autentizaci (recept na přidání přihlášení).

Nové aplikace Mythexu jsou často jednostránkové aplikace renderované v klientovi, o kterých recept pro SEO říká, že jsou pro vyhledávače slabší. Pokud chcete, aby se položky našly ve vyhledávání, požádejte o statické nebo předrenderované stránky changelogu. Stejný recept pokrývá titulky, popisy a mapy stránek. Pro výchozí bod s vestavěným changelogem se podívejte na šablonu centrum znalostí produktu.

Otázky