WikiUp

Formati della documentazione

Per la sua intrinseca complessità, la documentazione non può limitarsi ad essere soltanto testuale, o al più ipertestuale, ma deve poter estrarre informazioni dall'applicazione in modo dinamico, ed offrire strumenti di prova delle funzioni (sandbox).

La documentazione è prodotta quindi in tutti questi formati:
  • pagine in formato html, ottenute da membri di documentazione attiva, oppure da documentazione interna ai sorgenti ILE.
  • book in formato .pdf, ottenuti come lista di elementi di documentazione attiva.
  • power point, realizzati a partire da membri di documentazione attiva.
  • documenti commerciali in formato Word.
  • componenti di schede, (matrici ed alberi) che presentano liste di informazioni (ad esempio, i moduli di un'applicazione).

Un esempio signficativo sono i modelli dinamici: informazioni contenute negli archivi delle relazioni, ricostruiti automaticamente e che rappresentano la il modello di customizzazione realizzato.
Altra documentazione "dinamica" è rappresentata da.
  • TST di API
  • Set and Play

Destinatari della documentazione

I singoli elementi di documentazione sono rivolti ad una o più delle seguenti figure professionali:
  • PER CHI VENDE. Personale commerciale, o comunque chi è interessato ad una visione generale dei prodotti
  • PER CHI SVILUPPA. Personale che realizza le applicazioni
  • PER CHI INSTALLA. Utente installatore, che imposta l'utilizzo del sistema per l'utente finale. Tecnico installatore, che imposta il funzionamento generale del sistema, realizza le exit, ecc.., oltre a svolgere i compiti dell'utente installatore.
  • PER CHI UTILIZZA. Utente finale, che utilizza il sistema nel suo lavoro quotidiano

Add new attachment

Only authorized users are allowed to upload new attachments.
«