Questa famiglia di documenti raggruppa i manuali prodotti.
Per manuali si intendono documenti cartacei, ben formattati e indicizzati, scritti e compilati per essere letti dall'inizio alla fine.
Il sistema di documentazione funziona se:
- I manuali di alto livello vengono composti tramite i documenti di base con l'aggiunta di qualche documento di "raccordo".
- I manuali di riferimento vengono composti interamente automaticamente.
I manuali vengono scritti e compilati tenendo conto che il modo migliore di presentare i documenti di estremo di dettaglio (reference manual) è html. Lo scopo del manuale cartaceo è fornire un testo da leggere in sequenza (dall'inizio alla fine). Testo che ha lo scopo di inquadrare un argomento. I manuali di reference sono sostituiti egregiamente da un sistema di consultazione html.
MAN -- Nomi, Note, MSSI, DTD
Nome |
Note |
dsg.manual |
Manuali sul disegno, ovvero "Principles of Operations" Questi manuali descrivono il funzionamento complessivo del sistema. L'obiettivo è quello di enunciare e spiegare principi generali: Overview del sistema (cosa fa): Elenco dei componenti Elenco dei sottosistemi Struttura funzionale Modelli Eventi Entità Oggetti Flussi di massima Organizzazione aziendale Struttura Tecnica Data base Programmi Tipi di Hardare Altre risorse docg32 - Disegno funzionale docg33 - Disegno tecnico |
sup.manual |
Manuali di installazione |
hto.manuale |
Manuali How To, manuale per gli utenti: Contiene una descrizione procedurale e logica: Evento Ufficio Procedura Dettagli di utilizzo docu10 -Manuale dell'utente |
crs.manual |
Gestione dei Corsi ammt10 - Programma dei corsi ammt20 - Contenuto dei Corsi ammt21 - Schema per l'istruttore ammt25 - Agenda del Corso |
faq.auto |
Domande e risposte ovvero "Frequently asked Questions" |
auto |
Frammenti di testo da inserire in uno o più manuali. |
e-mail