CMS a supporto delle best practices del technical writing
Upcoming SlideShare
Loading in...5
×
 

Like this? Share it with your network

Share

CMS a supporto delle best practices del technical writing

on

  • 459 views

Perché e come un CMS può supportare le best practices del technical writing. Panotamica sulle best practices ed esempi tratti da Argo CMS di KEA, software per realizzare manuali, cataloghi, ...

Perché e come un CMS può supportare le 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.htm

Statistics

Views

Total Views
459
Views on SlideShare
450
Embed Views
9

Actions

Likes
1
Downloads
6
Comments
0

2 Embeds 9

https://twitter.com 7
http://www.linkedin.com 2

Accessibility

Categories

Upload Details

Uploaded via as Microsoft PowerPoint

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

CMS a supporto delle best practices del technical writing Presentation Transcript

  • 1. Perché e come un CMS può supportare le best practices del technical writing Esempi pratici tratti da Argo CMS di Kea
  • 2. 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
  • 3. Technical writing: best practices  Corollari  Gestione del flusso di   importanti sono Raccolta, redazione, revisione, approvazione, traduzione Normative e standard  Terminologie e linguaggio controllato  Automazione editoriale Cross-media publishing  Multicanalità
  • 4. Lego® e technical writing  Ogni  mattoncino è Modulare  Standard  Marcato… e
  • 5.  Riusabile per esempio per realizzare mezzi che vanno per mare, terra e aria
  • 6. Perché un CMS?  Un CMS gestisce i contenuti come mattoncini di Lego®  Può aiutarci a mettere in pratica le best practices del technical writing
  • 7.  Destinatari Perché un CMS?   Riuso condizionale Single sourcing  Modularizzazione  Content-variant-management  Automazione editoriale  Vari tipi di pubblicazione  Normative e standard  Vari tipi di formati  Terminologie   Linguaggio controllato Gestione del workflow  Multicanalità  Carta, web, mobile, app, ecc.
  • 8. Adottare un CMS con successo  Attività preliminari critiche  Process engineering  Content engineering      Selezione Modularizzazione Adeguamento normativo e terminologico Definizione e assegnazione di metadati Definizione e modellazione degli output
  • 9. Come ci supporta un CMS?  Panoramica sugli ambiti 5. Standardizzazione Modularizzazione Classificazione Single sourcing Metadati  Esempi tratti da Argo CMS 1. 2. 3. 4. 6. 7. 8. 9. Riuso di contenuti comuni Contenuti specifici Output Gestione del workflow
  • 10. 1/1 Standardizzazione  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 
  • 11. Esempio Standardizzazione Modelli di classificazione dei contenuti
  • 12. Esempio Standardizzazione Modelli di struttura dei contenuti
  • 13. 1/2 Standardizzazione  Terminologie  Del settore  Dell’azienda  Linguaggio controllato  Della lingua  Del settore
  • 14. 2/1 Modularizzazione  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 
  • 15. 2/2 Modularizzazione  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 
  • 16. Esempio Modularizzazione Contenuti a grana grossa
  • 17. Esempio Modularizzazione Contenuti a grana media
  • 18. Esempio Modularizzazione Contenuti a grana fine
  • 19. 3 Classificazione & Ricerca  Funzionale al reperimento dei contenuti da parte dei redattori  Oltre alla navigazione dell’albero di classificazione  Motore di ricerca del CMS
  • 20. Esempio Classificazione & Ricerca Motore di ricerca
  • 21. 4/1 Single sourcing  Nel CMS  Gestire 1 volta  Riusare N volte ogni contenuto comune  Problematiche  Minimizzare il rischio di creare contenuti comuni ridondanti  Integrare altre fonti dati
  • 22. 4/2 Single sourcing  Minimizzare il rischio di creare contenuti comuni ridondanti      Motore di ricerca Marcatura con metadati specifica delle condizioni di riuso Autorizzazione della creazione e modifica dei contenuti comuni Approvazione Tracciatura delle attività
  • 23. 4/3 Single sourcing  Integrare  PLM / PDM / PIM / SPIM / MAMS   Dati e contenuti relativi ai prodotti ERP   altre fonti dati Anagrafiche, distinte, ecc. DMS  Archiviazione degli output del CMS
  • 24. Esempio Single sourcing Integrazione con altre fonti dati Connettori da e verso altre fonti dati
  • 25. 5 Metadati  Specifica le condizioni di riuso dei contenuti comuni  Obiettivo  auto-configurare la documentazione  I marcatori possono essere Reference-based   Task-based   caratteristiche del prodotto fasi del workflow dei destinatari
  • 26. 6/1 Riuso dei contenuti comuni  Auto-configurazione e composizione della documentazione in base a  Metadati  Esplicitazione di Condizioni di riuso  Tipo di output  Canale  Modello di struttura dell’ouput Formato dell’output
  • 27. 6/2 Riuso dei contenuti comuni  Modalità  Reuse by reference  Il contenuto riusato è  Un link all’originale   di riuso 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
  • 28. Esempio Riuso dei contenuti comuni Definizione dei metadati
  • 29. Esempio Riuso dei contenuti comuni Associazione fra contenuto e metadati
  • 30. Esempio Riuso dei contenuti comuni Riuso condizionale 1. Specifica delle condizioni di riuso 2. Auto-configurazione dell’output
  • 31. Esempio Riuso dei contenuti comuni Reuse by reference o by value
  • 32. 7 Contenuti specifici  Integrazione dei contenuti riusati con contenuti specifici relativi all’output  Per esempio  Variabili Codice matricola  Denominazioni di famiglia, modello, ecc.   Contenuti relativi a personalizzazioni
  • 33. Esempio Contenuti specifici Integrazione fra contenuti riusati e specifici sul documento di destinazione
  • 34. 8/1 Output Cross-media publishing  Varietà      di Tipi di output Struttura degli output Canali Formati Presentazioni
  • 35. Output Cross-media publishing  Tipi  di output Per esempio:  Documentazione esterna     Manuali di installazione, uso, manutenzione Schede, data sheet Cataloghi Documentazione interna   Procedure di assemblaggio Offerte 8/2
  • 36. 8/3 Output Cross-media publishing  Struttura  A ogni output è possibile associare un modello che ne definisce la struttura   degli output Per esempio: copertina, sommario, pagine interne, indice analitico, indice dei codici ricambio Ogni contenuto può essere riusato in un numero non predefinito di strutture
  • 37. Esempio Output Modello di struttura dell’output
  • 38. Output Cross-media publishing  Canali      Carta CD, DVD, USB, ecc. Web Mobile (web app) App 8/4
  • 39. Output Cross-media publishing  Formati       Adobe InDesign, FrameMaker MS Word, Excel PDF HTML XML … 8/5
  • 40. Output 8/6 Cross-media publishing  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
  • 41. Esempio Output MS Word
  • 42. Esempio Output Adobe InDesign o FrameMaker
  • 43. Esempio Output PDF
  • 44. Esempio Output HTML
  • 45. Esempio Output XML
  • 46. 9/1 Gestione del workflow  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
  • 47. Esempio Gestione del workflow
  • 48. 9/2 Gestione del workflow  Contenuti  originali rielaborati dal technical writer Supporto a Raccolta on site  Conferimento da parte dei detentori   Salvataggio  Marcatura con metadati  Tracciatura delle revisioni dei contenuti originali
  • 49. 9/3 Gestione del workflow  Redazione,  Note di redazione   revisione, approvazione Esplicitare e condividere best practices redazionali Scadenze  Stato di avanzamento del contenuto  Bozze complete di note di redazione  Tracciatura delle revisioni
  • 50. 9/4 Gestione del workflow  Traduzione  Marcatura  Filtro  Traduzione dei contenuti da tradurre Sul CMS  Su software esterni (CAT Tool)   Importazione
  • 51. Esempio Gestione del workflow Raccolta, redazione, revisione, traduzione
  • 52. Vantaggi di un CMS  Garanzie       Manutenibilità Correttezza Coerenza Condivisibilità Flessibilità Rapidità dei contenuti nel soddisfare le esigenze dei destinatari
  • 53. Vantaggi di un CMS  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
  • 54. Vantaggi di un CMS  Risparmi  Tempi e costi di Raccolta  Redazione  Revisione  Traduzione  Supporto al cliente  Pre-vendita  Post-vendita  dei contenuti
  • 55. I nostri riferimenti  Kea s.r.l.  Via Strà, 102  37042 Caldiero (VR)  Italia     Tel. e Fax: E-mail: Web: Blog: +39 045 6152381 info@keanet.it www.keanet.it http://blog.keanet.it/