Documentazione tecnica e di prodotto: panoramica su linee guida europee, leggi e norme, nonché sulle peculiarità del mercato USA. Report sul libro di Lars Kothes, Grundlagen der technischen Dokumentation, Springer-Verlag, Berlin, Heidelberg, 2011. Con una nota sulle specificità della gestione modularizzata dei contenuti (tramite sistemi di content management [CMS]) in termini di metadati, stato di avanzamento del contenuto, revisione, riferimenti incrociati e riuso.

1. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR)
Tel. / Fax: +39 045 6152381
Web: www.keanet.it | E-mail: info@keanet.it
Documentazione tecnica e di prodotto: panoramica su linee
guida europee, leggi e norme, nonché sulle peculiarità del
mercato USA
Report sul libro di Lars Kothes, Grundlagen der technischen Dokumentation, SpringerVerlag, Berlin, Heidelberg, 2011
Linee guida europee, leggi nazionali, norme
La prima parte del libero di Kothes è dedicata a un panoramica interessante sul rapporto fra linee guida
europee, leggi nazionali e standard nel settore della documentazione tecnica.
Linee guide della Commissione Europea
Seguendo il cosiddetto New Approach, le nuove linee guida della Commissione Europea non contengono
più indicazioni specifiche, ma prescrizioni sui requisiti fondamentali che il prodotto e la sua documentazione
devono avere dal punto di vista della sicurezza.
Le istruzioni nella lingua dell’utilizzatore sono parte costitutiva di ogni prodotto sicuro.
Leggi nazionali
Le leggi recepiscono a livello nazionale le linee guide emanate dalla Commissione Europea.
Norme
Contrariamente a quanto avviene per linee guida e leggi, l’adesione alle norme è volontaria.
Le norme tendono a fornire indicazioni concrete su come mettere in atto i dettami di linee guida e leggi.
Esistono norme armonizzate con le linee guida / le leggi e norme non armonizzate.
L’adesione a norme armonizzate non dà la certezza, ma la presunzione della conformità del prodotto e
della documentazione ai dettami di linee guida e leggi.
Il sito www.newapproach.org, curato da Commissione Europea, EFTA, CEN, CENELEC ed ETSI, fornisce
un elenco aggiornato delle norme armonizzate.
Panoramica su norme e altre risorse utili
Kothes fornisce una panoramica sulle principali norme e su altre risorse utili nell’ambito della
documentazione tecnica e di prodotto.
Il sito http://www.beuth.de/en/ rappresenta una risorsa utile per cercare, approfondire e acquistare norme e
altre risorse.
Qui di seguito un estratto delle norme e delle risorse citate da Kothes:
•
DIN EN 62079:
•
Norma non armonizzata
1
Documentazione tecnica e di prodotto: panoramica su linee guida europee, leggi e norme, nonché sulle
peculiarità del mercato USA – Febbraio 2014

2. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR)
Tel. / Fax: +39 045 6152381
Web: www.keanet.it | E-mail: info@keanet.it
•
DIN EN ISO 12100-2:
•
•
•
Norma armonizzata di tipo A. E’ considerata la trasposizione normativa della Direttiva Macchine. Ai
fini della documentazione tecnica e di prodotto è rilevante in particolare il Capitolo 6
E’ l’unica norma che si occupa della documentazione in formato elettronico. Kothes sottolinea che –
sebbene linee guida, leggi e norme non impongano la fornitura della documentazione in formato
cartaceo – attualmente la carta è l’unico medium che permette all’utente di usufruire della
documentazione senza dispositivi aggiuntivi, come previsto dalla legislazione. In attesa di
un’evoluzione tecnologica comunque probabile, il consiglio di Kothes è di fornire almeno una copia
cartacea della documentazione, considerando i formati elettronici come supporti aggiuntivi
DIN EN ISO 14121-1:
•
•
ANSI B11.19-2003 R2009 e ANSI B11.TR3-2000:
•
•
Standard USA dedicato in particolare all’analisi dei rischi per il mercato statunitense
ISO Guide 37:
•
•
Norma armonizzata secondo la Direttiva Macchine e dedicata in particolare all’analisi dei rischi
Standard internazionale dedicato alla redazione di documentazione per prodotti destinati al mercato
consumer
DIN 146:2006-01:
•
Technical report dedicato alla redazione di documentazione per impianti
•
A partire dalla documentazione dei fornitori, il report suggerisce di realizzare così il manuale
d’istruzioni dell’impianto:
•
•
Inserire link di approfondimento ai documenti dei fornitori
•
•
Estrarre dalla documentazione dei fornitori le informazioni di base relative a dispositivi di
sicurezza, uso, manutenzione e troubleshooting
Rendere accessibili i documenti dei fornitori attraverso indici multidimensionali, per esempio:
indice per produttore, per nome del prodotto, per gruppi / componenti, per flusso di lavoro, ecc.
Risorse dedicate a segnaletica e simboli grafici:
•
DIN 4844-1 e DIN 4844-2
•
Standard dedicato alla segnaletica nei luoghi pubblici e di lavoro
•
Kothes consiglia di inserire nel manuale la spiegazione e il piano di dislocazione della segnaletica
a bordo macchina, in modo tale da agevolarne non solo la comprensione, ma anche la
sostituzione in caso di distacco
•
ISO 3864-1
•
DIN ISO 3864-2 e DIN ISO 3864-3
•
DIN ISO 7000 e 7001
•
ANSI Z535.1 ad ANSI Z535.4
•
•
Standard USA per la redazione di Danger, Warning, Caution e Notice
VDI 4500 Fogli da 1 a 4:
2
Documentazione tecnica e di prodotto: panoramica su linee guida europee, leggi e norme, nonché sulle
peculiarità del mercato USA – Febbraio 2014

3. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR)
Tel. / Fax: +39 045 6152381
Web: www.keanet.it | E-mail: info@keanet.it
•
•
Guida alla redazione della documentazione tecnica e di prodotto realizzata dall'Associazione degli
Ingegneri Tedeschi (VDI - Verein Deutscher Ingenieure)
DIN EN 15038:
•
Norma dedicata alla gestione e realizzazione di traduzioni, con la possibilità – per i traduttori – di
certificarsi.
Particolarità del mercato USA
Negli Stati Uniti la responsabilità civile per i prodotti non è regolamentata a livello nazionale, ma federale,
cioè a livello di singolo stato.
Secondo la tradizione giurisprudenziale americana, legislazione, che può quindi differire fra stato e stato,
emerge dalle sentenze pregresse, è cioè essenzialmente una “case law”.
Le organizzazioni USA di cui considerare gli standard sono principalmente tre, anche se l’adesione non dà
luogo a presunzione di conformità:
•
OSHA (Occupational Safety and Health Administration)
•
ANSI (American National Standards Institute)
•
UL (Underwriters Laboratories).
Nella redazione di documentazione per il mercato statunitense Kothes consiglia di tenere in considerazione,
fra gli altri, questi aspetti:
•
Negli USA il background tecnico medio è inferiore a quello europeo e tedesco in particolare
•
E’ quindi necessario:
•
Realizzare istruzioni passo passo, corredate da illustrazioni chiare
•
Prevedere strumenti che agevolino al massimo il reperimento delle informazioni
•
Fornire la documentazione non solo in inglese americano, ma eventualmente anche in spagnolo
messicano, in base al target di destinazione
•
Curare in modo particolare la correttezza della traduzione e l’omogeneità della terminologia. Il sistema
giuridico statunitense rubrica come “negligenze” gli errori di traduzione e le incomprensioni, ascrivendole
a responsabilità del produttore
•
Eseguire l’analisi dei rischi secondo lo standard ANSI B11.19-2003 R2009 e ANSI B11.TR3-2000
•
Aggiungere all’inizio del manuale i seguenti capitoli:
•
Supplemental Directives
•
•
Introduzione
•
•
Va pubblicato prima del sommario e contiene testi generali sulla sicurezza secondo lo standard
ANSI Z535.6
Illustra con foto e testi gruppi e componenti principali del prodotto, descrivendone finalità e
funzioni di base
Spostare in fondo al manuale, prima del glossario, il capitolo dedicato all’esposizione dei dati tecnici del
prodotto.
3
Documentazione tecnica e di prodotto: panoramica su linee guida europee, leggi e norme, nonché sulle
peculiarità del mercato USA – Febbraio 2014

4. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR)
Tel. / Fax: +39 045 6152381
Web: www.keanet.it | E-mail: info@keanet.it
Gestione modularizzata dei contenuti
Fra i numerosi suggerimenti forniti da Kothes in tema di redazione e pubblicazione, vi è anche quello di
gestire in modo modulare i contenuti, per migliorare l’efficienza del flusso di redazione, revisione, traduzione
e pubblicazione.
Kothes sottolinea alcune specificità della gestione modularizzata dei contenuti:
•
Metadati: necessari per identificare, ricercare e riusare i contenuti
•
Stato di avanzamento del contenuto: l’authoring tool o il sistema di content management (CMS)
dovrebbe permettere di gestire lo stato di avanzamento del contenuto (es. Nuovo, In fase di redazione,
In fase di verifica, Approvato) ed eventualmente di bloccare contenuti approvati
•
Revisione: secondo Kothes, l’authoring tool o il sistema di content management (CMS) non dovrebbero
aggiornare in automatico i moduli riusati, ma congelarne la revisione alla consegna del documento. Il
sistema dovrebbe però segnalare la presenza di eventuali aggiornamenti, permettendo al redattore di
adottare o meno la versione rivista
•
Riferimenti incrociati: in particolare in caso di pubblicazioni parziali (per esempio per singoli
destinatari), l’authoring tool o il sistema di content management (CMS) dovrebbero verificare e segnalare
la presenza di broken link fra i riferimenti incrociati a capitoli / paragrafi e figure
•
Riuso: l’authoring tool o il sistema di content management (CMS) dovrebbero permettere al redattore di
verificare in quali documenti un modulo è riusato.
Autore: Petra Dal Santo (dalsanto@keanet.it)
www.keanet.it
http://blog.keanet.it/
4
Documentazione tecnica e di prodotto: panoramica su linee guida europee, leggi e norme, nonché sulle
peculiarità del mercato USA – Febbraio 2014