Si të ndërtoni një faqe changelog: Hyrje, etiketa, RSS dhe "Çfarë është e re"

Një faqe changelog është një listë e datuar e asaj që ka ndryshuar në produktin tuaj, më e reja së pari, e shkruar për njerëzit që e përdorin. Për ta ndërtuar, ju duhen hyrje me datë, titull të qartë, shpjegim të shkurtër dhe një etiketë (New, Improved, Fixed), një faqe që i liston, një URL e veçantë për çdo hyrje, dhe idealisht një fushë RSS dhe një mënyrë për t'u thënë përdoruesve se diçka është e re. Është një nga gjërat më të thjeshta që mund të ndërtoni, dhe vendimi kryesor është ku jetojnë hyrjet: si skedarë në faqen tuaj, apo në një bazë të dhënash me një faqe administrimi.

Pse vlen një changelog

Një changelog tregon klientëve dhe potencialëve se produkti mirëmbahet. I jep mbështetjes dhe shitjeve një lidhje për t'u dërguar kur dikush pyet "a e bën ende X?". Është gjithashtu një vend për të mbyllur ciklin me reagimet: kur shipohet një veçori e kërkuar, hyrja në changelog është ajo që u tregoni njerëzve. Nëse drejtoni një portal reagimesh nga klientët, lidhni kërkesat e lansuara drejtpërdrejt me hyrjet e tyre.

Një changelog nuk është historiku juaj i brendshëm i commit-eve. "Rifaktorizoi shërbimin e faturimit" nuk i thotë asgjë përdoruesit. "Faturat tani e shfaqin numrin e TVSH-së së kompanisë suaj" i thotë.

Çfarë i duhet faqes

Përmbajtja për çdo hyrje

Fusha	Shënime
Titulli	Çfarë ndryshoi, nga pikëpamja e përdoruesit
Data	Data e publikimit, e shfaqur në faqe
Etiketa	New, Improved, Fixed (dhe ndoshta Removed ose Security)
Trupi	Disa fjali ose pika; si përdoret, kush e merr
Imazh ose video	Opsionale; një pamje ekrani ndihmon më shumë sesa një paragraf
Slug	URL-ja e hyrjes, si `/changelog/invoice-vat-numbers`
Statusi	Draft ose i publikuar, plus një datë publikimi të planifikuar nëse nevojitet

Faqet

Indeksi i changelog-ut: më i riu së pari, me filtra sipas etiketës dhe faqe të thjeshta ose "ngarko më shumë".
Faqja e hyrjes: një hyrje për URL, që mund të lidhet dhe ndahet.
Fushë RSS ose Atom: i lejon njerëzit dhe mjetet të ndjekin përditësimet pa email.
Faqe administrimi (vetëm në versionin me bazë të dhënash): shkruan, shikon paraprakisht, planifikon dhe publikon hyrje.

Shtesa brenda aplikacionit

Stemë "Çfarë është e re": një pikë te një element menuje kur ka hyrje që përdoruesi nuk i ka parë. Ruani datën e hyrjes së fundit që ai hapi, për përdorues ose në shfletues.
Përmbledhje me email: një përmbledhje që u dërgohet përdoruesve që pranojnë. Kjo kërkon një ofrues dërgimi; shihni si të dërgoni emaile nga aplikacioni juaj.

Vendimi kryesor: skedarë ose bazë të dhënash

Hyrjet si skedarë në faqe

Çdo hyrje është një skedar Markdown në projekt. Publikimi i një hyrjeje do të thotë të shtosh një skedar dhe të bësh redeploy. Kjo është qasja më e thjeshtë dhe më e qëndrueshme: pa bazë të dhënash, pa hyrje administratori, pa asgjë për të siguruar, dhe faqet mund të para-renderohen, kështu që hapen shpejt dhe lexohen lehtë nga motorët e kërkimit.

Kjo i përshtatet ekipeve ku personat që shkruajnë hyrje janë të rehatshëm të kërkojnë nga një ndërtues me AI ose të redaktojnë një skedar.

