I l Fo l io pot rebbe sost i tu i re i l PDF +++ DocumentazIone D' ImPIanto +++ PubblIcata la S1000D ISSue 4 .1

Sommario

P. 02 ___ Fondamenti della documentazione tecnica

P. 03 ___Formati da sfiorare con le ditaP. 04 ___ Doxee: manuali moderni che

danno sicurezza agli utentiP. 06 ___ Documentazione d'impianto P. 08 ___ Pubblicata la S1000D Issue 4.1

Panoramica sui servizi TANNERzaB26º Anno – 01/2013

zAB

q

02

Editoriale A cosa vi fa pensare l'espressione

"tempo di giallo"? A un thriller?All'attesa davanti allo sportello

della posta? O magari a un appuntamen-to con TANNER? Il titolo "tempo di giallo" campeggiava sulla prima pagina di una brochure della città tedesca di Düsseldorf. All'interno veniva spiegato ai cittadini – attenzione attenzione! – come attraversare la strada con un sema-foro pedonale.

In ben otto pagine. Gradite un assaggio? "Il semaforo diventa verde. Per i pedoni è il momento giusto per muoversi." Del resto la brochure si chia-mava "tempo di giallo" perché Düssel-dorf è l'unica città tedesca in cui i sema-fori pedonali hanno una fase di giallo. Ebbene sì, "si chiamava", perché dopo una massiccia ondata di sarcasmo in Internet, il PDF è scomparso senza com-menti dal sito Web della città.

Con "ABZ" vogliamo regalarvi un "tempo di giallo" un po' più intelligente, dedicato all'argomento istruzioni & company.

In questo numero potrete leggere tra l'altro di come Doxee, azienda spe-cializzata nella gestione dati e nell'invio di massa di documenti, redige i suoi manuali in diverse lingue. Vi riveliamo anche quali requisiti deve soddisfare la documentazione d'impianto.

Vi auguro una lettura piacevole e informativa.

Il vostroTomislav Matiević

Fondamenti della "documentazione tecnica"

Questa sezione di ABZ illustra una panoramica sui fondamenti della documenta-zione tecnica. I lettori possono trovare approfondimenti sui linguaggi che aiutano ad accompagnare un prodotto dallo sviluppo alla produzione, all'imballaggio e alla commercializzazione. Vengono presentati i componenti della documentazio-ne tecnica. Con numerosi consigli su formulazioni, scelta delle parole e stile.

Argomento: "Linee guida redazionali"

Se esistono delle regole, in fase di creazione delle informazioni i redattori tecnici possono concentrarsi sulla trasmissione dei contenuti tecnici. Non devono più impe-gnarsi sulla struttura, sulle formulazioni e sull'organizzazione, ma possono limitarsi a far confluire nell'ambito di un processo efficiente i contenuti in una forma data.

Delle regole vincolanti sono irrinunciabili quando diversi redattori lavorano in parallelo a un grosso progetto o si creano frammenti di informazioni memorizzati in banche dati e solo successivamente li si combinano in vari modi per formare prodotti informativi di maggiori dimensioni. Tutto ciò porta che all'improvviso informazioni create nel 2004 vanno ad affiancarsi a quelle del 2012.

Argomento: "Avvertenza di pericolo"

AVVERTENZALe informazioni di questa sezione non si orientano alle direttive di una norma statunitense in

materia. Se si devono redigere avvertenze di pericolo esattamente in conformità a una norma,

occorre procedere a un confronto dettagliato con lo stato attuale delle esigenze normative e la

loro interpretazione attuale.

L'elemento strutturale avvertenza di pericolo trasmette all'utente le informa-zioni necessarie per proteggersi dai pericoli che potrebbero verificarsi durante le azioni da esso compiute.Un elemento strutturale avvertenza di pericolo completo:q richiama l'attenzione dell’utente attraverso opportuni simboli e la messa in risal-

to dell'informazione rilevante per la sicurezzaq informa l'utente della possibile gravità del danno generato dalla trasgressione

dell'avvertenza di pericolo – morte, ferimento, danni materialiq in caso di elevato potenziale di danno – morte, ferite gravi – informa sulla pro-

babilità del verificarsi di un danno in caso di trasgressione dell'avvertenza di pericolo

