Argo CMS come supporta il Technical Writing?

postato da Petra Dal Santo - KEA s.r.l. [26/07/2013 16:41]
foto

Sulla base del libro di Krista Van Laan, The Insider’s Guide to Technical Writing (presentato nel nostro ultimo post), ci siamo chiesti quali sono le funzioni di Argo CMS (#ArgoCMS) in grado di supportare le buone pratiche di technical writing illustrate dall’autrice.

In altri termini, Argo CMS come aiuta il technical writer a realizzare manuali, help online e documentazione tecnica di qualità? Vediamolo nel dettaglio.

Frammentazione e gestione strutturata dei contenuti, single sourcing, tagging, riutilizzo dei contenuti, multicanalità

  • Frammentazione dei contenuti in unità logiche elementari (chunk, topic)
    • Argo CMS supporta la frammentazione dei contenuti a vari livelli di granularità: termini ed espressioni (con i contenuti Inline), paragrafi, warning, immagini, tabelle, capitoli, ecc. (con la possibilità di riprendere i contenuti in base al Livello, cioè all’elemento di classificazione in cui sono inseriti)
  • Gestione strutturata dei contenuti
    • La funzione Modelli di Argo CMS permette di definire e utilizzare (istanziare) template per strutturare determinati tipi di contenuti (per esempio procedure, schede prodotto, schede ricambi, ecc.) in base a modelli standardizzati. Nella nostra esperienza, per il momento i modelli si orientano in prevalenza su schemi / DTD - Document Type Definition proprietari dell’azienda. Stiamo comunque approfondendo la conoscenza di schemi “universali” come DITA e valutandone il supporto
  • Single sourcing (gestione univoca dei contenuti)
    • Argo CMS supporta il single sourcing, permettendo di definire i contenuti “comuni” (globali), cioè le unità logiche elementari (chunk, topic) da gestire, tradurre e localizzare in modo univoco in vista del loro riutilizzo
  • Tagging dei contenuti
    • Le funzioni Proprietà e Destinatari di Argo CMS permettono di gestire qualsiasi tipo di marcatore (legati, per esempio, a famiglie e modelli, codici della distinta base [BOM - Bill of Material], destinatari, mercati, tipi di documentazione, canali, ecc.). Argo CMS supporta quindi anche i due tipi di tag a cui fa riferimento Krista Van Laan: task-based (con al centro l’utente e le fasi del suo flusso di lavoro) e reference-based (con al centro il prodotto e le sue caratteristiche). Infine, le Proprietà permettono di collegare il sistema informativo aziendale e Argo CMS, marcando i contenuti presenti in Argo con i codici componenti provenienti dal sistema informativo, con l’obiettivo di configurare in automatico la documentazione tecnica a partire dai codici della distinta base (BOM - Bill of Material)
  • Riutilizzo dei contenuti
    • Argo CMS permette di definire set di condizioni di riutilizzo dei contenuti e di applicarli per configurare in automatico la documentazione tecnica, per esportare selettivamente i contenuti e per realizzare pubblicazioni mirate
  • Documentazione multicanale (database publishing e cross-media publishing)
    • Argo CMS dispone di varie funzioni per automatizzare la realizzazione di documentazione tecnica multicanale: impaginazione automatica in MS Word, Adobe InDesign e Adobe FrameMaker, esportazione in HTML - completa di motore di ricerca interno e formattabile tramite CSS (fogli di stile) -, esportazione in XML per alimentare applicazioni di vario tipo (e-commerce, help online di software a bordo macchina, App, ecc.).

Flusso di lavoro della realizzazione di documentazione tecnica 

Quelli sopra illustrati rappresentano alcuni fra i principali punti di forza di Argo CMS. Il software dispone però anche di altre funzioni idonee a supportare il flusso di lavoro descritto da Krista Van Laan come favorevole alla produzione di documentazione tecnica di qualità:

  • Marcare un contenuto come “Contenuto originale” per salvare la versione originale delle informazioni raccolte, senza rischiare che confluiscano nella versione finale del documento
  • Utilizzare bookmark e marcatori per contrassegnare contenuti incompleti e note per il redattore
  • Utilizzare bookmark e flag di traduzione per gestire il flusso di redazione, revisione, traduzione e approvazione, inviando - per esempio - a revisori e traduttori solo i contenuti di loro pertinenza
  • Realizzare bozze in MS Word, applicando modelli che rendano immediatamente distinguibile la bozza dalla versione finale del documento. Bookmark e flag di traduzione possono essere “stampati” sulla bozza per contrassegnare visivamente contenuti incompleti, da rivedere, da tradurre, ecc. Se necessario, in fase di importazione dei contenuti revisionati o delle traduzione, Argo CMS permette di modificare lo stato di bookmark (per esempio da “Da approvare” ad “Approvato”) e flag di traduzione (per esempio da “Da tradurre in inglese” a “Tradotto in inglese”)
  • Congelare in Argo CMS la versione del documento all’atto della sua pubblicazione, scollegandola dal flusso evolutivo dei contenuti comuni
  • Gli output da Argo CMS supportano in vario modo l’usabilità della documentazione tecnica:
    • Presentazione dei contenuti in base a template grafici / modelli / fogli di stile CSS
    • Sommari e navigazione per capitoli / sottocapitoli (supportato dagli output in MS Word, Adobe InDesign, Adobe FrameMaker, HTML)
    • Indice analitico per agevolare il reperimento delle informazioni (realizzabile per output in Adobe InDesign e Adobe FrameMaker a partire da tag inseriti in Argo CMS)
    • Indici vari, per esempio per codice articolo, ecc. (realizzabile per output in Adobe InDesign e Adobe FrameMaker)
    • Motore di ricerca interno (supportato dall’output in HTML)

    • Glossario con abbreviazioni, acronimi, termini accettati (ora attraverso la gestione di contenuti Inline e prossimamente anche tramite il nuovo spell-checker [correttore ortografico] di Argo CMS).