Kuidas ehitada muudatuste logi: kirjed, sildid, RSS ja „Mis on uut“

Muudatuste logi on kuupäevastatud loend sellest, mis sinu tootes muutus, uusim kõige ees, kirjutatud neile, kes seda kasutavad. Selle ehitamiseks vajad kirjeid kuupäevaga, selge pealkirja, lühikese selgituse ja sildi (Uus, Täiustatud, Parandatud), lehte, mis neid loetleb, eraldi URL-i iga kirje jaoks ning soovitavalt RSS-voogu ja viisi kasutajatele öelda, et midagi on uut. See on üks lihtsamaid asju, mida saad ehitada. Peamine otsus on see, kus kirjed elavad: failidena sinu saidis või andmebaasis koos haldusleheküljega.

Miks muudatuste logi on väärt

Muudatuste logi näitab klientidele ja huvilistele, et toodet hooldatakse. See annab müügile ja toele lingi, mida saata, kui keegi küsib „kas see teeb juba X-i?“. See on ka koht tagasisidesse ringi sulgemiseks: kui soovitud funktsioon ilmub, on muudatuste logi kirje see, mille peale inimesi suunad. Kui sul on kliendi tagasisidepordi, lingi valminud soovid otse nende kirjetega.

Muudatuste logi ei ole sinu sisemine commitide ajalugu. „Refaktoreeriti arvelduse teenust“ ei tähenda kasutajale midagi. „Arved näitavad nüüd sinu ettevõtte käibemaksunumbrit“ tähendab.

Mida lehel peab olema

Kirje sisu

Lehed

• Muudatuste logi esileht: uusim kõige ees, siltide filtrid ja lihtne lehekülgede jaotus või „lae rohkem“.
• Kirje leht: üks kirje ühe URL-i kohta, nii et seda saab linkida ja jagada.
• RSS- või Atom-voog: lubab inimestel ja tööriistadel uuendusi jälgida ilma e-kirjata.
• Haldusleht (ainult andmebaasi versioonis): kirjuta, eelvaata, ajasta ja avalda kirjeid.

Rakenduse sisesed lisad

• „Mis on uut“ märk: punkt menüüelemendil, kui on kirjeid, mida kasutaja pole näinud. Salvesta viimase avatud kirje kuupäev kasutaja kohta või brauserisse.
• E-posti kokkuvõte: kokkuvõte, mis saadetakse nõusoleku andnud kasutajatele. See nõuab saatmisteenust; vaata kuidas saata rakendusest e-kirju.

Peamine otsus: failid või andmebaas

Kirjed failidena saidis

Iga kirje on Markdown-fail projektis. Uuenduse avaldamiseks lisad faili ja juurutad uuesti. See on kõige lihtsam ja vastupidavam lähenemine: andmebaasi pole, haldussisselogimist pole, midagi ei pea kindlustama, ja lehti saab eelrenderdada, et need laeksid kiiresti ja oleksid otsingumootoritele hõlpsasti loetavad.

See sobib meeskondadele, kus kirjutajad on mugavad AI-ehitajalt paluma või faili muutma.

Kirjed andmebaasis koos haldusleheküljega

Kirjed elavad tabelis ja privaatne haldusleht lubab meeskonna liikmetel kirjutada, eelvaadata, ajastada ja avaldada. See sobib meeskondadele, kus turundus või tugi kirjutab uuendusi, või kui tahad ajastatud avaldamist või publikuspetsiifilisi kirjeid (näiteks näidata ettevõtte klientidele ainult ettevõtte funktsioone).

Hind on rohkem ehitamist ja hooldust: haldussisselogimine, pildi üleslaadimine ning avalike lehtede jäämine otsingumootoritele loetavaks. Leht, mis laadib kirjed ainult brauseris, ei pruugi seda olla.

Kirjutamine, mida inimesed loevad

• Alusta kasuga. „Ekspordi aruanded Exceli“ on parem kui „Uus eksportimismoodul“.
• Ütle, kellele see on. Kõik paketid, ainult Pro, levib sel nädalal.
• Näita seda. Üks ekraanipilt või lühike klipp.
• Koonda väiksed parandused. Iganädalane kirje „Parandused ja täiustused“ punktidega hoiab lehe ülevoolust eemal.
• Ole eemaldamistes aus. Kui midagi kaob, ütle millal ja mida kasutada selle asemel.

