Come realizzare manuali, libretti e documentazione tecnica

  • 451 views
Uploaded on

10 buoni motivi per abbandonare la realizzazione “manuale” della documentazione tecnica (con MS Word, Adobe InDesign, ecc.) a favore dell’adozione di sistemi di gestione dei contenuti CMS (Content …

10 buoni motivi per abbandonare la realizzazione “manuale” della documentazione tecnica (con MS Word, Adobe InDesign, ecc.) a favore dell’adozione di sistemi di gestione dei contenuti CMS (Content Management System) e PDM (Product Data Manager).

  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Be the first to comment
    Be the first to like this
No Downloads

Views

Total Views
451
On Slideshare
0
From Embeds
0
Number of Embeds
0

Actions

Shares
Downloads
5
Comments
0
Likes
0

Embeds 0

No embeds

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
    No notes for slide

Transcript

  • 1. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) Tel. / Fax: +39 045 6152381 Web: www.keanet.it | E-mail: info@keanet.itPerché utilizzare Argo CMS per realizzare manuali e libretti10 buoni motivi per passare dalla creazione “a mano” della documentazionetecnica (con MS Word, Adobe InDesign o FrameMaker) alla produzionemediante il software di gestione dei contenuti Argo CMS (ContentManagement System) - PDM (Product Data Management)Spesso le aziende si interrogano sui motivi, che possono supportare la decisione di abbandonare larealizzazione “manuale” della documentazione tecnica a favore dell’adozione di sistemi di gestione deicontenuti, come il nostro software Argo CMS.Ecco 10 buoni motivi, tratti dalla nostra esperienza quotidiana di inserimento di Argo all’interno di aziendedel comparto manifatturiero e distributivo, nonché di studi di produzione di manualistica in conto terzi.1. Gestione univoca dei contenuti comuniIn Word / InDesign e in altri sistemi di impaginazione manuale abbiamo possibilità limitate di gestire in modounivoco i contenuti comuni. Perlopiù li possiamo riprendere mediante copia&incolla o duplicazione, ma - incaso di modifiche - siamo costretti a propagarle a mano nei vari punti in cui devono ricorrere.Argo permette di gestire in modo univoco parti comuni a qualsiasi livello, dal macro al micro: può trattarsi diun intero capitolo (per esempio, quello che contiene la tavola dei pittogrammi utilizzati); di note, attenzioni,pericoli, divieti che si ripetono; di espressioni che ricorrono in modo uguale allinterno di vari paragrafi delmanuale (termini del glossario aziendale, nomi di modelli, sigle di consumabili consigliati, ecc.).In Argo le parti comuni sono gestibili in modo gerarchico: possiamo cioè trattare parti comuni a tutti imanuali, a famiglie e modelli di macchina, a insiemi di codici della distinta base (BOM - Bill of Materials), ecc.Il software dispone inoltre di un sistema efficiente per marcare in questo senso i contenuti.La gestione e la marcatura delle parti comuni ne permette il riutilizzo allinterno dei manuali "specifici". (Permanuale specifico intendiamo il manuale che consegniamo al cliente a corredo della macchina).Quando modifichiamo una parte comune, la modifica si propaga in automatico a tutte le sue occorrenzeall’interno dei manuali specifici (fatto salvo che l’aggiornamento è sempre sotto il controllo del redattore epuò essere bloccato puntualmente, se necessario. Per esempio per "congelare" manuali consegnati alcliente, che non devono subire modifiche, ma essere archiviati come tali all’interno del sistema).La propagazione automatica delle modifiche non riguarda solo la lingua madre del manuale, ma anche letraduzioni.2. Efficienza nella gestione delle traduzioniRispetto alla gestione manuale delle traduzioni, quella mediata da Argo risulta complessivamente piùefficiente. Vediamo perché:1. Argo pareggia in automatico la struttura dei contenuti nelle varie lingue. Se aggiungiamo un paragrafo, unimmagine con didascalia o una tabella nella lingua madre del manuale, il software li inserisce anche nelle altre lingue, pronti per essere tradotti2. Il sistema permette di marcare in modo puntuale i contenuti da tradurre o la cui traduzione va rivista3. In base alla marcatura possiamo esportare selettivamente i contenuti da inviare al traduttore4. Limportazione dei contenuti tradotti è automatica. Le traduzioni si posizionano nei punti corretti senza necessità di intervenire manualmente. Questa funzione si concretizza in risparmio di tempo e precisione nella corrispondenza fra testo originale e traduzione, svincolata dalle competenze linguistiche del redattore 1AR – Augmented Reality: panoramica sulla realtà aumentata – Ottobre 2012
  • 2. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) Tel. / Fax: +39 045 6152381 Web: www.keanet.it | E-mail: info@keanet.it5. Grazie alla gestione delle parti comuni, Argo permette di risparmiare sui costi di traduzione, poiché i testi da riutilizzare sono tradotti una sola volta, garantendo anche la certezza dell’utilizzo della versione corretta della traduzione.Da notare che Argo è compatibile con i più diffusi CAT Tool (Trados, WordFast, ecc.), cioè con i software ditraduzione assistita.3. Configurazione automatica di manuali specificiIl sistema di marcatura sta alla base delle funzioni di configurazione automatica della documentazionetecnica di Argo.In fase di realizzazione di un libretto specifico, possiamo infatti chiedere ad Argo di recuperare tutti icontenuti disponibili per una determinata famiglia di macchine, per un modello, per un insieme di codici delladistinta base, ecc.Nel manuale così auto-configurato possiamo poi aggiungere i contenuti “specifici”, relativi alla macchina checonsegniamo al cliente (per esempio, quelli legati a personalizzazioni, configurazioni o ricambisticadedicate).4. Produrre manuali e libretti specifici per vari destinatariLa marcatura dei contenuti e le funzioni di esportazione selettiva dei dati, ci permettono di realizzare con unclic manuali specifici per i diversi destinatari della comunicazione tecnica: installatori, operatori, manutentori,ecc.Ottemperiamo così alle disposizioni della Direttiva Macchine, migliorando anche la fruibilità delladocumentazione tecnica.5. Creare pubblicazioni multicanale e multi-format editorialeLa marcatura dei contenuti e le funzioni di esportazione selettiva dei dati, ci permettono di utilizzare Argo perprodurre uscite multicanale (carta, web, app, ecc.) e multi-format editoriale (manuali, libretti, guide rapide,guide all’installazione, guide alle procedure, guide alla soluzione dei problemi, ecc.).Mentre Word / InDesign / FrameMaker sono formati fini a se stessi, Argo permette di alimentare a partire dauna fonte dati univoca i vari tipi di comunicazione aziendale (cross-media-publishing).Lazienda può quindi sfruttare appieno il patrimonio informativo, sia per migliorare il trasferimento dellaconoscenza dei prodotti e del loro utilizzo, sia per ampliare la gamma dei servizi di supporto offerti alla forzavendita, all’assistenza tecnica e agli utilizzatori finali.6. Condividere contenuti tecnici corretti all’interno dell’aziendaNon di rado cataloghi, schede prodotto e listini, offerte, manuali e schede tecniche, fatture non sono allineatidal punto di vista contenutistico.Argo permette alle varie aree aziendali (ufficio progettazione, ufficio documentazione tecnica, ufficiomarketing, ufficio commerciale, amministrazione, ecc.) di condividere informazioni tecniche corrette,utilizzandole per redigere tutti i documenti a corredo della macchina, nelle varie fasi del suo ciclo di vita(dalla proposta commerciale, all’installazione e formazione presso il cliente, alla fatturazione, alla gestionedella ricambistica, ecc.).7. Alimentare piattaforme di e-commerce business-to-businessArgo può essere agevolmente integrato con il sistema gestionale (ERP) presente in azienda (che gestisceanagrafica clienti, listini, sconti, ecc.) e concorrere dal punto di vista dei contenuti tecnici all’alimentazione die-commerce business-to-business, dedicati per esempio alla vendita di ricambi e accessori. 2AR – Augmented Reality: panoramica sulla realtà aumentata – Ottobre 2012
  • 3. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) Tel. / Fax: +39 045 6152381 Web: www.keanet.it | E-mail: info@keanet.itSi tratta di un’interessante opportunità per trasformare in fonte di guadagno la gestione delladocumentazione tecnica, che - in alcune realtà - è ancora percepita soprattutto come fattore di costo.8. Collaborare alla gestione dei contenuti della documentazione tecnicaArgo è un software multipostazione. Grazie alla sua gestione delle autorizzazioni permette a varie perpersone, allinterno e allesterno dellazienda, di collaborare alla redazione di manuali e libretti (productmanager, redattori interni, technical writer esterni, traduttori, consulenti, ecc.).Le autorizzazioni sono così granulari, che a ogni gruppo di lavoro possiamo assegnare la gestione dispecifici tipi di contenuti. Per esempio, possiamo incaricare l’ufficio tecnico di aggiornare disegni, schemi etabelle tecniche, mentre l’ufficio marketing di provvedere alle fotografie e alle descrizioni commerciali delprodotto; così come possiamo abilitare il traduttore inglese alla sola redazione dei contenuti in lingua.Inoltre Argo permette all’azienda di configurare il proprio workflow, per esempio marcando contenuti come“da rivedere” o “approvati” o di pertinenza di un determinato redattore o supervisore.9. Comodi strumenti di editingGrazie ai suggerimenti ricevuti dagli utilizzatori, nel corso degli anni Argo si è arricchito di varie utility diediting. Due per tutte:1. Il motore di ricerca globale, che permette di ricercare in tutti i documenti presenti in Argo, in base a vari criteri (per esempio, full-text, contenuti “da tradurre”, “da rivedere” o di pertinenza di una determinata persona, ecc.)2. La creazione di modelli, ovvero di template di pagina. Si tratta di una funzione utile, quando gestiamo contenuti la cui struttura è ripetitiva, come per esempio nel caso di schede prodotto, schede ricambi, schede tecniche, schede offerta, ecc.10. Impaginazione automatica in Word / InDesign / FrameMakerSul fronte specifico dellimpaginazione, quella automatica, a partire da Argo, è più rapida di quella manuale eapplica automaticamente gli stili di paragrafo e di tabella corretti (cioè coerenti con limpostazione del layoutpredefinito), garantendoci una maggiore coerenza nella comunicazione.Autore: Petra Dal Santo (dalsanto@keanet.it) 3AR – Augmented Reality: panoramica sulla realtà aumentata – Ottobre 2012