Perché e come utilizzare un CMS per realizzare documentazione tecnica e di prodotto più efficiente...
5
Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: [email protected] Perché e come utilizzare un CMS per realizzare documentazione tecnica e di prodotto più efficiente ed efficace I contenuti sono un capitale dell’azienda: vediamo come gestirli in modo ottimale e massimizzarne la resa Sommario Come possiamo gestire i contenuti della documentazione? ............................................................................ 2 Quali sono le debolezze della gestione in cui contenuto, documento e forma coincidono? ........................... 2 Quali sono i risvolti pratici negativi di questi punti di debolezza? .................................................................... 2 Fatichiamo ad aderire a normative, standard e best practices di settore..................................................... 2 Non sempre riusciamo a soddisfare appieno i bisogni informativi primari dei destinatari della documentazione ............................................................................................................................................ 3 Fatichiamo a soddisfare i bisogni informativi emergenti dei destinatari della documentazione e a fornire loro servizi a valore aggiunto ......................................................................................................................... 3 Rischiamo ripercussioni negative sull’azienda nel suo complesso ................................................................ 3 Un CMS può aiutarci a superare questi punti di debolezza?............................................................................. 4 Un CMS, da solo, non basta! L’importanza del metodo ................................................................................ 4 Perché privilegiamo i CMS rispetto agli authoring tools basati su XML ? ......................................................... 5 1 Perché e come utilizzare un CMS per realizzare documentazione tecnica e di prodotto più efficiente ed efficace
description
I contenuti sono un capitale dell’azienda: vediamo come gestirli in modo ottimale e massimizzarne la resa, rispondendo in modo adeguato ai bisogni informativi dei destinatari e attivando nuovi servizi knowledge intensive per utenti interni, forza vendita, partner e rivenditori, installatori, utilizzatori, manutentori, ecc. Guida pratica a come trasformare il contenuto da costo in risorsa a supporto della strategia aziendale.
Transcript of Perché e come utilizzare un CMS per realizzare documentazione tecnica e di prodotto più efficiente...
Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: [email protected]
Perche e come utilizzare un CMS per realizzare documentazione tecnica e di prodotto piu efficiente ed efficace I contenuti sono un capitale dell’azienda: vediamo come gestirli in modo ottimale e massimizzarne la resa
Sommario Come possiamo gestire i contenuti della documentazione? ............................................................................ 2
Quali sono le debolezze della gestione in cui contenuto, documento e forma coincidono? ........................... 2
Quali sono i risvolti pratici negativi di questi punti di debolezza? .................................................................... 2
Fatichiamo ad aderire a normative, standard e best practices di settore ..................................................... 2
Non sempre riusciamo a soddisfare appieno i bisogni informativi primari dei destinatari della documentazione ............................................................................................................................................ 3
Fatichiamo a soddisfare i bisogni informativi emergenti dei destinatari della documentazione e a fornire loro servizi a valore aggiunto ......................................................................................................................... 3
Rischiamo ripercussioni negative sull’azienda nel suo complesso ................................................................ 3
Un CMS può aiutarci a superare questi punti di debolezza?............................................................................. 4
Un CMS, da solo, non basta! L’importanza del metodo ................................................................................ 4
Perché privilegiamo i CMS rispetto agli authoring tools basati su XML ? ......................................................... 5
1
Perché e come utilizzare un CMS per realizzare documentazione tecnica e di prodotto più efficiente ed efficace
Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: [email protected]
Come possiamo gestire i contenuti della documentazione? Principalmente vi sono due modi per gestire i contenuti della documentazione tecnica e di prodotto. Possiamo:
1. Far coincidere il contenuto, il documento (cioè, per esempio, il manuale o il catalogo che consegniamo al cliente) e la forma di presentazione:
a. Questo accede quando redigiamo e formattiamo manualmente un documento in MS Word o Adobe InDesign
2. Separare il contenuto dal documento e dalla forma di presentazione a. Questo accade quando utilizziamo:
i. Authoring tools basati su XML o sistemi di gestione dei contenuti (CMS – Content Management System) per gestire i contenuti
ii. Sistemi di database publishing multicanale per realizzare i documenti iii. Template e fogli di stile per gestire l’aspetto.
Quali sono le debolezze della gestione in cui contenuto, documento e forma coincidono? Quando contenuto, documento e forma di presentazione coincidono è difficile:
• Far collaborare più figure professionali • Strutturare, standardizzare e riutilizzare i contenuti • Revisionare i contenuti • Garantire la coerenza dell’informazione, aggiornando in modo certo i contenuti presenti in più
documenti • Utilizzare glossari e terminologie • Ottimizzare i costi di traduzione • Omogeneizzare la forma di presentazione dei contenuti • Realizzare pubblicazioni multicanale e mirate a singoli destinatari • Integrare i contenuti presenti nelle varie fonti dati aziendali.
Quali sono i risvolti pratici negativi di questi punti di debolezza?
Fatichiamo ad aderire a normative, standard e best practices di settore Quando redigiamo a mano un manuale o un catalogo dobbiamo ricordarci puntualmente di mettere in pratica quanto previsto da normative, standard e best practices di settore.
Non riceviamo alcun supporto, per esempio per:
• Strutturare, redigere e formattare un manuale secondo quanto previsto dalla Direttiva Macchine e dalle altre normative che regolamentano la stesura della documentazione tecnica (per esempio ISO
2
Perché e come utilizzare un CMS per realizzare documentazione tecnica e di prodotto più efficiente ed efficace
Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: [email protected]
IEC 82079-1:2012, UNI 10653:2003, UNI 10893:2000, UNI/TS 11192:2006 che riguardano la classificazione, l’ordine espositivo, la redazione e la forma di presentazione dei contenuti)
• Realizzare documentazione aderente a standard di settore (per esempio AECMA / ATA / S1000D relativi alla documentazione di veicoli ed equipaggiamenti nel settore aeronautico, militare e civile) o indipendenti (per esempio DITA [Darwin Information Typing Architecture])
• Applicare strutture e forme di presentazione costanti ai prodotti di un catalogo • Mettere in pratica le best pratices del technical writing.
Non sempre riusciamo a soddisfare appieno i bisogni informativi primari dei destinatari della documentazione
• Correttezza e completezza • Fruibilità, usabilità, ricercabilità e filtraggio delle informazioni • Chiarezza • Coerenza di contenuti e presentazione • Traduzione e localizzazione.
Fatichiamo a soddisfare i bisogni informativi emergenti dei destinatari della documentazione e a fornire loro servizi a valore aggiunto
• Fruizione di immagini e video per facilitare la comprensione della sequenza delle operazioni da svolgere
• Disponibilità di informazioni contestuali, consultabili nel posto giusto e al momento giusto, anche grazie alla connessione fra mondo reale e contenuti digitali mediante codici QR o applicazioni di realtà aumentata (AR – Augmented Reality)
• Profilazione dei contenuti in base al destinatario per limitare il sovraccarico informativo • Accesso a informazioni integrate e aggregate, in modo tale da non dover consultare separatamente
più fonti per raccogliere i dati necessari • Disponibilità di strumenti per la condivisione di problemi e soluzioni • Accessibilità dei contenuti via mobile.
Rischiamo ripercussioni negative sull’azienda nel suo complesso • Aumento di tempi e costi di:
o Redazione, revisione e traduzione o Realizzazione della documentazione o Time-to-market del prodotto o Supporto commerciale pre-vendita o Assistenza tecnica post-vendita
• Minore soddisfazione del cliente • Potenziale passaparola negativo.
3
Perché e come utilizzare un CMS per realizzare documentazione tecnica e di prodotto più efficiente ed efficace
Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: [email protected]
Un CMS può aiutarci a superare questi punti di debolezza? Quale supporto offre un CMS per rendere più efficiente la gestione dei contenuti e più efficace la documentazione prodotta?
• Gestione collaborativa o Autorizzazioni o Gestione del flusso di redazione, traduzione e revisione, anche con il supporto di best
practices • Gestione dei contenuti basata sui principi di:
o Frammentazione (chunking) o Standardizzazione, anche con il supporto di glossari terminologici o Gestione univoca (single sourcing) o Strutturazione, anche con il supporto di normative e standard o Marcatura (tagging, con tag task- o reference-based e altri volti a specificare le condizioni di
riutilizzo) o Riutilizzo
• Configurazione automatica della documentazione in base ai tag • Produzione e formattazione automatica di documentazione multicanale per carta, web, mobile e
app (database publishing multicanale). Per esempio: o Manuali di installazione, uso e manutenzione o Tutorial, guide rapide, quick start, getting started o Help online o Guide ai messaggi di errore, troubleshooting o Documentazione “self-help” o Release note, con indicazione di novità, bug fix, bug noti e workaround o Documentazione interna per gli uffici tecnico, marketing, commerciale e amministrazione,
ecc. • Integrazione con altre fonti dati presenti in azienda.
Nel complesso, la separazione fra contenuto, documento e forma di presentazione, grazie all’uso di CMS o authoring tools e di sistemi database publishing multicanale permette di ottimizzare la gestione dei contenuti e massimizzarne la resa, rispondendo adeguatamente ai bisogni informativi dei destinatari e attivando nuovi servizi knowledge intensive per utenti interni, forza vendita, partner e rivenditori, installatori, utilizzatori, manutentori, ecc.
Da costo, il contenuto si trasforma in una risorsa a supporto della messa in pratica della strategia aziendale.
Un CMS, da solo, non basta! L’importanza del metodo Un CMS, da solo, non garantisce il raggiungimento dell’obiettivo di rendere più efficiente la gestione dei contenuti e più efficace la documentazione prodotta.
Alcuni fattori organizzativi e metodologici concorrono in modo determinante al buon esito del progetto di adozione di un CMS:
4
Perché e come utilizzare un CMS per realizzare documentazione tecnica e di prodotto più efficiente ed efficace
Kea s.r.l. | Via Strà, 102 | 37042 Caldiero (VR) | www.keanet.it Tel. / Fax: +39 045 6152381 | E-mail: [email protected]
• Coinvolgimento attivo dell’organizzazione con definizione chiara di ruoli, obiettivi e flussi di lavoro • Definizione di regole redazionali ispirate a normative, standard e best practices
o Attività di alfabetizzazione e formazione all’interno dell’azienda • Migrazione ragionata dei contenuti all’interno del CMS basata sui principi di:
o Standardizzazione o Univocità
Concetti uguali vanno espressi in modo uguale e inseriti una sola volta all’interno del CMS
o Frammentazione e granularità I contenuti vanno frammentati in modo tale da poter esistere come contenuto
stand-alone, ma da risultare anche componibili con altre unità elementari per creare un flusso logico di informazioni
o Classificazione mirata a facilitare la consultazione dei contenuti da parte di utenti interni e destinatari della comunicazione tecnica
o Marcatura volta a specificare le condizioni di riutilizzo del contenuto.
Perché privilegiamo i CMS rispetto agli authoring tools basati su XML ? Come i CMS, anche gli authoring tools basati su XML supportano la gestione strutturata dei contenuti, l’adesione a normative, standard e best practices, nonché il database publishing multicanale.
In questa sede privilegiamo i CMS, perché – nella media – dispongono di un’interfaccia utente più intuitiva, sono più facili da utilizzare per technical writer e product manager, e hanno quindi una buona curva di apprendimento.
5
Perché e come utilizzare un CMS per realizzare documentazione tecnica e di prodotto più efficiente ed efficace
![PresentazioneTamasi APT-PMS New Rev4 [modalità compatibilità] · PMS Aeroportuale che risulti efficace, efficiente e funzionale. L’Osservatorio intende formalizzare un gruppo](https://static.fdocumenti.com/doc/165x107/5f02328e7e708231d4030ea3/presentazionetamasi-apt-pms-new-rev4-modalit-compatibilit-pms-aeroportuale.jpg)
![Elementipiastra 12032013.ppt [modalità compatibilità] · È ora possibile eseguire con le solite tecniche l ... La formulazione di un efficiente ed efficace elemento finito di piastra](https://static.fdocumenti.com/doc/165x107/5ba5594b09d3f2634c8ca889/elementipiastra-modalita-compatibilita-e-ora-possibile-eseguire-con-le.jpg)
