IL PROBLEMA...

Una fase vitale per padroneggiare la distribuzione di un Sistema Informativo è la formalizzazione della documentazione tecnica.  Lo scopo di ARCAD-Observer è di automatizzare questo procedimento il più possibile.

Non c’è nessun vantaggio nel produrre documentazione fine a se stessa.  Tuttavia, questo è ciò che spesso succede nelle aziende.  La prova: molto spesso la documentazione è obsoleta.

Perché una documentazione tecnica sia realmente fruibile,  è necessario che segua i seguenti criteri:

• Gli utenti devono sapere che la documentazione è interamente aggiornata
• Accedervi deve essere facile e veloce
• La documentazione deve contenere informazioni sintetiche 
• Deve essere semplice per un utente rintracciare l’informazione desiderata.

LA SOLUZIONE ARCAD...

Dopo aver analizzato tutti questi criteri, siamo giunti alla conclusione che per la documentazione il miglior formato sia l’ HTML.  Questo formato semplifica davvero la distribuzione delle informazioni.  Qualunque utente può accedervi via Intranet ed essere sicuro di lavorare nella versione corretta.  Gli utenti possono eseguire ricerche dalla loro postazione usando tradizionali motori di ricerca.

ARCAD-Observer genera i documenti in formato HTML. I diagrammi  vengono inseriti come immagini o come eseguibili se si desidera fornire funzioni di navigazione direttamente nelle pagine generate.  Ad esempio questo è come vengono visualizzati I diagrammi organizzativi prodotti dall’analizzatore del codice sorgente. E’ inoltre semplice stabilire collegamenti di ipertesto verso qualsiasi documento esterno.  Per questo sarà possibile collegarsi a qualsiasi tipo di documentazione esistente.

COME FUNZIONA ?...

Questo prodotto permette di definire una varietà di standard (documentazione tecnica, documentazione per l’utente, cartelle operative, cartelle di versione) chiamati modelli.  Questi modelli possono essere interamente configurati in termini di capitoli e sotto-capitoli.  
Si selezionano diversi perimetri (tutta l’applicazione, sotto-livelli funzionali, componenti modificati, ecc.) e si applica un modello per ottenere la documentazione necessaria.

L’editor della documentazione permette di spaziare tra le varie sotto-sezioni generate automaticamente con informazioni funzionali formattate come note.
L’editor può inoltre incorporare tutti i diagrammi generati da Observer—compresi le videate e le stampate—all’interno della vostra documentazione.
Observer produce documentazione in HTML gestendo automaticamente il sommario, il formato e la grafica.   A questo punto è semplice metterle in Intranet per facilitare la circolazione delle informazioni.

AGGIORNARE LA DOCUMENTAZIONE...

Affinchè la documentazione sia utilizzabile, deve essere perfettamente aggiornata.  Ci siamo assicurati di includere tutti i meccanismi di aggiornamento.  Il nostro sistema di list merge assicura la distribuzione della documentazione esistente e che la descrizione dei componenti sia aggiornata.  Le sezioni generate in automatico possono essere sostituite automaticamente pur preservando le sezioni personalizzate.  Ovviamente anche i diagrammi inseriti manualmente possono essere aggiornati.