q fornisce informazioni sul tipo e sulla fonte del pericoloq informa sulle potenziali conseguenze in caso di trasgressione dell'avvertenza di

pericoloq istruisce l'utente su come evitare il danno.

Esempio di istruzioni nell'avvertenza di pericolo

L'invito a effettuare un'operazione viene formulato come gli inviti a effettua-re un'operazione delle istruzioni. In caso di dubbio, va preferita una formulazione come comando, non come divieto.

Meglio non: formulazione come divieto Meglio: formulazione come comando

q Non accedere al tamburo in movimento. q Aspettare l'arresto del tamburo.

q Non pulire lo schermo con detergenti

aggressivi.

q Pulire lo schermo con gli appositi panni

speciali.

zAB

t

03

Si chiamano PUB, Folio o iBooks e come formati di contenuti rendono possibile visualizzare i contenuti su dispositivi mobili come smartphone e tablet. Di seguito vengono illustrati i formati più importanti del momento e le relative differenze.

Formato PUB

ePUB è il più conosciuto tra i "nuovi" formati di conte-nuti per dispositivi mobili. In linea di principio si tratta di una pagina Web compressa in ZIP e riprodotta tramite un browser – il reader ePUB. Per l'ePUB vale ciò che vale per il Web-design: a seconda del browser e del sistema operativo i contenuti assumo-no un aspetto (leggermente) diverso, perché ogni produttore e piattaforma utilizza reader differenti. Nella sua versione attuale, la 3.0, ePUB ha nettamente potenziato le sue possibilità di design con HTML5, CSS3 e l'integrazione di JavaScript. Continua tut-tavia a essere principalmente idoneo per contenuti composti da testo e immagini.

Portable Document Format (PDF)

Grazie al problema della possibile differente interpretazio-ne dei contenuti in browser e sistemi operativi diversi, il dinosau-ro tra i formati di contenuti è riuscito a conquistarsi un posto anche sui dispositivi mobili. Il PDF (Portable Document Format) si impone ancora una volta in forza della sua caratteristica prin-cipale: la rappresentazione fedele dell'informazione originaria. Altrettanto evidenti sono anche gli svantaggi. Nel caso di ingrandimenti sono visibili solo sezioni parziali del docu-mento e si possono inserire solo limita-tamente widget mul-timediali interattivi.

Formato Folio

Come il PDF, anche il formato Folio viene da Adobe. Vuole essere la risposta alle esigenze del publishing digitale attuale che il PDF non è in grado di soddisfare. Molti addetti ai lavori riten-gono che questo nuovo formato potrebbe sostituire il PDF. Con gli strumenti di bordo già contenuti in InDesign CS6 i documenti InDesign diventano Folio interattivi e multimediali con audio, video, gallerie di immagini ecc. Per la riproduzione è disponi-bile come per i PDF un reader gratuito per tutte le piattaforme rilevanti, l'"Adobe Content Viewer". Tuttavia per la diffusione gratuita dei contenuti – come le informazioni pre-sales o after-sales in ambito B2B – il modello operativo di Adobe potrebbe rivelarsi svantaggioso, perché prevede costi di piattaforma ed eventualmente costi supplementari per ogni download.

Formato iBooks

L'iBooks è un formato proprietario Apple. "iBooks Author" serve a elaborare e arricchire con funzioni supplemen-tari (video, modelli 3D, gallerie di immagini ecc.) i contenuti per l'Apple iPad. Con iBooks, offerto gratuitamente agli utenti, il fornitore gode della massima libertà per quanto riguarda le modalità di distribuzione. Le pubblicazioni devono essere distri-buite attraverso l'Apple iBooks Store solo se sono a pagamento per l'utente.

Formati da sfiorare con le dita

1: non per Amazon Kindle 2: con ezPDF Reader (iOS e Android)3: teoricamente con JavaScript, ma occorre prestare attenzione

ai problemi di compatibilità del Reader

Punti deboli e punti forti dei for-mati di contenuti per il mobile publishing in sintesi.

26º Anno 01/2013

q

04

Doxee: manuali moderni che danno sicurezza agli utenti

