Generatore gratuito di note di rilascio

Cosa sono le note di rilascio?

Le note di rilascio sono un breve riepilogo di ciò che è cambiato in una nuova versione di un prodotto: nuove funzionalità, miglioramenti e correzioni, scritte in modo che il lettore sappia cosa può fare ora. Un generatore di note di rilascio trasforma l'elenco grezzo che il tuo team ha già, come commit o ticket, in quel riepilogo, così le note vengono rilasciate insieme all'aggiornamento invece che una settimana dopo.

Le buone note di rilascio spiegano ai clienti perché un aggiornamento è importante per loro. I messaggi di commit spiegano agli sviluppatori quali parti del codice sono cambiate. Il lavoro consiste nel tradurre l'uno nell'altro.

Note di rilascio o changelog?

Le persone usano questi termini in modo approssimativo. Una distinzione utile:

Questo strumento funziona anche come generatore di changelog: genera le note per ogni rilascio e aggiungile in cima alla tua pagina del changelog.

Cosa includere nelle note di rilascio

• Titolo con prodotto e versione: “Note di rilascio di Acme Analytics 3.2”.
• Un riepilogo di una riga: le una o due modifiche che interessano maggiormente ai lettori.
• Novità, Miglioramenti, Correzioni: in quest'ordine, omettendo le sezioni vuote.
• Punti focalizzati sui vantaggi: cosa può fare l'utente ora, non cosa fa il codice.
• Modifiche sostanziali: esattamente ciò che qualcuno deve fare, segnalato chiaramente.
• Link: all'articolo di aiuto o al video per tutto ciò che necessita di spiegazioni.

Un breve esempio di note di rilascio

Tre commit, “feat: esportazione report in CSV”, “fix: fuso orario dashboard sfasato di un'ora” e “chore: aggiornamento dipendenze”, potrebbero diventare:

Acme Analytics 3.2
Ora puoi portare i tuoi report ovunque e le dashboard mostrano gli orari corretti.

Novità

• Esportazione CSV: scarica qualsiasi report come file CSV per aprirlo in Excel o Google Sheets.

Correzioni

• Orari della dashboard: i grafici ora utilizzano correttamente il tuo fuso orario.

L'aggiornamento delle dipendenze viene omesso nella versione per i clienti, perché gli utenti non lo noteranno. La versione interna lo mantiene.

Come preparare le modifiche per il generatore

Non è necessario ripulire prima l'elenco, ma alcune abitudini rendono le note migliori. Incolla una modifica per riga, che si tratti di un messaggio di commit, un titolo di ticket o una frase. Mantieni i prefissi convenzionali come “feat:” e “fix:” se li usi; aiutano a classificare le modifiche in novità e correzioni. Aggiungi un po' di contesto agli elementi criptici, ad esempio “fix: esportazione (il CSV era vuoto per i report di grandi dimensioni)”. Inserisci il nome del prodotto e la versione in modo che il titolo sia pronto per la pubblicazione. Quindi eseguilo due volte se ti servono entrambe le versioni: una per i clienti, una per il team interno.

Best practice per le note di rilascio

Scrivi per chi utilizza il prodotto

“I report si caricano più velocemente” è meglio di “Ottimizzato il pianificatore di query”. Nomina la funzionalità come appare nell'interfaccia.

Dai priorità a ciò che conta di più

Metti per prima la modifica che la maggior parte delle persone noterà. Le piccole correzioni possono essere elencate alla fine.

Mostra la nuova funzionalità

Uno screenshot o un breve video di una nuova funzionalità vale più di un paragrafo. Collega l'articolo di aiuto che la spiega.

Pubblica secondo un programma che le persone possano seguire

Mantieni ogni rilascio su una pagina di changelog, dal più recente al meno recente, in modo che i clienti e il tuo team di supporto sappiano sempre dove guardare.

Errori comuni nelle note di rilascio

• Incollare il log dei commit così com'è, con numeri di ticket e gergo tecnico.
• Nascondere una modifica sostanziale nel mezzo di un elenco.
• Elencare ogni modifica interna nelle note per i clienti.
• Promettere date o funzionalità che non sono presenti nel rilascio.

Il generatore include solo le modifiche dal tuo elenco e non aggiungerà date che non hai fornito, ma controlla ogni elemento prima di pubblicare.