Fino a tutto il 1998 la documentazione prodotta dal MURST e dai suoi fornitori si presenta eterogenea nella forma e nella struttura. Classi di documenti omogenei, come ad esempio le relazioni sui moduli, si trovano ad avere forma e struttura differente. Inevitabilmente anche la parte tecnologica del software presenta gli stessi problemi.

Obiettivi di questo modulo sono:

• Definire linee guida per uniformare esteticamente e dal punto di vista dell’organizzazione dei contenuti i documenti del Sistema Informativo;
• Definire la struttura di ciascun tipo di documento delle fasi di produzione del software gestionale;
• Definire lo standard per i diagrammi di flusso;
• Definire gli standard per i nomi;
• Raccogliere tutti gli standard industriali che verranno utilizzati.

Tutti i documenti prodotti o acquisiti dal SI:

• devono essere chiari, sintetici e completi
• devono essere adeguatamente strutturati

Si indicano di seguito le caratteristiche del layout di un generico documento. A quanto di seguito descritto discorsivamente, si affianca il prototipo presentato in appendice che è comunque da considerarsi il principale riferimento, anche per ciò che non è contemplato in queste righe.

Inderogabilmente A4. Gli schemi e l'eventuale codice dovranno essere opportunamente segmentati e collegati logicamente.

I margini devono tali da consentire qualunque rilegatura.

Intestazione e piè di pagina devono essere presenti su tutte le pagine seguenti la copertina e devono contenere: ente o gruppo responsabile del documento, titolo del documento, nome del file, data di ultima modifica, numero di pagina corrente e complessivo.

Il testo deve essere validato da un correttore di errori.

La formattazione del testo deve essere delegata al programma e non realizzata con spazi, tabulazioni e righe bianche.

I capitoli sono numerati secondo la notazione araba puntata.

Il sommario deve essere generato automaticamente dalla struttura.

Tabelle, grafici e figure sono inserite all’interno dei capitoli quando non superano la pagina; in caso contrario sono riportate in allegato.

Il font del testo deve appartenere alla famiglia graziata, il font dei titoli alla famiglia dei bastoni.

I documenti devono essere corredati da un frontespizio che lo identifichi con immediatezza e univocità.

Nella prima pagina del documento devono perciò comparire tutte le indicazioni che definiscono il documento: logo, titolo, versione, area e progetto di appartenenza, autori, data e indicazioni di copyright. Ben evidenziato deve apparire se il documento è riservato o ad uso interno. In prima pagina non appare né l’intestazione né il piè di pagina.

Nel ribadire che tutti i documenti devono essere devono essere chiari, sintetici e completi e essere adeguatamente strutturati, si descrive nel seguito l'organizzazione principale e inderogabile di tutti i documenti.

Scopo della premessa è introdurre i contenuti del documento, indicare come sono affrontati nel documento e come eventualmente essi si inquadrano in un contesto più generale. Se i capitoli riguardanti i contenuti sono più di uno, in premessa viene inserita una descrizione sommaria degli argomenti di ciascun capitolo, che spiega in che modo è stato organizzato l'intero documento.

Nel capitolo Obiettivi si elencano gli obiettivi che il prodotto si prefigge.

Nel capitolo/i dei contenuti vengono trattate le problematiche del documento.

Partendo dall'analisi del problema si suggerisce una scomposizione della trattazione in sottoproblemi ciascuno affrontato separatamente in un paragrafo. Modalità di suddivisione, dipendenti dalla natura dell'argomento affrontato, possono essere:

-Suddivisione del problema in fasi;

-Suddivisione del problema in sottoproblemi.

In base all'ampiezza dei sottoproblemi/sottofasi (da ora in poi sp/sf) si può liberamente scegliere se trattare ogni sp/sf in un paragrafo (sottocapitolo) o in più distinti capitoli.

Se un capitolo è strutturato in paragrafi (sottocapitoli) ad inizio del capitolo viene inserita una descrizione dei sottoparagrafi.

Vanno qui inseriti i glossari e gli elenchi di definizioni. Opzionale.

Và qui inserito ogni eventuale dizionario dei dati.

Bibliografia. Opzionale.

Negli Allegati vanno inseriti:

• le tabelle, i grafici e le figure con dimensioni superiori alla pagina
• i documenti citati nel testo e indispensabili per la comprensione completa del documento

La sequenza temporale con cui viene rilasciato e modificato un documento; è individuata dal numero di versione seguito da un punto e dal numero di revisione.

Un documento completo rilasciato per la prima volta ha versione 1.0.

Un documento cambia versione (quindi per es: da 1.0 a 2.0) se:

• viene completamente riscritto;
• si inseriscono variazioni tali da cambiarne in modo significativo i contenuti;
• si inseriscono nuovi contenuti tali da modificare gli obiettivi.

La modifica, l'inserimento o la cancellazione di una o più parti che non ne cambiano significativamente i contenuti produce un documento revisionato (ad es: da ver. 1.0 a ver. 1.1).

Per documenti che vengono presentati pur essendo incompleti (eventualità si spera rara, ma comunque probabile), si utilizza la numerazione 0.XX dove con XX si intende la percentuale di documento che è stato realizzato.

Si utilizza la notazione ungara.

Si rimanda a:

Microsoft, Visual Basic 5, Manuale del programmatore, Appendice B: convenzioni per la scrittura di codice Visual Basic.

Stan Leszynski, Greg Reddick Naming Conventions for Microsoft Access, Microsoft 1994 (http://msdn.microsoft.com/library/backgrnd/html/msdn_20naming.htm)

Si vuole definire un metodo semplice e lineare per una uniforme organizzazione degli algoritmi e consentire un rapido passaggio dalla simbologia visiva a quella letterale, e viceversa.

In questa direzione si è voluto fornire una integrazione della simbologia con le espressioni.

Lo schema adottato per le definizioni segue quello del glossario, con l’aggiunta della notazione scritta da utilizzare. La data per le specifiche di un termine è da riferirsi a quella del documento.

Leggi nome Legge un valore

Leggi file Legge un record del file con i suoi campi

Apri file Apre un file e si posiziona sul primo record

Chiudi file Chiude un file

Vai al successivo Il record corrente è quello successivo

File.Campo Identificazione di un campo di un file del record corrente

Stampa Permette la stampa di valori

Rpt. Nome Report

In questa parte vengono proposte le figure che all’interno di un diagramma di flusso rappresentano una azione e la corrispondente struttura letterale associata per la pseudocodifica.

7.3.3.2 Condizione

Si considera il ramo alla destra del simbolo di condizione il ramo vero.

Le lettere A e B rappresentano istruzioni semplici o blocchi di istruzioni.

Non sono ammesse altre rappresentazioni. Nel caso in cui si debba eseguire una istruzione o un blocco di istruzioni quando una condizione non si verifica, si neghi la condizione e si utilizzi il costrutto precedente.

 

Un ciclo viene effettuato per il vero della condizione, rappresentato sempre dal ramo destro. Nel caso di dover effettuarlo per il falso si nega la condizione. L’uscita verso il basso rappresenta quindi il falso della condizione.

La lettera A rappresenta una istruzione semplice o un blocco di istruzioni.