La mobilità e i requisiti per la documentazione tecnica

La documentazione mobile ha rivitalizzato la discussione sulle nuove forme e sulla documentazione multimediale. In futuro leggeremo le istruzioni sull'e-book reader o ci faremo leggere le sequenze di azioni dallo smartphone? Il seguente articolo presenta lo spettro di possibilità della documentazione online o mobile.

Sempre più spesso la documentazione tecnica è distribuita elettronicamente. Infatti, questo permette notevoli vantaggi sui costi.

 

La documentazione mobile non comporta grandi cambiamenti, ma la possibilità di visualizzare le istruzioni su un tablet o addirittura su uno smartphone dimostra che anche la documentazione per l'hardware può essere online. Infatti, è assolutamente possibile che un consumatore legga le istruzioni per il suo rasoio elettrico sul tablet. Oppure che il tecnico addetto all'assistenza di una centrale eolica si faccia leggere le istruzioni passo per passo dal suo smartphone.

Fig. 1: la documentazione mobile promette di essere sempre a vostra disposizione e aiutarvi anche nelle situazioni più difficili.

Elettronica, online e mobile

Spesso si parla semplicemente di documentazione online, indipendentemente dalla forma e dal mezzo di distribuzione. Ecco le differenze principali:

• Documentazione elettronica: qualsiasi tipo di documentazione distribuita tramite mezzi elettronici, per esempio su CD o via Internet.
• Documentazione online (in senso stretto): qualsiasi tipo di documentazione a cui si accede direttamente tramite Internet, cioè ogni volta che se ne ha bisogno.
• Documentazione mobile: qualsiasi tipo di documentazione adatta o specificamente concepita per essere visualizzata su un dispositivo mobile.

Strumenti che ci cambiano la vita

Chi immagina ancora di telefonare a qualcuno per chiedere un numero di telefono? Oggigiorno viene naturale cercare l'informazione su Internet. Cercare una parola sul dizionario, consultare gli orari dei treni, confrontare i prezzi, fare acquisti, rimanere in contatto con le persone – la rete offre numerose possibilità che ovviamente vengono sfruttate. Internet ha cambiato profondamente o addirittura rivoluzionato la vita di molte persone.

Gli smartphone e i tablet con accesso a Internet sono il prossimo passo logico in questa direzione, visto che consentono di reperire rapidamente le informazioni in qualsiasi luogo. Tutto ciò che riusciamo a digitalizzare può essere usato comodamente dalla poltrona.

I proprietari di smartphone sanno bene quanto poco tempo ci voglia per abituarsi a consultare rapidamente Internet: per sapere l'orario del prossimo autobus, conoscere il prezzo di un articolo di marca o verificare la definizione di un termine su Wikipedia per dirimere una discussione. Le informazioni sono costantemente disponibili e facilmente accessibili grazie ad applicazioni specifiche.

Il ruolo della documentazione tecnica

Anche la documentazione tecnica si sta trasformando in un medium disponibile in ogni luogo? Osserviamo innanzitutto la varietà della documentazione tecnica:

• la descrizione di numerosi prodotti diversi, dal rasoio alla centrale nucleare;
• diversi tipi di documentazione, dalle istruzioni per l'uso al catalogo dei pezzi di ricambio, oppure forme speciali come le istruzioni rapide, i tutorial, le guide sintetiche;
• e il diverso bisogno di informazioni degli utenti, ad esempio per un apprendimento sistematico, la consultazione di dati o la risoluzione di problemi.

Per tutto questo abbiamo sviluppato documenti che di solito sono disponibili in forma cartacea o come file PDF. Non sarebbe dunque utile sviluppare libri elettronici, distribuire tutorial in formato video e cataloghi dei pezzi di ricambio come banche dati? Lo facciamo da tempo, ma non sfruttiamo ancora a pieno il mezzo a nostra disposizione.

Dal libro alla documentazione online

Al momento scriviamo ancora i libri, facendo ricorso alla nostra ampia ma spesso inconsapevole conoscenza di essi. Creiamo i documenti PDF secondo le stesse regole, solo che li memorizziamo in formato elettronico.

