Hvernig á að smíða breytingaskrársíðu: færslur, merki, RSS og „Hvað er nýtt“
Breytingaskrársíða er tímaröð yfir það sem breyttist í vörunni þinni, nýjasta fyrst, skrifuð fyrir þá sem nota hana. Til að smíða eina þarftu færslur með dagsetningu, skýrum titli, stuttri útskýringu og merki (Nýtt, Endurbætt, Lagfært), síðu sem listar þær, sérstaka slóð fyrir hverja færslu og helst RSS-straum og leið til að segja notendum að eitthvað sé nýtt. Þetta er ein einfaldasta smíðin sem þú getur gert, og stærsta ákvörðunin er hvar færslurnar lifa: sem skrár í síðunni þinni, eða í gagnagrunni með stjórnendasíðu.
Af hverju breytingaskrá er þess virði
Breytingaskrá sýnir viðskiptavinum og mögulegum kaupendum að varan sé viðhaldin. Hún gefur þjónustu- og sölufólki hlekk til að senda þegar einhver spyr „getur þetta gert X ennþá?“. Hún er líka staður til að loka hringnum um endurgjöf: þegar beiðni um eiginleika er tilbúin er færslan í breytingaskránni það sem þú vísar fólki á. Ef þú rekur endurgjafagátt viðskiptavina skaltu tengja afgreiddar beiðnir beint á færslur þeirra.
Breytingaskrá er ekki innri saga skuldbindinga (commit). „Endurskipulögðum innheimtuþjónustu“ þýðir ekkert fyrir notanda. „Reikningar sýna nú VSK-númer fyrirtækisins þíns“ þýðir það.
Það sem síðan þarf
Efni fyrir hverja færslu
| Reitur | Athugasemdir |
|---|---|
| Titill | Hvað breyttist, frá sjónarhorni notandans |
| Dagsetning | Birtingardagsetning, sýnd á síðunni |
| Merki | Nýtt, Endurbætt, Lagfært (og kannski Fjarlægt eða Öryggi) |
| Meginmál | Nokkrar setningar eða punktar; hvernig á að nota það, hver fær það |
| Mynd eða myndband | Valfrjálst; skjáskot hjálpar meira en málsgrein |
| Slóðarhluti (slug) | Slóð færslunnar, eins og /changelog/invoice-vat-numbers |
| Staða | Drög eða birt, auk tímasetts birtingardags ef þörf er á |
Síður
- Vísitala breytingaskrár: nýjasta fyrst, með síum eftir merkjum og einfaldri blaðsíðuskiptingu eða „hlaða fleiri“.
- Færslusíða: ein færsla á hverja slóð, svo hægt sé að tengja á hana og deila henni.
- RSS- eða Atom-straumur: gerir fólki og verkfærum kleift að fylgjast með uppfærslum án tölvupósts.
- Stjórnendasíða (aðeins í gagnagrunnsútgáfunni): skrifa, forskoða, tímasetja og birta færslur.
Viðbætur í appinu
- „Hvað er nýtt“-merki: punktur við valmyndaratriði þegar til eru færslur sem notandinn hefur ekki séð. Geymdu dagsetningu síðustu færslu sem notandinn opnaði, fyrir hvern notanda eða í vafranum.
- Tölvupóstsamantekt: yfirlit sent til notenda sem hafa valið það. Það krefst sendiþjónustu; sjá hvernig þú sendir tölvupóst úr appinu þínu.
Stóra ákvörðunin: skrár eða gagnagrunnur
Færslur sem skrár í síðunni
Hver færsla er Markdown-skrá í verkefninu. Að birta færslu þýðir að bæta við skrá og endurbirta. Þetta er einfaldasta og öruggasta aðferðin: enginn gagnagrunnur, engin stjórnendainnskráning, ekkert að tryggja, og síður geta verið forbyggðar svo þær hlaðist hratt og leitarvélar lesi þær auðveldlega.
Hún hentar teymum þar sem þeir sem skrifa færslur eru þægilegir með að biðja gervigreindarsmíðatól um eitthvað eða breyta skrá.
Færslur í gagnagrunni með stjórnendasíðu
Færslur lifa í töflu og einkastjórnendasíða gerir hverjum sem er í teyminu kleift að skrifa, forskoða, tímasetja og birta. Þetta hentar teymum þar sem markaðs- eða þjónustufólk skrifar uppfærslur, eða þar sem þú vilt tímasetta birtingu eða færslur fyrir ákveðna hópa (til dæmis að sýna eingöngu eiginleika fyrir fyrirtækjaviðskiptavini þeim).
Kostnaðurinn er meiri smíði og viðhald: innskráning stjórnanda, myndaupphleðsla, og að tryggja að opinberu síðurnar séu enn læsilegar fyrir leitarvélar, sem síða sem hleður færslum aðeins í vafranum gæti ekki verið.
| Skrár | Gagnagrunnur + stjórnandi | |
|---|---|---|
| Hver getur birt | Hver sem breytir verkefninu | Hver sem hefur stjórnandainnskráningu |
| Uppsetning | Lágmarks | Innskráning, geymsla, stjórnendaviðmót |
| SEO | Auðvelt (forbyggðar síður) | Krefst aðgátar svo síður séu birtar á þjóninum eða forbyggðar |
| Tímasetning | Birt við útgáfu | Hægt að tímasetja eftir dagsetningu |
| Hýsingarkostnaður | Kyrrstæð | Krefst keyrandi apps og gagnagrunns |
Að skrifa færslur sem fólk les
- Byrjaðu á ávinningnum. „Flytja út skýrslur í Excel“ slær „Ný útflutningseining“.
- Segðu hverjir fá það. Allar áætlanir, aðeins Pro, rúllar út í þessari viku.
- Sýndu það. Eitt skjáskot eða stutt myndskeið.
- Hópaðu smávægilegar lagfæringar. Vikuleg færsla „Lagfæringar og endurbætur“ með punktum heldur síðunni frá því að fyllast.
- Vertu hreinskilin um fjarlægingar. Ef eitthvað er að hverfa skaltu segja hvenær og hvað eigi að nota í staðinn.
Fyrsta skipun sem virkar
Bættu opinberri breytingaskrá við síðuna okkar á /changelog. Hver færsla er Markdown-skrá með titli, dagsetningu, merki (Nýtt, Endurbætt eða Lagfært), valfrjálsri forsíðumynd og meginmáli. Vísitölusíðan listar færslur, nýjustu fyrst, með dagsetningu, merki og fyrstu málsgrein, hefur hnappa fyrir merkjasíu og sýnir 10 færslur á síðu. Hver færsla hefur sína eigin síðu á /changelog/<slug> með réttum síðutitli og lýsingu fyrir leitarvélar. Bættu við RSS-straumi á /changelog/rss.xml. Búðu til þrjár sýnishornsfærslur. Passaðu við núverandi hönnun síðunnar, hafðu hana læsilega í símum og forbyggðu síðurnar svo þær hlaðist hratt.
Fyrir gagnagrunnsútgáfuna skaltu skipta fyrstu setningunni út fyrir „Geymdu færslur í gagnagrunni með stöðu drög/birt og birtingardagsetningu, og bættu við lykilorðsvarinni stjórnendasíðu til að skrifa, forskoða og birta þær.“
Byggingarskref
- Ákveddu skrár eða gagnagrunn með töflunni hér að ofan.
- Smíðaðu vísitölu- og færslusíður með nokkrum sýnishornsfærslum.
- Bættu við merkjum og síum.
- Bættu við RSS-straumnum og tengdu hann úr síðunni.
- Bættu við titlum síðna, lýsingum og sitemap-færslu fyrir hverja færslu. Leiðbeiningin okkar um SEO fyrir vefsíður smíðaðar með gervigreind fer yfir grunnatriðin.
- Stjórnendasíða og innskráning, ef þú valdir gagnagrunnsleiðina.
- „Hvað er nýtt“-merki í appinu þínu.
- Skrifaðu raunverulegar færslur fyrir síðustu mánuði svo síðan opni ekki tóm.
Algeng mistök
- Að afrita skuldbindingarskilaboð. Skrifaðu fyrir notendur, ekki forritara.
- Ein risastór síða án slóða fyrir hverja færslu. Enginn getur tengt á ákveðna breytingu, og leitarvélar sjá eina síðu í stað margra.
- Uppfærslur stöðvast eftir mánuð. Breytingaskrá sem var síðast uppfærð fyrir ári gefur til kynna yfirgefna vöru. Settu þér takt sem þú getur haldið.
- Að hlaða færslum eingöngu í vafranum. Leitarvélar og forskoðanir hlekkja gætu séð tóma síðu. Forbyggðu eða birtu á þjóninum.
- Að blanda saman atvikum. Rof eiga heima á stöðusíðu, ekki í breytingaskránni.
Þegar hýst breytingaskrártól er betri kostur
Til eru hýst verkfæri fyrir breytingaskrár og vöruuppfærslur og sum fylgja með endurgjafarborðum eða búnaði í appinu. Þau eru þess virði ef þú vilt sprettiglugga í appinu, markhópastýringu og greiningu án þess að smíða það sjálf/ur, eða ef teymið þitt borgar nú þegar fyrir tól sem inniheldur það. Hjálparmiðstöðin þín eða bloggið gæti líka haft hentugt snið.
Smíðaðu þitt eigið þegar þú vilt breytingaskrána á þínu eigin léni, í þinni eigin hönnun og fulla leitarhæfni, sem fyrir einfaldan lista af dagsettum færslum er ekki mikil vinna.
Smíðað með Mythex
Í Mythex geturðu beðið fulltrúann um að bæta breytingaskrá við núverandi verkefni eða smíða hana sem sérstaka litla síðu, og séð hana í beinni forskoðun meðan hún er smíðuð. Skráaútgáfan þarf engan gagnagrunn. Ef þú velur stjórnendaútgáfuna bætir fulltrúinn við sérstökum Postgres-gagnagrunni þegar færslur þarf að vista (eða skrifa /database), og skjáskot fara í skráageymslu verkefnisins. Innskráning stjórnanda er eitthvað sem þú bætir við með þinni eigin auðkenningaraðferð (uppskrift fyrir innskráningu).
Ný Mythex-öpp eru oft einsíðuforrit sem birtast í vafranum, og SEO-uppskriftin bendir á að þau séu veikari í leit, svo biddu um kyrrstæðar eða forbyggðar breytingaskrársíður ef þú vilt að færslur finnist í leit. Sama uppskrift fjallar um titla, lýsingar og sitemap. Fyrir upphafspunkt með innbyggðri breytingaskrá, sjá vörumiðstöðina með þekkingu sniðmátið.
Spurningar
Hvað ætti færsla í breytingaskrá að innihalda?
Dagsetningu, stuttan titil sem segir hvað breyttist fyrir notandann, nokkrar setningar eða punkta sem útskýra það, merki eins og Nýtt, Endurbætt eða Lagfært, og valfrjálst skjáskot og hlekk á nánari upplýsingar.
Þarf breytingaskrá gagnagrunn?
Ekki endilega. Ef ein eða tvær manneskjur birta uppfærslur geta færslur lifað sem Markdown-skrár á síðunni og birst við hverja útgáfu. Notaðu gagnagrunn þegar fólk sem ekki er tæknilega þjálfað þarf að skrifa og tímasetja færslur af stjórnendasíðu.
Hversu oft ætti ég að uppfæra breytingaskrána?
Alltaf þegar eitthvað sem notendur myndu taka eftir hefur breyst. Mörg lítil vöruteymi safna breytingum vikulega eða annahverja viku; það mikilvæga er reglulegur taktur svo síðan líti lifandi út.
Er breytingaskrá góð fyrir SEO?
Hún getur hjálpað lítillega: hver færsla er síða um eiginleika sem leitarvélar geta skriðið, og reglulega uppfærð síða gefur til kynna virka vöru. Gefðu hverri færslu sína eigin slóð og lýsandi titil.