L'impostazione del sistema di documentazione si basa sui punti che seguono:
- La struttura logica dei documenti si ispira a quella studiata da mssi con significative semplificazioni. I documenti vengono raggruppati per argomento o classe1. La sigla dcl denomina la classe del documento. Ogni documento possiede delle informazioni minime e in particolare: dcl, nome, titolo. Si utilizzano particolari convenzioni di nomenclatura per separare documenti di natura diversa2 all'interno della medesima classe. E' possibile inoltre categorizzare i documenti all'interno della propria classe. Il nome e la categoria sono i due sistemi di ricerca principali all'interno della classe.
- La struttura fisica dei documenti si basa su sgml. Ogni documento prrevede un formato che usando la terminologia sgml viene denominato dtd. Alcuni formati sono liberi e utilizzabili da qualunque classe di documenti, altri sono specifici e vengono utilizzati da una sola classe. Alcuni dcl prevedono l'utilizzo di più dtd altri prevedono un solo dtd. L'insieme dei documenti identificati tramite dcl.nome e caratterizzati dal proprio dtd rappresenta il db3 sgml in cui è riposta la documentazione.
- L'input del sistema di documentazione proviene da tre fonti principali:
- Lotus Notes per tutta la parte testuale. Un sistema di programmi lotusscript provvede a tradurre i documenti notes nel corretto formato sgml.
- I programmi e i sorgenti tecnici che compongono il sistema. Questi vengono scanditi tramite programmi perl e vengono prodotti automaticamente i diversi documenti.
- Grafici in formato bitmap e eps da includere sia nella presentazione html che nei manuali LaTeX.
- L'output del sistema di documentazione prevede:
- Output html dove ogni documento del db viene rappresentato da un separato documetno html.
- Output LaTeX dove uno o più documenti vengono raccolti insieme fino a formare un vero e proprio manuale. La formattazione dei manuali deve raggiungere la qualità prodotta da un normale word-processor senza che l'utilizzatore del sistema debba preoccuparsene.
1 Meno di venti dcl. Si pensi che gli indici M.S.S.I sono quasi un centinaio e quelli Method-1 più di duecento.
2 In pratica la classe viene suddivisa tramite convenzioni di nomencaltura. Tali suddivisioni hanno la medesima funzione dei moltissimi indici dei sistemi esaminati in precedenza. Il vantaggio è che le convenzioni di nomenclatura sono meno rigide e vincolanti di un sistema formato da centinaia di indici.
3 Il termine db viene usato in senso logico: inizialmente i documenti sono conservati nella forma di file usando il file-system.
e-mail