Cum construiești o pagină de changelog: intrări, etichete, RSS și „Ce e nou”

O pagină de changelog este o listă datată a ceea ce s-a schimbat în produsul tău, cele mai noi întâi, scrisă pentru oamenii care îl folosesc. Ca s-o construiești, ai nevoie de intrări cu o dată, un titlu clar, o explicație scurtă și o etichetă (Nou, Îmbunătățit, Reparat), o pagină care le listează, un URL propriu pentru fiecare intrare și, idealmente, un flux RSS și o modalitate de a spune utilizatorilor că ceva este nou. Este unul dintre cele mai simple lucruri pe care le poți construi, iar decizia principală este unde trăiesc intrările: ca fișiere în site sau într-o bază de date cu pagină de administrare.

De ce merită un changelog

Un changelog arată clienților și potențialilor clienți că produsul este întreținut. Îi dă echipei de suport și de vânzări un link de trimis când cineva întreabă „face deja X?”. Este și un loc unde închizi bucla feedback-ului: când o funcționalitate cerută ajunge live, intrarea din changelog este ce le arăți oamenilor. Dacă rulezi un portal de feedback pentru clienți, leagă cererile livrate direct de intrările lor.

Un changelog nu este istoricul intern de commit-uri. „Refactorizat serviciul de facturare” nu înseamnă nimic pentru un utilizator. „Facturile arată acum numărul de TVA al companiei tale” înseamnă.

Ce are nevoie pagina

Conținutul fiecărei intrări

Pagini

• Indexul changelog-ului: cele mai noi întâi, cu filtre pe etichete și paginare simplă sau „încarcă mai mult”.
• Pagina intrării: o intrare pe URL, ca să poată fi trimisă sau distribuită.
• Flux RSS sau Atom: lasă oamenii și instrumentele să urmărească actualizările fără email.
• Pagină de administrare (doar în varianta cu bază de date): scrie, previzualizează, programează și publică intrări.

Extra în aplicație

• Insigna „Ce e nou”: un punct lângă un element din meniu când există intrări pe care utilizatorul nu le-a văzut. Stochează data ultimei intrări deschise, per utilizator sau în browser.
• Digest prin email: un rezumat trimis utilizatorilor care s-au abonat. Ai nevoie de un furnizor de trimitere; vezi cum trimiți emailuri din aplicația ta.

Decizia principală: fișiere sau bază de date

Intrări ca fișiere în site

Fiecare intrare este un fișier Markdown în proiect. Publicarea unei intrări înseamnă adăugarea unui fișier și o nouă lansare. Este cea mai simplă și mai robustă variantă: fără bază de date, fără autentificare de administrare, nimic de securizat, iar paginile pot fi pre-randate, deci se încarcă rapid și sunt ușor de citit pentru motoarele de căutare.

Este potrivită pentru echipele în care cei care scriu intrările se simt confortabil să ceară asta unui constructor cu AI sau să editeze un fișier.

Intrări într-o bază de date cu pagină de administrare

Intrările trăiesc într-un tabel, iar o pagină privată de administrare le permite oricui din echipă să scrie, să previzualizeze, să programeze și să publice. Este potrivită pentru echipele în care marketingul sau suportul scriu actualizările sau când vrei publicare programată ori intrări diferite pentru audiențe diferite (de exemplu, să arăți funcționalitățile pentru companii doar clienților enterprise).

Costul este mai multă muncă de construit și de întreținut: o autentificare pentru administrare, încărcări de imagini și grija ca paginile publice să rămână citibile pentru motoarele de căutare, ceea ce o pagină care încarcă intrările doar în browser s-ar putea să nu permită.

Scrierea intrărilor pe care oamenii le citesc

• Începe cu beneficiul. „Exportă rapoarte în Excel” bate „Modul nou de export”.
• Spune cine o primește. Toate planurile, doar Pro, se livrează săptămâna aceasta.
• Arată-o. O captură de ecran sau un scurt clip.
• Grupează reparațiile mici. O intrare săptămânală „Reparații și îmbunătățiri” cu puncte ține pagina departe de inundații.
• Fii sincer despre eliminări. Dacă ceva dispare, spune când și ce să folosească în loc.

