La documentazione del sistema viene prodotto in diversi momenti della sua vita:
- In fase di analisi.
- In fase di sviluppo.
In fase di analisi1 di un sistema è necessario produrre documenti prima che la struttura definitiva del sistema sia nota. Possiamo immaginare una produzione di documenti di lavoro. I documenti subiranno diverse sistemazioni e revisioni, via via che il lavoro di analisi progredisce. Il concetto di fondo è che la documentazione si evolve insieme all'analisi.
In fase di sviluppo2 si apportano modifiche ai documenti di analisi e si producono nuovi documenti a supporto dell'attività tecnica di sviluppo.
Uno strumento come notes permette al gruppo di lavoro di accedere in modo ordinato ad un data base di documenti e permette una decente gestione dei testi. Questa produzione frammentata porta alla creazione di una nuvola di documenti, dove ogni singolo documento ha un contenuto ben preciso.
Non è possibile effettuare una produzione frammentata se non si dispone di un'adeguato catalogo dei documenti. Il sistema di documentazione stabilisce il tipo di documento da utilizzare in base al tipo di contenuto. I documenti rientrano in un sistema di catalogazione completo, gestibile ed estensibile. Una base di tale sistema è il sistema mssi.
- La catalogazione deve essere completa affinchè ogni singolo documento abbia una precisa collocazione.
- La catalogazione deve essere gestibile altrimenti è molto difficile raggiungere i livelli di addestramento necessari al suo utilizzo. Il criterio fondamentale alla base della gestibilità è la semplicità.
- Il sistema deve essere estensibile per tener conto delle complessità del singolo progetto.
Periodicamente è necessaria un'attività di riorganizzazione. Tipicamente tale riorganizzazione si ottiene preparando manuali e tirando le fila del lavoro svolto fino a quel momento.
1 La fase di analisi può riguardare: un nuovo sistema o la revisione di un sistema esistente.
2 La fase di sviluppo comporta anche la stesura del codice. E' fondamentale che la documentazione e la stesura del codice siano attività coordinate. A tal fine l'obiettivo è la produzione automatica di documenti a partire dal codice.
e-mail