technical-writing

name

technical-writing

description

Redazione e revisione di documenti tecnici professionali per PMI italiane e studi di ingegneria/architettura. Copre relazioni di calcolo, perizie, capitolati, specifiche tecniche, verbali, documenti di progetto e relazioni normative. Usa questa skill quando l'utente deve produrre, migliorare o strutturare qualsiasi documento tecnico-professionale in italiano, garantendo precisione terminologica, coerenza formale e conformità agli standard di settore.

Redazione Documenti Tecnici Professionali

Skill operativa per la produzione di documenti tecnici di qualità professionale destinati a PMI italiane, studi di ingegneria, architettura, consulenza tecnica e uffici tecnici aziendali.

Tipologie di Documento Coperte

Documenti di Progetto

• Relazione tecnica di progetto: premessa, obiettivi, descrizione dell'intervento, metodologia, risultati attesi, conclusioni
• Relazione di calcolo strutturale: ipotesi di carico, modello di calcolo, risultati, verifiche normative
• Capitolato speciale d'appalto: descrizione lavorazioni, prescrizioni tecniche, materiali, prove, collaudi
• Specifiche tecniche di fornitura: requisiti tecnici, tolleranze, normative di riferimento, criteri di accettazione
• Piano di manutenzione: descrizione elementi tecnici, frequenze, operazioni, responsabilità

Documenti di Valutazione

• Perizia tecnica: descrizione stato di fatto, analisi, valutazione, conclusioni motivate
• Relazione estimativa: metodologia di stima, comparables, calcolo del valore, incertezza
• Due diligence tecnica: checklist conformità, criticità rilevate, raccomandazioni prioritizzate
• Relazione di collaudo: prove eseguite, risultati, giudizio di conformità, riserve

Documenti Gestionali e Operativi

• Verbale di riunione/sopralluogo: presenti, ordine del giorno, punti discussi, decisioni, azioni, firme
• Rapporto di avanzamento lavori: attività eseguite, stato avanzamento, problemi, prossime attività
• Report KPI tecnici: indicatori, target, consuntivo, scostamento, commento
• Procedura operativa (SOP): scopo, campo di applicazione, responsabilità, istruzioni passo-passo, registrazioni

Struttura Canonica della Relazione Tecnica

Ogni relazione tecnica professionale italiana segue questo schema:

1. FRONTESPIZIO
   - Titolo documento
   - Committente / Ente
   - Redattore, revisore, approvatore
   - Codice documento, revisione, data
   - Numero di pagine

2. INDICE (automatico nei documenti > 5 pagine)

3. PREMESSA
   - Contesto e motivazione dell'incarico
   - Oggetto del documento
   - Limitazioni dell'analisi (se applicabili)

4. RIFERIMENTI NORMATIVI E DOCUMENTALI
   - Norme tecniche citate (DM, UNI, EN, ISO)
   - Documenti di progetto richiamati
   - Letteratura tecnica

5. DESCRIZIONE DELLO STATO DI FATTO / SISTEMA
   - Descrizione tecnica dell'oggetto di analisi
   - Dati di input rilevanti
   - Foto/schemi se applicabili

6. METODOLOGIA
   - Approccio tecnico adottato
   - Strumenti/software utilizzati
   - Ipotesi e semplificazioni

7. ANALISI E RISULTATI
   - Calcoli, misure, elaborazioni
   - Tabelle e grafici con didascalie
   - Interpretazione dei risultati

8. VERIFICHE E CONFORMITÀ NORMATIVA
   - Confronto con limiti/requisiti normativi
   - Giudizi di conformità/non conformità

9. CONCLUSIONI
   - Sintesi dei risultati principali
   - Giudizio tecnico complessivo
   - Raccomandazioni operative

10. ALLEGATI
    - Tabulati di calcolo
    - Documentazione fotografica
    - Certificati, prove di laboratorio

Stile Tecnico-Professionale Italiano

Regole di Base