Un prompt de start care funcționează

Adaugă un changelog public pe site-ul nostru, la /changelog. Fiecare intrare este un fișier Markdown cu titlu, dată, etichetă (Nou, Îmbunătățit sau Reparat), imagine de copertă opțională și conținut. Pagina de index listează intrările cele mai noi întâi, cu dată, etichetă și primul paragraf, are butoane de filtrare pe etichete și afișează 10 intrări pe pagină. Fiecare intrare are propria pagină la /changelog/<slug>, cu titlu de pagină și descriere corecte pentru motoarele de căutare. Adaugă un flux RSS la /changelog/rss.xml. Creează trei intrări de test. Potrivește designul existent al site-ului, păstrează-l lizibil pe telefon și pre-randează paginile ca să se încarce rapid.

Pentru varianta cu bază de date, înlocuiește prima propoziție cu „Stochează intrările într-o bază de date cu stare de ciornă/publicată și o dată de publicare și adaugă o pagină de administrare protejată cu parolă, pentru a scrie, previzualiza și publica intrări.”

Pașii de construire

1. Decide între fișiere și bază de date folosind tabelul de mai sus.
2. Construiește paginile de index și de intrare cu câteva intrări de test.
3. Adaugă etichete și filtre.
4. Adaugă fluxul RSS și pune un link către el pe pagină.
5. Adaugă titluri de pagină, descrieri și o intrare în sitemap pentru fiecare intrare. Ghidul nostru despre SEO pentru site-uri construite cu AI acoperă bazele.
6. Pagina de administrare și autentificarea, dacă ai ales varianta cu bază de date.
7. Insigna „Ce e nou” în aplicația ta.
8. Scrie intrări reale pentru ultimele câteva luni, ca pagina să nu fie goală la lansare.

Greșeli frecvente

• Copierea mesajelor de commit. Scrie pentru utilizatori, nu pentru dezvoltatori.
• O singură pagină uriașă, fără URL-uri pe intrare. Nimeni nu poate trimite o schimbare specifică, iar motoarele de căutare văd o pagină în loc de multe.
• Actualizările se opresc după o lună. Un changelog actualizat ultima dată acum un an sugerează un produs abandonat. Stabilește un ritm pe care îl poți susține.
• Încărcarea intrărilor doar în browser. Motoarele de căutare și previzualizările de linkuri pot vedea o pagină goală. Pre-randează sau randează pe server.
• Amestecarea incidentelor. Întreruperile aparțin unei pagini de stare, nu changelog-ului.

Când un instrument de changelog găzduit este alegerea mai bună

Există instrumente găzduite de changelog și de actualizări de produs, unele incluse în table de feedback sau widget-uri din aplicație. Merită dacă vrei un popup în aplicație, targetare pe audiențe și analitice fără să le construiești tu, sau dacă echipa ta plătește deja un instrument care include unul. Software-ul tău de blog sau de centru de ajutor poate avea deja un format potrivit.

Construirea propriului changelog are sens când vrei pagina pe propriul domeniu, în propriul design și complet indexabilă, ceea ce pentru o listă simplă de postări datate nu înseamnă mult efort.

Construirea cu Mythex

În Mythex poți cere agentului să adauge un changelog la un proiect existent sau să-l construiască ca un site mic separat și să-l vezi în previzualizarea live pe măsură ce se construiește. Varianta pe fișiere nu are nevoie de bază de date. Dacă alegi varianta cu administrare, agentul adaugă o bază de date Postgres dedicată atunci când intrările trebuie salvate (sau scrii /database), iar capturile de ecran merg în stocarea de fișiere a proiectului. Autentificarea pentru administrare o adaugi cu propria abordare (rețeta pentru autentificare).

Aplicațiile noi Mythex sunt adesea aplicații cu o singură pagină randate pe client, pe care rețeta SEO le notează ca fiind mai slabe pentru căutare, deci cere pagini de changelog statice sau pre-randate dacă vrei ca intrările să fie găsite. Aceeași rețetă acoperă titlurile, descrierile și sitemap-urile. Pentru un punct de plecare cu changelog inclus, vezi șablonul hub de cunoaștere al produsului.

Întrebări