La documentazione online ha ancora ampie possibilità di sviluppo, allontanandosi sempre più dalla carta. Spesso evoluzioni simili si protraggono per decenni, come dimostrato dall'esempio delle automobili: le prime auto erano carrozze modificate. Le vetture hanno conservato questa forma per molto tempo, con le ruote a raggi, i parafanghi e la cappotta apribile. Solo poco a poco l'automobile si è trasformata in un veicolo completamente diverso che oggi non ha più nulla in comune con le carrozze. Lo stesso potrebbe accadere alla documentazione tecnica: la documentazione online deriva da quella stampata e inizialmente ne conserva l'aspetto, come i PDF o gli e-book.

Tuttavia, si stanno sviluppando forme nuove che non si fondano sui documenti cartacei quanto piuttosto sulle esigenze, cui rispondono con soluzioni autonome.

Le caratteristiche della documentazione online

Il vantaggio della nuova forma è la riduzione dei costi. La documentazione non deve essere stampata, non c'è bisogno di magazzini e gestione. Inoltre, risulta più rapidamente disponibile, il redattore tecnico non deve prevedere i tempi di stampa, basta memorizzare i file e metterli a disposizione su mezzi elettronici.

Si ha un ulteriore vantaggio, se il produttore pubblica la documentazione su un server in una forma tale da non richiedere il download da parte dell'utente. In questo modo la documentazione può essere aggiornata facilmente. Sul server esiste sempre solo il manuale d'istruzioni attuale e il cliente non può possedere eventuali versioni obsolete.

Dal punto di vista dell'utente

Secondo molti utenti, la lettura a schermo è scomoda. L'esperienza però dimostra che ormai ci si è abituati a leggere almeno testi brevi anche dallo schermo.

Un'altra caratteristica tipica è possibilità di eseguire ricerche e quindi di reperire rapidamente informazioni particolari. Anche un indice chiaro e immagini a colori contribuiscono a trovare rapidamente l'informazione necessaria.

Quando si tratta di addestrare nuovi collaboratori, i manuali d'istruzioni stampati sono più utili. L'esperienza dimostra che questo tipo d'istruzioni viene comunque stampato dagli utenti.

Le possibilità d'interazione

Il vantaggio fondamentale dell'attuale tecnologia Internet è la possibilità d'interazione. Le pagine non sono statiche e sempre uguali, bensì possono essere adattate all'utente o utilizzate in modo differente. Inoltre, l'utente ha la possibilità di creare note proprie.

Per la documentazione tecnica, questa caratteristica potrebbe avere le seguenti conseguenze:

• I manuali d'istruzioni moderni consentono all'utente di integrare singole pagine con riferimenti propri o di porre delle domande. Entrambe le cose possono essere utili per altri utenti.
• La pubblicazione centrale può essere sfruttata anche per migliorare continuamente le istruzioni. Soprattutto nel caso di nuovi prodotti, è difficile valutare quali domande possano sorgere tra gli utenti oppure dove emergano incertezze.
• Pubblicando le istruzioni su Internet, senza la possibilità di download sul proprio computer, il manuale può essere migliorato continuamente con l'aiuto delle indicazioni e delle domande.
• Gli argomenti possono esser dotati anche di una funzione per esprimere un proprio giudizio: "Questa informazione è stata utile?" È possibile quindi migliorare la documentazione in base ai punti raccolti e alle indicazioni fornite.
• Nel caso di sistemi molto articolati, può essere utile classificare i risultati delle ricerche mettendo ai primi posti i contributi migliori o quelli redatti dagli autori con la valutazione migliore.

La multimedialità offre molteplici possibilità d'interazione:

• I meccanismi di funzionamento possono essere illustrati efficacemente, quando le immagini sono animate e l'utente ha la possibilità di controllare il processo.
• Un dispositivo può essere controllato e vissuto direttamente sullo schermo grazie alla simulazione, completata dalle istruzioni o dalla struttura del menu animato con il ramo selezionato.

L'utilità di tali strumenti è dimostrata dal simulatore di volo. L'utente può provare anche situazioni estreme senza pericoli.

La statistica dei visitatori

Con quale frequenza e per quanto tempo viene letta un'istruzione? Quanti utenti vi accedono? I manuali cartacei non sono in grado di fornire queste informazioni, ma può farlo la documentazione online con una statistica delle pagine (figura 2). Allo stesso modo le chiavi di ricerca e le pagine visitate consentono deduzioni sul comportamento degli utenti (figura 3).

