La documentazione tecnica deve essere fruibile

La documentazione tecnica deve essere fruibile

Per fruibilità si intende usabilità e si intende una prova o test che verifichi la facilità di individuazione degli argomenti, la valutazione dell’efficacia delle istruzioni d’uso nel comunicare le informazioni e prevederne l’efficacia sul comportamento dell’utilizzatore. Ne parla la norma ISO 82079-1:2012.

Ne parla la norma ISO 82079-1:2012 al capitolo 7:

7  Valutazione della conformità a questa parte della serie ISO 82079-1

7.1  Richiesta di conformità a questa parte della serie ISO 82079-1

Le richieste di conformità a questa parte della serie ISO 82079-1 dipende dalla persistenza nelle mani del fornitore della disponibilità di provare che le istruzioni d’uso (comprese le informazioni sulla sicurezza) sono state valutate da un ufficio studi esperto o empiricamente, ad esempio, tramite test di adeguatezza, in base ai requisiti e alle linee guida contenute negli Allegati A, B e C.

La lista di controllo dell’Allegato B elenca i tipi di informazione e gli elementi di contenuto (in base al tipo di prodotto) da fornire ad alcuni o a tutti gli utilizzatori tramite le istruzioni d’uso.  La conformità può essere indicata con la spunta delle singole voci adeguatamente affrontate.

La lista di controllo dell’Allegato C riassume i criteri per la valutazione dell’efficacia delle istruzioni d’uso nel comunicare le informazioni e prevederne l’efficacia sul comportamento dell’utilizzatore. Per la maggior parte dei prodotti non è possibile raggiungere il 100% dell’efficacia né effettuarne una misurazione qualitativa, pertanto nella pratica la valutazione è basata su giudizi soggettivi. La lista di controllo può anche essere utilizzata come guida per muovere critiche alle voci delle istruzioni d’uso rivelatesi non efficaci, piuttosto che considerarla solo come un elenco di criteri per l’assegnazione di un punteggio al documento nel suo insieme. Una critica costruttiva deve essere molto specifica sulle sezioni che devono essere migliorare e sulle ragioni per cui non sono considerate efficaci (e preferibilmente su come revisionarle per renderle efficaci).

Le liste di controllo non devono essere considerate esaustive per qualsiasi tipo di prodotto. Potrebbero necessitare interazioni e/o modifiche in base alle norme del prodotto o (in assenza di tali norme) in base a quelle di prodotti o funzioni simili, o come altrimenti appropriato.

Ove sia richiesto un certificato di conformità indipendente (per legge, dalla norma del prodotto o per specifiche contrattuali) i certificati indipendenti devono dichiarare:

  • le prove documentali (ovvero rapporti di ricerca o valutazione) presentate dal fornitore a seguito della valutazione delle istruzioni d’uso;
  • se le prove di cui sopra siano basate su ufficio studi o valutazione empirica;
  • il nome dell’ente o della persona esecutrice di tale valutazione.

7.2  Prove documentali della valutazione

I rapporti di ricerca o valutazione devono dichiarare:

  • le istruzioni d’uso e confezionamento al dettaglio presentate per l’esame;
  • la lingua delle istruzioni d’uso valutata e approvata in conformità a questa parte del ISO 82079-1;
  • se il campione del prodotto sia stato fornito completamente montato o se dia stato montato come parte della valutazione delle istruzioni d’uso;
  • gli aspetti della valutazione basati su ufficio studio e quelli basati su valutazione empirica;
  • il nome dell’ente o della(e) persona(e) che ha condotto la valutazione;
  • il nome dell’ente o della(e) persona(e) responsabili del controllo e della verifica di ogni traslazione.

La conformità a questa parte della ISO 82079-1 non può essere concessa se le istruzioni d’uso non sono state valutate da esperti adeguatamente qualificati. Detti esperti non devono essere stati precedentemente coinvolti nella redazione delle istruzioni d’uso né nello sviluppo, progettazione, produzione e commercializzazione del prodotto in questione. Vedere anche l’Allegato A.

NOTA: In base alla complessità del prodotto e in base a quanto un utilizzo sicuro e corretto dipende dalle informazioni impartite all’utilizzatore, può essere necessario valutare le istruzioni d’uso durante la fase di sviluppo e/o valutare e revisionare internamente la bozza delle istruzioni d’uso per ottimizzarle prima di sottoporle all’analisi di parti terze.

Si rimanda alla lettura degli allegati A, B e C della norma.

Allegato A : Valutazione delle istruzioni d’uso

Allegato B: Lista di controllo conformità e commenti

Allegato C: Lista di controllo per la comunicazione efficac

L’autore rimanda alla versione ufficiale della norma IEC 82079-1:20012 citate nell’articolo, reperibili presso il sito della della CEI (myceinorme.it) o ISO (www.iso.org) e dichiara che la traduzione fornita è una traduzione non ufficiale della norma stessa.

Potrebbe interessarti anche

Alessandro Pratelli
Alessandro Pratelli

Perito aeronautico, calsse '72. Lavora come redattore tecnico dal 1995 poi fonda AP Publishing. Appassionato di Direttive e norme tecniche. La frase che preferisce? "Se non alzi mai gli occhi, ti sembrerà di essere nel punto più in alto".

No Comments

Post A Comment