Kaip sukurti pakeitimų žurnalo puslapį: įrašai, žymos, RSS ir „Kas naujo“

Pakeitimų žurnalo puslapis – tai datuotas sąrašas, kas pasikeitė jūsų produkte, naujausi pirmi, parašytas žmonėms, kurie juo naudojasi. Jam sukurti reikia įrašų su data, aiškiu pavadinimu, trumpu paaiškinimu ir žyma (Naujas, Patobulinta, Ištaisyta), puslapio, kuris juos išvardija, atskiro URL kiekvienam įrašui ir, idealiu atveju, RSS srauto bei būdo pasakyti naudotojams, kad yra naujienų. Tai vienas paprasčiausių dalykų, kuriuos galite sukurti, o pagrindinis sprendimas – kur gyvena įrašai: kaip failai jūsų svetainėje ar duomenų bazėje su administravimo puslapiu.

Kodėl pakeitimų žurnalas verta

Pakeitimų žurnalas parodo klientams ir potencialiems klientams, kad produktas prižiūrimas. Jis suteikia palaikymo ir pardavimų komandai nuorodą, kurią galima išsiųsti, kai kas nors klausia „ar tai jau daro X?“. Tai taip pat vieta uždaryti grįžtamąjį ryšį: kai įgyvendinama prašyta funkcija, žmonėms nukreipiate į pakeitimo įrašą. Jei vedate klientų atsiliepimų portalą, įgyvendintas užklausas tiesiogiai sieskite su jų įrašais.

Pakeitimų žurnalas nėra jūsų vidinė commit istorija. „Perdarytas atsiskaitymo servisas“ naudotojui nieko nereiškia. „Sąskaitose dabar rodomas jūsų įmonės PVM numeris“ – reiškia.

Ko reikia puslapiui

Turinys kiekvienam įrašui

Puslapiai

• Pakeitimų žurnalo indeksas: naujausi pirmi, su žymų filtrais ir paprastu puslapiavimu arba „įkelti daugiau“.
• Įrašo puslapis: vienas įrašas viename URL, kad jį būtų galima pasidalinti ar nuorodą pateikti.
• RSS arba Atom srautas: leidžia žmonėms ir įrankiams sekti naujienas be el. laiškų.
• Administravimo puslapis (tik duomenų bazės versijoje): rašyti, peržiūrėti, planuoti ir publikuoti įrašus.

Papildomi dalykai programoje

• „Kas naujo“ ženkliukas: taškas meniu punkte, kai yra įrašų, kurių naudotojas dar nematė. Išsaugokite paskutinio atidaryto įrašo datą – kiekvienam naudotojui arba naršyklėje.
• El. laiškų apžvalga: santrauka, siunčiama naudotojams, kurie sutiko. Tam reikia siuntimo paslaugos teikėjo; žr. kaip siųsti el. laiškus iš programos.

Pagrindinis sprendimas: failai ar duomenų bazė

Įrašai kaip failai svetainėje

Kiekvienas įrašas yra Markdown failas projekte. Įrašui paskelbti pridedate failą ir iš naujo diegiate. Tai paprasčiausias ir patikimiausias būdas: nėra duomenų bazės, administratoriaus prisijungimo, nieko, ką reikia apsaugoti, o puslapiai gali būti iš anksto suformuoti, todėl greitai įkeliami ir lengvai skaitomi paieškos sistemoms.

Tinka komandoms, kuriose žmonės, rašantys įrašus, yra patogūs prašyti DI kūrimo įrankio arba redaguoti failą.

Įrašai duomenų bazėje su administravimo puslapiu

Įrašai gyvena lentelėje, o privatus administravimo puslapis leidžia visai komandai rašyti, peržiūrėti, planuoti ir publikuoti. Tai tinka komandoms, kuriose rinkodara ar palaikymas rašo naujienas, arba kai norite planuoti publikavimą ar rodyti įrašus skirtingoms auditorijoms (pvz., rodyti įmonių funkcijas tik įmonių klientams).

Kaina – daugiau darbo kuriant ir prižiūrint: administratoriaus prisijungimas, nuotraukų įkėlimas ir užtikrinimas, kad viešieji puslapiai vis dar būtų paieškos sistemoms pasiekiami, o puslapis, kuris įrašus įkelia tik naršyklėje, to gali nepasiekti.

Kaip rašyti įrašus, kuriuos žmonės skaito

• Pradėkite nuo naudos. „Eksportuoti ataskaitas į Excel“ geriau nei „Naujas eksporto modulis“.
• Nurodykite, kam tai skirta. Visi planai, tik Pro, diegiama šią savaitę.
• Parodykite. Viena ekrano nuotrauka arba trumpas įrašas.
• Grupuokite smulkius pataisymus. Kas savaitę „Pataisymai ir patobulinimai“ įrašas su punktais neleidžia puslapiui perpildyti.
• Būkite sąžiningi dėl pašalinimų. Jei kas nors dings, pasakykite kada ir ką naudoti vietoje.

