Eventi

Modello procedurale per la creazione di documentazione tecnica

La strada verso una documentazione tecnica completa è tortuosa e accidentata. Specialmente coloro che hanno intrapreso da poco la professione, incontrano delle difficoltà nel lavorare sul loro primo manuale d'istruzioni. Il modello ALASKA, che definisce fasi precise e orientate all'obiettivo, offre un aiuto.
La comunicazione tecnica e la mediazione, che è un processo di risoluzione dei conflitti, non hanno nulla a che fare l'una con l'altra. O almeno così sembrerebbe ad un primo sguardo. Tuttavia, la mediazione è il principio base che viene applicato alla creazione delle istruzioni o dei manuali dell'utente. Rende le singole fasi del lavoro più comprensibili, dunque più facili da seguire. Questa procedura aiuta anche i professionisti del campo, non solo i neofiti, ad affrontare il proprio lavoro quotidiano in maniera molto migliore.

Da ALPHA a ALASKA*

La mediazione è un processo composto da cinque fasi consecutive:

A All about the order (tutto ciò che riguarda l'ordine)
L List of topics to be discussed (elenco degli argomenti da discutere)
P Peek at the underlying interests behind the various list items (sguardo agli interessi basilari dietro i vari punti dell'elenco)
H Eureka (nuova soluzione trovata)
A Agreement in the end (accordo finale)

Il processo di creazione della documentazione tecnica segue lo stesso schema. Il modello ALASKA, composto da sei fasi, è stato ricavato dall'APLHA [1]:

A All about the order (tutto ciò che riguarda l'ordine)
L List of topics, persons involved and framework conditions (elenco di argomenti, persone coinvolte e condizioni strutturali)
A Analysis of the product and of the target group (analisi del prodotto e del target group)
S Structural outline, research, write (organizzazione, ricerca, scrittura)
K Correcting and checking (correzione e controllo)
A At the end, release through the Technical Documentation department (infine, rilascio tramite il reparto di Documentazione Tecnica)

Il modello ALASKA si basa sull'assunto che la creazione di documentazione tecnica sia un servizio. Dunque, coinvolge il cliente, il fornitore di servizi e il redattore tecnico. Essi possono lavorare nella stessa azienda o in aziende diverse.
Il modello è stato sviluppato tenendo presenti i seguenti obiettivi:

  • Processo di creazione semplice, chiaro e trasparente
  • Soddisfare le esigenze del cliente

Tutto ciò che riguarda l'ordine: cosa vuole il cliente?

Scoprire tutto ciò che riguarda l'ordine è di aiuto perché:

  • definisce il prodotto da descrivere e l'obiettivo perseguito;
  • introduce il processo: la documentazione tecnica non può essere creata dal solo redattore tecnico; essa richiede la cooperazione del cliente e dei suoi colleghi;
  • chiarisce il punto di partenza;
  • fornisce la base per una successiva valutazione;
  • individua le aspettative e determina la divisione delle responsabilità per le singole fasi del processo.

Un buon punto di partenza è porsi la domanda, piuttosto banale, "Cosa posso fare per te?". Questa domanda evidenzia il fatto che il redattore tecnico si considera un fornitore di servizi. Inoltre, questa domanda incoraggia il cliente a far conoscere le sue idee e i suoi obiettivi. Durante il processo, il redattore tecnico verrà a conoscenza del prodotto da descrivere e il tipo di manuale di istruzioni che ci si attende dal punto di vista del cliente. Dopo di che, il redattore dovrebbe anche affrontare l'obiettivo del manuale:

  • Perché descrivere un prodotto?
  • Cosa ci si aspetta che il manuale cambi?

Gli obiettivi tipici sono la riduzione del numero degli errori di installazione e le lamentele dei clienti. Oppure, l'azienda potrebbe voler rispettare gli adempimenti previsti dalla legge sulla responsabilità del prodotto. Un altro obiettivo che è possibile presupporre è che il cliente voglia affrontare l'insoddisfazione dell'utente e agevolare l'utilizzo del servizio tecnico.
Saperne di più rispetto all'ordine vuol dire anche chiedere al cliente la forma in cui la documentazione tecnica debba essere creata. In questo modo, è possibile creare, in una fase iniziale, i prerequisiti per il layout desiderato, le traduzioni e i canali di pubblicazione.

Partiamo dal risultato

A questo punto, il cliente ha delineato il prodotto da descrivere, il tipo di manuale desiderato e il perché sia necessario. Quello che non conosce ancora è il processo da seguire per la creazione del manuale. Il processo può essere spiegato al cliente con l'aiuto del modello ALASKA.
L'organizzazione del modello ALASKA diventa evidente se partiamo dal risultato finale. Immaginate che un cliente si rivolga a voi, in qualità di scrittore tecnico, richiedendo un manuale di istruzione. Prima della pubblicazione, dovrà essere rilasciato. Ora, prima che qualsiasi cosa venga rilasciata, dovrà essere analizzata da varie persone e corretta dal redattore tecnico. Pre-requisito fondamentale a tal fine è l'esistenza di una bozza scritta del manuale, completa di punti generali. Prima ancora di creare un manuale di istruzioni è necessario conoscere sia il prodotto che il target group.
A questo punto, il redattore tecnico avrà dato un grande contributo alla creazione. Il cliente sa cosa ha voluto descrivere. Sa perché vuole la descrizione e avrà un'idea del processo di creazione. Tuttavia, c'è ancora molto margine per aspettative divergenti e incomprensioni tra il redattore e il cliente. Un modo per limitare questo margine è guardare al processo in modo astratto, con il supporto di una matrice. La matrice fotografa la situazione iniziale e la distribuzione delle responsabilità durante le varie fasi del processo di creazione. Inoltre, è consigliabile discutere, con l'aiuto della matrice, dei possibili ostacoli. In questo modo, le incomprensioni e gli ostacoli possono essere individuati in una fase iniziale ed eliminati. Questi aspetti sono sintetizzati nella seguente tabella, attraverso un esempio.

149_1
Fig. 2: violazioni del principio di elementarietà, granularità e autonomia dei termini

Ottenere chiarezza sulle aspettative e la distribuzione delle responsabilità allenta la pressione delle aspettative che grava sulle spalle del redattore tecnico. Stabilire i dettagli dell'ordine consente, a coloro che sono coinvolti, di identificare dove la responsabilità di ognuno abbia inizio e fine. In questo modo, sarà possibile individuare le incomprensioni prima che queste portino a delusione. L'individuazione delle aspettative e la definizione delle responsabilità, l'ordine diventa chiaro e preciso.

Elenco di argomenti, persone coinvolte e condizioni strutturali

Nel corso della prossima fase, il redattore tecnico coordinerà i processi di comunicazione con il cliente e il suo staff. Insieme a loro, il redattore tecnico individuerà le persone coinvolte. Durante il processo saranno rivolte le seguenti domande:
• Chi può fornire degli input in termini di contenuto?
• Quali documenti sono disponibili?
• Chi decide quali informazioni siano rilevanti ai fini del manuale? • In cosa consistono i processi di correzione e rilascio?
• Qual è l'esperienza del reparto di servizio con prodotti simili?
• Esistono in azienda delle linee guida per la creazione?
• Chi richiederà i documenti al redattore tecnico, e in quali momenti?

Nel corso del processo, il redattore tecnico dovrà avere un approccio di richiesta attiva delle informazioni. A tal proposito, il comportamento dei bambini può fare da modello: quando un bambino scopre qualcosa di nuovo, cerca di comprendere questa nuova esperienza o il nuovo oggetto, e pone continuamente delle domande. Allo stesso modo, il redattore tecnico dovrebbe porsi domande finché non sappia le esigenze del cliente.

Analisi del prodotto e del target group

Durante la terza fase, il redattore tecnico esaminerà sia il prodotto che il target group del manuale. Con l'aiuto dell'analisi del target group e l'analisi dei requisiti delle informazioni, il redattore troverà risposte a domande del tipo:

  • Esistono diversi target group?
  • Qual è il titolo di studio o la professione del target group?
  • Che tipo di vocabolario possiede il target group?
  • Che conoscenza pregressa del prodotto ha il target group? Ci sono delle riserve riguardo il prodotto?
  • Di quali componenti è costituito il prodotto?
  • In quali situazioni l'utente legge il manuale, ad esempio, all'aria aperta o in una cantina ammuffita?

Attraverso le risposte a queste domande, il redattore tecnico può definire l'adeguata vastità e profondità delle informazioni per il manuale da creare. Inoltre, comprende anche come può preparare e presentare le informazioni in una maniera appropriata per il target group. Per far ciò, possono essere utilizzati metodi come la tecnica dei personaggi, i Sinus-Milieus o la matrice chi-fa-cosa.

Organizzazione, ricerca, scrittura

Nella quarta fase inizia l'organizzazione e la scrittura dei compiti. I risultati delle fasi precedenti serviranno da punto di partenza. Durante la seconda fase il redattore tecnico e il cliente hanno identificato insieme le persone coinvolte; ora, nella quarta fase, il redattore tecnico sa a chi rivolgersi e quali fonti di informazioni ha a sua disposizione: specifiche tecniche, specifiche di requisiti, specifiche, libri bianchi, progetti ingegneristici, documenti della concorrenza, o linee guida per la creazione. Ora potrà cominciare a raccogliere i frutti delle fasi precedenti.
Il redattore tecnico ricercherà informazioni, le analizzerà e le verificherà. Le mancanze individuate saranno colmate, ad esempio per mezzo di interviste. Il contenuto sarà strutturato secondo le linee guida per la creazione o perfino utilizzando metodi di standardizzazione e organizzazione. Al fine di creare un buon manuale, potrà trarre assistenza da altri metodi di comprensione quali

  • Tecniche di intervista
  • Ricerche cognitive
  • Gestione terminologia
  • Standard e leggi

Se, durante questo processo, il redattore tecnico tiene conto dei risultati dei chiarimenti rispetto all'ordine (motivazione del cliente nell'avere il manuale scritto) e i risultati della terza fase (analisi del target group), avrà fatto un passo in avanti verso la creazione di un buon manuale in armonia con le aspettative del cliente. In questa quarta fase, il redattore tecnico dovrebbe essere guidato dall'idea che la scrittura è un metodo per specificare la tecnologia in termini precisi e che consiste sempre nell'adottare un approccio selettivo delle conoscenze disponibili. Ciò si ottiene controllando e revisionando costantemente il documento esistente. Il risultato di questa fase è una copia revisionata della documentazione tecnica.

Correzione e controllo

Il redattore distribuisce le copie revisionate alle persone interessate – risultato della seconda fase. Il controllo delle revisioni può essere fatto tenendo chiari in mente i seguenti aspetti:

  • correttezza tecnica;
  • allineamento o corrispondenza tra il manuale e il prodotto;
  • correttezza linguistica e grammaticale;
  • controllo sul manuale in termini di documentazione specifica e standard specifici di prodotto;
  • correttezza formale: aspetto esterno, facilità d'uso, design, orientamento, testo e illustrazioni.

Successivamente, il redattore tecnico adatterà il manuale ai risultati dei controlli e creerà la copia di rilascio. Al termine di questa quinta fase, dovrebbe essere pronta una copia del manuale revisionata e approvata. A questo punto il lavoro dell'editore è ulteriormente semplificato dato che può sempre tornare indietro ai risultati della fase precedente. Il termine del processo di creazione coincide sempre con il termine del processo di sviluppo del prodotto, dunque, è una fase in cui gli sviluppatori e i product manager subiscono una pressione enorme. Può essere molto utile, durante questa fase di lavoro molto intenso, non avere necessità di discutere delle responsabilità, ma fare riferimento soltanto a quanto concordato in precedenza. Questo riduce lo stress delle persone coinvolte, minimizza le perdite di carico e aumenta le possibilità di successo.

Conclusione con il rilascio del manuale di istruzioni

Una volta controllato, il manuale viene rilasciato, tradotto e pubblicato. I tempi di rilascio, traduzione e pubblicazione della documentazione tecnica variano notevolmente in base alle aziende. Ecco perché questa fase non è elaborata in dettaglio nel modello ALASKA.
Nella fase conclusiva, gli scrittori tecnici e i clienti controllano se gli obiettivi sono stati raggiunti e valutano il progetto. A tale scopo, vengono aggiunte due colonne alla matrice creata durante la prima fase, rispettivamente "Situazione raggiunta" e "Ostacoli incontrati"  – si trovano nella tabella seguente. La matrice sarà di aiuto agli scrittori e ai clienti nelle loro attività future.
 
149_2

Riassunto

Il modello ALASKA organizza il processo di creazione di un manuale di istruzioni in modo chiaro e trasparente e può essere utilizzato in modo molto efficace nella scrittura tecnica. Allo stesso modo, le fasi chiare e rintracciabili del processo di creazione favoriscono l'aumento dei livelli di accettazione dei reparti di documentazione tecnica all'interno delle aziende. L'utilizzo del modello ALASKA  aumenta le possibilità di successo nella creazione di un manuale di istruzioni e nella soddisfazione e fidelizzazione dei clienti che in questo modo si rivolgeranno sicuramente allo stesso redattore tecnico per i lavori successivi.

149_goers_britta
 
Dr. Britta Görs è una redattrice tecnica/editrice e mediatrice aziendale. Ha creato manuali di istruzioni e cataloghi per prodotti tecnici in vari settori. Inoltre, tiene un corso avanzato in "Documentazione tecnica" presso l'Università di Rostock.
info(at)britta-goers.de
www.britta-goers.de
 

Questa è una traduzione di un articolo Tedesco pubblicato su 'technische kommunikation', rivista specializzata nella documentazione tecnica e sviluppo delle informazioni. Per maggiori informazioni, visitate www.tekom.de
Cliccate qui per leggere l'articolo originale in tedesco.
Scritto da Dr. Britta Goers

Link e bibliografia
Link all'articolo
[1] Görs, B. (2010): Vortragsunterlagen,
tekom-Frühjahrstagung, www.tekom.de/artikel/artikel_3036.html.

* Nota dall'editore: i modelli ALPHA e ALASKA sono di origine tedesca. Non tutte le iniziali del concetto sono state mantenute nella traduzione.

Bibliografia per approfondimenti
• Baumert, A. (2008): Professionell texten, Grundlagen, Tipps and Techniken, München.
• Göpferich, S. (2008): Textproduktion im Zeitalter der Globalisierung, Entwicklung einer Didaktik des Wissenstransfers.
• Hertel, A. v. (2008): Professionelle Konfliktlösung. Führen mit Mediationskompetenz, Frankfurt, New York.