Hyrjet në një bazë të dhënash me faqe administrimi

Hyrjet jetojnë në një tabelë, dhe një faqe private administrimi e lejon kë do nga ekipi të shkruajë, shikojë paraprakisht, planifikojë dhe publikojë. Kjo i përshtatet ekipeve ku marketingu ose mbështetja shkruan përditësime, ose kur dëshironi publikim të planifikuar ose hyrje për audienca të ndryshme (për shembull, të shfaqësh veçoritë enterprise vetëm për klientët enterprise).

Kosto është më shumë punë për ndërtim dhe mirëmbajtje: një hyrje administratori, ngarkime imazhesh, dhe sigurimi që faqet publike të mbeten të lexueshme nga motorët e kërkimit, gjë që një faqe që ngarkon hyrjet vetëm në shfletues mund të mos e bëjë.

	Skedarë	Bazë të dhënash + administrim
Kush mund të publikojë	Kushdo që redakton projektin	Kushdo me hyrje administratori
Konfigurimi	Minimal	Hyrje, ruajtje, ndërfaqe administrimi
SEO	E lehtë (faqe të para-renderuara)	Kërkon kujdes që faqet të renderohen në server ose të para-renderohen
Planifikimi	Publikohet kur bëni deploy	Mund të planifikohet sipas datës
Kosto e hostingut	Statike	Kërkon aplikacion dhe bazë të dhënash që punojnë

Shkrimi i hyrjeve që lexohen

Filloni me dobinë. "Eksporto raportet në Excel" është më mirë se "Modul i ri eksporti".
Thoni kush e merr. Të gjitha planet, vetëm Pro, po lansohet këtë javë.
Tregojeni. Një pamje ekrani ose një klip i shkurtër.
Gruponi ndreqjet e vogla. Një hyrje javore "Ndreqje dhe përmirësime" me pika e mban faqen nga mbushja.
Jini të sinqertë për heqjet. Nëse diçka po largohet, thoni kur dhe çfarë të përdoret në vend të saj.

Një kërkesë e parë që funksionon

Shtoni një changelog publik në faqen tonë te /changelog. Çdo hyrje është një skedar Markdown me titull, datë, etiketë (New, Improved ose Fixed), imazh opsional kopertine dhe trup. Faqja e indeksit liston hyrjet më të reja së pari me datën, etiketën dhe paragrafin e parë, ka butona filtri sipas etiketës, dhe shfaq 10 hyrje për faqe. Çdo hyrje ka faqen e vet te /changelog/<slug> me titull dhe përshkrim të duhur për motorët e kërkimit. Shtoni një fushë RSS te /changelog/rss.xml. Krijoni tre hyrje shembull. Përshtatni dizajnin ekzistues të faqes, mbajeni të lexueshme në telefona, dhe para-renderoni faqet që të hapen shpejt.

Për versionin me bazë të dhënash, zëvendësoni fjalinë e parë me "Ruani hyrjet në një bazë të dhënash me status draft/të publikuar dhe një datë publikimi, dhe shtoni një faqe administrimi të mbrojtur me fjalëkalim për t'i shkruar, parë paraprakisht dhe publikuar."

Hapat e ndërtimit

Vendosni skedarë ose bazë të dhënash duke përdorur tabelën më sipër.
Ndërtoni faqet e indeksit dhe të hyrjes me disa hyrje shembull.
Shtoni etiketa dhe filtra.
Shtoni fushën RSS dhe lidheni nga faqja.
Shtoni titujt e faqeve, përshkrimet dhe një hyrje në sitemap për çdo hyrje. SEO për faqet e ndërtuara me AI mbulon bazat.
Faqja e administrimit dhe hyrja, nëse keni zgjedhur rrugën me bazë të dhënash.
Stema "Çfarë është e re" në aplikacionin tuaj.
Shkruani hyrje reale për muajt e fundit, që faqja të mos hapet bosh.

Gabimet më të zakonshme

