Come scrivere la documentazione del progetto

Question

Ho appena terminato un progetto relativamente piccolo (~ 3000 righe di codice in diversi moduli) e mi è stato chiesto di produrre un documento per il progetto. Non ho idea di come andare su questo come ho scritto in gran parte il codice per altri programmatori prima. Descrivo ogni modulo, faccio diagrammi UML per ogni oggetto, semplicemente espandi i miei commenti? C'è un modello che posso usare per questo? Se qualcuno ha dovuto fare documentazione standard, apprezzerei il tuo aiuto/i tuoi consigli.

Answer 1

Non c'è molto in termini di documentazione "standard"; I documenti API in stile "Javadoc" sono il più vicino possibile. Ottieni requisiti più solidi. Di che tipo di documenti ha bisogno il tuo cliente? I diagrammi UML per tutte le tue lezioni sono un esercizio pulito e talvolta utile, ma il tuo tempo potrebbe essere meglio speso per progetti futuri.

Answer 2

Come minimo si dovrebbe documentare

• come costruire il software
• come installarlo
• un "manifesto" di file e strumenti necessari
• note di rilascio: cosa è cambiato dal versione precedente
• informazioni su licenza e copyright

Poi, a seconda di come viene utilizzato il software, si potrebbe desiderare

• Manuale Utente
• documentazione API

Answer 3

Si potrebbe fare molto peggio di rivedere le Descrizioni di articolo DOD-STD-2178A dati per il documento di progettazione software e il documento di descrizione della versione.

L'SDD descrive il design del software. Il VDD descrive la confezione, incluso come installarla (decomprimere, compilare, caricare, configurare).