Ora che è tutto online, molti clienti ci chiedono pareri sul mezzo più adatto per distribuire la documentazione tecnica e i manuali. Con la diffusione dei PC e l’avvento di tablet e smart phone, soprattutto qui in Italia dove siamo molto sensibili alle mode, c’è la tendenza a voler tutto online. In questa frenesia è facile confondere i termini e parlare di documentazione online, indipendentemente dal formato per cui è stato pensato il singolo documento.

In questo post vorrei analizzare i due formati, PDF e guide in linea, quando vengono usati online. Partiamo dalle definizioni date da Wikipedia:

“Portable Document Format (PDF) is a file format used to represent documents in a manner independent of application software, hardware, and operating systems.[1] Each PDF file encapsulates a complete description of a fixed-layout flat document, including the text, fonts, graphics, and other information needed to display it. In 1991”

“Online help is topic-oriented, procedural or reference information delivered through computer software. It is a form of user assistance. Most online help is designed to give assistance in the use of a software application or operating system, but can also be used to present information on a broad range of subjects. When online help is linked to the state of the application (what the user is doing), it is called Context-sensitive help.”

Premessa

Il mio obiettivo è quello di concentrarmi sulle caratteristiche dei due formati nell’ambito della user assistance rispetto a software, dispositivi elettronici o sistemi meccanici. Esula da questo post parlare di altri usi (es.: compilare dei moduli PDF), o tantomeno disquisire sulle potenzialità del formato PDF nella stampa.

Premetto che sono di parte: la mia prima guida in linea l’ho realizzata nei primissimi anni ‘90 (!!), per il primo SCADA (Supervisory Control And Data Acquisition) italiano realizzato in ambiente Windows. La lungimiranza dei miei responsabili di allora, freschi di una formazione al MIT (Massachusetts Institute of Technology), mi portò a creare una guida in linea e non il classico documento cartaceo.  Realizzato, prima con delle macro in MS Word, poi con Robohelp in formato Winhelp.

Manuali cartacei

Per quanto riguarda i manuali tecnici, il PDF da stampare è suggerito quando c’è la necessità di stampare il documento, o parte di esso per esempio:

• Manuali installazione, uso e manutenzione richiesti dalla Direttiva Macchine
• Fogli istruzione
• Dispositivi elettronici per cui si vuole allegare alla confezione una guida stampata
• Fascicolo Tecnico, con tutti i suoi schemi
• .. tutto ciò che deve essere stampato

Manuali online in formato PDF

Se un manuale viene stampato in formato PDF e consultato online, viene chiamato “manuale online”, ma resta sempre un documento di una o più pagine di una certa dimensione, con un sommario e ultimamente la possibilità di cercare nel documento dei testi.

Per ridurre i costi di stampa è stato utilizzato spesso in sostituzione del manuale cartaceo.

In questi ultimi anni, dalla prima uscita della Technical Communication Suite della Adobe (i nostri primi esempi risalgono al 2008), il PDF online può essere arricchito di video 3D interattivi. Nel caso di procedure di smontaggio/montaggio, è molto intrigante poter osservare un oggetto in tutte le sue dimensioni, espanderlo e ingrandendone i particolari.

Detto questo, vediamo le caratteristiche dei manuali PDF quando vengono consultati online:

• Il layout della pagina è fisso, pensato appunto per essere stampato. Se mostrato su un PC con un monitor 19” o su un tablet di 7” resta sempre lo stesso.
• La risoluzione delle immagini è quella proposta in fase di creazione del PDF, quindi che l’immagine venga stampata (e chieda alta risoluzione) o che venga guardata online (e chieda una risoluzione inferiore) la risoluzione è una sola.
• Se il manuale è di 400 pagine, anche il PDF online è di 400 pagine. L’autore potrà esser molto in gamba a creare un sommario breve, ma sarà sempre un sommario molto denso. Nel caso venga consultato online il documento risulta molto pesante da scorrere, e le informazioni molto difficoltose da cercare.
• La consultazione di un PDF è comunque sequenziale: una pagina dopo l’altra con frequenti salti al sommario per passare ad altri capitoli.
• La struttura del documento è “piatta”: non c’è modo se non modificando il layout o gli stili, di far percepire all’utente un diverso peso degli argomenti. Tutta la valanga di informazioni è buttata lì davanti agli occhi di chi legge con il risultato di sovraccaricare il lettore, che non riesce a trovare ciò che cerca.

Guide in linea (online help)

Le “guide in linea” sono nate appunto, per la consultazione online, e dedicate all’inizio esclusivamente alle applicazioni software. Aiutano l’utente a trovare l’informazione giusta nel momento giusto.

Vediamo le caratteristiche base delle guide in linea:

• Il formato delle pagine è HTML con tutte le sue potenzialità (layout e caratteri ridimensionabili, portabilità su più sistemi operativi, e così via)
• La risoluzione delle immagini è adatta alla consultazione online.
• La dimensione finale del manuale è invisibile all’utente: per esempio noi realizziamo guide in linea che in Word sono circa 3.000 pagine. Chi consulterebbe un manuale A4 di 3.000 pagine?
• La guida in linea può essere personalizzata in base a chi la consulta. Si possono costruire percorsi per invitare un utente a leggere solo i contenuti di suo interesse.
• La strategia di navigazione è pensata dall’autore per far sì che il lettore non si perda ma che arrivi presto a ciò che cerca.

Vediamo ora le caratteristiche un po’ più avanzate delle guide in linea:

• In una guida in linea posso mostrare gradualmente l’informazione, nascondendo certe parti in modo che l’utente le scopra solo quando servono. in questo modo evito di sovraccaricare la consultazione.
• Il contenuto può essere consultato in locale sul proprio PC o scaricato automaticamente dal server dell’azienda senza che l’utente se ne renda conto. Questo è vantaggioso per essere sicuri di avere sempre l’ultima versione della guida.
• Le immagini possono apparire nella loro dimensione naturale solo se quando l’utente lo desidera.
• Trattandosi di contenuto online è possibile creare una community, rispondendo a domande degli utenti e mantenendo così attuali e corretti i contenuti della guida.
• Una guida in linea può contenere altre guide in linea, anche in modo dinamico. Questa è una caratteristica importante per software complessi o per software dove si implementa lo sviluppo Agile.
• e tante altre caratteristiche peculiari alla user assistance online.

Conclusione

Quindi se si vuole portare i propri contenuti “online” occorre fare le giuste considerazioni prima di decidere se creare un PDF oppure una guida in linea.

Come sempre ad aiutarci a decidere sarà l’analisi del tipo di destinatario e l’uso che farà del documento, poi occorrerà considerare la scelta dello strumento di redazione e il periodo necessario per conoscerlo, e poi soprattutto la conoscenza dei fattori di progettazione: organizzazione delle pagine, modalità di scrittura, navigazione, scelta di elementi grafici, convenzioni e regole redazionali e scelta delle caratteristiche utili.

Fatto tutto ciò si può partire!

Come è accaduto per i primi siti web costruiti in HTML che avevano tutto dell’HTML tranne che essere usabili e chiari, il rischio di passare dai contenuti per PDF a guide online è proprio questo: sfruttare tutte le caratteristiche del software di redazione senza valutare l’effetto sul destinatario. Attenzione quindi: sempre un occhio alla semplicità e efficacia dei contenuti!