|
|
Documentare i programmi che si scrivono è importantissimo, forse tanto quanto scriverne il codice. La documentazione di un programma è tutto ciò che, senza essere il programma stesso, può essere utilizzato da un altro programmatore per capire il programma. La documentazione di un programma si può dividere in:
documentazione interna;
documentazione esterna.
Documentazione interna
La documentazione interna di un programma è costituita principalmente dai commenti
introdotti nel corpo del programma allo scopo di spiegare il suo modo di operare.
Anche la formattazione di un programma può essere considerata una forma di documentazione
interna, in quanto, se ben fatta, guida l'occhio del programmatore ed evidenzia
graficamente i blocchi concettuali in cui si divide il codice.
Documentazione esterna
La documentazione esterna consiste nei documenti di progetto che sono separati
dal programma: documenti di specifica, spiegazioni scritte, manuali di riferimento,
schemi e diagrammi. In generale, si possono distinguere due tipi di manuali:
il manuale utente, indirizzato essenzialmente a chi, non addetto ai lavori, dovrà utilizzare il programma;
il manuale di riferimento, indirizzato all'utente avanzato, spesso un addetto ai lavori, e agli eventuali programmatori che potrebbero utilizzare il programma come componente di un sistema software più grande
Tutto quanto riportato in questa pagina è a puro scopo informativo personale. Se non ti trovi in accordo con quanto riportato nella pagina, vuoi fare delle precisazioni, vuoi fare delle aggiunte o hai delle proposte e dei consigli da dare, puoi farlo mandando un email. Ogni indicazione è fondamentale per la continua crescita del sito.