Esimene prompt, mis töötab

Lisa meie saidile avalik muudatuste logi aadressil /changelog. Iga kirje on Markdown-fail, millel on pealkiri, kuupäev, silt (Uus, Täiustatud või Parandatud), valikuline kaanepilt ja sisu. Esileht loetleb kirjed uusimast vanimani, kuupäeva, sildi ja esimese lõigu järgi, sildinupud filtriks ja 10 kirjet lehe kohta. Igal kirjel on oma leht aadressil /changelog/<slug>, millel on korralik lehe pealkiri ja kirjeldus otsingumootorite jaoks. Lisa RSS-voog aadressil /changelog/rss.xml. Loo kolm näidiskirjet. Sobita olemasoleva saidi disainiga, hoia loetav telefonides ja eelrenderda lehed, et need laeksid kiiresti.

Andmebaasi versiooni jaoks vaheta esimene lause välja lausega: „Salvesta kirjed andmebaasis mustandi/avaldatud staatuse ja avaldamise kuupäevaga ning lisa parooliga kaitstud haldusleht, kus neid kirjutada, eelvaadata ja avaldada.“

Ehitamise sammud

1. Otsusta failid või andmebaas ülaltoodud tabeli põhjal.
2. Ehita esileht ja kirjete lehed mõne näidiskirjega.
3. Lisa sildid ja filtrid.
4. Lisa RSS-voog ja lingi see lehelt.
5. Lisa lehe pealkirjad, kirjeldused ja saidikaardi kirje iga kirje jaoks. Meie juhend SEO AI-ga ehitatud veebisaitidele katab põhitõed.
6. Haldusleht ja sisselogimine, kui valisid andmebaasi tee.
7. „Mis on uut“ märk sinu rakenduses.
8. Kirjuta päris kirjed viimase paari kuu kohta, et leht ei avaneks tühjana.

Levinud vead

• Commit-sõnumite kopeerimine. Kirjuta kasutajatele, mitte arendajatele.
• Üks tohutu leht ilma kirjete URL-ideta. Keegi ei saa linkida konkreetset muudatust ja otsingumootorid näevad ühte lehte, mitte paljusid.
• Uuendused seisavad pärast kuud. Aasta tagasi viimati uuendatud muudatuste logi viitab hüljatud tootele. Sea rütm, mida suudad hoida.
• Kirjete laadimine ainult brauseris. Otsingumootorid ja lingieelvaated võivad näha tühja lehte. Eelrenderda või renderda serveris.
• Intsidentide segamine. Katkestused kuuluvad staatuslehele, mitte muudatuste logisse.

Millal on hostitud muudatuste logi tööriist parem valik

Olemas on hostitud muudatuste logi ja tootevärskenduste tööriistu, mõni tuleb koos tagasiside tahvlite või rakendussiseste vidinatega. Need on väärt, kui tahad rakenduse hüpikakent, sihtimist ja analüütikat ilma nende ehitamiseta või kui su meeskond maksab juba tööriista eest, mis seda sisaldab. Sinu blogi- või abikeskkonna tarkvaral võib samuti olla sobiv vorming.

Oma ehitamine on mõttekas, kui tahad muudatuste logi oma domeenil, oma disainiga ja täielikult indekseeritavana. Lihtsa kuupäevastatud postituste loendi puhul pole see palju tööd.

Muudatuste logi ehitamine Mythexiga

Mythexis saad paluda agendil lisada muudatuste logi olemasolevale projektile või ehitada selle eraldi väikese saidina ning näha seda live-eelvaates ehitamise ajal. Failipõhine versioon ei vaja andmebaasi. Kui valid adminversiooni, lisab agent spetsiaalse Postgresi andmebaasi, kui kirjeid on vaja salvestada (või sisesta /database), ja ekraanipildid lähevad projekti failisalvestusse. Haldussisselogimise lisad ise oma autentimisviisiga (sisselogimise retsept).

Uued Mythexi rakendused on sageli kliendipoolsed ühe lehe rakendused, mida SEO retsept peab otsingu jaoks nõrgemaks. Seega palu muudatuste logi lehtedele staatilist või eelrenderdatud versiooni, kui tahad, et kirjeid leitakse otsingus. Sama retsept katab pealkirjad, kirjeldused ja saidikaardid. Valmis muudatuste logiga alguspunkti jaoks vaata toote teadmuskeskuse malli.

Küsimused