Manuali tecnici: strumenti per crearli e gestirli

Nel primo articolo dedicato alla realizzazione dei manuali tecnici: La documentazione tecnica B2B industriale: una vista d’insieme, abbiamo parlato dei diversi tipi di documentazione e dei vari supporti, oltre al cartaceo, che puoi utilizzare per divulgarli.

Abbiamo anche accennato a nuove forme di comunicazione come la realtà aumentata e i webinar che possono trasformarsi ottime occasioni di comunicazione con gli interlocutori del tuo mercato.

In questo secondo articolo entriamo nel vivo della produzione partendo dalla decisione primaria: chi fa i cataloghi o i manuali tecnici?

Risorsa gratuita a fine articolo: Check list revisione documentazione tecnica

Vai alla video pillola: i concetti base in un minuto o poco più

Quali software per creare un manuale?

Nel settore B2B industriale esistono realtà con pochi prodotti e altre con decine se non centinaia di prodotti. Pensa ad esempio alle aziende di distribuzione di componenti industriali. Ogni componente ha una sua immagine e come minimo una tabella di caratteristiche tecniche. Non solo, dato che il prodotto può essere fornito con marchi diversi, le caratteristiche descrittive cambiano da marchio a marchio.

Questo è il caso in cui senza un software per creare il manuale la sua gestione e creazione diventa una incubo.  In questo campo, tale software si chiama: sistema di impaginazione automatica per realizzare la manualistica tecnica.

Cosa fa un sistema di impaginazione automatica?

L’impaginazione automatica è un sistema centralizzato di gestione della produzione dei cataloghi, manualistica tecnica, listini, che si basa su un database in cui vengono memorizzati tutti i dati relativi ai prodotti.

I dati sono separati dalla struttura grafica che viene integrata utilizzando nella maggior parte dei casi Adobe InDesign, il software di impaginazione più diffuso.

La gestione dei dati a livello di database significa che:

• se l’informazione (che può essere un dato tecnico ma anche una porzione di testo) cambia, viene aggiornata una sola volta nel database e in automatico si aggiornano tutti i documenti che riportano quell’informazione,
• facilità di modifica della grafica perché è scollegata dai dati. Realizzata la nuova grafica basta ripopolare il documento e si ottiene il nuovo catalogo,
• facilità nella gestione dei cataloghi multilingua: come abbiamo detto il dato si cambia solo una volta nel database e tutti i documenti che lo riportano vengono aggiornati in automatico,
• produzione multicanale: cartaceo, PDF, ePub, web, APP e altro,
• gestione collaborativa, ciascuno dipartimento aggiorna la sua porzione di dati. Il sistema gestisce le revisioni, i controllori, le approvazioni.

Ho elencato solo alcuni punti per darti un’idea della potenzialità dell’impaginazione automatica.

Se il volume di documentazione tecnica non è tale da giustificare questo sistema, la via da perseguire è quella dello sviluppo tradizionale.

Anche per i manuali tecnici, il marketer B2B è il responsabile dell’immagine dell’azienda

Se tra le tue attività non è già presente la gestione della manualistica tecnica è bene che ci fai un pensierino. Lo so hai già molte cose da fare, figuriamoci se ti prendi anche questa rogna.

Probabilmente i manuali tecnici sono gestiti dall’ufficio tecnico della tua azienda e probabilmente, pur sapendo che ne combinano di tutti i colori, preferisci non scoperchiare quel vaso di Pandora.

Mi spiace ma devo dirti che quel vaso lo devi proprio aprire. Mai come adesso l’informazione tecnica è uno strumento importante per la Customer nurturing e per la Customer experience e quindi avviare una più stretta collaborazione con l’ufficio tecnico sta diventando sempre più importante.

L'informazione tecnica è uno strumento importante per la Customer nurturing e per la Customer experience. #documentazionetecnica #manualisticatecnica #customerexperience Condividi il Tweet

Dalla manualistica tecnica si capisce che si tratta della tua azienda?

Ogni documento che rappresenta la tua azienda deve avere un tratto distintivo che lo riconduca ad essa. Una “impronta grafica” che faccia dire, questo è il catalogo della ACME, per esempio.

Se oggi i tuoi documenti tecnici hanno impostazioni diverse, il primo lavoro che devi fare è decidere quale impronta grafica vuoi dare e, ad ogni nuova ristampa, allinearli all’immagine aziendale che li renda riconoscibili nel tuo mercato di riferimento.

Ecco un esempio di come Bosch caratterizza la propria documentazione tecnica fin dalla copertina.

Redazione manuali tecnici: valutazione delle risorse

A seconda della dimensioni e della tipologia del prodotto, le aziende possono essere organizzate in diversi modi. Nelle realtà più grandi c’è un ufficio dedicato alla redazione dei manuali tecnici, nelle realtà più piccole è una delle tante attività dell’ufficio tecnico e, in entrambi i casi, sono coinvolte risorse interne.

La terza via è collaborare con una figura professionale specializzata nella redazione di manuali chiamata Technical writer o specialista di scrittura tecnica, o redattore di manuali tecnici.

Non è un lavoro semplice perché occorre comprendere appieno il funzionamento del prodotto e saperlo portare nella scrittura affinché sia fruibile da un determinato pubblico.

Per questo motivo, in genere, lo specialista di scrittura tecnica si dedica a certe tipologie di prodotto, poiché è diverso scrivere di un software o di una una macchina utensile.

