Perché e come un CMSpuò supportarele best practicesdel technical writing
Esempi pratici tratti daArgo CMS di Kea
Technical writing: best practices
Al centro delle best practices del technical writing stanno i concetti di Single sourcing Riuso condizionale Modularizzazione Marcatura con metadati
dei contenuti
Content-variant-management
Technical writing: best practices
Corollari importanti sono Gestione del flusso di
Raccolta, redazione, revisione, approvazione, traduzione
Normative e standard Terminologie e linguaggio controllato Automazione editoriale Multicanalità Cross-media publishing
Lego® e technical writing
Ogni mattoncino è Modulare Standard Marcato… e
Riusabileper esempio per realizzare mezzi che vanno per mare, terra e aria
Perché un CMS?
Un CMS gestisce i contenuti come mattoncini di Lego® Può aiutarci a mettere in pratica
le best practices del technical writing
Perché un CMS?
Single sourcing Modularizzazione Content-variant-management
Normative e standard Terminologie Linguaggio controllato Gestione del workflow
Riuso condizionale
Automazione editoriale Vari tipi di pubblicazione Vari tipi di formati
Multicanalità Carta, web, mobile, app, ecc.
Destinatari
Attività preliminari critiche Process engineering Content engineering
Selezione Modularizzazione Adeguamento normativo e terminologico Definizione e assegnazione di metadati Definizione e modellazione degli output
Adottare un CMS con successo
Panoramica sugli ambiti
Esempi tratti da Argo CMS
Come ci supporta un CMS?
6. Riuso di contenuti comuni
7. Contenuti specifici
8. Output
9. Gestione del workflow
1. Standardizzazione
2. Modularizzazione
3. Classificazione
4. Single sourcing
5. Metadati
Modelli di classificazione e struttura dei contenuti Normative
UNI 13460, UNI 10893, UNI 10653, UNI EN 13306 Standard
ANSI Z535 Safety Alerting Standards DITA S1000D
Standardizzazione1/1
StandardizzazioneModelli di classificazione dei contenuti
Esempio
StandardizzazioneModelli di struttura dei contenuti
Esempio
Terminologie Del settore Dell’azienda
Linguaggio controllato Della lingua Del settore
Standardizzazione1/2
Definizione della «grana» dei contenuti Contenuti a grana grossa
Minore complessità di gestione Maggiore rischio di ridondanza
Contenuti a grana fine Maggiore complessità di gestione Minore rischio di ridondanza
Modularizzazione2/1
Non vi è una regola universale La modularizzazione può essere funzionale a
Riuso pratico all’interno dei vari tipi di output Struttura di un documento tipo Metodi, standard e norme Ciclo di vita o configurazione del prodotto
Modularizzazione2/2
ModularizzazioneContenuti a grana grossa
Esempio
ModularizzazioneContenuti a grana media
Esempio
ModularizzazioneContenuti a grana fine
Esempio
Funzionale al reperimento dei contenuti da parte dei redattori Oltre alla navigazione dell’albero di
classificazione Motore di ricerca del CMS
Classificazione & Ricerca3
Classificazione & RicercaMotore di ricerca
Esempio
Nel CMS Gestire 1 volta Riusare N volte
Problematiche Minimizzare il rischio di creare contenuti
comuni ridondanti Integrare altre fonti dati
Single sourcing
ogni contenuto comune
4/1
Minimizzare il rischio di creare contenuti comuni ridondanti Motore di ricerca Marcatura con metadati specifica delle condizioni di riuso
Autorizzazione Approvazione Tracciatura delle attività
Single sourcing
della creazione e modificadei contenuti comuni
4/2
Integrare altre fonti dati PLM / PDM / PIM / SPIM / MAMS
Dati e contenuti relativi ai prodotti ERP
Anagrafiche, distinte, ecc. DMS
Archiviazione degli output del CMS
Single sourcing4/3
Single sourcingIntegrazione con altre fonti dati
Connettori da e verso altre fonti dati
Esempio
Specifica le condizioni di riuso dei contenuti comuni Obiettivo auto-configurare la documentazione
I marcatori possono essere Reference-based caratteristiche del prodotto
Task-based fasi del workflow dei destinatari
Metadati5
Auto-configurazione e composizione della documentazione in base a
Metadati Esplicitazione di
Condizioni di riuso Tipo di output Canale
Riuso dei contenuti comuni
Modello di struttura dell’ouput
Formato dell’output
6/1
Modalità di riuso Reuse by reference Il contenuto riusato è
Un link all’originale Segue il ciclo di vita dell’originale
Gestione delle revisioni
Reuse by value Il contenuto riusato è Una copia scollegata dall’originale
Non segue il ciclo di vita dell’originale Rischio di creare contenuti ridondanti
Riuso dei contenuti comuni6/2
Riuso dei contenuti comuniDefinizione dei metadati
Esempio
Riuso dei contenuti comuniAssociazione fra contenuto e metadati
Esempio
Riuso dei contenuti comuniRiuso condizionale
1. Specifica delle condizioni di riuso2. Auto-configurazione dell’output
Esempio
Riuso dei contenuti comuniReuse by reference o by value
Esempio
Integrazione dei contenuti riusati con contenuti specifici relativi all’output
Per esempio Variabili
Codice matricola Denominazioni di famiglia, modello, ecc.
Contenuti relativi a personalizzazioni
Contenuti specifici7
Contenuti specifici
Esempio
Integrazione fra contenuti riusati e specifici sul documento di destinazione
Varietà di Tipi di output Struttura degli output Canali Formati Presentazioni
Output Cross-media publishing
8/1
Tipi di output Per esempio:
Documentazione esterna Manuali di installazione, uso, manutenzione Schede, data sheet Cataloghi
Documentazione interna Procedure di assemblaggio Offerte
Output Cross-media publishing
8/2
Struttura degli output A ogni output è possibile associare un
modello che ne definisce la struttura Per esempio: copertina, sommario, pagine interne,
indice analitico, indice dei codici ricambio Ogni contenuto può essere riusato in un
numero non predefinito di strutture
Output Cross-media publishing
8/3
Output Modello di struttura dell’output
Esempio
Canali Carta CD, DVD, USB, ecc. Web Mobile (web app) App
Output Cross-media publishing
8/4
Formati Adobe InDesign, FrameMaker MS Word, Excel PDF HTML XML …
Output Cross-media publishing
8/5
Presentazioni Nel CMS contenuto e forma sono separati La presentazione è gestita da modelli e fogli
di stile associati all’output Allo stesso contenuto può corrispondere un
numero non predefinito di forme di presentazione Guide di stile secondo specifiche di settore o del cliente
Output Cross-media publishing
8/6
Output MS Word
Esempio
Output Adobe InDesign o FrameMaker
Esempio
Output PDF
Esempio
Output HTML
Esempio
Output XML
Esempio
Gestione collaborativa del flusso di Raccolta, redazione, revisione, approvazione
e traduzione Ruoli e autorizzazioni per far svolgere a ogni
utente i compiti di sua pertinenza Lavoro in rete locale o da remoto
Gestione del workflow9/1
Gestione del workflow
Esempio
Contenuti originali rielaborati dal technical writer
Supporto a Raccolta on site Conferimento da parte
dei detentori Salvataggio Marcatura con metadati Tracciatura delle revisioni
Gestione del workflow
dei contenuti originali
9/2
Redazione, revisione, approvazione Note di redazione
Esplicitare e condividere best practices redazionali Scadenze Stato di avanzamento del contenuto Bozze complete di note di redazione Tracciatura delle revisioni
Gestione del workflow9/3
Traduzione Marcatura Filtro Traduzione
Sul CMS Su software esterni (CAT Tool)
Importazione
Gestione del workflow
dei contenuti da tradurre
9/4
Gestione del workflowRaccolta, redazione, revisione, traduzione
Esempio
Garanzie Manutenibilità Correttezza Coerenza Condivisibilità Flessibilità Rapidità
Vantaggi di un CMS
dei contenuti
nel soddisfare le esigenze dei destinatari
Guadagni Servizi a valore aggiunto
Per esempio Generare ricavi da un e-commerce di parti di ricambio e
accessori
Ottimizzazione del time-to-market Incremento della soddisfazione del cliente
Ritorno d’immagine
Vantaggi di un CMS
Risparmi Tempi e costi di
Raccolta Redazione Revisione Traduzione Supporto al cliente
Pre-vendita Post-vendita
Vantaggi di un CMS
dei contenuti
I nostri riferimenti
Kea s.r.l. Via Strà, 102 37042 Caldiero (VR) Italia
Tel. e Fax: +39 045 6152381 E-mail: [email protected] Web: www.keanet.it Blog: http://blog.keanet.it/