Alta qualità, affidabilità e fiducia: le aziende con un modello di business B2C che devono spedire comunicazioni massive contenenti informazioni personali o confidenziali hanno la necessità di affidarsi a un operatore in grado di soddisfare queste esigenze. Esattamente i valori che Doxee, specialista nell'erogare servizi di Customer Communication Manage-ment (CCM), Document Output Management e Demateria-lizzazione dei processi documentali, voleva rendere visibili anche nella documentazione. Insieme a TANNER sono stati creati manuali dal layout moderno, chiaramente strutturati e scritti in modo comprensibile.

Quando si effettua l'invio di massa di documenti aziendali critici contenenti informazioni personali, come estratti conto, documentazione bancaria e assicurativa, fatture o referti medici, tutto deve essere creato e recapitato senza intoppi. L'invio scor-retto o incompleto di un mailing massivo può comportare serie conseguenze economiche e danni all'immagine del mittente. Chi – come Doxee – si occupa dell'intero processo, deve garantire un funzionamento costantemente affidabile del sistema e l'assenza pressoché totale di errori di utilizzo attraverso una documenta-zione di supporto.

Se in passato documenti come estratti conto, bollette, fatture venivano spediti solo via posta o fax, l'invio delle comunicazioni in modo massivo multicanale porta una nuova complessità nei sistemi tecnici e nei relativi processi: a seconda della struttura del cliente, si inviano diversi mailing in un singolo passaggio: via posta, e-mail, SMS, fax o pagine web personalizzate. La piattafor-ma sviluppata da Doxee cresce con le necessità del cliente, diven-tando sempre più efficiente. Dalla creazione della piattaforma Doxee ad oggi sono stati inviati oltre 2 miliardi di documenti, raggiungendo più di 100 milioni di clienti.

L'obiettivo: qualità nei minimi dettagli

Doxee propone due modelli di business: il cliente può ester-nalizzare completamente a Doxee i servizi oppure installare e utilizzare in modo autonomo i sistemi IT.

Per evitare errori di utilizzo e incrementare la fiducia del cliente verso la piattaforma, Doxee ha riservato particolare attenzione alla documentazione. L'obiettivo era preciso: ottene-re manuali qualitativamente di alto livello per dare sicurezza al cliente; sicurezza pratica per il corretto utilizzo del sistema, ma anche sicurezza emozionale che i dati e i documenti nel sistema Doxee siano sempre in buone mani.

La ricerca: priorità a un operatore full-service

Nel 2009 Doxee – che allora si chiamava ancora eBilling– cercava un fornitore di servizi esperto, in grado di offrire la docu-mentazione, la traduzione dei manuali in più lingue e il controllo del progetto da un'unica fonte.

Per questo motivo Doxee ha incaricato alcuni operatori – tra cui la società di traduzioni Interlanguage, che si è rivolta a TANNER per alcuni aspetti relativi alla manualistica. Il lavo-ro di TANNER ha convinto Doxee: un briefing di quattro ore è stato sufficiente per affidare a TANNER la creazione di un manuale in italiano e in inglese. I lavori hanno preso il via a metà del 2010.

ClienteDoxee

Settore e prodottiDoxee è una realtà multinazionale che offre soluzioni e servizi di customer communication management (ccm), Document output management, Data management, electronic Invoicing, legal elec-tronic archiving e tracking & Reporting a clienti di classe enterprise in tutto il mondo. con sedi in europa e nord america, Doxee ha una base clienti che appartengono a diversi settori, caratterizzati preva-lentemente da un modello b2c: servizi finanziari, telecomunicazioni, utility, media, sanità e servizi.

L'incaricocreazione di manuali in più lingue e controllo di tutti i processi del progetto.

La sfidaq nuova creazione di manuali per sistemi It complessiq limitate possibilità di layout dei manuali a fronte del formato

microsoft Word richiestoq timing stringente per la produzione e la traduzione

La soluzioneq creazione di un modello coerenteq sviluppo di linee guida di validità generale per la redazione di

testo e graficaq produzione entro i termini stabiliti di manuali in italiano e nelle

altre lingue richieste

t

05

Le sfide: contenuto, formato e tempo