Pirmoji veikianti užklausa

Pridėk viešą pakeitimų žurnalą mūsų svetainėje adresu /changelog. Kiekvienas įrašas – Markdown failas su pavadinimu, data, žyma (Naujas, Patobulinta arba Ištaisyta), pasirinktine viršelio nuotrauka ir turiniu. Indekso puslapyje įrašai rodomi naujausi pirmi su data, žyma ir pirmąja pastraipa, yra žymų filtro mygtukai ir rodoma 10 įrašų puslapyje. Kiekvienas įrašas turi savo puslapį adresu /changelog/<slug> su tinkamu puslapio pavadinimu ir aprašymu paieškos sistemoms. Pridėk RSS srautą adresu /changelog/rss.xml. Sukurk tris pavyzdinius įrašus. Suderink su esamu svetainės dizainu, išlaikyk skaitomumą telefonuose ir iš anksto suformuok puslapius, kad jie greitai įsikeltų.

Duomenų bazės versijai pirmąjį sakinį pakeiskite į: „Saugok įrašus duomenų bazėje su juodraščio ir paskelbto statusu bei publikavimo data ir pridėk administravimo puslapį, apsaugotą slaptažodžiu, kad galima būtų rašyti, peržiūrėti ir publikuoti.“

Kūrimo žingsniai

1. Nuspręskite failus ar duomenų bazę pagal aukščiau pateiktą lentelę.
2. Sukurkite indekso ir įrašų puslapius su keliais pavyzdiniais įrašais.
3. Pridėkite žymas ir filtrus.
4. Pridėkite RSS srautą ir nuorodą į jį iš puslapio.
5. Pridėkite puslapių pavadinimus, aprašymus ir svetainės žemėlapio įrašą kiekvienam įrašui. Mūsų vadove SEO DI sukurtoms svetainėms aprašyti pagrindai.
6. Administravimo puslapis ir prisijungimas, jei pasirinkote duomenų bazės kelią.
7. „Kas naujo“ ženkliukas jūsų programoje.
8. Parašykite tikrus įrašus už kelis paskutinius mėnesius, kad puslapis nepasirodytų tuščias.

Dažnos klaidos

• Commit žinučių kopijavimas. Rašykite naudotojams, o ne kūrėjams.
• Vienas didelis puslapis be įrašų URL. Niekas negali nurodyti konkretaus pakeitimo, o paieškos sistemos mato vieną puslapį vietoje daugelio.
• Atnaujinimai sustoja po mėnesio. Pakeitimų žurnalas, paskutinį kartą atnaujintas prieš metus, rodo apleistą produktą. Nustatykite ritmą, kurio galite laikytis.
• Įrašų įkėlimas tik naršyklėje. Paieškos sistemos ir nuorodų peržiūros gali matyti tuščią puslapį. Atvaizduokite iš anksto arba serveryje.
• Incidentų maišymas. Gedimai priklauso būsenos puslapiui, o ne pakeitimų žurnalui.

Kada geresnė paruošta pakeitimų žurnalo priemonė

Yra įmonių pakeitimų žurnalo ir produkto naujienų įrankių, kai kurie pateikiami kartu su atsiliepimų lentomis ar programos valdiklais. Jie verti, jei norite programos viduje iškylančio langelio, auditorijos taikymo ir analitikos be jų kūrimo arba jei jūsų komanda jau moka už įrankį, kuriame yra toks modulis. Jūsų tinklaraščio ar pagalbos centro programinė įranga taip pat gali jau turėti tinkamą formatą.

Savo kūrimas prasmingas, kai norite žurnalo savo domene, savo dizaino ir visiškai indeksuojamo, o paprastam datuotų įrašų sąrašui tai nedaug darbo.

Kūrimas su Mythex

Mythex galite paprašyti agento pridėti pakeitimų žurnalą prie esamo projekto arba sukurti jį kaip atskirą mažą svetainę ir matyti jį gyvoje peržiūroje kuriant. Failų versijai duomenų bazės nereikia. Jei pasirenkate administravimo versiją, agentas prideda atskirą Postgres duomenų bazę, kai įrašus reikia išsaugoti (arba įveskite /database), o ekrano nuotraukos saugomos projekto failų saugykloje. Administratoriaus prisijungimą pridedate su savo autentifikavimo būdu (prisijungimo pridėjimo receptas).

Nauji Mythex projektai dažnai yra kliento pusėje atvaizduojamos vieno puslapio programos, o SEO receptas nurodo, kad jos paieškai silpnesnės, todėl jei norite, kad įrašai būtų randami paieškoje, prašykite statinių arba iš anksto suformuotų pakeitimų žurnalo puslapių. Tas pats receptas aprašo pavadinimus, aprašymus ir svetainės žemėlapius. Pradiniam variantui su įmontuotu pakeitimų žurnalu žr. produkto žinių centro šabloną.

Klausimai