Kako napraviti changelog stranicu: unosi, oznake, RSS i „šta je novo“

Stranica changelog-a je hronološki spisak šta se promenilo u vašem proizvodu, najnovije prvo, napisan za ljude koji ga koriste. Da biste je napravili, potrebni su vam unosi sa datumom, jasnim naslovom, kratkim objašnjenjem i oznakom (Novo, Poboljšano, Ispravljeno), stranica koja ih navodi, zaseban URL za svaki unos i, po mogućnosti, RSS feed i način da korisnicima kažete da je nešto novo. To je jedna od najjednostavnijih stvari koje možete da napravite, a glavna odluka je gde unosi žive: kao fajlovi u sajtu ili u bazi uz stranicu za administraciju.

Zašto je changelog vredan

Changelog pokazuje kupcima i potencijalnim korisnicima da se proizvod održava. Daje prodaji i podršci link koji mogu da pošalju kad neko pita „da li već radi X?“. Takođe je mesto da zatvorite krug povratnih informacija: kad se tražena funkcija pojavi, unos u changelogu je ono na šta upućujete ljude. Ako vodite portal za povratne informacije kupaca, povežite isporučene predloge direktno sa njihovim unosima.

Changelog nije vaša interna istorija commit-ova. „Refaktorisan servis za naplatu“ ne znači ništa korisniku. „Fakture sada prikazuju PIB vaše firme“ znači.

Šta stranica treba

Sadržaj svakog unosa

Stranice

• Indeks changelog-a: najnovije prvo, sa filterima po oznakama i jednostavnim stranicama ili dugmetom „učitaj još“.
• Stranica unosa: jedan unos po URL-u, da može da se linkuje i deli.
• RSS ili Atom feed: omogućava ljudima i alatima da prate izmene bez e-pošte.
• Stranica za administraciju (samo u verziji sa bazom): pisanje, pregled, zakazivanje i objavljivanje unosa.

Dodaci u aplikaciji

• Oznaka „šta je novo“: tačka uz stavku menija kad postoje unosi koje korisnik nije video. Čuvajte datum poslednjeg otvorenog unosa, po korisniku ili u pregledaču.
• Pregled e-poštom: sažetak poslat korisnicima koji su se prijavili. Ovo zahteva provajdera za slanje; pogledajte kako slati e-poštu iz aplikacije.

Glavna odluka: fajlovi ili baza

Unosi kao fajlovi u sajtu

Svaki unos je Markdown fajl u projektu. Objavljivanje unosa znači dodavanje fajla i ponovno postavljanje. Ovo je najjednostavniji i najpouzdaniji pristup: nema baze, nema prijave za administraciju, nema šta da se obezbeđuje, a stranice mogu da se unapred renderuju pa se brzo učitavaju i lako ih čitaju pretraživači.

Pogodno je timovima u kojima oni koji pišu unose mogu da zamole AI alat za izradu ili da urede fajl.

Unosi u bazi uz stranicu za administraciju

Unosi žive u tabeli, a privatna stranica za administraciju omogućava svakome iz tima da piše, pregleda, zakazuje i objavljuje. Ovo odgovara timovima u kojima marketing ili podrška pišu novosti, ili kad želite zakazano objavljivanje ili unose po publici (na primer, da se funkcije za preduzeća prikazuju samo korisnicima iz preduzeća).

Cena je više posla za izradu i održavanje: prijava za administraciju, otpremanje slika i osiguranje da javne stranice i dalje čitaju pretraživači, što stranica koja učitava unose samo u pregledaču možda neće moći.

Pisanje unosa koje ljudi čitaju

• Počnite od koristi. „Izvoz izveštaja u Excel“ je bolje od „novi modul za izvoz“.
• Recite ko to dobija. Svi planovi, samo Pro, uvodi se ove nedelje.
• Pokažite. Jedan snimak ekrana ili kratak klip.
• Grupišite sitne ispravke. Nedeljni unos „Ispravke i poboljšanja“ sa tačkama sprečava da stranica bude preplavljena.
• Budite iskreni o uklanjanju. Ako nešto odlazi, recite kada i šta da se koristi umesto toga.

