GPOI - Documentazione tecnica - introduzione

Jackson Pollock

Documento tecnico

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

Si hanno tanti tipi di documentazioni:

di prodotto:-->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.

di processo-->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.

gestionale-->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.

di progetto-->svolgimento del progetto dal punto di vista tecnico

• 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-R

Emittente-Messaggio-Ricevente

Chi è “E”, l’Emittente: chi scrive il documento? Quali sono le competenze che deve
avere, quale il suo metodo? Con chi interagisce quando progetta e scrive un documento?
Cos’è “M”, il Messaggio: come sono fatti (come devono essere fatti) i documenti? Si
possono formalizzare e generalizzare regole o linee-guida per impostare e scrivere documenti
standard? Quali sono le caratteristiche linguistiche e comunicative che deve avere?
Chi è “R”, il Ricevente: chi è l’utente, il lettore, il destinatario del documento? Qual è il suo ruolo e di cosa ha bisogno? Quali vincoli e indicazioni ne derivano per chi deve scrivere?

Componenti dei documenti tecnici

componenti descrittive (testi), comparative (tabelle) e grafiche (disegni e schemi)

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 *