Elena Faggin: " i manuali tecnici: norme, regole e strumenti innovativi
1. Redigere manuali tecnici: norme, regole e strumenti innovativi (database publishing) Dott.ssa Elena Faggin
2. LE “ISTRUZIONI D’USO” Sono parte integrante della macchina Descrivono la macchina dal punto di vista del suo utilizzo Avvertono gli utilizzatori sui rischi residui sulle modalità di protezione Sono parte integrante del processo di “messa in sicurezza” Consentono un utilizzo della macchina corretto in sicurezza
3. NORME DI RIFERIMENTO 1/3 La Direttiva Macchine 2006/42/CE recepita a livello nazionale dal D. Lgs. 17/2010 Le Norme Armonizzate EN ISO 12100-1:2003 EN ISO 12100-2:2003 Sicurezza del Macchinario Concetti fondamentali e principi generali di progettazione Parte 1. Terminologia di base, metodologia Parte 2. Principi tecnici Regolamenta anche le “istruzioni d’uso” e rinvia alla norma internazionale IEC 62079 recepita a livello europeo dalla EN 62079
4. Le Norme Nazionali CEI EN 62079 recepimento della norma europea EN 62079 “ Preparazione di istruzioni - Struttura, contenuto e presentazione” UNI 10653:2003 “ Qualità della documentazione tecnica di prodotto” UNI 10893:2000 “ Documentazione tecnica di prodotto: articolazione e ordine espositivo del contenuto” NORME DI RIFERIMENTO 2/3 UNI/TS 11192:2006 “ Documentazione tecnica di prodotto destinata all'utente - Criteri per la classificazione”
5. NORME DI RIFERIMENTO 3/3 Le Norme danno indicazioni: su come va condotto il processo di redazione sull’individuazione delle informazioni da inserire sull’ ordine espositivo che devono avere le informazioni sulla strutturazione delle informazioni sulle regole semantiche che devono guidare la comunicazione sull’ aspetto grafico che occorre dare al contenuto
6. L’EDITING TRADIZIONALE 1/2 È caratterizzato da … una gestione non pianificata una gestione non centralizzata impaginazione non automatizzata una scarsa attenzione all’integrazione una gestione non controllata degli aggiornamenti
7. … tutto ciò si traduce in duplicazione di informazioni rischio di disallineamenti tempi elevati di impaginazione difficoltà ad apportare variazioni o correzioni traduzioni non integrate e tempi elevati di reimpaginazione nessuna integrazione con documenti commerciali L’EDITING TRADIZIONALE 2/2
8. IL PUBLISHING STRUTTURATO 1/3 separa la gestione del contenuto dalle regole di presentazione struttura le regole di presentazione in un progetto editoriale consente la riusabilità delle regole editoriali automatizza l’utilizzo e il ri-utilizzo del progetto editoriale
9. IL PUBLISHING STRUTTURATO 2/3 … e per quanto riguarda le informazioni relative al contenuto, permette una gestione: Centralizzata tramite un unico repository Strutturata tramite un database Controllata tramite una classificazione ingegnerizzazione del processo editoriale
10. VANTAGGI abbattimento dei tempi e dei costi allineamento dei dati facilità nell’apportare modifiche massive o “last minute” produzione di estratti gestione integrata di un ambiente multi-lingue gestione controllata di aggiornamenti, revisioni ed estratti gestione integrata con documenti commerciali uscite multicanale IL PUBLISHING STRUTTURATO 3/3
11. Frame Editor da DB aziendali Data-entry contenuti testuali Immagini PAGINE MASTRO Frame Maker OUTPUT SU PDF OUTPUT SU WEB Argo File .mif OUTPUT SU CD-ROM GESTIONE REGOLE EDITORIALI PRODUZIONE IMPAGINATO Codifiche di configurazione File di export DATABASE PUBLISHING ARCHITETTURA REGOLE DI IMPAGINAZIONE
12. PERCHÉ? conformità alla normativa di riferimento integrazione con documenti commerciali impaginazione automatica estrazioni selettive gestione controllata di aggiornamenti, versioni ed estratti generazione dinamica e automatica gestione integrata di un ambiente multi-lingue allineamento tra dati possibilità di apportare modifiche massive o “last minute” uscite multicanale
13. PERCHÉ? Per avere un manuale completo, aggiornato e aggiornabile che esalta la qualità del prodotto e dell’azienda