Buone pratiche di scrittura di note di rilascio

10

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

  • Data di rilascio
  • Bug risolto

È abbastanza, o c'è qualcos'altro?

    
posta CoolProgrammer 05.10.2012 - 10:31
fonte

2 risposte

19

Penso che i seguenti daranno un modo alle buone pratiche

// Date Related

  • Data di rilascio

// Feature related

  • Funzionalità aggiunte
  • In primo piano rimosso
  • Funzionalità modificate

// Bug related

  • Bug risolti
  • Bug non risolti

// Dependency related

  • Elenco delle dipendenze

// Testing related

  • Risultati del test unitario
  • Risultati del test di accettazione

// Version controlling related

  • Nota tag
  • Numero revisione

EDIT: mi piace il commento di @ jk

Anche alcune volte vale la pena di evidenziare le cose che l'utente finale potrebbe voler cambiare nelle sue configurazioni o nel flusso di lavoro.

EDIT: mi piace il commento di @Henrik

Alla maggior parte degli utenti finali non interessa il risultato del test. Si aspettano che abbia una qualità elevata, indipendentemente da ciò che dice la nota di rilascio.

EDIT: anche come la risposta di @ ddyer

The most important thing about release notes is to be aware that every additional sentence loses another 10% of the readers. So you must strictly prioritize what your current users need to know about the release.

    
risposta data 05.10.2012 - 10:39
fonte
4

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

    
risposta data 05.10.2012 - 19:15
fonte

Leggi altre domande sui tag