Formulate le note di rilascio in modo coerente

2

Nel mio progetto mi sono reso conto che scrivere note di rilascio è sia utile che necessario. Tuttavia, non è richiesto dalla mia gestione e tengo questi file virtualmente a me stesso. Si potrebbe dire, lo faccio per l'auto-organizzazione. Per ogni versione del software di prototipia interna, creo un numero di versione e aggiorno il file RELEASE con le modifiche che si sono verificate dall'ultima versione. Le note di rilascio sono classificate in elenchi di nuove funzionalità, correzioni di bug e limitazioni rimanenti (funzionalità da implementare nella prossima versione). Poiché la mia gestione non richiede questo documento da me, continuo a scrivere le note di rilascio in modo libero.

Ora, non sono sicuro di come formulare al meglio (spero di non essere inviato a English @ SE; non sono interessato alle funzioni grammaticali, ma all'esperienza di altri sviluppatori qui che fanno compilano note di rilascio per i clienti) funzionalità che sono state implementate. Al momento uso una grammatica diversa che è incoerente tra le note. Voglio raccogliere esperienza da altri sviluppatori.

Formuli le note di rilascio:

  • iniziando con I / I (ho / abbiamo integrato / testato / aggiornato alcune nuove funzionalità), o
  • come frasi non personali (alcune nuove funzionalità sono state integrate / testate / aggiornate) o
  • come nomi: integrazione / test / aggiornamento di alcune nuove funzionalità o
  • altri?

Al momento, mescolo tutti questi stili e scegliendo uno stile, voglio essere coerente con lo standard del settore.

    
posta Pavlo Dyban 17.06.2014 - 14:48
fonte

1 risposta

3

Se posso mettere la tua domanda da un lato per il momento, la mia carne principale con le note di rilascio è che spesso sembrano discariche di cervello.

Il lettore dovrebbe essere in grado di vedere a colpo d'occhio a cosa sono interessati. Non dovrebbero essere costretti a guadare pagine e pagine per vedere se il loro errore è stato corretto, o se quella nuova caratteristica tanto attesa è stata finalmente completata.

Prova a suddividerlo in sezioni:

  • Nuove funzionalità
  • Principali modifiche
  • Modifiche minori
  • Correzioni di bug

Per rispondere alla tua domanda, mantieni le note di rilascio concise, neutre e impersonali.

Alcuni esempi:

Bad : dopo circa 3 settimane di indagini, abbiamo finalmente risolto il modulo di calcolo ieri sera tardi. Era un overflow nella routine AddSummaryTotals. Restituiva un Long quando avrebbe dovuto restituire un Int.

Buono : errore di overflow corretto nel modulo di calcolo

Cattivo : modificato i colori del grafico come Jake nel marketing dice che non hanno un bell'aspetto sul suo laptop

Buono : modificato i colori del grafico per migliorare il contrasto

Non valido : ha interrotto i rapporti stampando una pagina aggiuntiva alla fine. Non pensavo fosse un grosso problema, ma adesso è stato risolto!

Buono : il report è stato interrotto e alla fine è stata stampata una pagina aggiuntiva

    
risposta data 17.06.2014 - 16:21
fonte

Leggi altre domande sui tag