Gestione progetto organizzazione d’impresa

Documentazione tecnica

Il documento tecnico

Quando parliamo di documentazione tecnica possiamo in realtà comprendere una grande quantità di documenti.

In pratica può rientrare in questa categoria OGNI tipo di documentazione scritta che illustra le caratteristiche e spiega il funzionamento di un prodotto o di una procedura, o che documenta lo svolgimento di un progetto.

In realtà quando si parla di documento tecnico NON è sempre ben definito cosa si intenda.

A cosa serve un documento tecnico?

Per comprendere cosa si intende con documento tecnico partiamo da alcuni esempi di ciò a cui serve.

Un documento tecnico serve per: • documentare il completamento di una fase del progetto; • specificare le caratteristiche di un componente o di un impianto da costruire o acquistare; • descrivere come montare e/o collaudare un impianto o un componente; • illustrare le modalità di manutenzione di un sistema • dimostrare la correttezza del progetto per assolvere le leggi (permessi, verifiche, autorizzazioni ecc.).

Tipologie di documentazione

In base al fatto che la documentazione si riferisca all’oggetto da produrre o alle modalità con cui produrlo possiamo definire differenti tipologie di documentazione:

-Documentazione di prodotto-Documentazione di processo-Documentazione gestionale-Documentazione di progetto

Documentazione di prodotto

La documentazione di prodotto riguarda tutto ciò che afferisce alla progettazione del prodotto:

• Descrizione delle caratteristiche. • Disegno della forma esteriore (studio della linea, dell’apparenza esterna del prodotto) se si tratta di un oggetto fisico. • Descrizione dell’interfaccia verso l’utente. • Elenco delle componenti (distinta base). • Calcoli matematici. • Simulazioni. • Preventivi e consuntivi di costo.

Documentazione di processo

La documentazione di processo riguarda tutto ciò che afferisce alla progettazione del processo che permetterà la produzione di un prodotto:

• Definizione del ciclo produttivo. • Layout di stabilimento. • Studi ergonomici. • Simulazioni di montaggio delle componenti. • Tabelle di tempificazione delle operazioni.

Documentazione gestionale

La documentazione gestionale riguarda tutto ciò che concerne la fase contrattuale (specifiche e offerte) e quella di gestione del progetto (pianificazioni, controlli, avanzamenti e consegne):

• Specifiche e richieste di offerta. • Offerta di riferimento. • Project Plan. • Avanzamento progetto e consuntivi. • Verbali di consegna.

Documentazione di progetto

La documentazione di progetto riguarda tutto ciò che concerne lo svolgimento del progetto dal punto di vista tecnico (analisi requisiti, specifiche, dati, implementazione, manutenzione):

• Analisi dei requisiti. • Descrivere l’architettura del sistema. • Descrizione dei dati utilizzati qualunque sia il formato (file, database, ecc.). • Analisi/Specifiche tecniche/funzionali. • Specifiche implementative. • Manuali.

Il modello E-M-RI documenti sono atti comunicativi che devono SEMPRE tener conto del modello Emittente-Messaggio-Ricevente.

Ogni comunicazione è un Messaggio che un Emittente trasmette a un Ricevente:

Quando si deve realizzare un documento bisogna sempre aver chiaro chi scrive, cosa scrive e per chi scrive.

È importante quindi porsi delle domande sia all’inizio sia durante la realizzazione circa emittente, messaggio e ricevente.

Componenti dei documenti tecniciIn base alla modalità di rappresentazione dell’informazione possiamo individuare componenti:-descrittive (testi), sono documenti di tipo prevalentemente testuale che possono essere corredati da immagini, schemi, tabelle, disegni, ecc. Sono usati per definire specifiche, capitolati, requisiti, manuali-comparative (tabelle), permettono la rappresentazione schematica dei dati e sono usate generalmente per rappresentare liste di componenti, analisi comparative, risultati di test, costi, ecc.-grafiche (disegni e schemi), si hanno normalmente disegni vettoriali bidimensionali (2D) e tridimensionali (3D), immagini raster e animazioni.