• Usa la forma attiva dove possibile: "si verifica che" → "la verifica mostra"; "viene calcolato" → "si calcola"
• Frasi brevi e precise: una frase = un concetto. Massimo 25-30 parole per frase tecnica
• Elimina i pleonasmi: "in quanto tale", "come già detto", "ovviamente", "chiaramente"
• Sostituisci termini vaghi: "adeguato" → specificare la misura; "elevato" → dare il valore numerico
• Voce impersonale controllata: ammessa nei documenti formali ("si osserva", "si rileva"), da non abusare

Terminologia e Numeri

• Unità di misura SI sempre: m, kg, kN, MPa, kPa, °C, Hz, W, kWh
• Separatore decimale italiano: virgola (3,14 — non 3.14) nei testi; punto nei codici/software
• Migliaia: punto come separatore (1.000.000 €) nei testi italiani formali
• Significatività: riportare cifre significative coerenti con la precisione del metodo (tipicamente 3-4)
• Grandezze vettoriali: indicare sempre modulo, direzione, verso quando rilevanti
• Sigle la prima volta: scrivere per esteso + sigla tra parentesi: "Norme Tecniche per le Costruzioni (NTC 2018)"

Riferimenti Normativi Corretti

• DM: Decreto Ministeriale — es. "DM 17 gennaio 2018 (NTC 2018)"
• UNI EN ISO: numerazione europea con anno — es. "UNI EN ISO 9001:2015"
• D.Lgs.: Decreto Legislativo — es. "D.Lgs. 81/2008 (T.U. Sicurezza)"
• L. / Legge: es. "L. 443/2001 (Legge Obiettivo)"
• Circolare: "Circolare 21 gennaio 2019, n. 7 (C.S.LL.PP.)"
• Non inventare mai normative. Se incerto, segnalare con "[da verificare]"

Tabelle e Figure

Regole per le Tabelle

• Ogni tabella ha un numero progressivo e una didascalia sopra: "Tabella 1 — Carichi di progetto"
• Prima riga = intestazione in grassetto
• Unità di misura nell'intestazione colonna, non nelle celle
• Nota sotto la tabella per abbreviazioni o precisazioni

Regole per le Figure

• Didascalia sotto, numerazione progressiva: "Figura 3 — Schema struttura portante"
• Risoluzione minima 150 DPI per stampa
• Schemi tecnici: quote, scale, frecce nord per planimetrie
• Foto: data, autore, coordinate GPS se rilievo

Checklist Pre-Consegna

Prima di consegnare qualsiasi documento tecnico, verificare:

• Frontespizio completo con codice documento e revisione
• Indice aggiornato con numeri di pagina corretti
• Tutti i riferimenti normativi riportati per esteso alla prima citazione
• Unità di misura SI coerenti in tutto il documento
• Tutte le tabelle e figure numerate e con didascalia
• Conclusioni rispondono agli obiettivi dichiarati in premessa
• Nessun termine vago non quantificato (adeguato, sufficiente, elevato)
• Firme e timbri professionali previsti nella copertina
• Allegati numerati e referenziati nel testo

Errori Comuni da Evitare

Errore	Correzione
"Come è noto..."	Eliminare — affermare direttamente
"Il sottoscritto ha proceduto a..."	"Si è proceduto a..." o forma attiva diretta
Misto italiano/inglese	Scegliere una lingua; se si usa inglese, spiegare il termine
Valori senza unità	Sempre specificare l'unità di misura
"Ecc." nelle liste tecniche	Elencare esplicitamente tutti gli elementi rilevanti
Normative citate senza anno	Aggiungere sempre l'anno di edizione/pubblicazione
Percentuali senza riferimento	Specificare sempre rispetto a cosa (es. "15% del costo totale")

Skill Correlate

Skill	Quando invocarla
template-generation	Per generare il documento a partire da un template strutturato
pdf-extraction	Per estrarre dati da documenti esistenti da rielaborare
docx	Per produrre il file DOCX finale formattato
relazioni-strutturali	Per relazioni di calcolo strutturale specifiche
capitolato-speciale	Per capitolati di appalto dettagliati