La comunicazione tecnica è uno strumento per differenziarsi dalla concorrenza, dimostrare qualità e restare competitivi.
Come scrivere un manuale tecnico? Ecco 10 regole di cui ogni scrittore tecnico dovrebbe essere consapevole.
Conosci il tuo target
Per scrivere manuali efficaci, devi conoscere il tuo target, con chi stai parlando. Il tone of voice del manuale di un tablet, ad esempio, potrebbe essere utile a consumatori di tutte le tipologie, dai giovani agli anziani, e dovrà essere piuttosto diverso da quello di un impianto chimico utile ad un meccanico specializzato.
Sii consapevole di tutte le direttive legali
Quando un prodotto è difettoso in qualche modo, il fabbricante o rivenditore possono essere ritenuti responsabili per le sue conseguenze. Le direttive europee includono requisiti per scrivere manuali tecnici. Questo significa che il tuo manuale tecnico è soggetto a scrutinio. Un manuale è una parte integrante del prodotto e potrebbe condurre alla responsabilità legale!
Segui le linee guida
Va bene considerare i requisiti e le direttive legali. Ma come essere sicuri che si incontrano tutti questi requisiti? Fortunatamente, ci sono linee guida, che potrebbero avere un origine nazionale. Chiaramente, ognuno dovrebbe essere consapevole di questi orientamenti. Le linee guida ti indicano quali capitoli includere, che dimensione di carattere utilizzare etc.
Raccogli tutte le informazioni che puoi
E’ meglio scegliere di inserire troppe informazioni piuttosto che rischiare che il tuo manuale tecnico sia incompleto. Illustrazioni CAD? Documentazione marketing? Tutte queste tipologie di comunicazione forniscono un contesto e, per questo motivo, dovrebbero essere parte integrante della scrittura di un manuale.
Scrivi in modo efficace
Come scrivere efficacemente un manuale tecnico? Sfruttando tutta l’expertise nella scrittura di manuali che hai a disposizione.
Ci sono almeno tre principi che portano alla scrittura di un manuale efficace:
- Simplified Technical English (STE), il minimalismo e la scrittura basata su argomenti. Il Simplified Technical English è uno standard specifico che semplifica l’utilizzo della lingua Inglese nelle documentazioni tecniche mettendo un limite al numero di parole di ciascuna frase.
- Il Minimalismo è un modo di pensare. Questo modo di pensare significa: fornisci solo le informazioni che sono davvero utili. Viene in mente un esempio che viene dall’industria di aviazione. Quando c’era una perdita di pressione in un aeroplano, il manuale di emergenza, una lista, come primo punto scriveva che probabilmente qualcosa non stava andando nel modo corretto con una valvola. Questo è certamente un inizio sbagliato. La prima frase avrebbe dovuto essere: “Poniti la maschera di ossigeno.” In questo caso il minimalismo avrebbe potuto salvare delle vite, visto che i piloti non furono pronti a porsi le maschere di ossigeno e la lista non disse loro di fare così. Il minimalismo ci dice che dovremmo concentrarci sui nostri compiti, non su informazioni che possono essere offerte più tardi (o che non sono affatto necessarie).
- Scrittura basata su argomenti significa che scrivere manuali tecnici si traduce in scrivere blocchi che possono essere riutilizzati in nuove comunicazioni tecniche. Per esempio, i capitoli o le sezioni “Misure di sicurezza” e/o “Manutenzione” potrebbero essere identici in manuali differenti. Nella scrittura basata su argomenti, a differenza di quello che succede nella scrittura lineare, i blocchi di informazioni diventano accessibili prontamente tutte le volte. Utilizzare questi tre principi dovrebbe diminuire il tempo di training per la meccanica del 30%. Gli utenti possono assorbire il 25% delle informazioni in più come conseguenza della trasformazione dei tre principi di scrittura in pratica.
Sfrutta il potere delle immagini
Scrivere manuali tecnici non dovrebbe includere solo… la scrittura tecnica. Anzi, proprio il contrario: scrivere manuali tecnici non dovrebbe comportare preferibilmente la scrittura dei manuali. Se è vero che un’immagine riesce a essere più chiara più di 1000 parole, le illustrazioni dovrebbero essere preferite. Un’illustrazione può essere molto più efficace se vuoi che il tuo messaggio venga realmente compreso. Le illustrazioni possono essere anche più convenienti da produrre. E in ogni caso, la traduzione delle immagini non è necessaria.
Utilizza le animazioni
Quando un utente deve eseguire molte azioni simili, è molto probabile che una serie di illustrazioni sia più efficace della descrizione testuale. Ma è probabile che un’animazione sia la scelta addizionale che stai cercando.
Traduci e… localizza
Potrebbe essere che il tuo manuale abbia bisogno di una traduzione, anche solo a causa delle direttive europee. Non c’è neanche bisogno di dirlo: i testi nella lingua locale sono molto più user friendly: praticamente tutti preferiscono ricevere le comunicazioni nella loro lingua madre. La traduzione dovrebbe implicare di più della semplice sostituzione di parole, dovrebbe comportare anche la “localizzazione”.
Cosa significa “localizzazione” in un manuale? Ad esempio, significa che per gli utenti del continente europeo il volante di una macchina dovrebbe essere rappresentato sul lato sinistro, mentre per gli utenti del Regno Unito dovrebbe stare sul lato destro.
Costruisci il tuo archivio
Perché un sistema di gestione dei contenuti è così enormemente importante? Perché in questo modo può riusare blocchi di informazioni esistenti in ogni canale di uscita immaginabile: la stampa, on-line o off-line su un device (per mezzo di un PDF, per esempio). La presenza on-line e off-line rende possibile anche l’utilizzo di animazioni 3D.
Pubblica in ogni forma
Perché un sistema di gestione dei contenuti è così enormemente importante? Perché in questo modo può riusare blocchi di informazioni esistenti in ogni canale di uscita immaginabile: la stampa, on-line o off-line su un device (per mezzo di un PDF, per esempio). La presenza on-line e off-line rende possibile anche l’utilizzo di animazioni 3D.
Creare immagini 3D sempre aggiornate, animazioni etc. ti sembra troppo complicato?
SolidWorks Composer è la soluzione SolidWorks che consente di riutilizzare dati CAD 3D per creare contenuti grafici in grado di spiegare processi e procedure all’interno delle comunicazioni tecniche. Composer ha lo scopo di generare le risorse visive da inserire nel documento finale, che possono essere collegate tramite Microsoft OLE per consentire l’aggiornamento automatico in caso di modifica dei dati di origine.
Ricordati che un’efficace comunicazione tecnica porta a diversi benefici come il miglioramento del time to market, la riduzione dei costi di progettazione, di produzione e assemblaggio, di assistenza e l’aumento delle vendite.
Questo articolo ti è stato utile? Vorresti ricevere approfondimenti su SolidWorks Composer o hai domande da farci? Scrivici e ti risponderemo!
