Uno sviluppatore dovrebbe scrivere "documento soluzione" prima di iniziare la codifica?

Naviga le tue risposte
-2

Perché lo facciamo per "Pianificare prima di codificare" e un altro punto è "aiutare i nuovi arrivati nella squadra". Siamo una squadra di 5-8 membri. Disponiamo di documentazione API e Readme inclusi con i nostri progetti. Scrivere una soluzione documento una volta non è un compito difficile. Ma il problema è che, è tempo e difficile mantenere ogni cambiamento che facciamo nelle fasi successive del nostro codice sorgente in un documento di soluzione separato che conserviamo. Vale la pena scrivere un documento di soluzione?

    
posta tan 27.10.2018 - 12:24
fonte

1 risposta

5

Dipende da perché stai creando il documento.

  1. Per mostrare al cliente cosa aspettarsi e agire come una specifica per il progetto.

  2. Fungere da manuale di istruzioni per il software a cui i nuovi avviatori possono fare riferimento.

  3. Per tenere traccia dei requisiti del software nel tempo, in modo che le nuove richieste non rimuovano i requisiti utilizzati raramente per errore ecc.

Direi che un documento di soluzione è abbastanza buono per 1. Ma la gente ha smesso di preoccuparsi di 2 tutti insieme e usa test di unità / accettazione per 3.

Se trovi che stai creando documentazione perché "abbiamo bisogno di documentazione!" ma nessuno lo legge mai. Quindi smetti di scriverlo.

    
risposta data 27.10.2018 - 14:08
fonte

Leggi altre domande sui tag

Modelli software per quadri [chiuso] Che cosa sono "Version.txt / Version in build script" e "Build Server versioning"?