Buone pratiche di scrittura delle note di rilascio

Alla consegna di ogni versione del software dobbiamo scrivere una nota di rilascio. Ad esempio, ecco alcuni dei termini che aggiungo quando scrivo una nota di rilascio:

Data di rilascio
Bug risolto

È abbastanza o c'è qualcos'altro?

release

— CoolProgrammer
fonte

Sembra un duplicato di programmers.stackexchange.com/questions/66377/…

non dimenticare le funzionalità aggiunte

— maniaco del cricchetto

Risposte:

Penso che i seguenti seguiranno le buone pratiche

// Data relativa

Data di rilascio

// Funzionalità correlate

Funzionalità aggiunte
In primo piano rimosso
Funzionalità modificate

// Correlazione ai bug

Bug risolti
Bug irrisolti

// Relativo alla dipendenza

Elenco di dipendenza

// Test correlati

Risultati del test unitario
Risultati del test di accettazione

// Relativo al controllo della versione

Nota tag
Numero di revisione

Inoltre, a volte vale la pena evidenziare le cose che l'utente finale potrebbe voler modificare nelle proprie configurazioni o nel flusso di lavoro.

La maggior parte degli utenti finali non si preoccupa del risultato del test. Si aspettano che abbia un'alta qualità indipendentemente da ciò che dice la nota di rilascio.

La cosa più importante delle note di rilascio è essere consapevoli del fatto che ogni frase aggiuntiva perde un altro 10% dei lettori. Quindi devi dare priorità rigorose a ciò che i tuoi attuali utenti devono sapere sulla versione.

— Md Mahbubur Rahman
fonte

vale anche la pena evidenziare alcune cose che l'utente finale potrebbe voler modificare nelle proprie configurazioni o nel flusso di lavoro

— jk.

@jk. Si hai ragione. Ho modificato la mia risposta come tuo buon commento.

— Md Mahbubur Rahman,

La maggior parte degli utenti finali non si preoccupa del risultato del test. Si aspettano che abbia un'alta qualità indipendentemente da ciò che dice la nota di rilascio.

— Henrik,

Le note di rilascio di @Henrik possono essere utili a persone diverse dagli utenti finali

— jk.

La cosa più importante delle note di rilascio è essere consapevoli del fatto che ogni frase aggiuntiva perde un altro 10% dei lettori. Quindi devi dare priorità rigorose a ciò che i tuoi attuali utenti devono sapere sulla versione.

— ddyer
fonte

ogni riga potrebbe perdere il 10% di lettori casuali, disinteressati (o pigri). Quei lettori sono quelli per cui le note di rilascio non sono scritte. Coloro che si preoccupano di ciò che hai fatto li leggeranno tutti e ti ringrazieranno per ogni riga pertinente: devi solo stare attento a includere la lanugine che deve davvero andare nella documentazione corretta.

— gbjbaanb,