Al temine del manuale viene predisposto, se richiesto dal documento man, un indice dei documenti inclusi nel manuale.
Questo indice comprende una parte che elenca tutti i documenti tecnici in ordine di nome, e un parte che elenca tutti i documenti, tecnici inclusi, in ordine di apparizione nel manaule.
I documenti tecnici non partecipano alla formazione dei capitoli, delle sezioni o delle sottosezioni. Non appiaono nell'indice. Sono documenti tecnici i seguenti: CLA, DAF, DAT, FUN, KON, JOB, RPT, SRC, UUI. Vi sono svariati motivi per i quali questi documenti non partecipano alla formazine di capitoli, sezioni, ecc:
- Quando si includono i documenti tecnici in un manuale si desidera normalmente creare un manuale che contenga del materiale di consultazione. Ne segue che si includono un gran numero di questi documenti. Ad esempio un centinaio di documenti dat. Includere questi documenti nell'indice comporterebbe un enorme allungamento dell'indice. Si è scelto di creare un indice ad hoc che riporti in ordine alfabetico tutti i documenti tecnici.
- I documenti tecnici richiedono una formattazine particolare che ne evidenzi la struttura. Questa formattazione comprende anche il titolo del documento. Non è agevole prevederediverse varianti in funzione del livello.
- I documenti tecnici, all'interno della propria descrizione lunga non ammettono altri titoli.
Nel corregge un manuale spesso si lavora su di una copia stampata, è indispensabile un indice che permetta di risalire rapidamente al documento il cui testo si desira modificare. Per questo motivo è stato incluso un indice dei documenti in ordine di apparizione.
e-mail