Negli ultimi anni abbiamo assistito alla diffusione di strumenti di authoring sempre più versatili, dotati di un numero crescente di funzioni intelligenti. Ma dobbiamo domandarci che cosa ne è stato dell'arte di produrre contenuti di buon livello. Stiamo correndo il rischio che il grande interesse suscitato da programmi sofware sofisticati metta in ombra la necessità di scrivere testi esaurienti e di qualità?

La documentazione software è nata con lo scopo di aiutare l'utente ad implementare le varie applicazioni. Dai manuali stampati degli inizi, la documentazione è venuta assumendo svariate forme, riconducibili a due categorie principali: guide in linea, spesso integrate nel programma, e guide cartacee.

L'evoluzione degli strumenti di authoring è andata di pari passo con quella della documentazione. RoboHelp, FrameMaker, Doc-To-Help, HTML Help Workshop e Author-it sono solo alcuni degli strumenti di authoring più conosciuti al momento. Dispongono tutti di funzionalità per la generazione automatica dell'indice, la memorizzazione dei contenuti in un database relazionale, la pubblicazione sul Web, l'importazione e l'esportazione di testo da e verso il formato XML e così via. Indubbiamente, facilitano le operazioni di riutilizzo e di aggiornamento dei contenuti. Le soluzioni più avanzate per la gestione della documentazione tecnica, oggi, sono gli strumenti di authoring ‘single source' che, a partire da un contenuto sorgente unico sono in grado di generare diversi formati di output.

Gli strumenti hanno avuto il sopravvento sul "mestiere"?

I vantaggi offerti da questi strumenti e dalle loro funzionalità sono ovvi; tuttavia, il loro crescente utilizzo ha prodotto effetti collaterali indesiderati. L'interesse suscitato da questi programmi software in alcuni dei redattori tecnici più giovani è talmente grande da portarli a pensare che la buona riuscita della documentazione tecnica sia il prodotto dell'"intelligenza" di questi strumenti, confondendo gli strumenti del mestiere con il mestiere di scrivere, e trascurando l'obiettivo principale: il contenuto. Un redattore tecnico che dichiara di utilizzare Microsoft Word, oggi, è decisamente fuori moda. Bisogna utilizzare uno di questi strumenti intelligenti o qualcosa di ancora più avveniristico. Sembra che trovare lavoro dipenda da quanti di questi strumenti è possibile citare nel proprio curriculum. Nei forum e negli incontri sulla redazione tecnica, ma anche nei gruppi di discussione, il dibattito verte spesso sugli strumenti e le tecnologie emergenti, sulle metodologie di misurazione, sulla metodologia Agile e argomenti simili. Accade raramente che i temi siano lo sviluppo dei contenuti e la qualità. Perciò, la maggior parte dei redattori tecnici è estremamente veloce a capire il funzionamento degli strumenti ma ha scarsa consapevolezza dei contenuti.

La documentazione di un prodotto, per essere di buon livello, deve guidare con semplicità l'utente al raggiungimento dei suoi obiettivi, e poco conta che sia stata prodotta con RoboHelp, Author-it o con l'antiquato Microsoft Word. Sulla documentazione di un prodotto non è stampigliata la scritta "Sviluppata con i migliori strumenti di authoring" e non si conoscono casi di clienti che abbiano espresso preferenze per l'uno o per l'altro di questi strumenti.

I vantaggi offerti da questi strumenti sono indiscutibili ma occorre ricordare che, almeno per ora, non sono di grado di produrre contenuti, e che anche le funzionalità più sofisticate non li possono sostituire. È ancora necessario un redattore per creare i contenuti, e lo scopo di questi strumenti è quello di renderli più navigabili e utilizzabili. In nessun modo la flessibilità e le funzionalità di navigazione possono sopperire alla mancanza di contenuti accurati e di buona qualità. I collegamenti ipertestuali e i paragrafi a scomparsa o le funzioni di ricerca rapida possono aiutare a scorrere velocemente un documento, saltando da un punto all'altro, ma se l'utente non trova le informazioni che cercava, oppure se queste sono incomplete, si produrrà in lui un sentimento di frustrazione.

Impatto sulla catena del valore

Abbiamo tutti sentito parlare di locali che hanno un enorme successo vendendo un'unica specialità alimentare la cui ricetta è difficile da imitare. Per continuare a svolgere la loro professione, il redattore tecnico dovrebbe essere come uno chef che prepara un piatto prelibato: il creatore del contenuto. Il loro obiettivo dovrebbe essere quello di creare contenuti di qualità, che aggiungano valore a tutte le tappe della catena del valore, non quello di diventare degli esperti in strumenti informatici. Una documentazione più efficace significa meno chiamate al servizio di assistenza, traduzioni verso altre lingue con un rapporto qualità prezzo più interessante, aumento delle vendite e così via.

