KjerrExemple de changelog
care merită copiate.
Exemplele bune de changelog au trei lucruri în comun: un titlu care spune ce s-a schimbat, o frază despre ce poate face acum utilizatorul și o notă cinstită despre ce urmează. Mai jos, patru postări, câte una pentru fiecare tip de schimbare, apoi changelog vs. release notes și o listă de verificare.
Patru exemple de changelog, după categorie
Fiecare exemplu este scris pentru un produs fictiv, în cele patru categorii pe care le folosește secțiunea Noutăți din Kjerr. Copiază forma, nu cuvintele.
Funcționalitate nouă
Autentificarea în doi pași este aici
Acum îți poți proteja contul cu un al doilea pas la autentificare. Deschide Setări, apoi Securitate, scanează codul QR cu orice aplicație de autentificare și salvează codurile de rezervă. Ownerul unui spațiu de lucru o poate cere fiecărui membru. A fost una dintre cele mai cerute idei de pe panoul nostru.
De ce funcționează: Începe cu ce poate face acum utilizatorul, spune unde găsește lucrul și recunoaște cererea.
Îmbunătățire
Rapoartele se încarcă de până la trei ori mai repede
Am reconstruit felul în care se calculează rapoartele. Rezumatul lunar, care pe conturile mari dura șase secunde, se deschide acum în mai puțin de două, iar intervalele mai lungi de un an nu mai expiră. Cifrele în sine nu s-au schimbat.
De ce funcționează: Dă o cifră pe care cititorul o simte și liniștește grija că datele s-ar fi schimbat.
Remediere
Rezolvat: exportul CSV pierdea ultimul rând
Exporturilor cu peste 10.000 de rânduri le lipsea ultimul rând. Problema e rezolvată, iar exporturile făcute de azi sunt complete. Dacă ai exportat un raport mare în prima jumătate a lui august, rulează-l din nou.
De ce funcționează: Spune ce era greșit, pe cine a afectat și ce e de făcut. Fără eufemisme.
Anunț
La ce lucrăm în toamna asta
O privire scurtă asupra lunilor următoare, pe baza voturilor voastre. Notificările în Slack sunt deja în lucru. Urmează modul întunecat; este ideea cu cele mai multe voturi de pe panou și designul a început. Vom scrie aici când fiecare dintre ele este implementată.
De ce funcționează: Setează așteptări fără date pe care nu le poate ține și trimite înapoi la voturi.
Anatomia unei postări de changelog care funcționează
- Titlul: schimbarea, nu numărul versiunii. „Rapoartele se încarcă de până la trei ori mai repede” îi spune cititorului dacă îl privește. „v4.12.1” nu îi spune.
- Categoria. Funcționalitate nouă, îmbunătățire, remediere sau anunț. Îi lasă pe oameni să răsfoiască și să filtreze.
- Ce poți face acum. Una sau două fraze, din perspectiva utilizatorului.
- Unde găsești lucrul. Calea din meniu sau un link.
- Ce urmează. De multe ori, nimic. Când o remediere cere un nou export sau o setare, spune-o direct.
- Recunoaște cererea. Dacă utilizatorii au cerut asta, pune link la cerere. E cea mai ieftină dovadă că feedbackul este citit.
Changelog vs. release notes
Un changelog este registrul curent al tuturor schimbărilor importante; release notes sunt descrierea unei singure lansări. Changelogul este o listă de parcurs: postări scurte, cele mai noi primele, câte una per schimbare. Release notes sunt un document de citit: grupează schimbările dintr-o versiune, le explică pe cele mari cu capturi de ecran și conțin pașii de actualizare sau de migrare.
Echipelor mici le ajunge de obicei changelogul, cu o postare mai lungă când o lansare o merită. Produsele cu instalări versionate sau cu un API publică adesea și release notes și pun link la ele din fiecare postare de changelog.
Lista de verificare înainte de publicare
Citește postarea ca un utilizator care n-a văzut niciodată roadmapul tău.
- Are sens titlul fără text?
- Prima frază este despre utilizator, nu despre echipă?
- Există o cifră, o cale sau o captură de ecran acolo unde ar ajuta?
- Dacă ceva s-a stricat, se înțelege pe cine a afectat și ce e de făcut?
- Cererile la care răspunde postarea au link?
- Vor afla de ea cei care au cerut, nu doar cei care se întâmplă să intre?
Cum publici asemenea postări în Kjerr
Secțiunea Noutăți din Kjerr este un changelog cu cele patru categorii de mai sus. Postările acceptă titluri, liste, linkuri și imagini, indică ideile la care răspund și pot trimite un e-mail abonaților la publicare.
- Categorii, căutare după text și dată, reacții emoji și comentarii.
- Abonament prin e-mail cu adresă confirmată.
- Ideile conectate apar sub postare; statusul Shipped trimite un e-mail votanților.
- Widgetul de pe propriul tău site arată aceleași noutăți într-un panou lateral, cu numărul postărilor necitite pe butonul de lansare.
Întrebări, răspunsuri simple.
Ce este un changelog?
Un changelog este o listă datată a schimbărilor dintr-un produs, cu cele mai noi primele, scrisă pentru oamenii care îl folosesc. Fiecare postare spune ce s-a schimbat, pe cine privește și ce, dacă e cazul, trebuie făcut.
Care este diferența dintre changelog și release notes?
Un changelog este registrul curent al tuturor schimbărilor importante; release notes sunt descrierea unei singure lansări. O postare de changelog are câteva fraze. Release notes pot ocupa o pagină, cu capturi de ecran și pași de actualizare. Multe produse le publică pe amândouă în același loc.
Ce ar trebui să conțină o postare de changelog?
Un titlu care spune ce s-a schimbat, o categorie, una sau două fraze despre ce poate face acum utilizatorul, unde găsește lucrul și eventuala acțiune necesară. Dacă schimbarea răspunde unei cereri, spune-o și pune link la ea.
Cât de des ar trebui actualizat un changelog?
Ori de câte ori implementezi ceva ce utilizatorii pot observa. O postare scurtă la fiecare una-două săptămâni clădește mai multă încredere decât una lungă pe trimestru.
Unde ar trebui să stea un changelog?
Pe o pagină publică cu adresa ei, ca să poată fi dată mai departe, căutată și indexată, și prin e-mail pentru cei care se abonează. Kjerr îl pune pe același panou cu cererile de funcționalități.
Pagini înrudite
Dă-le utilizatorilor un răspuns.
În perioada de acces anticipat, Kjerr este gratuit: toate funcționalitățile, fără card de credit. Când vor apărea planurile plătite, vor fi tarifate per spațiu de lucru, niciodată per administrator.