domenica 19 dicembre 2010

La Qualità nella documentazione tecnica: lo scalpello di Michelangelo... o la sua mente?

Mi sono laureato in Ingegneria a La Sapienza di Roma, nella storica sede di S.Pietro in Vincoli. La facoltà è ospitata in uno splendido edificio che in origine era un convento, adiacente ad una delle più antiche basiliche romane in cui è ospitato "Il Mosè" di Michelangelo, una delle sue opere più maestose.
photo © 2005 Vento di Grecale | more info (via: Wylio)

Più volte ho avuto occasione di ammirarlo ed ogni volta c'era un particolare che mi sorprendeva: una piega del panneggio che sembrava morbida come la seta, una vena che sembrava pulsare nel possente braccio sinistro, un particolare della barba o del viso che sembravano in movimento.

Quale tecnologia ha prodotto questa meraviglia? In apparenza, un banale scalpello. Simile a quelli che ho nella cassetta degli attrezzi per i lavori domestici.

C'è qualcosa di più rozzo di uno scalpello che vi possa venire in mente? Non lo so, forse si, ma poca roba. Eppure, messo nelle mani di un genio dell'umanità, ha prodotto qualcosa di meraviglioso. Mentre nelle mie mani al massimo serve a far da leva per sollevare il tombino di cemento che ho in giardino.

MA TUTTO QUESTO COSA A CHE FARE CON IL TECHNICAL WRITING?

Nelle offerte di lavoro che ricevo attraverso i siti di JobSearch, specialmente negli ultimi 2-3 anni, sono sempre più pressanti le richieste inerenti alla conoscenza di strumenti di Authoring largamente utilizzati (RoboHelp, FrameMaker, DocBook, HTML Help Workshop, DITA, ...) che negli ultimi 10 anni si sono progressivamente diffusi, specialmente nelle aziende medio-grandi.

Tali prodotti sono divenuti via via sempre più versatili e dotati di un gran numero di possibilità.

Dispongono di funzionalità per la generazione automatica dell'indice di un manuale, per la memorizzazione dei contenuti in un DB,  per l'attività di importazione/esportazione di testo da/verso il formato XML, per la pubblicazione sul Web e nei diversi formati generalmente utilizzati dagli utenti, in particolare PDF.

Indubbiamente, facilitano le operazioni di riutilizzo e di aggiornamento dei contenuti.

Lo stesso contenuto posso "montarlo" in 5 "schemi" diversi che possono generare 5 documenti diversi.
Quindi lo scrivo una volta sola, eventualmente lo traduco nella lingua che mi interessa una volta sola e lo utilizzo in 5 situazioni diverse senza dover fare "copia e incolla" ma attraverso una procedura automatizzata.
Quando questo contenuto deve essere modificato, modifico "il master" e poi propago la modifica ovunque mi necessita con un semplice click.

BELLO NO? Bellissimo! MA FATE ATTENZIONE!

Non confondete lo scalpello di Michelangelo (i sistemi di Authoring) con la mano di Michelangelo, che sta attaccata al cervello di Michelangelo che ospita la fantasia visionaria ed il genio di Michelangelo!

In altri termini, è utile conoscere tecnologie che sono in grado di velocizzare e razionalizzare il processo di produzione della documentazione tecnica. Ma tali strumenti cosa sono, nella loro essenza?

Sono dei "montatori di contenuti". E se non sappiamo scrivere e strutturare "i contenuti", cioè se non conosciamo "il mestiere di scrivere" e non applichiamo i suoi fondamentali nella realizzazione di ogni singolo contenuto, poi potremo montarli e rimontarli come vogliamo, con tutti i prodotti di Authoring di questo mondo, ma otterremo sempre un risultato scadente.

Dobbiamo quindi riflettere sull'idea che gli strumenti possano, ingannevolmente, prendere il sopravvento sul “mestiere”, pericolo tanto più subdolo quando si incarna nella skill request che viene specificata in un'offerta di lavoro.

Infatti, sembra che si stia facendo strada l'idea che trovare lavoro come Technical Writer dipenda da quanti di questi strumenti è possibile elencare nel proprio CV. Frequentemente, nei forum, il dibattito è imperniato sugli strumenti e le tecnologie emergenti, sulle metodologie di misurazione del proprio rendimento lavorativo (in termini di "pagine al giorno" o "documenti in un mese" o altro ancora), mentre accade di rado che i temi siano lo sviluppo dei contenuti e la loro Qualità.

I vantaggi offerti dagli strumenti di Authoring sono indiscutibili ma, almeno per ora, non sono di grado di produrre contenuti. E' ancora necessario un redattore per creare i contenuti e lo scopo di questi strumenti è quello di rendere più efficente e veloce la produzione e l'aggiornamento su larga scala di molti documenti diversi. Tutto qui.

Del resto, a cosa serve usare i collegamenti ipertestuali o le funzioni di ricerca rapida per scorrere velocemente un documento, saltando da un punto all'altro, se poi l'utente non trova le informazioni che cercava, oppure se queste sono incomplete?

La documentazione di un prodotto, se è di buon livello, deve guidare con semplicità l'utente all'uso efficace del prodotto e poco conta che sia stata prodotta con RoboHelp o DITA o con un "primitivo scalpello" altrimenti noto come Microsoft Word.
Su nessun manuale ho mai visto la scritta “Sviluppato con il miglior strumento di Authoring in commercio”.
Non ho mai conosciuto un cliente che abbia espresso preferenze sugli strumenti utilizzati per realizzare un Installation Manual o un Tutorial.

Quindi usiamo gli strumenti per quello che sono, traendone cospicui vantaggi di ogni genere, ma non infiliamo "la scorciatoia concettuale" di pensare che la Qualità di un documento derivi dallo strumento che usiamo per realizzarlo.

Se fosse vero, con il mio scalpello potrei scolpire capolavori come "Il Mosè" ogni giorno.
Invece non mi succede mai... :-).

Condividi


Articoli correlati per categorie



Nessun commento:

Posta un commento