Realizzare documentazione tecnica e di prodotto in modo efficiente ed efficace con Argo CMS

  • 348 views
Uploaded on

GUIDA PRATICA - Come utilizzare il software Argo CMS per realizzare in modo efficiente ed efficace documentazione tecnica (manuali, istruzioni, help online, ecc.) e documentazione di prodotto …

GUIDA PRATICA - Come utilizzare il software Argo CMS per realizzare in modo efficiente ed efficace documentazione tecnica (manuali, istruzioni, help online, ecc.) e documentazione di prodotto (cataloghi, e-commerce, listini, schede, ecc.) da pubblicare su carta, web e app.
Risparmiate tempi di redazione e revisione e costi di traduzione, migliorando la qualità della documentazione e fornendo servizi a valore aggiunto ai vostri interlocutori.

More in: Technology
  • 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
348
On Slideshare
0
From Embeds
0
Number of Embeds
2

Actions

Shares
Downloads
20
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) | www.keanet.it Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Panoramica sugli strumenti con cui Argo aiuta tecnical writer, product manager e traduttori a realizzare documentazione di qualità "E' tempo di trasformare la comunicazione tecnica da un male necessario in un bene aziendale" (Sarah O'Keefe e Alan S. Pringle) Sommario Gestione collaborativa ........................................................................................................................................................ 2 Autorizzazioni ............................................................................................................................................................. 2 Flusso di redazione: gestione di “Contenuti originali”................................................................................................ 3 Flusso di redazione e revisione: bookmark e note per redattori e revisori ................................................................ 6 Flusso di traduzione: flag “Da tradurre” ..................................................................................................................... 8 Flusso di redazione: “congelare” il documento consegnato al cliente ..................................................................... 10 Flusso di redazione: revisioni .................................................................................................................................... 10 Riutilizzo dei contenuti ..................................................................................................................................................... 11 Frammentazione ....................................................................................................................................................... 11 Single sourcing .......................................................................................................................................................... 11 Standardizzazione ..................................................................................................................................................... 11 Strutturazione ........................................................................................................................................................... 13 Glossari ..................................................................................................................................................................... 15 Tagging ...................................................................................................................................................................... 17 Configurazione automatica della documentazione tecnica ............................................................................................. 21 Produzione automatica di documentazione multicanale ................................................................................................. 23 Strumenti per facilitare l'adesione a normative, standard e best practices ..................................................................... 24 Integrazione fra Argo e altri software............................................................................................................................... 25 1 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 2. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Gestione collaborativa Strumenti a supporto del flusso di redazione, revisione, traduzione e approvazione Autorizzazioni Gli strumenti di gestione di ruoli e autorizzazioni ti permettono di assegnare a ogni utente i compiti di sua pertinenza. Gli utenti possono lavorare su Argo in rete locale o da remoto. 2 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 3. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Marca un contenuto come “Contenuto originale” per salvare la versione Flusso di redazione: gestione originale delle informazioni raccolte, senza rischiare che confluiscano nella di “Contenuti originali” versione finale del documento. Salva la versione originale delle informazioni raccolte e marcala come “Contenuto originale” Decidi, se esportare o impaginare anche le informazioni marcate come “Contenuto originale”. Nell’esempio esportiamo anche questo tipo di contenuti 3 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 4. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Nell’esempio la bozza del documento riporta anche le informazioni marcate come “Contenuto originale” Nell’esempio non esportiamo le informazioni marcate come “Contenuto originale” 4 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 5. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Nell’esempio la versione finale del manuale non riporta le informazioni marcate come “Contenuto originale” 5 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 6. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Marca un contenuto con un bookmark per condividerne lo stato (“Da Flusso di redazione e verificare”, “Errato”, “Approvato”, ecc.) all’interno del team di redazione e revisione: bookmark e note revisione. Puoi gestire liberamente i bookmark per adattarli al tuo contesto per redattori e revisori operativo. Le “Note per il redattore” (e/o per il revisore) ti permettono di condividere best practices e scadenze all’interno del team di redazione e revisione. Marca il contenuto con un bookmark per condividerne lo stato all’interno del team di redazione e revisione Le note per redattori e revisori ti permettono di condividere best practices e scadenze 6 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 7. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Puoi cercare, esportare e impaginare in modo selettivo contenuti contrassegnati da bookmark e note Nell’esempio la bozza del documento riporta il bookmark e la nota per il redattore 7 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 8. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Marca un contenuto con un flag “Da tradurre” per indicare al traduttore in Flusso di traduzione: flag “Da modo selettivo quali sono i contenuti da tradurre o da rivedere. tradurre” In Argo puoi gestire un numero non predefinito di lingue. Il traduttore può eseguire la traduzione • • In Argo, per esempio nel caso di traduzioni breve o urgenti Su file esportati, compatibili con i più comuni software di traduzione assistita (CAT Tool). Le traduzioni possono essere importate in automatico in Argo. Marca il contenuto con il flag “Da tradurre” per condividere con il traduttore questa indicazione 8 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 9. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Puoi cercare ed esportare in modo selettivo contenuti contrassegnati con il flag “Da tradurre” Puoi importare automaticamente i contenuti tradotti, modificandone lo stato di traduzione 9 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 10. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Argo ti permette di “congelare” il documento all’atto della pubblicazione, Flusso di redazione: scollegandolo dal flusso evolutivo dei contenuti comuni riutilizzati nel “congelare” il documento manuale consegnato al cliente. consegnato al cliente Documento consegnato al cliente Parti comuni Flusso di redazione: revisioni Argo ti permette di gestire revisioni di documenti e contenuti. 10 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 11. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Riutilizzo dei contenuti Frammentazione, single sourcing, standardizzazione, strutturazione, glossari e tagging Frammentazione Argo ti permette di frammentare i contenuti a qualsiasi livello di granularità, in base alle tue esigenze di riutilizzo: termini ed espressioni, paragrafi, warning, immagini, tabelle, capitoli, ecc. Single sourcing Argo supporta la gestione univoca dei contenuti comuni multilingua in vista del loro riutilizzo. Standardizzazione Argo ti aiuta a standardizzare i contenuti da riutilizzare. Per esempio puoi associare un pittogramma standard a ogni tipo di warning e di destinatario. Il pittogramma è impaginato in automatico in tutti i tipi di pubblicazione (MS Word, Adobe InDesign o FrameMaker, HTML per il web, ecc.). Pittogramma standard associato all’Attenzione 11 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 12. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Pittogramma standard associato ai contenuti per il destinatario “Redattore” 12 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 13. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Strutturazione Argo ti permette di definire e applicare modelli (template) per strutturare determinati tipi di contenuti, per esempio: schede prodotto, schede ricambio, schede offerta, procedure, ecc. Nella definizione dei modelli puoi basarti su schemi proprietari della tua azienda, su schemi standard di settore oppure su schemi universali. I modelli ti permettono di condividere la struttura dei contenuti con il team di redazione, di automatizzare l’applicazione dei modelli e di semplificarne l’aggiornamento. Definisci il modello o i modelli di contenuti. Nell’esempio definiamo il modello della “Scheda ricambi” 13 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 14. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Nel documento puoi applicare il modello o i modelli creati in precedenza. Nell’esempio applichiamo il modello “Scheda ricambi” 14 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 15. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Glossari Argo ti permette di gestire glossari multilingua con due finalità: 1. 2. Riutilizzo di a. Termini ed espressioni del linguaggio aziendale b. Denominazioni, per esempio: ragione sociale del produttore, famiglia e modello del prodotto c. Codici, per esempio: codice matricola d. Variabili in genere, per esempio: consumabili consigliati Correzione ortografica. Lo spell-checker di Argo funziona sia con dizionari standard che con i tuoi glossari, verificando che i termini del linguaggio aziendale siano scritti correttamente. Gestisci glossari multilingua e riutilizzane i contenuti all’interno del documento 15 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 16. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Gestisci glossari multilingua in modo tale che lo spell-checker verifichi che i termini del tuo linguaggio aziendale siano scritti correttamente 16 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 17. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Tagging Argo ti permette di gestire qualsiasi tipo di marcatore per definire le condizioni di riutilizzo di un contenuto. Può trattarsi di marcatori reference-based, incentrati sulle caratteristiche del prodotto oppure task-based, focalizzate sulle fasi del flusso di lavoro dei destinatari della comunicazione. Fra i marcatori più utilizzati vi sono: famiglie e modelli, codici della distinta base (BOM, Bill of Material), destinatari, mercati, tipi di pubblicazione (manuali, help online, procedure, troubleshooting, schede, cataloghi, ecc.), tipi di canali (carta, web, app, ecc.). Obiettivo della marcatura è auto-configurare i documenti. Gestisci i tipi di marcatori e i relativi valori in base alle tue esigenze di marcatura. Puoi importare in Argo anche i codici dei componenti delle tue distinte base 17 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 18. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Marca i contenuti con i tag gestiti in precedenza Utilizza i marcatori per auto-configurare il documento da consegnare al cliente oppure per esportare o impaginare in modo selettivo i contenuti 18 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 19. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Gestisci la lista dei destinatari della comunicazione tecnica Marca i contenuti come rivolti a uno o più destinatari. Nell’esempio il contenuto è dedicato all’Operatore 19 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 20. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Puoi impaginare in modo selettivo i contenuti in base al destinatario o ai destinatari. Nell’esempio impaginiamo i contenuti dedicati all’Operatore 20 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 21. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Configurazione automatica della documentazione tecnica Utilizza i marcatori che definiscono le condizioni di riutilizzo dei contenuti comuni per configurare in automatico la tua documentazione tecnica e di prodotto. Per esempio, puoi auto-configurare il manuale da consegnare al cliente in base alla famiglia e al modello del prodotto, ai codici dei componenti della distinta base, al mercato, alla lingua e al destinatario della comunicazione. Il documento auto-configurato riutilizza contenuti comuni: lo puoi integrare con contenuti specifici, relativi per esempio a personalizzazioni richieste dal cliente. Utilizza il Wizard di Argo per auto-configurare il documento da consegnate al cliente, riprendendo i contenuti comuni in base alle condizioni di riutilizzo 21 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 22. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Nell’esempio: • A sinistra: i contenuti comuni opportunamente marcati • A destra: il documento da consegnare al cliente, auto-configurato in base alle condizioni di utilizzo specificate • Al centro: l’elenco dei documenti che riutilizzano il contenuto comune selezionato Integra il documento auto-configurato con contenuti specifici, relativi a personalizzazioni richieste dal cliente 22 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 23. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Produzione automatica di documentazione multicanale Argo ti aiuta a realizzare in modo più efficiente la documentazione tecnica e di prodotto, supportando database publishing e cross-media publishing. Il software ti permette di: • • • Impaginare in automatico in MS Word, Adobe InDesign e Adobe FrameMaker per realizzare manuali, cataloghi, listini, schede, ecc. Esportare in formato HTML per realizzare help online e documentazione tecnica da pubblicare sul web Esportare in formato XML per alimentare applicazioni di vario tipo, per esempio: CMS web, e-commerce, help online di software a bordo macchina, App, ecc. Dal momento che Argo separa nettamente il contenuto dalla presentazione, le pubblicazioni sono formattate automaticamente in base ai tuoi template grafici e fogli di stile. Anche sommari, indici analitici, indici vari (per esempio per codice articolo) e funzioni di ricerca sono supportati dagli strumenti di database publishing integrati con Argo. Risparmio di tempo, multicanalità e migliore fruibilità della documentazione sono i principali vantaggi che puoi ottenere. 23 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 24. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Strumenti per facilitare l'adesione a normative, standard e best practices Argo facilita in vari modi la tua adesione a normative, standard e best practices. Per esempio, il software ti permette di: • • • • Disporre di un sommario commentato, aderente alle normative di settore (Direttiva Macchine, ecc.) Gestire in modo univoco contenuti multilingua per riutilizzarli Definire e applicare modelli (template) per strutturare determinati tipi di contenuti (schede prodotto, schede ricambio, schede offerta, procedure, ecc.) Associare un pittogramma standard a ogni tipo di warning e di destinatario. Nell’esempio il sommario dei contenuti secondo la normativa e alcune note 24 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS
  • 25. Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: info@keanet.it Integrazione fra Argo e altri software Grazie a Plugin sviluppabili a progetto, Argo può essere integrato con altri software utilizzati nella tua azienda, per esempio: sistema gestionale, ERP, MRP, PDM, PLM, CAD, CMS web, ecc. Ecco alcuni campi di applicazione tipici dei Plugin di Argo: • • • Importare informazioni base sui prodotti a catalogo (classificazioni merceologiche, codici, descrizioni brevi, ecc.) per consentire ai product manager di arricchirle in Argo, aggiungendo immagini, schemi, logo, pittogrammi, descrizioni estese, specifiche tecniche, traduzioni, correlazioni fra prodotti, file allegati, ecc. Esportare i contenuti verso sistemi gestionali, ERP, MRP Esportare i contenuti verso cataloghi web ed e-commerce. 25 Come realizzare documentazione tecnica e di prodotto più efficiente ed efficace con Argo CMS