cms a supporto delle best practices del technical writing
DESCRIPTION
Perché e come un CMS può supportarele best practices del technical writing. Panotamica sulle best practices ed esempi tratti da Argo CMS di KEA, software per realizzare manuali, cataloghi, documentazione tecnica e documentazione di prodotto. Per maggiori informazioni su Argo CMS: http://www.keanet.it/argoManuali.htmTRANSCRIPT
![Page 1: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/1.jpg)
Perché e come un CMSpuò supportarele best practicesdel technical writing
Esempi pratici tratti daArgo CMS di Kea
![Page 2: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/2.jpg)
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
![Page 3: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/3.jpg)
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
![Page 4: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/4.jpg)
Lego® e technical writing
Ogni mattoncino è Modulare Standard Marcato… e
![Page 5: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/5.jpg)
Riusabileper esempio per realizzare mezzi che vanno per mare, terra e aria
![Page 6: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/6.jpg)
Perché un CMS?
Un CMS gestisce i contenuti come mattoncini di Lego® Può aiutarci a mettere in pratica
le best practices del technical writing
![Page 7: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/7.jpg)
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
![Page 8: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/8.jpg)
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
![Page 9: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/9.jpg)
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
![Page 10: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/10.jpg)
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
![Page 11: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/11.jpg)
StandardizzazioneModelli di classificazione dei contenuti
Esempio
![Page 12: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/12.jpg)
StandardizzazioneModelli di struttura dei contenuti
Esempio
![Page 13: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/13.jpg)
Terminologie Del settore Dell’azienda
Linguaggio controllato Della lingua Del settore
Standardizzazione1/2
![Page 14: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/14.jpg)
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
![Page 15: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/15.jpg)
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
![Page 16: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/16.jpg)
ModularizzazioneContenuti a grana grossa
Esempio
![Page 17: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/17.jpg)
ModularizzazioneContenuti a grana media
Esempio
![Page 18: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/18.jpg)
ModularizzazioneContenuti a grana fine
Esempio
![Page 19: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/19.jpg)
Funzionale al reperimento dei contenuti da parte dei redattori Oltre alla navigazione dell’albero di
classificazione Motore di ricerca del CMS
Classificazione & Ricerca3
![Page 20: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/20.jpg)
Classificazione & RicercaMotore di ricerca
Esempio
![Page 21: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/21.jpg)
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
![Page 22: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/22.jpg)
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
![Page 23: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/23.jpg)
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
![Page 24: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/24.jpg)
Single sourcingIntegrazione con altre fonti dati
Connettori da e verso altre fonti dati
Esempio
![Page 25: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/25.jpg)
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
![Page 26: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/26.jpg)
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
![Page 27: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/27.jpg)
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
![Page 28: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/28.jpg)
Riuso dei contenuti comuniDefinizione dei metadati
Esempio
![Page 29: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/29.jpg)
Riuso dei contenuti comuniAssociazione fra contenuto e metadati
Esempio
![Page 30: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/30.jpg)
Riuso dei contenuti comuniRiuso condizionale
1. Specifica delle condizioni di riuso2. Auto-configurazione dell’output
Esempio
![Page 31: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/31.jpg)
Riuso dei contenuti comuniReuse by reference o by value
Esempio
![Page 32: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/32.jpg)
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
![Page 33: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/33.jpg)
Contenuti specifici
Esempio
Integrazione fra contenuti riusati e specifici sul documento di destinazione
![Page 34: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/34.jpg)
Varietà di Tipi di output Struttura degli output Canali Formati Presentazioni
Output Cross-media publishing
8/1
![Page 35: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/35.jpg)
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
![Page 36: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/36.jpg)
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
![Page 37: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/37.jpg)
Output Modello di struttura dell’output
Esempio
![Page 38: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/38.jpg)
Canali Carta CD, DVD, USB, ecc. Web Mobile (web app) App
Output Cross-media publishing
8/4
![Page 39: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/39.jpg)
Formati Adobe InDesign, FrameMaker MS Word, Excel PDF HTML XML …
Output Cross-media publishing
8/5
![Page 40: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/40.jpg)
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
![Page 41: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/41.jpg)
Output MS Word
Esempio
![Page 42: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/42.jpg)
Output Adobe InDesign o FrameMaker
Esempio
![Page 43: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/43.jpg)
Output PDF
Esempio
![Page 44: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/44.jpg)
Output HTML
Esempio
![Page 45: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/45.jpg)
Output XML
Esempio
![Page 46: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/46.jpg)
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
![Page 47: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/47.jpg)
Gestione del workflow
Esempio
![Page 48: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/48.jpg)
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
![Page 49: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/49.jpg)
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
![Page 50: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/50.jpg)
Traduzione Marcatura Filtro Traduzione
Sul CMS Su software esterni (CAT Tool)
Importazione
Gestione del workflow
dei contenuti da tradurre
9/4
![Page 51: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/51.jpg)
Gestione del workflowRaccolta, redazione, revisione, traduzione
Esempio
![Page 52: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/52.jpg)
Garanzie Manutenibilità Correttezza Coerenza Condivisibilità Flessibilità Rapidità
Vantaggi di un CMS
dei contenuti
nel soddisfare le esigenze dei destinatari
![Page 53: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/53.jpg)
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
![Page 54: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/54.jpg)
Risparmi Tempi e costi di
Raccolta Redazione Revisione Traduzione Supporto al cliente
Pre-vendita Post-vendita
Vantaggi di un CMS
dei contenuti
![Page 55: CMS a supporto delle best practices del technical writing](https://reader035.vdocuments.site/reader035/viewer/2022062513/55635691d8b42a90698b59e4/html5/thumbnails/55.jpg)
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/