Come per la maggior parte dei progetti IT, anche in questo caso la programmazione del software e la documentazione dove-vano procedere di pari passo. I manuali sono stati continuamente adeguati alle nuove funzioni e modifiche dell'interfaccia utente, con ripercussioni dirette sulle schermate da inserire nella docu-mentazione e sulla terminologia. A ciò si è aggiunta la pressione delle scadenze, perché i manuali dovevano essere disponibili in poco tempo dopo la finalizzazione del software, e naturalmente in entrambe le lingue, ovvero italiano e inglese americano.

Per prima cosa, è stato necessario elaborare le caratteristi-che di base per i manuali. Secondo le indicazioni di Doxee, la documentazione doveva essere redatta in formato Microsoft Word e presentare una struttura coerente, riutilizzabile anche per altri manuali. Oltre alla facile comprensibilità, Doxee attri-buiva grande importanza a un layout chiaro, che ha messo forte-mente alla prova le capacità di Microsoft Word.

La soluzione: manuali strutturati in modo intelligente

Per soddisfare i requisiti richiesti, inizialmente TANNER ha creato dei modelli Word e definito chiaramente le terminologie strutturali e contenutistiche e gli elementi grafici del manuale. TANNER ha sviluppato diverse soluzioni speciali per una con-figurazione del layout il più possibile innovativa e facilmente fruibile. Prima di iniziare è stata analizzata la localizzazione dei manuali, definendo accuratamente quali elementi dovevano essere tradotti e quali no. Anche le schermate dell'interfaccia software utilizzate per spiegare il corretto utilizzo sono state realizzate nelle due lingue.

D'accordo con Doxee, i manuali sono stati suddivisi nelle sezioni "Introduction", "Quick Guide", "Reference Guide" e "Index". La "Introduction" (introduzione) illustra con linguag-gio semplice le funzionalità. Mentre la "Quick Guide" fornisce una veloce panoramica sull'uso del sistema, nella "Reference Guide" si approfondiscono i possibili impieghi. L'"Index" offre un rapido accesso alle informazioni in tutte le sezioni.

Il risultato: una realizzazione collaborativa

I manuali sono stati redatti in lingua italiana da esperti redattori TANNER e consegnati secondo la tempistica prevista. TANNER ha assunto la direzione dell'intero progetto, in stretta collaborazione con il partner Interlanguage per le traduzioni.

Con il cambiamento di brand da eBilling a Doxee, nel 2010 i documenti sono stati adeguati alle linee guida del nuovo Cor-porate Design.

La collaborazione tra Doxee e TANNER, basata sulla piena fiducia e disponibilità, ha fruttato nel frattempo manuali com-plessivamente composti da oltre 600 pagine, in diverse lingue e in parte anche in versione online.

"I nostri manuali rispecchiano i nostri severi criteri qua-litativi. Li applichiamo addirittura nelle vendite, per illustrare ai potenziali clienti le funzionalità dei nostri servizi. Di TAN-NER apprezziamo l'impegno, l'alta professionalità e l'ampia gamma di prestazioni, su cui sappiamo di poter sempre conta-re. Ogni colloquio di approfondimento con TANNER è anche un'occasione per comprendere come realizzare dei manuali professionali."

Davide Daccio, Responsabile Sviluppo di Doxee

q

06q

Documentazione d'impiantoComponenti – aspetti contenutistici – esigenze superiori

Nell'industria dei beni d'investimento la documentazione dei fornitori rappresenta un argomento centrale. I fornitori si impegnano per soddisfare le richieste dei committenti. I committenti si lamentano del carico di lavoro che devono sostenere per ottenere la documentazione sulle componenti dei loro fornitori e combinarla in modo facilmente fruibile.

Struttura e componenti della documentazione d'impianto

Con documentazione tecnica per gli impianti si intende la compilazione sistematica di tutti i documenti necessari alla pro-gettazione, realizzazione (costruzione e montaggio), messa in funzione, esercizio e manutenzione e tutti i risultati delle prove e i certificati di prova.

In questo numero di ABZ presentiamo cinque elementi di una documentazione d'impianto: documentazione di esercizio, manuale operativo, manuale operativo complessivo, documen-tazione dei fornitori e documentazione di messa in servizio.

Documentazione di esercizio

Nell'UE nell'ambito della documentazione di esercizio si devono fornire almeno:

le dichiarazioni di conformità e di incorporazione dei componenti e degli impianti installati

i manuali operativi in conformità alla direttiva UE per i fabbricanti (Direttiva Macchine)