Kopjimi i mesazheve të commit-eve. Shkruani për përdoruesit, jo për zhvilluesit.
Një faqe e madhe pa URL për çdo hyrje. Askush nuk mund të lidhë një ndryshim specifik, dhe motorët e kërkimit shohin një faqe në vend të shumë.
Përditësimet ndalen pas një muaji. Një changelog i përditësuar për herë të fundit para një viti sugjeron një produkt të braktisur. Vendosni një ritëm që mund ta mbani.
Ngarkimi i hyrjeve vetëm në shfletues. Motorët e kërkimit dhe parapamjet e lidhjeve mund të shohin një faqe bosh. Para-renderoni ose renderoni në server.
Përzierja me incidente. Ndërprerjet i takojnë një faqeje statusi, jo changelog-ut.

Kur një mjet i hostuar changelog është zgjedhja më e mirë

Ka mjete të hostuara për changelog dhe përditësime produkti, dhe disa vijnë të paketuara me tabela reagimesh ose widget-e brenda aplikacionit. Vlejnë nëse dëshironi një popup brenda aplikacionit, targetim audiencash dhe analitikë pa i ndërtuar vetë, ose nëse ekipi juaj tashmë paguan për një mjet që e përfshin. Softueri juaj i blogut ose qendrës së ndihmës mund të ketë gjithashtu një format të përshtatshëm.

Ndërtimi i vetë ka kuptim kur dëshironi changelog-un në domenin tuaj, me dizajnin tuaj, dhe plotësisht të indeksueshëm — që për një listë të thjeshtë postimesh të datuara nuk është shumë punë.

Ndërtimi me Mythex

Në Mythex mund t'i kërkoni agjentit të shtojë një changelog në një projekt ekzistues ose ta ndërtojë si një faqe të vogël të veçantë, dhe ta shihni në pamjen e drejtpërdrejtë ndërsa ndërtohet. Versioni me skedarë nuk ka nevojë për bazë të dhënash. Nëse zgjidhni versionin me administrim, agjenti shton një bazë të dhënash Postgres të dedikuar kur hyrjet duhet të ruhen (ose shkruani /database), dhe pamjet e ekranit shkojnë në ruajtjen e skedarëve të projektit. Hyrja e administratorit është diçka që e shtoni me qasjen tuaj të autentikimit (recetë për hyrjen).

Aplikacionet e reja Mythex janë shpesh aplikacione me një faqe të renderuara në klient, të cilat recetë SEO i përshkruan si më të dobëta për kërkimin, kështu që kërkoni faqe statike ose të para-renderuara të changelog-ut nëse dëshironi që hyrjet të gjenden në kërkim. E njëjta recetë mbulon titujt, përshkrimet dhe sitemap-et. Për një pikënisje me një changelog të integruar, shihni shablloni qendra e njohurisë së produktit.

Pyetje

Çfarë duhet të përmbajë një hyrje changelog?

Një datë, një titull të shkurtër që thotë çfarë ndryshoi për përdoruesin, disa fjali ose pika që e shpjegojnë, një etiketë si New, Improved ose Fixed, dhe opsionalisht një pamje ekrani dhe një lidhje për më shumë detaje.

A më duhet bazë të dhënash për një changelog?

Jo domosdoshmërisht. Nëse një ose dy persona publikojnë përditësime, hyrjet mund të jetojnë si skedarë Markdown në faqe dhe të publikohen me çdo deploy. Përdorni një bazë të dhënash kur persona jo teknikë duhet të shkruajnë dhe planifikojnë hyrje nga një faqe administrimi.

Sa shpesh duhet të përditësoj një changelog?

Sa herë që ndryshon diçka që përdoruesit do ta vërejnë. Shumë produkte të vegjël grupojnë ndryshimet çdo javë ose çdo dy javë; gjëja e rëndësishme është një ritëm i qëndrueshëm, që faqja të duket e gjallë.

A është i mirë changelog për SEO?

Mund të ndihmojë pak: çdo hyrje është një faqe e indeksueshme për një veçori, dhe një faqe e përditësuar rregullisht tregon një produkt aktiv. Jepni çdo hyrjeje URL të vet dhe titull përshkrues.