Kako zgraditi stran z dnevnikom sprememb: vnosi, oznake, RSS in »Novosti«

Stran dnevnika sprememb je datiran seznam tega, kaj se je spremenilo v tvojem izdelku, najnovejše najprej, napisan za ljudi, ki ga uporabljajo. Za izdelavo potrebuješ vnose z datumom, jasnim naslovom, kratko razlago in oznako (Novo, Izboljšano, Popravljeno), stran, ki jih našteje, ločen naslov URL za vsak vnos ter po možnosti vir RSS in način, da uporabnike obvestiš, da je nekaj novega. Gre za eno najpreprostejših stvari, ki jih lahko zgradiš, glavna odločitev pa je, kje živijo vnosi: kot datoteke na tvojem spletnem mestu ali v bazi podatkov s skrbniško stranjo.

Zakaj je dnevnik sprememb koristen

Dnevnik sprememb pokaže strankam in zanimivim kupcem, da je izdelek vzdrževan. Podpori in prodaji da povezavo, ki jo lahko pošljejo, ko nekdo vpraša »ali to že zmore X?«. Je tudi mesto, kjer zaključiš krog povratnih informacij: ko se zahtevana funkcija izda, ljudi usmeriš na njen vnos v dnevniku. Če vodiš portal za povratne informacije strank, izdane zahteve povežeš neposredno z njihovimi vnosi.

Dnevnik sprememb ni tvoja interna zgodovina commitov. »Refaktoriral storitev za obračunavanje« uporabniku ne pomeni nič. »Računi zdaj prikazujejo davčno številko tvojega podjetja« pa pomeni.

Kaj stran potrebuje

Vsebina za vsak vnos

Strani

• Kazalo dnevnika sprememb: najnovejše najprej, s filtri po oznakah in preprostim straničenjem ali gumbom »naloži več«.
• Stran vnosa: en vnos na naslov URL, da ga je mogoče povezati in deliti.
• Vir RSS ali Atom: omogoča ljudem in orodjem, da spremljajo posodobitve brez e-pošte.
• Skrbniška stran (samo v različici z bazo): pisanje, predogled, načrtovanje in objava vnosov.

Dodatki v aplikaciji

• Značka »Novosti«: pika ob elementu menija, kadar obstajajo vnosi, ki jih uporabnik še ni videl. Shrani datum zadnjega odprtega vnosa, na uporabnika ali v brskalniku.
• Povzetek po e-pošti: povzetek, poslan uporabnikom, ki se odločijo zanj. To potrebuje ponudnika za pošiljanje; glej kako pošiljati e-pošto iz aplikacije.

Glavna odločitev: datoteke ali baza

Vnosi kot datoteke na spletnem mestu

Vsak vnos je datoteka Markdown v projektu. Objava vnosa pomeni dodati datoteko in ponovno uvesti. To je najpreprostejši in najbolj robusten pristop: brez baze, brez skrbniške prijave, ničesar za varovanje, strani pa je mogoče vnaprej upodobiti, tako da se hitro naložijo in jih iskalniki preberejo.

Ustreza ekipam, kjer so ljudje, ki pišejo vnose, vajeni prositi graditelja z AI ali urejati datoteke.

Vnosi v bazi s skrbniško stranjo

Vnosi živijo v tabeli, zasebna skrbniška stran pa omogoča komurkoli v ekipi pisanje, predogled, načrtovanje in objavo. To ustreza ekipam, kjer marketing ali podpora piše posodobitve, ali kadar želiš načrtovano objavljanje ali vnose po občinstvu (na primer prikaz funkcij za podjetniške stranke samo podjetniškim strankam).

Cena je več dela pri izdelavi in vzdrževanju: skrbniška prijava, nalaganje slik in zagotavljanje, da so javne strani še vedno berljive za iskalnike, kar stran, ki nalaga vnose samo v brskalniku, morda ni.

Pisanje vnosov, ki jih ljudje berejo

• Začni s koristjo. »Izvoz poročil v Excel« je boljše od »nov modul za izvoz«.
• Povej, kdo to dobi. Vsi paketi, samo Pro, uvaja se ta teden.
• Pokaži. En posnetek zaslona ali kratek posnetek.
• Združuj manjše popravke. Tedenski vnos »Popravki in izboljšave« s točkami prepreči, da bi stran preplavili.
• Bodi iskren glede odstranitev. Če nekaj izginja, povej kdaj in kaj uporabiti namesto tega.

