Livelli di documentazione


Il sistema di documentazione può essere classificato in diverse aree, e ciascuna area può essere suddivisa in livelli.

Scendendo di livello aumenta il volume della documentazione e contestualmente il dettaglio.

La tabella che segue fornisce uno schema di questa suddivisione. Si illustrati tre livelli di dettaglio:

  • Il 1° livello: comprende tutta la macro documentazione. La documentazione di primo livello comprende:
    • Il disegno logico completo.
    • Il disegno tecnico di massima, la suddivisione in sistemi e il censimento dei sorgenti.
    • I principali eventi e flussi del disegno utente.
  • Il 2° livello: aggiunge i dettagli di primaria importanza:
    • Nel disegno tecnico si aggiungono: la struttura del data base, i files di interscambio.
    • Nel disegno utente si aggiungono: le procedure manuali, le interfacce, i job, le stampe.
  • Il 3° livello: si spinge al massimo dettaglio:
    • Nel disegno tecnico si documentano le classi e le funzioni di libreria. Si documentano tutti i programmi.
    • Nel disegno utente si documentano tutte le mappe, le stampe, e le procedure di input da utilizzare.
DCL di Analisi

DCL

Descrizione

Disegno Logico

Che cosa deve fare? Quali cose fa? Con che logica? Con quale motivazione?

 

1° Livello

 

 

 

REQ

Requisiti Funzionali del Sistema

   

DSG

Disegno del sistema

Disegno Tecnico

Di quali componenti è composto? Come è fatto ciascun componente?

 

1° Livello

Struttura Generale

   

DST

Disegno Tecnico

 

 

SYS

Sistema o sotto-sistema

 

 

SRC

File sorgente

 

2° Livello

Struttura del Data base

   

DST

Disegno Tecnico

 

 

DAF

File di Dati

 

 

DAT

Struttura o Aggregato di dati

 

 

KON

enumerazioni

 

2° Livello

File di Interscambio

   

DST

Disegno Tecnico

 

 

DAF

File di Dati

 

 

DAT

Struttura o Aggregato di dati

 

 

KON

enumerazioni

 

3° Livello

Struttura Implementativa

   

DST

Disegno Tecnico

 

 

CLA

Classe

 

 

FUN

Funzione

 

 

SRC

File sorgente

Disegno Utente

Quali sono i cicli di utilizzo? Quali sono le modalità di utilizzo? Quali sono i controlli amministrativi?

 

1° Livello

Macro flussi procedurali

 

 

DSU

Eventi Elementari

 

 

DSU

Procedure Manuali Utente

 

2° Livello

Procedure di dettaglio

 

 

DSU

Procedure Manuali Utente

 

 

DSU

Documenti e moduli manuali

 

2° Livello

Interfaccia con il sistema, inventario

 

 

UUI

Interfaccia Utente

 

 

JOB

Job e Processi Batch

 

 

RPT

Stampe e Report

 

3° Livello

I/O del sistema, dettagli

 

 

UUI

Interfaccia Utente

 

 

JOB

Job e Processi Batch

 

 

RPT

Stampe e Report

 

3° Livello

Istruzioni all'utilizzo dell'I/O

 

 

DSU

Procedure Manuali Utente

dsg.3wdloee • LastModified: 14-9-2007 • John Peter Arnold