Documentazione d'impianto

Manuale operativo o manuale operatore

Documentazione tecnica(impianto e prodotti)

Documentazione sulla

gestione di progetto

termine

risorse

costi

Documentazione

di autorizzazione

domande

decisioni

documentazione su

prove preliminari

Documentazione

esecutiva

funzione

struttura

equipaggiamento

manutenzione

Documentazione finale (= documentazione da consegnare con stato as-built)

Documentazione

sulla qualità

protocolli

certificati

Documentazione

di esercizio

Manuale operativo

intero impianto

sistema

componenti

Documentazione per i fornitori

Documentazione di messa in servizio

t

07

le valutazioni di rischio di tutti i prodotti che non siano parti di massa o in serie e siano soggetti a una direttiva UE per i fabbricanti o a una direttiva nazionale

la documentazione di messa in servizio con tutte le infor-mazioni e i dati operativi registrati in sede di messa in servizio e funzionamento di prova

Manuale operativo

Dopo il collaudo dell'impianto, in base al contenuto e all'esten-sione della documentazione di esercizio il gestore dell'impianto redige un manuale operativo, chiamato anche manuale operatore.

Nel manuale operativo il gestore descrive tutte le misure e formula tutte le istruzioni di lavoro per il personale atte a garan-tire un funzionamento sicuro dell'impianto, vale a dire il "cosa" e il "come" relativi al suo reale utilizzo.

Manuale operativo complessivo

La redazione del manuale operativo complessivo di un impianto rappresenta un'impegnativa sfida pratica. Le informa-zioni della documentazione dei fornitori vanno inserite in un contesto complessivo. I contenuti, la struttura e l'identificazione di un manuale operativo sono regolamentati dall'IEC 82079 (standard internazionale sulla redazione dei manuali istruzioni).

Il regolamento illustra in particolare i seguenti aspetti:modalità di impiego dei manuali istruzioniparticolarità dei manuali operativiesercizio normale e sicuroprodotti a controllo automatico e remotofunzioni / situazioni straordinarieindicazioni da osservareistruzioni sul rilevamento erroriprotezione delle personesommario, indice analitico (indice) e altri elenchi,

definizioni e metasintassinumerazione delle pagine (paginazione)definizione della terminologia tecnicadefinizione dei simbolispiegazione delle convenzioni per la rappresentazioneleggibilitàtipo e dimensioni del carattere

Documentazione dei fornitori

Con documentazione dei fornitori si intende in generale la documentazione tecnica di tutti i sistemi, i componenti o le parti di un impianto. Compete al fabbricante dell'impianto la respon-sabilità di sintetizzare le informazioni derivanti da questi docu-menti (p. es. intervalli di manutenzione) nel manuale operativo complessivo dell'impianto.

La Relazione tecnica DIN 146 "Documentazione tecnica di prodotto – Manuali operativi per gli impianti" (Technische Produktdokumentation – Betriebsanleitungen für Anlagen) si occupa in particolare dell'integrazione e della composizione dei documenti dei fornitori nel manuale operativo complessivo.

Documentazione di messa in servizio

La redazione della documentazione di messa in servizio, che viene effettuata alla fine della progettazione esecutiva, è un impor-tante strumento di assicurazione della qualità. Di norma, sulla base della documentazione esecutiva disponibile si verifica ancora una volta in dettaglio se l'impianto progettato può essere messo in eser-cizio in modo efficiente e conforme alle normative. Tutti i sistemi sono sottoposti a ulteriore analisi e osservazione complessa. Una documentazione di messa in servizio di qualità semplifica notevol-mente la successiva redazione del manuale operativo.

Indirizzi

REDAZIONE

Riproduzione – anche parziale – consentita solo tramite preventiva autorizzazione scritta dell'editore. La TANNER AG non si assume nessuna responsabi-lità per manoscritti e fotografie non richiesti.

L'ABZ è distribuita gratuitamente agli interessati. Pertanto, non sussiste alcun diritto a ricevere la rivista.

tanneR s.r.l.Salita Santa Caterina 10/10, 16123 Genova (GE), ItaliaT +39 010 818 30 51F +39 010 818 31 58E-Mail: info@tanner.it