Fig. 2: una statistica delle pagine mostra quali pagine sono lette di frequente e quali non sono visitate mai.

Fig. 3: per ogni visitatore, vengono memorizzati il percorso e la durata della lettura.

Integrazione

Può essere assolutamente utile raccogliere i gruppi di utenti in una community, rivolgersi a essi come comunità e sfruttare la comunicazione. Chat, forum e speciali azioni di marketing mirano a creare un senso di appartenenza, a consentire uno scambio tra utenti e a canalizzare i feedback, sfruttandoli ad esempio per il miglioramento dei prodotti e della documentazione tecnica. Così facendo, però, è chiaro che la documentazione non può essere redatta una volta per tutte e messa da parte. Al contrario, la documentazione vive e, insieme alla hotline, all'assistenza e allo sviluppo del prodotto, forma un sistema di sostegno reciproco.

Nuove funzionalità

I dispositivi mobili, come gli smartphone, sono dotati di componenti aggiuntivi che creano nuove possibilità: gli smartphone conoscono la posizione attuale grazie al GPS, sanno chi è il loro proprietario e tramite la fotocamera e il Bluetooth sono in grado di leggere i dati ambientali.

Identificazione: gli smartphone possono leggere i codici a barre di un dispositivo e assicurare che sia disponibile il manuale d'istruzioni corretto. Per esempio, può essere interessante dotare di codici a barre i componenti di un impianto. In questo modo il tecnico dell'assistenza, per esempio, può consultare rapidamente la relativa documentazione sul proprio tablet.

Anche a casa, però, se un codice a barre permette di reperire la documentazione su Internet, si evita la noiosa ricerca del manuale d'istruzioni corretto.

Personalizzazione: tramite i dati personali dell'utente, si può pensare di adattare ad hoc la documentazione. Ogni gruppo target riceve così l'informazione adatta, per esempio in base alla lingua o ai requisiti tecnici.

Nuovi formati

La documentazione tecnica è sviluppata prevalentemente per la stampa. Almeno molti redattori hanno in mente testo e immagini mentre stilano le istruzioni. Spesso ne risultano formati come i PDF e gli e-book.

Basandosi di più sull'applicazione, sarebbero più utili altri formati: sono diffusi ormai tutorial, come screencast o video. I tutorial sono introduzioni a fondamenti teorici o all'utilizzo. Particolarmente interessanti sono i video-tutorial, come ce ne sono anche su Youtube. Di solito un tutor presenta un'azione e fornisce spiegazioni. Questo tipo di fruizione è molto più piacevole rispetto alle stesse informazioni presentate in forma testuale. Soprattutto la combinazione tra immagini e spiegazione orale è altamente informativa e corrisponde alle nostre abitudini percettive.

Bisognerebbe pensare anche a delle istruzioni con testo e immagini. Un'immagine di grandi dimensioni con una didascalia, eventualmente letta tramite sintesi vocale, veicola le informazioni in modo più visivo. Poiché nella documentazione elettronica il numero delle pagine e i costi di stampa non hanno alcuna importanza, il redattore tecnico può impiegare una maggiore quantità di immagini e concepire il manuale d'istruzioni come libro illustrato.

Ricerca degli errori e banca dati delle conoscenze

Ancora più comode sarebbero istruzioni orali passo per passo, ad esempio con l'ausilio di smartphone e auricolari: l'azione viene visualizzata sul display e letta ad alta voce. L'installatore esegue direttamente l'azione e passa alla fase successiva con "avanti".

Anche la ricerca degli errori, che sulla carta è rappresentata da un diagramma di flusso, potrebbe essere più chiara. Tramite un dispositivo elettronico, il tecnico dell'assistenza sarebbe guidato in ogni fase dei controlli e potrebbe passare direttamente alla prossima fase utile della verifica in base al risultato.

Un altro esempio potrebbe essere una sorta di banca dati delle conoscenze, come quelle che esistono su Internet: tipicamente tutte le conoscenze sono memorizzate in una banca dati. Di solito l'utente vuole sfruttare queste conoscenze in modo mirato per trovare una soluzione a un problema. Certamente tutti si sono già trovati in una situazione simile e l'hanno risolta grazie a Internet. Ad esempio, se durante la programmazione in Visual Basic sorge un problema, si cerca di trovare i contributi dell'editore (in questo caso Microsoft) o di altri utenti tramite le proprie chiavi di ricerca. L'esperienza dimostra che l'utente può trovare soluzioni anche per i problemi più insoliti. Questo vale almeno per i prodotti utilizzati spesso nella prassi.

