4° Anno TEORIA 4. Fondamenti di ingegneria del software | Page 11
12. Fondamenti di ingegneria del software Vers.1.1 – Marzo 2009
La Documentazione
La Documentazione, pur non avendo un obiettivo specifico all’interno del ciclo di vita del
software, rappresenta una fase trasversale a tutto il progetto.
Un prodotto scarsamente documentato non può essere considerato l’output di un buon progetto in
quanto non garantisce il raggiungimento di molti attributi di qualità ed ostacola il lavoro di
manutenzione.
La preparazione ella documentazione deve procedere in parallelo ad ogni fase del ciclo di vita.
Questo vale sia per la documentazione dei programmi, sia per la documentazione dell’utente:
rimandare la stesura dei vari documenti è pericoloso in quanto si rischia di produrre documenti
parziali assolutamente non in linea rispetto a quanto implementato.
La scarsezza o la non corrispondenza o la completa assenza di documentazione influiscono
negativamente non solo sulla futura manutenzione, ma anche sull’utilizzo del prodotto da parte
dell’utente.
Gli obiettivi della documentazione sono:
- fornire la documentazione del sistema ossia il materiale documentativi consultabile dagli esperti
in fase di intervento sul prodotto;
- fornire la documentazione per l’utente ossia il materiale documentativi consultabile dall’utente
nel corso della sua normale attività lavorativa. Tale documentazione è più frequentemente fornita in
formato elettronico sottoforma di file (in genere PDF oppure DOC oppure HTML) su CD ma può
anche essere fornita sottoforma di guida on-line o help online.
Autore: Rio Chierego (email: [email protected] - sito web: www.riochierego.it)
Pag. 11