GPOI - Documentazione tecnica - La codifica dei documenti

Identificare un documento

Consente di individuare un prodotto in modo univoco e si viene a conoscere la sua storia e la sua evoluzione tecnica o del sistema a cui è collegato.

Un documento tecnico deve essere gestito in tutto il contesto in cui opera:
• nel contratto/commessa cui si riferisce;
• nell’ambito del prodotto che rappresenta;
• nella struttura che lo produce e lo utilizza.

Vi sono molti modi di definire un codice identificativo.

I più utilizzati sono:
• codice numerico assoluto (assegnato centralmente);
• codice “parlante” composto da più parti a indicare alcune caratteristiche del documento
o dell’oggetto che rappresenta.

Identificazione

Il nome (o codice identificativo) univoco non può sempre contenere tutte le informazioni necessarie (e quindi da solo a volte non basta). Devono esistere una serie di attributi che permettano di collocare il documento nel giusto ambito.

Possono essere attributi di tipo generale (data emissione, tipologia, emittente, ecc.) o gestionale (commessa, sottocommessa, cliente). Se il documento si riferisce a un prodotto, tra gli attributi indicheremo anche il sistema, l’impianto, il sottosistema. Se parliamo di disegni avremo il formato, lo standard, il software, che lo ha generato, ecc.

Cartiglio

Il cartiglio è una particolare tabella inserita nei disegni dove vengono riportate le principali informazioni identificative (denominazione del particolare, autore, materiale, data, distinta dei componenti se si tratta di un assemblato...).

Versioni e revisioni

Versione: si intende il congelamento di un documento (o di un oggetto) a cui sono state
apportate modifiche sostanziali tali da rendere la versione precedente obsoleta.

Revisione: si intende il congelamento di un documento (o di un oggetto) a cui sono state
apportate modifiche di lieve entità tali da non stravolgere l’impostazione di base del documento.

In un’azienda produttrice di software per il rilascio di prodotti software.

Rilascio ufficiale
• Versione consolidata del sistema o release successive che comportano evoluzioni architetturali, di piattaforma o di funzioni fondamentali rispetto a quella precedente.
• L’identificativo evolve nella cifra <x> (prima cifra).
• V<x>.<y>.<z>.<k>.

Rilascio intermedio 1
• Versione/revisione che comporta evoluzioni funzionali non fondamentali rispetto a quella
precedente.
• L’identificativo evolve nella cifra <y> (seconda cifra).
• V<x>.<y>.<z>.<k>.

Rilascio intermedio 2
• Revisione che comporta lievi miglioramenti nelle funzionalità già presenti ma che non hanno (o lo hanno in modo limitato) impatto immediato sulla percezione dell’utente.
• L’identificativo evolve nella cifra <z> (terza cifra).
• V<x>.<y>.<z>.<k>.

Rilascio intermedio 3
• Revisione che comporta la correzione di errori evidenziati in una delle release precedenti.
• L’identificativo evolve nella cifra <k> (ultima cifra).
• V<x>.<y>.<z>.<k>.

Controllo stato e versioni

In genere un oggetto o documento può trovarsi nei seguenti stati:
In Work: si tratta di un documento su cui si sta lavorando. Sono versioni modificabili
solo dal creatore e cancellabili. Sono normalmente presenti in un ambiente di lavoro
privato.

Preliminare: è un documento non ancora completato, ma non modificabile.

Rilasciato: è un oggetto completato per la fase relativa, cioè in versione definitiva. Non
è più modificabile, nè cancellabile.

Informazioni su Francesco Bragadin

Insegno informatica e telecomunicazioni al liceo scienze applicate ed all'indirizzo informatica e telecomunicazioni. Ho terminato gli studi in ingegneria elettronica e telecomunicazioni lavorando per molti anni come libero professionista nell'ambito della gestione storage e disaster recovery su mainframe.
Questa voce è stata pubblicata in Senza categoria. Contrassegna il permalink.

Lascia un commento

Il tuo indirizzo email non sarà pubblicato. I campi obbligatori sono contrassegnati *