Istruzioni visuali

Il collegamento con la realtà aumentata è un'opzione per il futuro, ma potrebbe essere possibile tra non molto tempo. Un esempio: immaginate di trovarvi sulla Torre Eiffel, di osservare Parigi dall'alto e di riconoscere alcune attrazioni della città. Prendete lo smartphone, avviate un'applicazione e tenete il dispositivo davanti a voi come se voleste fotografare uno dei ponti sulla Senna. Sul display vedete il fiume, il ponte e sull'immagine il nome del ponte con le spiegazioni. Dal punto di vista tecnico, l'applicazione rileva la posizione, l'orientamento e la direzione dello smartphone, eventualmente analizza l'immagine della fotocamera e, in base ai dati 3D, aggiungono dati e testo. Trasferendo questo concetto alla documentazione tecnica, sarebbe possibile uno scenario simile: un tecnico indossa occhiali HMD (head-mounted display) e visualizza le istruzioni per una riparazione. In aggiunta all'immagine reale vede indicazioni, frecce e movimenti che lo aiutano durante le singole fasi del lavoro.

Applicazioni proprie

Con la tecnologia mobile, è nato un nuovo tipo di programma, le cosiddette "app". Spesso tali applicazioni non sono molto diverse da un sito Internet, ma ridotte al minimo indispensabile e quindi più chiare e facili da utilizzare. L'impiego delle app è assolutamente realistico anche nella comunicazione tecnica, ad esempio per far leggere allo smartphone le istruzioni passo per passo e per controllare il dispositivo con la voce.

Aspetti legali

Per ogni produttore, la sicurezza legale è un aspetto fondamentale. È consentito mettere a disposizione il manuale d'istruzioni in forma elettronica oppure deve essere fornita anche la documentazione cartacea? L'attuale volume dei documenti sulla comunicazione tecnica affronta questa questione in modo approfondito [1].

Conclusioni

La documentazione mobile e la documentazione online presentano solo lievi differenze. Tuttavia, grazie all'indipendenza dal PC, possono essere impiegate anche per l'hardware. Ne risultano numerose applicazioni interessanti, soprattutto se si riesce ad allontanarsi dalla documentazione cartacea, creando sistemi specifici orientati all'applicazione.

I principali vantaggi sono:

• più immagini e colori;
• più spazio (un gran numero di pagine non rappresenta un problema);
• le possibilità d'interazione;
• le nuove funzionalità.

In un primo momento appaiono sensati i formati abituali come i PDF, l'ePub e altri formati per e-book, perché consentono di salvare semplicemente i documenti cartacei esistenti nel formato adatto.

Un'analisi più attenta, però, dimostra che la documentazione online in senso proprio e i nuovi formati possono rendere la documentazione ancora più utile.

La pubblicazione centrale su un server, ad esempio, comporta grandi vantaggi: un controllo sulla fruizione, la comunicazione con i clienti e la possibilità di un miglioramento continuo.

Creando applicazioni innovative orientate alla pratica e di diretta utilità per gli utenti, si aprono opportunità completamente nuove.

I nuovi formati forniranno possibilità del tutto diverse di pubblicare istruzioni specializzate per la fruizione mobile.

Letteratura e approfondimenti

[1] Heuer, J.-U. (2011): Auswirkungen von neuen Medientechniken und -gewohnheiten auf Gesetzgebung und Rechtspflege. Schriften zur Technischen Kommunikation 15, pp. 65–74.

Dietrich Juhl lavora a Wiesbaden come consulente indipendente e autore. È specializzato in manuali d'istruzioni per software, per la telecomunicazione, nonché per la tecnologia di misurazione e di regolazione. Da molti anni si occupa di documentazione tecnica come docente e autore di libri. Il suo libro specializzato "Technische Dokumentation" (Documentazione tecnica) è ormai alla seconda edizione. Per le imprese, ha sviluppato un servizio per la pubblicazione della documentazione tecnica su Internet.