Kā izveidot izmaiņu žurnāla lapu: ieraksti, tagi, RSS un „Kas jauns”
Izmaiņu žurnāla lapa ir datēts saraksts ar to, kas mainījies jūsu produktā, jaunākie pirmie, rakstīts tiem, kas to lieto. Lai to izveidotu, vajag ierakstus ar datumu, skaidru nosaukumu, īsu skaidrojumu un tagu (Jauns, Uzlabots, Labots), lapu, kas tos uzskaita, atsevišķu URL katram ierakstam un ideālā gadījumā RSS plūsmu un veidu, kā lietotājiem pateikt, ka ir kaut kas jauns. Tā ir viena no vienkāršākajām lietām, ko var izveidot, un galvenais lēmums ir, kur dzīvo ieraksti: kā faili vietnē vai datubāzē ar administratora lapu.
Kāpēc izmaiņu žurnāls ir vērts
Izmaiņu žurnāls parāda klientiem un potenciālajiem klientiem, ka produkts tiek uzturēts. Tas dod atbalstam un pārdošanai saiti, ko nosūtīt, kad kāds jautā „vai tas jau dara X?”. Tā ir arī vieta, kur aizvērt atgriezenisko saiti: kad pieprasīta funkcija tiek izlaista, izmaiņu žurnāla ieraksts ir tas, uz ko norādāt cilvēkus. Ja vadāt klientu atsauksmju portālu, saistiet izpildītos pieprasījumus tieši ar to ierakstiem.
Izmaiņu žurnāls nav jūsu iekšējā commit vēsture. „Pārstrādāts norēķinu serviss” lietotājam nozīmē neko. „Rēķinos tagad redzams jūsu uzņēmuma PVN numurs” nozīmē.
Ko lapai vajag
Saturs katram ierakstam
| Lauks | Piezīmes |
|---|---|
| Nosaukums | Kas mainījies, no lietotāja viedokļa |
| Datums | Publicēšanas datums, redzams lapā |
| Tags | Jauns, Uzlabots, Labots (un varbūt Noņemts vai Drošība) |
| Saturs | Daži teikumi vai punkti; kā to lietot, kam tas pieejams |
| Attēls vai video | Pēc izvēles; ekrānuzņēmums palīdz vairāk nekā rindkopa |
| Slug | Ieraksta URL, piemēram, /changelog/invoice-vat-numbers |
| Statuss | Melnraksts vai publicēts, plus ieplānots publicēšanas datums, ja vajag |
Lapas
- Izmaiņu žurnāla indekss: jaunākie pirmie, ar tagu filtriem un vienkāršu lapošanu vai „ielādēt vairāk”.
- Ieraksta lapa: viens ieraksts vienā URL, lai to var saistīt un dalīties.
- RSS vai Atom plūsma: ļauj cilvēkiem un rīkiem sekot atjauninājumiem bez e-pasta.
- Administratora lapa (tikai datubāzes versijā): rakstīt, priekšskatīt, plānot un publicēt ierakstus.
Papildinājumi lietotnē
- „Kas jauns” zīme: punkts blakus izvēlnes vienumam, kad ir ieraksti, ko lietotājs nav redzējis. Glabājiet pēdējā atvērtā ieraksta datumu katram lietotājam vai pārlūkā.
- E-pasta kopsavilkums: kopsavilkums lietotājiem, kas to ir izvēlējušies. Tam vajag sūtīšanas pakalpojumu sniedzēju; skatiet kā sūtīt e-pastus no lietotnes.
Galvenais lēmums: faili vai datubāze
Ieraksti kā faili vietnē
Katrs ieraksts ir Markdown fails projektā. Ieraksta publicēšana nozīmē faila pievienošanu un jaunu izvietošanu. Šī ir vienkāršākā un izturīgākā pieeja: nav datubāzes, nav administratora pieteikšanās, nav nekā, ko nodrošināt, un lapas var iepriekš renderēt, lai tās ielādētos ātri un meklētājiem būtu viegli nolasīt.
Tas der komandām, kur cilvēki, kas raksta ierakstus, ir ērti ar AI veidotāju vai failu labošanu.
Ieraksti datubāzē ar administratora lapu
Ieraksti atrodas tabulā, un privāta administratora lapa ļauj ikvienam komandā rakstīt, priekšskatīt, plānot un publicēt. Tas der komandām, kur mārketings vai atbalsts raksta atjauninājumus, vai kur vēlaties plānotu publicēšanu vai ierakstus pa auditorijām (piemēram, rādīt uzņēmuma funkcijas tikai uzņēmuma klientiem).
Cena ir vairāk darba izveidē un uzturēšanā: administratora pieteikšanās, attēlu augšupielāde un nodrošinājums, ka publiskās lapas joprojām var nolasīt meklētāji — ko lapa, kas ielādē ierakstus tikai pārlūkā, var nespēt.
| Faili | Datubāze + administrators | |
|---|---|---|
| Kas var publicēt | Ikviens, kas rediģē projektu | Ikviens ar administratora pieteikšanos |
| Uzstādīšana | Minimāla | Pieteikšanās, glabātuve, administratora saskarne |
| SEO | Viegls (iepriekš renderētas lapas) | Vajag rūpību, lai lapas tiktu renderētas serverī vai iepriekš |
| Plānošana | Publicē, kad izvieto | Var plānot pēc datuma |
| Hostinga izmaksas | Statiskas | Vajag darbojošos lietotni un datubāzi |
Kā rakstīt ierakstus, ko cilvēki lasa
- Sāciet ar ieguvumu. „Eksportē pārskatus uz Excel” ir labāk nekā „Jauns eksporta modulis”.
- Pasakiet, kam tas pieejams. Visiem plāniem, tikai Pro, tiek ieviests šonedēļ.
- Parādiet to. Viens ekrānuzņēmums vai īss klips.
- Grupējiet mazus labojumus. Iknedēļas ieraksts „Labojumi un uzlabojumi” ar punktiem neļauj lapai pārpludināt.
- Esiet godīgi par noņemšanu. Ja kaut kas tiks likvidēts, pasakiet, kad un ko izmantot tā vietā.
Piemēra pirmā uzvedne
Pievieno publisku izmaiņu žurnālu mūsu vietnei adresē /changelog. Katrs ieraksts ir Markdown fails ar nosaukumu, datumu, tagu (Jauns, Uzlabots vai Labots), pēc izvēles vāka attēlu un saturu. Indeksa lapa uzskaita ierakstus, jaunākie pirmie, ar datumu, tagu un pirmo rindkopu, ir tagu filtru pogas un rāda 10 ierakstus lapā. Katram ierakstam ir sava lapa adresē /changelog/<slug> ar pareizu lapas nosaukumu un aprakstu meklētājiem. Pievieno RSS plūsmu adresē /changelog/rss.xml. Izveido trīs paraugierakstus. Saskaņo ar esošo vietnes dizainu, padari lasāmu telefonos un iepriekš renderē lapas, lai tās ielādētos ātri.
Datubāzes versijai aizstājiet pirmo teikumu ar „Glabā ierakstus datubāzē ar melnraksta/publicēts statusu un publicēšanas datumu, un pievieno uz paroli aizsargātu administratora lapu, lai tos rakstītu, priekšskatītu un publicētu.”
Veidošanas soļi
- Izlemiet faili vai datubāze, izmantojot tabulu augstāk.
- Izveidojiet indeksa un ierakstu lapas ar dažiem paraugierakstiem.
- Pievienojiet tagus un filtrus.
- Pievienojiet RSS plūsmu un saistiet to no lapas.
- Pievienojiet lapu nosaukumus, aprakstus un vietnes kartes ierakstu katram ierakstam. Mūsu ceļvedis SEO AI veidotām vietnēm aptver pamatus.
- Administratora lapa un pieteikšanās, ja izvēlējāties datubāzes ceļu.
- „Kas jauns” zīme jūsu lietotnē.
- Uzrakstiet īstus ierakstus par pēdējiem pāris mēnešiem, lai lapa netiktu palaista tukša.
Biežākās kļūdas
- Commit ziņojumu kopēšana. Rakstiet lietotājiem, nevis izstrādātājiem.
- Viena milzīga lapa bez ierakstu URL. Neviens nevar saistīt konkrētu izmaiņu, un meklētāji redz vienu lapu, nevis daudzas.
- Atjauninājumi apstājas pēc mēneša. Izmaiņu žurnāls, kas pēdējo reizi atjaunināts pirms gada, liek domāt par pamestu produktu. Iestatiet ritmu, ko varat noturēt.
- Ierakstu ielāde tikai pārlūkā. Meklētāji un saišu priekšskatījumi var redzēt tukšu lapu. Iepriekš renderējiet vai renderējiet serverī.
- Incidentu sajaukšana. Dīkstāves pieder statusa lapai, nevis izmaiņu žurnālam.
Kad labāka izvēle ir hostēts izmaiņu žurnāla rīks
Eksistē hostēti izmaiņu žurnāla un produkta atjauninājumu rīki, daži ir iekļauti kopā ar atsauksmju dēļiem vai lietotnes logrīkiem. Tie ir vērti, ja vēlaties lietotnes uznirstošo logu, auditorijas mērķēšanu un analītiku bez to veidošanas vai ja jūsu komanda jau maksā par rīku, kas to iekļauj. Jūsu blogu vai palīdzības centra programmatūrai var jau būt piemērots formāts.
Savu veidot ir jēga, ja vēlaties izmaiņu žurnālu savā domēnā, savā dizainā un pilnīgi indeksējamu, kas vienkāršam datētu ierakstu sarakstam nav liels darbs.
Veidošana ar Mythex
Mythex varat lūgt aģentam pievienot izmaiņu žurnālu esošam projektam vai izveidot to kā atsevišķu mazu vietni un redzēt to tiešraides priekšskatījumā, kamēr tas top. Failu versijai datubāze nav vajadzīga. Ja izvēlaties administratora versiju, aģents pievieno atsevišķu Postgres datubāzi, kad ierakstus vajag saglabāt (vai ierakstiet /database), un ekrānuzņēmumi tiek glabāti projekta failu glabātuvē. Administratora pieteikšanos pievienojat ar savu autentifikācijas pieeju (pieteikšanās receptes).
Jaunas Mythex lietotnes bieži ir klienta pusē renderētas vienas lapas lietotnes, un SEO recepte norāda, ka tās ir vājākas meklēšanai, tāpēc, ja vēlaties, lai ieraksti tiktu atrasti meklēšanā, lūdziet statiskas vai iepriekš renderētas izmaiņu žurnāla lapas. Tā pati recepte aptver nosaukumus, aprakstus un vietnes kartes. Sākumpunktam ar iebūvētu izmaiņu žurnālu skatiet produktu zināšanu centra veidni.
Jautājumi
Kas jāiekļauj izmaiņu žurnāla ierakstā?
Datums, īss nosaukums, kas pasaka, kas lietotājam ir mainījies, daži teikumi vai punkti to paskaidrot, tags, piemēram, Jauns, Uzlabots vai Labots, un pēc izvēles ekrānuzņēmums un saite uz sīkāku informāciju.
Vai izmaiņu žurnālam vajag datubāzi?
Ne obligāti. Ja atjauninājumus publicē viens vai divi cilvēki, ieraksti var atrasties Markdown failos vietnē un tikt publicēti ar katru izvietošanu. Datubāze vajadzīga, ja ne-tehniskiem cilvēkiem ieraksti jāraksta un jāplāno administratora lapā.
Cik bieži jāatjaunina izmaiņu žurnāls?
Ikreiz, kad mainās kaut kas, ko lietotāji pamanītu. Daudzi mazi produkti grupē izmaiņas nedēļas vai divu nedēļu laikā; svarīgi ir stabils ritms, lai lapa izskatītos dzīva.
Vai izmaiņu žurnāls ir labs SEO?
Tas var nedaudz palīdzēt: katrs ieraksts ir meklētāju indeksējama lapa par funkciju, un regulāri atjaunināta lapa signalizē par aktīvu produktu. Piešķiriet katram ierakstam savu URL un aprakstošu nosaukumu.