Usare un CMS per adottare le best practices del technical writing

  • 5,463 views
Uploaded on

Come usare un CMS per adottare facilmente le best practices del technical writing. …

Come usare un CMS per adottare facilmente le best practices del technical writing.

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
5,463
On Slideshare
0
From Embeds
0
Number of Embeds
5

Actions

Shares
Downloads
4
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. Usare un CMS per adottare facilmente le best practices del technical writing COM&TEC Formazione Primavera 2014 Bologna, 9 aprile 2014
  • 2. Technical writing: best practices  Concetti fondamentali per le best practices del technical writing  Modularizzazione  Standardizzazione  Single sourcing  Varianti  Marcatura con metadati  Riuso condizionale dei contenuti 1/2
  • 3. Technical writing: best practices  Concetti fondamentali per le best practices del technical writing  Gestione del flusso di  Raccolta, redazione, revisione, approvazione e traduzione dei contenuti  Leggi, norme e standard  Terminologie, controlli linguistici e linguaggi controllati  Automazione editoriale e cross-media-publishing 2/2
  • 4. Lego® e technical writing  Ogni mattoncino è  Modulare  Standard  Marcato  Riusabile 1/2
  • 5. 2/2
  • 6. Perché un CMS*?  Un CMS gestisce i contenuti come mattoncini di Lego®  Può aiutarci ad adottare facilmente le best practices del technical writing * Vd. Glossario alla penultima slide 1/3
  • 7. Perché un CMS?  Redazione  Revisione  Varianti di contenuto  Traduzione  Archiviazione  Riuso condizionale  Pubblicazione  Destinatari 2/3
  • 8.  Ambiti in cui un CMS può supportarci  Redazione  Revisione  Varianti  Traduzione  Pubblicazione  Archiviazione Perché un CMS? 3/3 dei contenuti dei documenti
  • 9. Redazione
  • 10.  Attività preliminare  Process engineering  Ridefinizione dei processi di  Raccolta  Redazione  Revisione  Approvazione  Traduzione Redazione Flusso di lavoro 1/11
  • 11.  Gestione collaborativa del flusso di  Raccolta  Redazione e gestione delle varianti di contenuto  Revisione e approvazione  Traduzione  Stati di avanzamento  Bozze  Tracking delle attività Redazione Flusso di lavoro 2/11
  • 12.  Classificazione dei contenuti  Può essere basata su  Leggi  Norme di settore  Standard di settore  Esempio: S1000D  Linee guida aziendali Redazione Contenuti: classificazione 3/11
  • 13.  Segmentazione  Strutturazione  Può essere  Bottom up  Top down  Mista fra bottom up e top down Redazione Contenuti: segmentazione e strutturazione 4/11 dei contenuti
  • 14.  Segmentazione  Strutturazione  Bottom up  Dettata da esigenze di riuso pratiche e contingenti  Top down  Dettata da  Leggi, norme, standard, metodiche  Esempi: ANSI Z535, DITA, S1000D  Configurazioni di prodotto  Linee guida aziendali Redazione Contenuti: segmentazione e strutturazione 5/11 dei contenuti
  • 15.  Segmentazione  Strutturazione  «Granularità» 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 Redazione Contenuti: segmentazione e strutturazione 6/11 dei contenuti
  • 16.  Definizione dei metadati  Esempi di dimensioni. Metadati relativi a  Prodotto  Famiglia, modello, codici della distinta…  Destinatari  Tipo di destinatario, livello di conoscenza, fase del flusso di lavoro…  Mercato  Tipo di documento e canale  Marcatura dei contenuti con metadati Redazione Metadati 7/11
  • 17.  Definizione di  Tipi di documento  Esempi: manuali, online help, guide rapide, data sheet, troubleshooting, cataloghi ricambi…  Struttura di ogni tipo di documento  Può essere basata su  Leggi  Norme  Standard  Linee guida aziendali Redazione Documento: struttura 8/11
  • 18.  Obiettivo  Standardizzare i contenuti per riusarli  Supporti alla redazione standardizzata  Linee guida redazionali  Funzioni di auto-text  Esempi: per warning, caution, notice, riferimenti incrociati…  Terminologie  Controlli linguistici (CLC)  Linguaggi controllati  Esempio: ASD Simplified Technical English Redazione Contenuti: redazione standardizzata 9/11
  • 19.  Attività preliminari  Content engineering  Selezione  Standardizzazione  Adeguamento a leggi, norme, standard  Adeguamento terminologico  Modularizzazione  Assegnazione dei metadati Redazione Contenuti: recupero dello storico 10/11 dei contenuti
  • 20.  Integrazione fra CMS e altre fonti dati  Esempi  PLM / PDM / PIM / SPIM / MAMS  Dati e contenuti relativi ai prodotti  ERP  Anagrafiche, distinte, ecc.  DMS  Archiviazione degli output del CMS Redazione Contenuti: integrazione tra fonti dati 11/11
  • 21. Revisione
  • 22. Revisione = Modifica nel tempo di un contenuto a parità di metadati  Gestione delle revisioni  Gestione del rapporto fra revisione e riuso del contenuto Revisione
  • 23. Varianti di contenuto
  • 24. Variante = Contenuto distinto, marcato da metadati distinti  Sono giustificate dal riferimento a famiglie, modelli, codici, destinatari, mercati, documenti, ecc., distinti  Content variant management  Gestione della redazione, marcatura, revisione, traduzione delle varianti Varianti di contenuto
  • 25. Traduzione
  • 26.  Gestione del processo di traduzione  Integrazione con TMS  Supporto alla localizzazione  Varianti di contenuto  Unità di misura e conversioni  Formati di data, ora e numeri  Immagini e pittogrammi  Formati dei documenti  Esempi: A4, Lettera USA Traduzione
  • 27. Riuso condizionale
  • 28.  Obiettivo  Single sourcing  "Dev'essere più facile trovare un contenuto esistente, che scriverne uno nuovo!"  Minimizzare il rischio di creare contenuti ridondanti  Strumenti di ricerca dei contenuti da riusare  Gestione del flusso di lavoro  Distinzione dei ruoli. Utenti autorizzati a  Redigere nuovi contenuti  Approvare nuovi contenuti  Riusare contenuti esistenti Riuso condizionale 1/6
  • 29.  Ricerca di contenuti da riusare  Motore di ricerca  Ricerca testuale  Ricerca basata su metadati  Funzioni di AMS Riuso condizionale Ricerca 2/6
  • 30.  Riuso di contenuti  By reference  Il contenuto riusato mantiene il link all'originale  By content  Il contenuto riusato è una copia dell'originale  Non mantiene il link all’originale Riuso condizionale Riuso in fase di redazione 3/6
  • 31. Documento = Insieme di segmenti di contenuto, selezionati secondo condizioni di riuso date e strutturati in base alla struttura del tipo di documento  Obiettivo  Automazione  Configurazione e composizione del documento avvengono in modo automatico Riuso condizionale Riuso in fase di realizzazione del documento 4/6
  • 32.  Realizzazione del documento  Definizione delle condizioni di riuso da applicare  Esempio: «Famiglia  XYZ», «Modello  123», «Destinatario  Installatore», «Mercato  USA»  Selezione dei contenuti in base alle condizioni di riuso  Mappatura dei contenuti riusati sulla struttura del tipo di documento di destinazione Riuso condizionale Riuso in fase di realizzazione del documento 5/6
  • 33.  Se necessario  Integrazione dei contenuti riusati con contenuti specifici del documento realizzato per il destinatario  Esempi:  Variabili  Codice matricola  Denominazioni di famiglia, modello, ecc.  Contenuti relativi a personalizzazioni del prodotto Contenuti specifici In fase di realizzazione del documento 6/6
  • 34. Pubblicazione
  • 35.  Cross-media-publishing  Varietà di  Tipi di documento  Esempi: manuali, online help, data sheet, cataloghi…  Struttura dei documenti  Canali  Carta, web, mobile, app, cd/dvd/usb…  Formati  InDesign, FrameMaker, Word, PDF, HTML, XML…  Presentazione grafica Pubblicazione
  • 36. Archiviazione
  • 37.  All’interno del CMS  Archiviazione di segmenti di contenuto  A sé stanti  Aggregati in documenti  All’interno di DMS  Archiviazione dei documenti pubblicati  Esempio: manuali in formato PDF Archiviazione
  • 38.  Garanzie  Manutenibilità  Correttezza  Coerenza  Possibilità di condivisione  Flessibilità  Rapidità Vantaggi di un CMS dei contenuti nel soddisfare le esigenze dei destinatari 1/3
  • 39.  Guadagni  Servizi a valore aggiunto  Esempi  E-commerce di ricambi e accessori  Applicazioni per il mobile  Knowledge base  Migliore del time-to-market  Maggiore soddisfazione del cliente  Ritorno d’immagine Vantaggi di un CMS 2/3
  • 40.  Risparmi  Tempi e costi di  Raccolta  Redazione  Revisione  Traduzione  Supporto al cliente  Pre-vendita  Post-vendita Vantaggi di un CMS dei contenuti 3/3
  • 41.  AMS Authoring Memory System  CLC Controlled Language Checker  CMS Content Management System  DMS Document Management System  ERP Enterprise Resource Planning system  MAMS Media Asset Management System  PDM Product Data Management system  PIM Product Information Management system  PLM Product Lifecycle Management system  SPIM Spare Parte Information Management system  TMS Translation Memory System Glossario
  • 42. I nostri riferimenti  Kea s.r.l.  Via Strà, 102  37042 Caldiero (VR)  Italia  Tel. e Fax: +39 045 6152381  E-mail: info@keanet.it  Web: www.keanet.it  Blog: http://blog.keanet.it/