Capisco cosa includere nelle comuni note di rilascio - ci sono molte domande e risposte relative a questo.
Cosa dovrei includere nel primo set di note di rilascio, ad esempio per la prima versione rilasciata? Le note di rilascio sono necessarie per la prima versione?
Le note di rilascio (changelogs) vengono utilizzate principalmente per notificare agli utenti le modifiche tra versioni. Forse è disponibile una nuova funzione utile oppure una vecchia funzionalità è stata dichiarata obsoleta.
La prima versione rilasciata non ha modifiche. Le note di rilascio sono quindi abbastanza semplici:
v1.0.0 2017-02-20
- Anche se è vero che le note di rilascio tendono a comparire solo nelle revisioni successive, non c'è motivo per cui non possa essere spedito con la prima versione.
Come minimo, vorrai la data, il numero di versione e qualche descrizione, anche se si tratta di qualcosa come "Versione iniziale".
È perfettamente possibile che la versione iniziale non sia così completa come originariamente prevista. Gli utenti potrebbero essere desiderosi di mettere le mani su alcune funzionalità e aspettare gli altri. Potresti quindi descrivere cosa c'è nella versione iniziale e cosa è stato parcheggiato per dopo.
Potresti aver riscontrato alcuni problemi durante i test che, sebbene non impediscano l'uscita del rilascio, ti consigliamo di rendere gli utenti consapevoli. Questi tendono ad essere raccolti sotto l'intestazione Problemi noti o simili.
Non descrivi a cosa serva, ma potrebbero esserci anche alcuni requisiti software o hardware.
È importante notare che le note di rilascio dovrebbero essere un riassunto conciso. Se la versione iniziale viene eseguita su un numero di pagine, è possibile semplicemente indirizzare l'utente alla documentazione.
Normalmente includeresti una sezione per "nuove funzionalità"?
Nella versione prima , tutto è una nuova funzionalità. Sfruttare al meglio; questa sezione mai sarà così grande come questa prima.
Il tuo utente ha già acquistato / scaricato il software in modo che ci sia almeno una funzione che desiderava, ma offrirgli un elenco completo di tutto che hai fornito potrebbe non guastare neanche.
Leggi altre domande sui tag release-management release documentation