Prvi poziv, ki deluje

Dodaj javni dnevnik sprememb na naše spletno mesto na /changelog. Vsak vnos je datoteka Markdown z naslovom, datumom, oznako (Novo, Izboljšano ali Popravljeno), neobveznim naslovno sliko in vsebino. Kazalo prikazuje vnose od najnovejšega, z datumom, oznako in prvim odstavkom, ima gumbe za filtriranje po oznakah in prikazuje 10 vnosov na stran. Vsak vnos ima svojo stran na /changelog/<slug> z ustreznim naslovom strani in opisom za iskalnike. Dodaj vir RSS na /changelog/rss.xml. Ustvari tri vzorčne vnose. Ujemi obstoječo oblikovno podobo spletnega mesta, poskrbi za berljivost na telefonih in vnaprej upodobi strani, da se hitro naložijo.

Za različico z bazo prvi stavek zamenjaj z: »Shrani vnose v bazo s statusom osnutka/objavljeno in datumom objave ter dodaj skrbniško stran, zaščiteno z geslom, za pisanje, predogled in objavo.«

Koraki gradnje

1. Odloči se za datoteke ali bazo z uporabo zgornje tabele.
2. Zgradi kazalo in strani vnosov z nekaj vzorčnimi vnosi.
3. Dodaj oznake in filtre.
4. Dodaj vir RSS in ga poveži s stranjo.
5. Dodaj naslove strani, opise in vnos v zemljevid strani za vsak vnos. Naš vodnik o SEO za spletna mesta, zgrajena z AI pokrije osnove.
6. Skrbniška stran in prijava, če si izbral pot z bazo.
7. Značka »Novosti« v tvoji aplikaciji.
8. Napiši prave vnose za zadnjih nekaj mesecev, da stran ne bo prazna ob zagonu.

Pogoste napake

• Kopiranje sporočil commitov. Piši za uporabnike, ne za razvijalce.
• Ena ogromna stran brez naslovov URL za posamezne vnose. Nihče ne more povezati določene spremembe, iskalniki pa vidijo eno stran namesto mnogih.
• Posodobitve se ustavijo po enem mesecu. Dnevnik, zadnjič posodobljen pred letom dni, nakazuje zapuščen izdelek. Nastavi ritem, ki ga lahko vzdržuješ.
• Nalaganje vnosov samo v brskalniku. Iskalniki in predogledi povezav lahko vidijo prazno stran. Vnaprej upodobi ali upodabljaj na strežniku.
• Mešanje incidentov. Izpadi sodijo na statusno stran, ne v dnevnik sprememb.

Kdaj je boljše gostovano orodje za dnevnik sprememb

Obstajajo gostovana orodja za dnevnik sprememb in posodobitve izdelkov, nekatera so vključena v table za povratne informacije ali vtičnike v aplikaciji. Vredna so, če želiš pojavno okno v aplikaciji, ciljanje občinstva in analitiko, ne da bi to gradil sam, ali če tvoja ekipa že plačuje orodje, ki jih vključuje. Tvoja programska oprema za blog ali središče za pomoč morda že ima primeren format.

Zgradi svojega, kadar želiš dnevnik sprememb na lastni domeni, v svoji obliki in popolnoma indeksiran, kar za preprost seznam datiranih objav ni veliko dela.

Gradnja z Mythexom

V Mythexu lahko od agenta zahtevaš, da doda dnevnik sprememb v obstoječ projekt ali ga zgradi kot svoje majhno spletno mesto, in ga vidiš v živem predogledu med gradnjo. Različica na podlagi datotek ne potrebuje baze. Če izbereš skrbniško različico, agent doda namensko bazo Postgres, kadar je treba vnose shranjevati (ali vnesi /database), posnetki zaslona pa gredo v shrambo datotek projekta. Prijava za skrbnika je nekaj, kar dodaš s svojim pristopom k avtentikaciji (recept za dodajanje prijave).

Nove aplikacije Mythex so pogosto enostranske aplikacije na strani odjemalca, za katere recept za SEO pove, da so za iskalnike šibkejše, zato zahtevaj statične ali vnaprej upodobljene strani dnevnika, če želiš, da jih iskalniki najdejo. Isti recept pokrije naslove, opise in zemljevide strani. Za izhodišče z vgrajenim dnevnikom sprememb si oglej predlogo središče znanja o izdelku.

Vprašanja