Che tipo di informazioni andrebbero inserite nella buona documentazione di distribuzione? [chiuso]

Question

Ho queste continue battaglie con i miei colleghi per quanto riguarda la composizione della documentazione di spiegamento.

Tutti concordano che la documentazione è necessaria. Non tutti possono trovare un terreno comune su quale livello di dettaglio dovrebbe andare in questo, in particolare la differenziazione tra rilasci di grandi dimensioni, correzioni di bug e miglioramenti.

Che cosa hai trovato funziona meglio per te?

Answer 1

Se lo scopo della documentazione è garantire che il codice sia distribuito in modo ripetibile, la seguente pratica minima sarebbe la seguente:

1. Un riepilogo di ciò che riguarda la versione, cosa è cambiato, versione, dove è possibile trovare il file della soluzione ecc.
2. Elenca possibili dipendenze
3. Procedure dettagliate di spiegamento
4. Modifiche al database o script richiesti per l'installazione
5. Riepilogo della configurazione della configurazione dell'applicazione.
6. Test funzionale chiave che può essere eseguito per verificare l'installazione come operativa.
7. Procedura di rollback - se necessario.

Answer 2

Ho scoperto che la creazione di uno strumento che consente una distribuzione con un clic è molto meglio della documentazione di distribuzione completa.

Answer 3

Qual è lo scopo della tua documentazione? Inizia da lì e immagina cosa soddisfa quell'obiettivo.

Per noi, il nostro obiettivo era consentire a qualcuno del tutto nuovo del gruppo di essere in grado di eseguire una distribuzione nuova o aggiornata per alcuni sistemi diversi. Stiamo eseguendo un tipo di operazione estremamente semplice: servizi di Windows, cron job, backup di database, aggiornamenti di siti Web, ecc.

In ogni caso, il livello di dettaglio era basato sul sistema e su ciò di cui un nuovo membro del team avrebbe bisogno per eseguire aggiornamenti e nuove distribuzioni.