Data Base ArDoc


ArDoc è un sistema di gestione e manutenzione della documentazione basato su sgml. E' il risultato di una lunga esperienza nella gestione della documentazione dei sistemi informativi. Si pone l'obiettivo di semplificare e rendere più efficace l'attività di documentazione.

La classificazione delle informazioni permette di collocare e ritrovare i documenti prodotti classificandoli innanzitutto in una struttura di meta argomenti detti DCL. I documenti possono avere diversi formati e diverse strutture di contenuto. Questi formati e strutture sono regolati dal DTD SGML associato ad ogni documento prodotto.

Una parte dei documenti vengono preparati come testi o frammenti di testi. Il supporto principale alla preparazione di questi testi è un data base NOTES. L'utilizzo di un db permette l'attività di gruppo e la gestione della nuvola di documenti. Questo fatto differenzia, anche per quanto riguarda i testi, il sistema dall'utilizzo di un word processor. L'utilizzo di NOTES, SGML, e TeX permette una gestione del testo completa. Il risultato è almeno pari a quello che si può ottenere da un word processor ed è certamente superiore quando l'utilizzatore è inesperto.

Una parte dei documenti viene generata automaticamente scandendo i sorgenti. Il rapporto tra il risultato e lo sforzo richiesto per ottenerlo è molto favorevole, sia nella formattazione che nei contenuti. Il programmatore o l'analista generano la documentazione manipolando i commenti nel codice. Sia la produzione iniziale che la manutenzione dovrebbero semplificarsi di conseguenza.

L'output HTML permette la creazione di un sito ben strutturato molto efficace nella consultazione. Prevede diversi percorsi di navigazione, in parte precostituiti e in parte costruibili dal gestore della documentazione. L'output è html standard e non richiede altro supporto che non sia quello fornito dal browser. E' compatibile sia con Netscape che con Internet Explorer.

L'output cartaceo, realizzato con LaTeX, permette di trasformare la nuvola di documenti in un manuale ben strutturato e completo. Il documento che ne risulta, senza particolare sforzo per l'utente, è formattato in modo omogeneo anche se i documenti sono stati prodotti in epoche diverse e da utenti diversi. I criteri di formattazione e di presentazione sono il frutto di un'esperienza che non è alla portata dell'utente wp normale.

Il sistema è stato realizzato appoggiandosi a molte tecnologie diverse, alcune note da tempo altre molto recenti. E' stato programmato utilizzando tre diversi linguaggi di programmazione: LotusScript, C++, Perl. E' disponibile un rapido riepilogo degli strumenti utilizzati.

La versione corrente del sistema è la release 2.0 beta.

man.a • LastModified: 14-9-2009 • Gabriella Bozzolo