I manuali utente e i manuali di architettura devono essere prodotti su carta. A tal fine serve un sistema di formattazione sofisticato e una metodologia per comporre documenti finiti da un insieme di frammenti di ingresso.
E' necessario distinguere i manuali permanenenti dalle collection di lavoro.
Un manuale permanente viene preparato collegando insieme decine e decine di documenti.
- Si decide una struttura di massima del manuale.
- Si raccolgono i documenti e si immettono nella struttura prevista.
- Si creano i documenti di colla allo scopo di raccordare tra loro i testi.
- Si creano i documenti che mancano.
- Si correggono i testi dei documenti.
La stesura del manuale è tipicamente uno dei momenti di riorganizzazione e riordino della documentazione. Senza questi momenti la nuvola di documenti rischia di trasformarsi un un caos.
Normalmente un manuale viene creato a fronte di documentazione prodotta manualmente. La documentazione automatica può essere citata ma raramente viene inclusa. La consultazione via web è senza dubbio il modo più efficace di esaminare i documenti automatici.
Una collection di lavoro è un insieme di documenti creato per eseguire un determinato lavoro. Ad esempio nello sviluppo di una procedura può essere utile creare delle collection che comprendano tutti i documenti necessari. Terminato lo sviluppo questa collection viene eliminata. In alcuni casi è utile creare un manuale assemblandolo da una serie di collection.
e-mail