tanneR aGKemptener Straße 99, D-88131 Lindau (B)Tel. +49 8382 272-119Fax +49 8382 272-900E-Mail: info@tanner.de

Filiale di berlino Geneststraße 5, Eingang Hof G, D-10829 BerlinTel. +49 30 920378 -90Fax +49 30 920378 -88E-Mail: info@tanner.de

Filiale di erlangenWetterkreuz 27, D-91058 ErlangenTel. +49 9131 970028-15Fax +49 9131 970028-88E-Mail: erla ngen@tanner.de

Filiale di Graben-neudorfBahnhofsring 37, D-76676 Graben-NeudorfTel. +49 7255 76276-29Fax +49 7255 76276-28E-Mail: info@tanner.de

Filiale di amburgoPappelallee 28, D-22089 HamburgTel. +49 40 2530453-71Fax +49 40 2530453-88E-Mail: hamburg@tanner.de

Filiale di PaderbornTechnologiepark 13, D-33100 PaderbornTel. +49 5251 879718-12Fax +49 5251 879718-88E-Mail: paderborn@tanner.de

Filiale di ReutlingenArbachtalstraße 6, D-72800 Eningen unter AchalmTel. +49 7121 144934-0Fax +49 7121 144934-20E-Mail: reutlingen@tanner.de

tanneR Vietnam ltd.House 43D/8 Ho Van Hue St. Ward 9, PhuNhuan District, VN-70999 Ho Chi Minh CityTel. +84 8 9973-452Fax +84 8 9973-465E-Mail: vietnam@tanner.de

tanner translations GmbH+coMarkenstr. 7, D-40227 DüsseldorfTel. +49 211 179665-0Fax +49 211 179665-29E-Mail: info@tanner-translations.de

Pubblicata daTANNER s.r.l.Salita S.Caterina, 10/1016123 Genova (GE)T +39 010 818 30 51F +39 010 818 31 58E info@tanner.itwww.tanner.it

Caporedattore: Dr. Sven Bergert

Questa edizione è stata redatta e creata con la collaborazione di: Silke Ebert, Tomislav Matievic, Klaus Pochert, Lena Sattler, Andreas Schlenkhoff

Immagini: Titolo: shutterstock / mmmxPagina 05: shutterstock / photobank.kiev.ua Pagina 07: shutterstock / Joe Gough

Panoramica sui servizi TANNER

S1000D Issue 4.1 pubblicata

Con i nostri servizi siamo partner di aziende leader che realizzano e commercializ-zano prodotti tecnici che richiedono spiegazioni. Ci occupiamo delle informazioni di accompagnamento al prodotto per l'intero ciclo di vita del prodotto stesso. Le aziende che richiedono i nostri servizi lo fanno con l'obiettivo di ottenere risultati di alta qualità in uno o più dei seguenti casi:

Istruzioni d'uso Traduzioni

Istruzioni di montaggio Grafici ed animazioni 2D/3D

Istruzioni di assistenza Sistemi di content management

Manuali tecnici Sistemi di gestione delle traduzioni

Guide online Sistemi di gestione delle informazioni sui prodotti

Materiale per corsi di formazione Sistemi per la gestione di cataloghi

Cataloghi di prodotti Sistemi di gestione della documenta-zione

Specifiche tecniche di prodotti Soluzioni per la gestione della termi-nologia

Cataloghi online/e-shop

Cataloghi di pezzi di ricambio

Competenze in materia di contenuti • sistemi • processiDocumentazione tecnica

Gestione documentazione Cataloghi di prodotti Integrazione di sistemi e sviluppo software

La S1000D è stata pubblicata nella versione più recente, versione 4.1. La speci-fica definisce il nuovo standard con cui in futuro nel settore dell'aviazione militare e civile dovrà essere documentato.

Contrariamente al vecchio iSpec ATA 2200 che definisce un unico manuale nel suo complesso, la documentazione secondo la S1000D si basa su piccoli, singoli moduli di dati, che vengono assemblati in documenti. Uno dei primi aerei civili, per il quale i documenti tecnici sono creati in base a questa norma, è l'Airbus A350 XWB.

La versione 4.1 è un ulteriore sviluppo congiunto di AeroSpace and Defence Industries Association of Europe (ASD), Aerospace Industries Association (AIA) e ATA e-Business Program.