Inoltre, ha un effetto collaterale di segno positivo: i redattori tecnici che conoscono bene il mestiere della scrittura possono collaborare ad attività secondarie di marketing, come le newsletter e altri tipi di comunicazioni che un'azienda ha necessità di far circolare con regolarità.

I punti chiave

La creazione di contenuti efficaci non è un compito facile ed è ciò che fa la differenza tra un professionista e un dilettante. Per contribuire alla riuscita della documentazione, il redattore tecnico deve conoscere bene le funzioni del prodotto e le esigenze di mercato che deve soddisfare. Un redattore tecnico che vuole distinguersi deve tenere a mente i seguenti punti chiave:

• Conoscere bene il prodotto. È impossibile descrivere un prodotto, o un posto, che non si è visto.

• Il documento deve essere ben strutturato. È necessario avere la capacità di valutare quali informazioni inserire, e in quale sequenza, e quali possono essere omesse.

• Stabilire il livello di dettaglio idoneo a ciascun argomento; non ha senso descrivere tutto ogni volta.

• Individuare gli argomenti che richiedono riferimenti incrociati ad altri argomenti o a sezioni di approfondimento ("Ulteriori informazioni"). Disseminare i documenti di riferimenti incrociati è come mettere indicazioni stradali per tutto il tragitto.

• Compilare un indice delle voci pertinente. Un eccesso di voci di indice è solo uno spreco di tempo e di risorse. Regole di buon senso come "almeno duecento voci per ogni argomento" contribuiscono solo ad aumentare le dimensioni del documento, non hanno alcuna utilità per l'utente.

• Lo stile deve essere semplice e accurato. L'intento non è quello di stupire l'utente con una prosa ricercata; uno stile essenziale va benissimo.

• Rileggere, tornare a rileggere e poi ancora. I passi precedenti vanno ripetuti in sequenza sino a che il documento non è pronto per essere riposto sullo scaffale.

• Spingersi oltre, arricchire il contenuto. Le regole e le pratiche aziendali non possono contemplare tutte le situazioni; perciò, bisogna immaginare quali sono le necessità di documentazione dello specifico prodotto e colmare le lacune.

Se poi il redattore, oltre ad essere bravo nel produrre contenuti, è anche un esperto informatico, ben venga. Ma se non lo è, non è un problema. Le competenze nell'utilizzo degli strumenti informatici possono essere apprese via via; si impara ad usare una funzionalità quando se ne ha bisogno. Alcune compagnie hanno sperimentato con successo il seguente modello: i redattori con più esperienza creano i contenuti e approfondiscono le loro conoscenze sull'argomento mentre i redattori più giovani si occupano della creazione della libreria, della pubblicazione di diversi output servendosi di uno strumento di authoring single-source, di "traghettare" il contenuto da uno strumento di gestione dei contenuti a un altro e così via.

Il nocciolo è il contenuto

Nelle aziende che producono software, una buona parte dei problemi segnalati dai clienti trae origine da una documentazione di scarsa qualità. Ciò provoca un effetto a catena che conduce, alla fine, all'aumento dei costi e del carico di lavoro per l'azienda, che si vede costretta ad assegnare molto personale ai servizi di assistenza.

L'effetto domino può essere evitato se i redattori tecnici conoscono il loro mestiere e non si accontentano di diventare esperti nell'utilizzo di strumenti di authoring. Le nuove tecnologie facilitano la vita; non stiamo sostenendo che vadano ignorate. Ma il fulcro è il livello qualitativo dei contenuti, che potranno trovare validi alleati negli strumenti informatici e nelle tecnologie. Il settore del software è caratterizzato da una certa volubilità; gli strumenti che usiamo oggi verranno scartati e sostituiti da altri più nuovi e sofisticati. Perciò, i redattori tecnici che confondono l'abilità nell'utilizzo degli strumenti di authoring con la professione, faranno la stessa fine dei loro strumenti.

Ricordate la crisi della New economy? Molte aziende che operavano via Internet hanno chiuso i battenti non perché vi fosse scarsità di designer di pagine Web ma per l'insufficienza di fornitori di contenuti. Le cose non vanno molto diversamente per la redazione tecnica: il successo di un prodotto non si scrive con utensili sofisticati e contenuti "precotti".

Scritto da: Ramana Murthy, Senior Technical Writer at CA, India

www.ca.com

tratto da tcworld Marzo 2010

Traduzione fornita da Ic.Doc Srl