Manuali

Un manuale è un documento che serve per spiegare il funzionamento di qualche cosa. Una suddivisione riguarda il tipo di approccio: -tutorial è un manuale relativamente semplificato, rivolto al principiante. -manuale di tipo reference costituisce invece una guida di riferimento per lo specialista o l’utente esperto.

I manuali sono in genere composti da “istruzioni”, al cui interno compaiono sequenze di operazioni ed eventi, glossario.

Identificare un documentoLa carta d’identità di un documento è a sua volta un documento complesso.

Consente di individuarlo in modo univoco non solo nel contesto produttivo in cui viene sviluppato, ma anche nella storia e nell’evoluzione tecnica del prodotto o del sistema a cui è collegato.

Un documento tecnico deve essere gestito in tutto il contesto in cui opera.

Vi sono molti modi di definire un codice identificativo:• codice numerico assoluto (assegnato centralmente); • codice “parlante” composto da più parti a indicare alcune caratteristiche del documento o dell’oggetto che rappresenta (in figura).

Il 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...).

In genere ogni azienda ha un proprio standard per rappresentare i dati in un cartiglio.

Nei disegni CAD le stesse informazioni sono inserite nel file e visualizzabili dal software di disegno.

Versioni e revisioniÈ possibile mantenere più versioni e revisioni dello stesso documento.

- Versione: congelamento di un documento (o di un oggetto) a cui sono state apportate modifiche sostanziali tali da rendere la versione precedente obsoleta. - Revisione: congelamento di un documento (o di un oggetto) a cui sono state apportate modifiche di lieve entità tali da non stravolgerne l’impostazione di base.

Le versioni e le revisioni seguono delle numerazioni progressive. Vengono usate indifferentemente:• lettere minuscole o maiuscole (a, b, c, ... – A, B, C, ...); • numeri (1, 2, 3, ... – 001, 002, 003, ...); • numeri romani (I, II, III, IV, ...).

Le versioni e le revisioni sono normalmente divise da:• punti (.); • barre (/); • trattini (-); • qualunque altro segno.

Controllo stato e versioni

I documenti (o oggetti) possono essere in differenti situazioni in base alle quali agli utenti è possibile effettuare differenti operazioni.

Ogni oggetto può passare da uno stato a un altro in base a vari requisiti.

In genere un oggetto o documento può trovarsi nei seguenti stati: • In Work: si tratta di un documento su cui si sta lavorando. • Preliminare: è un documento non ancora completato, ma non modificabile. • Rilasciato: è un oggetto completato per la fase relativa, cioè in versione definitiva.

Spesso si suddividono le versioni anche in base a come possono essere utilizzate dai partecipanti a un progetto:• Pubbliche: versioni disponibili a tutti gli utenti• Private: versioni locali a disposizione di un singolo utente • Progetto: condivise a livello di gruppo di lavoro e modificabili da più persone

Document Management

La diffusione dei calcolatori e delle memorie ottiche permette di memorizzare grandi quantità di informazioni, strutturandole nel modo più consono ai vari ambienti (Document Management), e possono inoltre essere facilmente gestiti i flussi dei documenti tra gli ambienti di lavoro e il flusso stesso del lavoro (Workflow).

La scelta del sistema di gestione

Sotto il nome di sistemi per la gestione elettronica di documenti possiamo considerare oggetti con caratteristiche e funzionalità completamente differenti.

È quindi molto importante capire cosa i vari sistemi sono in grado di offrire, e quali prestazioni ci si può attendere da essi.

Nella scelta di questi sistemi vanno attentamente valutate le proprie esigenze e bisogna formalizzare in modo adeguato la struttura dei documenti, nonché il modo in cui questi circolano e vengono usati in azienda.

La scelta del sistema di gestione

