KjerrEsempi di changelog
che vale la pena copiare.
I buoni esempi di changelog hanno tre cose in comune: un titolo che dice cosa è cambiato, una frase su cosa l’utente può fare adesso e una nota onesta su cosa fare dopo. Qui sotto quattro post, uno per ogni tipo di modifica, poi changelog vs release notes e una checklist.
Quattro esempi di changelog, per categoria
Ogni esempio è scritto per un prodotto inventato, nelle quattro categorie che usa la sezione Novità di Kjerr. Copia la forma, non le parole.
Nuova funzionalità
L’autenticazione a due fattori è arrivata
Ora puoi proteggere il tuo account con un secondo passaggio all’accesso. Apri Impostazioni, poi Sicurezza, scansiona il codice QR con una qualsiasi app di autenticazione e salva i codici di recupero. I proprietari del workspace possono renderla obbligatoria per ogni membro. Era una delle idee più richieste sulla nostra board.
Perché funziona: Parte da cosa l’utente può fare adesso, dice dove trovarlo e riconosce la richiesta.
Miglioramento
I report si caricano fino a tre volte più in fretta
Abbiamo ricostruito il modo in cui i report vengono calcolati. Il riepilogo mensile che sugli account grandi ci metteva sei secondi ora si apre in meno di due, e gli intervalli di date più lunghi di un anno non vanno più in timeout. I numeri in sé non cambiano.
Perché funziona: Dà un numero che chi legge può sentire e risponde al timore che i dati siano cambiati.
Correzione
Risolto: le esportazioni CSV perdevano l’ultima riga
Alle esportazioni con più di 10.000 righe mancava l’ultima riga. È risolto, e le esportazioni fatte da oggi sono complete. Se nella prima metà di agosto hai esportato un report grande, rifallo.
Perché funziona: Dice cosa non andava, chi era coinvolto e cosa fare. Senza eufemismi.
Annuncio
Su cosa lavoriamo quest’autunno
Uno sguardo breve ai prossimi mesi, basato sui vostri voti. Le notifiche su Slack sono già in sviluppo. Poi arriva il tema scuro: è l’idea più votata sulla board e il design è iniziato. Scriveremo qui quando ognuna di queste cose sarà rilasciata.
Perché funziona: Fissa le aspettative senza date che non si possono mantenere e rimanda ai voti.
Anatomia di un post del changelog che funziona
- Titolo: la modifica, non il numero di versione. “I report si caricano fino a tre volte più in fretta” dice a chi legge se la cosa lo riguarda. “v4.12.1” no.
- Categoria. Nuova funzionalità, miglioramento, correzione o annuncio. Permette di scorrere e filtrare.
- Cosa puoi fare adesso. Una o due frasi dal lato dell’utente.
- Dove trovarlo. Il percorso nel menu, o un link.
- Cosa fare dopo. Spesso niente. Quando una correzione richiede una nuova esportazione o un’impostazione, dillo chiaramente.
- Riconosci la richiesta. Se gli utenti l’hanno chiesta, collega la richiesta. È la prova più economica che il feedback viene letto.
Changelog vs release notes
Un changelog è il registro continuo di tutte le modifiche rilevanti; le release notes sono il resoconto di un singolo rilascio. Il changelog è una lista da scorrere: post brevi, dal più recente, uno per modifica. Le release notes sono un documento da leggere: raggruppano le modifiche di una versione, spiegano le più grandi con screenshot e contengono i passaggi di aggiornamento o migrazione.
Ai team piccoli di solito basta il changelog, con un post più lungo quando un rilascio lo merita. I prodotti con installazioni versionate o con un’API spesso pubblicano anche le release notes e le collegano da ogni post del changelog.
Una checklist prima di pubblicare
Leggi il post come un utente che non ha mai visto la tua roadmap.
- Il titolo si capisce senza il testo?
- La prima frase parla dell’utente, non del team?
- C’è un numero, un percorso o uno screenshot dove sarebbero utili?
- Se qualcosa si era rotto, si capisce chi era coinvolto e cosa fare?
- Le richieste a cui il post risponde sono collegate?
- Lo sapranno le persone che hanno chiesto, e non solo quelle che passano per caso?
Come pubblicare post così in Kjerr
La sezione Novità di Kjerr è un changelog con le quattro categorie qui sopra. I post supportano titoli, elenchi, link e immagini, citano le idee a cui rispondono e alla pubblicazione possono inviare un’email agli iscritti.
- Categorie, ricerca per testo e data, reazioni emoji e commenti.
- Iscrizione via email con indirizzo verificato.
- Le idee collegate compaiono sotto il post; lo stato Shipped invia un’email a chi ha votato.
- Il widget sul tuo sito mostra le stesse novità in un pannello laterale, con il numero di post non letti sul pulsante.
Domande, con risposte chiare.
Cos’è un changelog?
Un changelog è un elenco datato delle modifiche a un prodotto, dal più recente, scritto per le persone che lo usano. Ogni post dice cosa è cambiato, chi riguarda e cosa, se qualcosa, bisogna fare.
Che differenza c’è tra changelog e release notes?
Un changelog è il registro continuo di tutte le modifiche rilevanti; le release notes sono il resoconto di un singolo rilascio. Un post del changelog è di poche frasi. Le release notes possono occupare una pagina, con screenshot e passaggi di aggiornamento. Molti prodotti pubblicano entrambi nello stesso posto.
Cosa dovrebbe contenere un post del changelog?
Un titolo che dice cosa è cambiato, una categoria, una o due frasi su cosa l’utente può fare adesso, dove trovarlo e l’eventuale azione richiesta. Se la modifica risponde a una richiesta, dillo e collegala.
Quanto spesso aggiornare il changelog?
Ogni volta che rilasci qualcosa che gli utenti possono notare. Un post breve ogni una o due settimane costruisce più fiducia di uno lungo ogni trimestre.
Dove dovrebbe stare un changelog?
Su una pagina pubblica con un suo indirizzo, così si può linkare, cercare e indicizzare, e via email per chi si iscrive. Kjerr lo mette sulla stessa board delle feature request.
Pagine correlate
Dai una risposta ai tuoi utenti.
Durante l’early access Kjerr è gratuito: tutte le funzionalità, nessuna carta di credito. I piani a pagamento, quando arriveranno, saranno calcolati per workspace, mai per postazione amministratore.