Tra le risorse disponibili per questo articolo trovi una lista di elementi per la revisione della documentazione tecnica.

Come faccio a scegliere un Technical writer?

Hai deciso di affidarti a un Technical writer (TW), bene, la professionalità non si inventa. Ecco alcuni punti di cui devi tenere conto.

La distanza conta

Il TW dovrà parlare con il tecnico o i tecnici che conoscono il prodotto. Dovrà acquisire da loro la conoscenza da trasferire nel manuale. In una parola avrà bisogno di confrontarsi con loro. Se il professionista che hai scelto non può fisicamente recarsi in azienda, devi poter predisporre delle interviste telefoniche o, meglio, via Skype o similare. Avere un contatto in cui ci si possa guardare in faccia, anche se mediato dalla tecnologia, aiuta la relazione e ha effetti positivi sul risultato finale del lavoro.

Deve conoscere strumenti di Office Automation

Non solo elaboratore di testi (Word o similari) ma anche fogli di lavoro (Excel o similari) perché dovrà gestire le tabelle di dati. Se la tua azienda ha un sistema di impaginazione automatica una caratterista preferenziale sarà un’esperienza con tali sistemi. In caso contrario dovrai prevedere un corso di formazione.

Deve conoscere strumenti di lavoro collaborativo

Il lavoro di redazione può durare mesi ed è soggetto a diverse revisioni. Non puoi pensare che avvenga tutto via email perché è troppo dispersivo. Se la tua azienda non ha già un sistema collaborativo per la produzione di documentazione, puoi pensare di utilizzare strumenti come Google Drive e Google Docs.

Qualsiasi sia la tua scelta è importante che il sistema sia in grado di registrare ed evidenziate le modifiche apportate, chi e quando le ha inserite. Sono tutte funzionalità fondamentali per tenere traccia delle diverse versioni dei documenti soprattutto quando ci sono più persone coinvolte.

Deve essere capace di proporti un piano di lavoro

Un TW esperto conosce le dinamiche di produzione della documentazione tecnica quindi fin dal primo colloquio deve essere in grado di proporti un piano di massima del lavoro, indicandoti qual è la sua metodologia.

Deve sapersi relazionare con il grafico

Se già non utilizza sistemi di impaginazione elettronica deve essere in grado di trasferire le informazioni al grafico e di indicare come vengono impaginati i testi, le tabelle, le immagini, le didascalie, le note ecc.

Un redattore tecnico esperto conosce le dinamiche di produzione della documentazione tecnica quindi fin dal primo colloquio è in grado di proporti un piano di massima del lavoro. #technicalwriter #redattoretecnico #documentazionetecnica Condividi il Tweet

6 punti da verificare prima di avviare la realizzazione di un documento tecnico

Prima di entrare nel vivo dell’organizzazione del lavoro, cosa che faremo nel prossimo articolo, ti propongo questi sei punti che puoi verificare al tuo interno:

1. Ci sono normative particolari a cui è soggetto il tuo prodotto?

Se sì, individua quelle inerenti alla redazione dei manuali tecnici. Gli elementi che normalmente vengono normati sono: il contenuto minimo che deve essere presente nel manuale, la necessità o meno della traduzione nella lingua del paese di riferimento, l’utilizzo dei simboli grafici e pittogrammi per evidenziare un’avvertenza o un pericolo.

2. Individua la forma di comunicazione tecnica più idonea al tuo interlocutore

Tenendo presente il tuo mercato di riferimento, la competenza specifica o meno degli operatori destinatari del manuale devi individuare qual è il tono più appropriato.

3. Verifica se la forma di comunicazione attuale è veramente efficace con un test sul campo

Ad esempio se l’installazione del tuo prodotto richiede la presenza del personale della tua azienda puoi chiedere loro di svolgere l’installazione e la formazione facendo seguire all’operatore passo passo il manuale. Meglio non ripetere gli errori del passato.

4. Individua il supporto migliore per il manuale tecnico

Nella prima parte di questo articolo abbiamo visto i diversi supporti, su carta e digitali, utilizzabili per il manuale tecnico. Ricorda che il supporto scelto influisce sulla modalità di fruizione del manuale e dei suoi dati come tabelle e disegni tecnici

5. Individua i canali che vorrai utilizzare

Diciamo che la scelta primaria è di produrre il manuale cartaceo. Le stesse informazioni però possono essere utilizzate anche su altri canali. Ad esempio se pensi di realizzare anche la versione in PDF devi almeno progettare una navigazione per titoli e Hyperlink. E cosa dire dei webinar o dell’e-learning? Se prevedi fin dall’inizio l’utilizzo su canali differenti ti sarà più facile in seguito adattare le informazioni a ciascuno di essi.

6. Individua i tuoi SME (Subject Matter Experts)

Potresti avere più figure tecniche da coinvolgere a seconda delle parti del prodotto, ad esempio, l’ingegnere meccanico e quello elettronico. Per il tuo manuale devi capire chi è, o chi sono, le persone competenti per ciascun aspetto, saranno quelle alle quali sottoporre il documento per la revisione.

Nel prossimo articolo vedremo come realizzare in piano di lavoro e come gestire i tempi e le diverse fasi della realizzazione del manuale.

Nel frattempo clicca sull’immagine qui di seguito per scaricare la check list di revisione della documentazione tecnica.