I sistemi per la Gestione Elettronica dei Documenti sono generalmente formati da due componenti:- una in grado di coprire le esigenze dell’IMAGE PROCESSING, dove l’enfasi maggiore viene posta sulla gestione e manipolazione dell’immagine in quanto tale, - una rivolta al DOCUMENT MANAGEMENT, dove vengono trattate problematiche di gestione e memorizzazione del documento con funzionalità e problemi simili a quelli delle Basi di Dati.

Le quattro aree di un sistema completoTipicamente in un sistema “completo” per la gestione dei documenti vengono individuate quattro aree: -una per la gestione e archiviazione (Document Management), -una per l’acquisizione, -una per la creazione e le modifiche,-una per la consultazione dei documenti (queste ultime tre aree fanno parte dell’Image Processing).

Archiviazione

L’area di gestione e archiviazione è il fulcro del sistema e si occupa sia della memorizzazione sia della gestione dei documenti.

Mantenere traccia dello stato dei documenti, nonché traccia dell’ evoluzione e delle modifiche ai documenti nel tempo, consente verifiche accurate sugli avanzamenti e permette di individuare tempestivamente eventuali ritardi fornendo un supporto automatico alle procedure organizzative che governano il “ciclo di vita” dei documenti, in modo da garantire che siano state effettuate le necessarie verifiche di qualità e che i responsabili abbiano convalidato i risultati di competenza.

Per quanto riguarda l’Archiviazione, poiché i documenti sono fatti di componenti multimedia e data la quantità enorme di dati da immagazzinare, si ricorre alla Tecnologia Ottica. Attualmente i sistemi più usati sono i DISCHI OTTICI DIGITALI (OD3).

Image ProcessingAnalizziamo i vari moduli componenti l’area dell’Image Processing:

-Acquisizione dall’esterno: l’area di acquisizione è l’area in cui gli oggetti provenienti dal mondo esterno vengono acquisiti e trasformati in un formato elettronico. Generalmente dotata di uno scanner.

-Area Creazione e modifica: le normali stazioni di lavoro degli utenti, e devono essere in grado di fornire gli strumenti per la creazione di nuovi documenti e per la modifica di quelli già memorizzati. Tipicamente sono Word Processor, sistemi CAD, sistemi di Drawing ecc. Molto utili sono i sistemi OCR (Optical Character Recognition), per la conversione di immagini di caratteri in caratteri alfanumerici. Per quanto riguarda invece i disegni tecnici e architettonici è utile il riconoscimento di immagini e la vettorizzazione.

-Area di consultazione e stampa: differisce dall’area di creazione e modifica essenzialmente solo per l’inibizione che si dà alla possibilità di modificare i documenti. È in quest’area che vengono realizzate le attività di riproduzione dei documenti dal formato elettronico al formato cartaceo o ad altri formati.

Sicurezza dei documenti

Il Document Manager garantisce l’integrità dei dati evitando modifiche concorrenti e controllando gli accessi ai documenti da parte degli utenti.

I privilegi di accesso vengono determinati in base al ruolo ricoperto dall’utente, allo stato e al tipo dell’oggetto

Workflow Management

Compito dei sistemi di Workflow è quello di permettere di definire e descrivere i processi lavorativi in termini di attività da svolgere, i partecipanti alle attività suddivisi per ruoli, gli oggetti utilizzati, e di seguire, guidare e controllare che questi processi vengano portati a termine.

Lo scopo di questi sistemi è quello di informare al momento giusto ogni partecipante relativamente al proprio compito da svolgere (task) e di fornire tutte le informazioni necessarie per il suo espletamento.

In ogni momento quindi un utente non solo dovrà essere in grado di accedere ai dati e alle informazioni necessarie per lo svolgimento della propria attività, ma dovrà anche poter conoscere lo stato dei lavori paralleli al suo.

La fine della propria attività dovrà essere segnalata, in modo che chi dovrà continuare il lavoro sia avvisato e che quindi possa iniziare la propria parte.

Release Management