Primer prvog upita

Dodaj javni changelog na naš sajt na /changelog. Svaki unos je Markdown fajl sa naslovom, datumom, oznakom (Novo, Poboljšano ili Ispravljeno), opcionom naslovnom slikom i tekstom. Indeks prikazuje unose od najnovijeg, sa datumom, oznakom i prvim pasusom, ima dugmad za filtriranje po oznakama i prikazuje 10 unosa po stranici. Svaki unos ima sopstvenu stranicu na /changelog/<slug> sa pravim naslovom stranice i opisom za pretraživače. Dodaj RSS feed na /changelog/rss.xml. Napravi tri probna unosa. Uskladi dizajn sa postojećim sajtom, neka bude čitljivo na telefonima i unapred renderuj stranice da se brzo učitavaju.

Za verziju sa bazom, zamenite prvu rečenicu sa „Čuvaj unose u bazi sa statusom nacrta/objavljeno i datumom objave, i dodaj stranicu za administraciju zaštićenu lozinkom za pisanje, pregled i objavljivanje.“

Koraci izrade

1. Odlučite fajlovi ili baza prema tabeli iznad.
2. Napravite indeks i stranice unosa sa nekoliko probnih unosa.
3. Dodajte oznake i filtere.
4. Dodajte RSS feed i povežite ga sa stranicom.
5. Dodajte naslove stranica, opise i unos u sitemap za svaki unos. Naš vodič o SEO-u za sajtove pravljene uz AI pokriva osnove.
6. Stranica za administraciju i prijava, ako ste izabrali verziju sa bazom.
7. Oznaka „šta je novo“ u vašoj aplikaciji.
8. Napišite prave unose za poslednjih nekoliko meseci, da stranica ne bude prazna pri pokretanju.

Česte greške

• Kopiranje poruka commit-ova. Pišite za korisnike, a ne za programere.
• Jedna velika stranica bez URL-a za svaki unos. Niko ne može da linkuje određenu promenu, a pretraživači vide jednu stranicu umesto mnogo.
• Ažuriranja stanu posle mesec dana. Changelog koji nije ažuriran godinu dana sugeriše napušten proizvod. Postavite ritam koji možete da održite.
• Učitavanje unosa samo u pregledaču. Pretraživači i pregledi linkova mogu da vide praznu stranicu. Unapred renderujte ili renderujte na serveru.
• Mešanje incidenata. Prekidi rada pripadaju statusnoj stranici, a ne changelog-u.

Kada je hostovani alat za changelog bolji izbor

Postoje hostovani alati za changelog i ažuriranja proizvoda, a neki dolaze uz odbore za povratne informacije ili vidžete za aplikaciju. Vredi ih koristiti ako želite iskačuće obaveštenje u aplikaciji, ciljanje publike i analitiku bez njihove izrade, ili ako vaš tim već plaća alat koji ih sadrži. Softver za blog ili centar za pomoć takođe može imati odgovarajući format.

Pravljenje sopstvenog ima smisla kad želite changelog na sopstvenom domenu, u sopstvenom dizajnu i potpuno indeksiran, što za jednostavan spisak datiranih objava nije mnogo posla.

Izrada uz Mythex

U Mythexu možete zatražiti od agenta da doda changelog postojećem projektu ili da ga napravi kao zaseban mali sajt, i da vidite rezultat u pregledu uživo dok se gradi. Verzija sa fajlovima ne treba bazu. Ako izaberete verziju za administraciju, agent dodaje posebnu Postgres bazu kad unosi treba da se čuvaju (ili otkucajte /database), a snimci ekrana idu u skladište fajlova projekta. Prijavu za administraciju dodajete sami, sopstvenim pristupom za prijavu (recept za prijavu).

Nove Mythex aplikacije su često jednostranične aplikacije renderovane u klijentu, za koje SEO recept napominje da su slabije za pretragu, pa zatražite statične ili unapred renderovane stranice changelog-a ako želite da ih pretraga nađe. Isti recept pokriva naslove, opise i sitemap. Kao polazna tačka sa ugrađenim changelog-om, pogledajte šablon product knowledge hub.

Pitanja