Ako vytvoriť stránku so zmenami: záznamy, štítky, RSS a „Čo je nové“
Stránka so zmenami je zoznam zmien vo vašom produkte s dátumami, od najnovšej po najstaršiu, písaný pre ľudí, ktorí ho používajú. Aby ste ju vytvorili, potrebujete záznamy s dátumom, jasným názvom, krátkym vysvetlením a štítkom (Nové, Vylepšené, Opravené), stránku, ktorá ich vypisuje, samostatnú URL pre každý záznam a ideálne RSS kanál a spôsob, ako používateľovi oznámiť, že je niečo nové. Je to jedna z najjednoduchších vecí, ktoré môžete vytvoriť, a hlavné rozhodnutie je, kde záznamy žijú: ako súbory na vašom webe, alebo v databáze s administračnou stránkou.
Prečo má stránka so zmenami zmysel
Stránka so zmenami ukazuje zákazníkom a záujemcom, že produkt sa udržiava. Podpore a obchodu dáva odkaz, ktorý môžu poslať, keď sa niekto spýta „už to robí X?“. Je to aj miesto, kde uzatvárate spätnú väzbu: keď sa vyžiadaná funkcia nasadí, záznam v zmenách je to, na čo ľudí odkážete. Ak prevádzkujete portál na spätnú väzbu od zákazníkov, priamo prepojte nasadené požiadavky na ich záznamy.
Stránka so zmenami nie je vaša interná história commitov. „Refaktorovaná služba fakturácie“ pre používateľa nič neznamená. „Faktúry teraz zobrazujú DIČ vašej firmy“ áno.
Čo stránka potrebuje
Obsah každého záznamu
| Pole | Poznámky |
|---|---|
| Názov | Čo sa zmenilo, z pohľadu používateľa |
| Dátum | Dátum publikovania, zobrazený na stránke |
| Štítok | Nové, Vylepšené, Opravené (a možno Odstránené alebo Bezpečnosť) |
| Text | Niekoľko viet alebo odrážok; ako to použiť, kto to dostane |
| Obrázok alebo video | Voliteľné; snímka obrazovky pomôže viac než odsek |
| Slug | URL záznamu, napríklad /changelog/invoice-vat-numbers |
| Stav | Koncept alebo publikované, plus dátum naplánovaného publikovania, ak treba |
Stránky
- Zoznam zmien: od najnovšieho, s filtrami štítkov a jednoduchým stránkovaním alebo tlačidlom „načítať ďalšie“.
- Stránka záznamu: jeden záznam na jednu URL, aby sa dal odkazovať a zdieľať.
- RSS alebo Atom kanál: umožňuje ľuďom a nástrojom sledovať aktualizácie bez e-mailu.
- Administračná stránka (len v databázovej verzii): písanie, náhľad, plánovanie a publikovanie záznamov.
Doplnky v aplikácii
- Odznak „Čo je nové“: bodka pri položke menu, keď sú záznamy, ktoré používateľ ešte nevidel. Uložte dátum posledného otvoreného záznamu, pre každého používateľa alebo v prehliadači.
- E-mailový prehľad: súhrn posielaný používateľom, ktorí sa prihlásili. Na to potrebujete poskytovateľa odosielania; pozri ako posielať e-maily z aplikácie.
Hlavné rozhodnutie: súbory, alebo databáza
Záznamy ako súbory na webe
Každý záznam je súbor Markdown v projekte. Publikovanie záznamu znamená pridať súbor a znovu nasadiť. Je to najjednoduchší a najodolnejší prístup: žiadna databáza, žiadne administračné prihlásenie, nič na zabezpečenie a stránky sa dajú predrenderovať, takže sa načítajú rýchlo a vyhľadávače ich ľahko čítajú.
Hodí sa tímom, kde ľudia píšúci záznamy vedia požiadať AI nástroj alebo upraviť súbor.
Záznamy v databáze s administračnou stránkou
Záznamy žijú v tabuľke a súkromná administračná stránka umožňuje komukoľvek v tíme písať, zobrazovať náhľad, plánovať a publikovať. Hodí sa tímom, kde aktualizácie píše marketing alebo podpora, alebo kde chcete plánované publikovanie či záznamy pre konkrétne skupiny (napríklad funkcie pre podnikové plány zobrazovať len podnikovým zákazníkom).
Cena je viac práce pri stavbe a údržbe: administračné prihlásenie, nahrávanie obrázkov a zabezpečenie, že verejné stránky ostanú čitateľné pre vyhľadávače, čo stránka, ktorá načítava záznamy až v prehliadači, nemusí byť.
| Súbory | Databáza + administrácia | |
|---|---|---|
| Kto môže publikovať | Ktokoľvek, kto upravuje projekt | Ktokoľvek s administračným prihlásením |
| Nastavenie | Minimálne | Prihlásenie, úložisko, administračné rozhranie |
| SEO | Jednoduché (predrenderované stránky) | Treba dbať, aby sa stránky renderovali na serveri alebo predrenderovali |
| Plánovanie | Publikovanie pri nasadení | Možno plánovať podľa dátumu |
| Náklady na hosting | Statické | Potrebuje bežiacu aplikáciu a databázu |
Písanie záznamov, ktoré ľudia čítajú
- Začnite výhodou. „Export reportov do Excelu“ je lepšie než „nový modul exportu“.
- Napíšte, kto to dostane. Všetky plány, len Pro, nasadzuje sa tento týždeň.
- Ukážte to. Jedna snímka obrazovky alebo krátky záznam.
- Zoskupujte drobné opravy. Týždenný záznam „Opravy a vylepšenia“ s odrážkami zabráni tomu, aby stránka zaplavila.
- Buďte úprimní pri odstraňovaniach. Ak niečo zaniká, napíšte kedy a čo použiť namiesto toho.
Prvý prompt, ktorý funguje
Pridaj na náš web verejnú stránku so zmenami na /changelog. Každý záznam je súbor Markdown s názvom, dátumom, štítkom (Nové, Vylepšené alebo Opravené), voliteľným titulným obrázkom a textom. Stránka so zoznamom ukazuje záznamy od najnovšieho s dátumom, štítkom a prvým odsekom, má tlačidlá filtrov podľa štítkov a zobrazuje 10 záznamov na stránku. Každý záznam má vlastnú stránku na /changelog/<slug> s riadnym názvom stránky a popisom pre vyhľadávače. Pridaj RSS kanál na /changelog/rss.xml. Vytvor tri vzorové záznamy. Zachovaj existujúci dizajn webu, nech je čitateľné na telefónoch a predrenderuj stránky, aby sa načítali rýchlo.
Pri databázovej verzii nahraďte prvú vetu takto: „Ukladaj záznamy do databázy so stavom koncept/publikované a dátumom publikovania a pridaj administračnú stránku chránenú heslom na písanie, náhľad a publikovanie.“
Kroky stavby
- Rozhodnite sa pre súbory alebo databázu podľa tabuľky vyššie.
- Postavte zoznam a stránky záznamov s niekoľkými vzorovými záznamami.
- Pridajte štítky a filtre.
- Pridajte RSS kanál a odkážte naň zo stránky.
- Pridajte názvy stránok, popisy a položku v sitemape pre každý záznam. Náš sprievodca SEO pre weby vytvorené pomocou AI pokrýva základy.
- Administračná stránka a prihlásenie, ak ste zvolili databázovú cestu.
- Odznak „Čo je nové“ vo vašej aplikácii.
- Napíšte skutočné záznamy za posledné mesiace, aby stránka nezačala prázdna.
Časté chyby
- Kopírovanie commit správ. Píšte pre používateľov, nie pre vývojárov.
- Jedna obrovská stránka bez URL pre jednotlivé záznamy. Nikto nemôže odkázať na konkrétnu zmenu a vyhľadávače vidia jednu stránku namiesto mnohých.
- Aktualizácie sa zastavia po mesiaci. Stránka so zmenami naposledy aktualizovaná pred rokom naznačuje opustený produkt. Nastavte si rytmus, ktorý udržíte.
- Načítanie záznamov len v prehliadači. Vyhľadávače a náhľady odkazov môžu vidieť prázdnu stránku. Predrenderujte alebo renderujte na serveri.
- Miešanie výpadkov. Výpadky patria na stránku so stavom, nie na stránku so zmenami.
Kedy je lepšia hotová služba na zmeny
Existujú hotové nástroje na stránky so zmenami a aktualizácie produktu, niektoré sú zabalené s nástenkami spätnej väzby alebo widgetmi v aplikácii. Stoja za to, ak chcete vyskakovacie okno v aplikácii, cielenie na publikum a analytiku bez toho, aby ste ich budovali, alebo ak váš tím už platí nástroj, ktorý ju obsahuje. Softvér pre blog alebo centrum pomoci môže mať tiež vhodný formát.
Vlastnú stránku si postavte, keď chcete stránku so zmenami na vlastnej doméne, vo vlastnom dizajne a plne indexovateľnú, čo pri jednoduchom zozname datovaných záznamov nie je veľa práce.
Stavba s Mythex
V Mythex môžete agenta požiadať, aby pridal stránku so zmenami do existujúceho projektu alebo ju postavil ako samostatný malý web, a vidieť ju v živom náhľade počas stavby. Verzia so súbormi nepotrebuje databázu. Ak zvolíte administračnú verziu, agent pridá vyhradenú databázu Postgres, keď treba ukladať záznamy (alebo napíšte /database), a snímky obrazoviek idú do úložiska súborov projektu. Prihlásenie do administrácie pridávate vlastným prístupom k autentifikácii (recept na pridanie prihlásenia).
Nové aplikácie Mythex sú často jednostránkové aplikácie renderované v klientovi, o ktorých recept na SEO uvádza, že sú pre vyhľadávanie slabšie, takže ak chcete, aby sa záznamy našli vo vyhľadávaní, požiadajte o statické alebo predrenderované stránky so zmenami. Ten istý recept pokrýva názvy, popisy a sitemapy. Ako východiskový bod s vstavanou stránkou so zmenami pozrite šablónu centrum znalostí produktu.
Otázky
Čo má obsahovať záznam v zmenách?
Dátum, krátky názov, ktorý hovorí, čo sa zmenilo pre používateľa, niekoľko viet alebo odrážok, ktoré to vysvetľujú, štítok ako Nové, Vylepšené alebo Opravené a voliteľne snímku obrazovky a odkaz na podrobnosti.
Potrebuje stránka so zmenami databázu?
Nemusí. Ak aktualizácie publikujú jeden alebo dvaja ľudia, záznamy môžu byť súbormi Markdown na webe a publikujú sa pri každom nasadení. Databázu použite vtedy, keď musia záznamy písať a plánovať netechnickí ľudia z administračnej stránky.
Ako často by som mal stránku so zmenami aktualizovať?
Vždy, keď sa zmení niečo, čo si používatelia všimnú. Mnohé malé produkty zoskupujú zmeny každý týždeň alebo každé dva týždne; dôležitý je pravidelný rytmus, aby stránka pôsobila živo.
Pomáha stránka so zmenami SEO?
Trochu môže: každý záznam je stránka o funkcii, ktorú vyhľadávače dokážu prechádzať, a pravidelne aktualizovaná stránka signalizuje aktívny produkt. Každému záznamu dajte vlastnú URL a výstižný názov.