Nel corso del suo ciclo di vita, ogni specifica versione di un oggetto è sottoposta a una serie di operazioni che ne modificano lo stato; la sequenza di tali stati viene solitamente indicata come “procedura di rilascio”.

Una procedura di rilascio consente di: • descrivere l’iter di un documento all’interno dell’organizzazione (i vari passi vengono detti stati o livelli di approvazione); • definire le condizioni che devono essere soddisfatte affinché un documento venga promosso a un dato livello; • stabilire i privilegi di consultazione e modifica del documento per ciascun livello.

Project Management

È importante poter organizzare le informazioni creando diversi ambienti di lavoro.

Per ogni attività vengono definiti gli utenti abilitati ad accedere al sistema e il ruolo che ciascuno di essi ricopre, i privilegi di accesso, i documenti di interesse, le regole di approvazione e di notifica degli eventi.

Per ogni singolo stato è possibile definire vincoli specifici.

Autorizzazioni

Il completamento di una certa attività è determinato da una serie di circostanze: chi doveva svolgere un certo compito deve averlo fatto, i documenti e i folder relativi devono essere in un particolare stato, i responsabili devono aver dato la loro approvazione.

Esiste quindi un insieme di vincoli di completezza e di consistenza (chiamati check) che devono essere soddisfatti affinché un passaggio di stato possa aver luogo.

Il principale tipo di check è costituito dalle firme elettroniche, cioè dalle autorizzazioni che gli utenti abilitati possono dare per approvare una fase del lavoro o promuovere un documento o un folder al livello successivo.

La conoscenza in azienda

Quando si affronta un nuovo progetto molto spesso si tratta di lavori che devono seguire degli standard aziendali o di settore.

È importante avere quindi una guida da seguire per produrre documentazione di qualità per i progetti.

La documentazione e la conoscenza dei vecchi progetti e degli standard sono normalmente presenti in azienda, ma non sempre facilmente reperibili. Purtroppo a volte la conoscenza si trova solamente nella “testa” dei dipendenti.

Questa disseminazione della conoscenza porta a notevoli criticità.

Diventa fondamentale avere una “metodologia” e dei “template” di supporto ai progetti, e avere uno “strumento” per gestire la documentazione (il Knowledge) in modo da poterla recuperare successivamente.

Template standard in azienda

Abbiamo detto che è importante in azienda avere degli standard per organizzare i dati, gestire progetti, creare documenti a partire da template.

Il template è un documento di base, una struttura vuota da riempire in base al progetto.

Può essere uno schema Excel che andrà configurato con i dati relativi al progetto dove poi andranno inseriti i dati durante lo svolgimento dello stesso, oppure lo schema di svolgimento di un progetto con le attività standard già proposte.

Per ogni tipo di progetto operativo è bene individuare documenti necessari e relativi template.

Potrebbe essere necessario utilizzare gli standard del cliente. In questo caso è bene cercare la corrispondenza tra ciò che ha organizzato il cliente e la nostra impostazione.

Organizzazione dei documenti

Per organizzare i documenti all’interno del server può essere utile:-definire delle aree standard (per esempio directory o cartelle) organizzati come “Archivi Tecnici”, -identificare i documenti in modo standard per agevolarne la comprensibilità e reperibilità, -definire i template dei vari tipi di documenti.

Tradizionalmente l’accesso alla documentazione avviene con gestione dei nomi. Può essere strutturato (per cliente, per area di business, ecc.) oppure non strutturato con accesso per parola chiave o full test.

Nomi dei documenti

Il nome dei documenti dovrebbe essere di tipo “parlante” e potrebbe seguire la regola per cui ogni documento “pseudo ufficiale” dovrà avere un codice autoesplicativo circa il contenuto del documento.

Un esempio di “nome parlante” potrebbe essere:commessa_tipolavoro_tipodocumento_nprogressivo_release

Ogni documento dovrà poter essere memorizzato in base ad alcune informazioni:- argomento lavoro - tipo documento - cliente - autore