Perché la documentazione tecnica è importante nel business

In questo post spieghiamo perché la documentazione tecnica è importante e in che modo sia l'azienda che il cliente finale possono beneficiare di una documentazione tecnica di alta qualità. Daremo anche un'occhiata alle sfide della documentazione tecnica e al suo futuro.

Perché è importante una documentazione tecnica di alta qualità?

Le informazioni tecniche consentono un uso ottimale del prodotto e contribuiscono a una maggiore soddisfazione del cliente. Per questo motivo è importante perseguire la qualità nella documentazione tecnica. In alcuni settori, questo è è un requisito indispensabile in relazione alla responsabilità del prodotto.

In che modo una documentazione tecnica di alta qualità è vantaggiosa per un'azienda?

Karl:
La documentazione tecnica dà alle aziende un vantaggio competitivo perché migliora l'esperienza dell'utente e facilita le vendite. Le informazioni tecniche devono essere prontamente disponibili durante tutto il percorso del cliente. In poche parole, serve a creare una buona esperienza per l'utente e funge anche da leva per le vendite.

Mats:
A mio parere, la documentazione tecnica porta benefici a un'azienda in molti modi, uno dei quali è il fatto di dare prova di affidabilità. Quando la documentazione è curata, trasmette l’idea che si possa fare affidamento sul brand o il prodotto o l'azienda . Non non è necessario avere una grande organizzazione di supporto se si ha una buona documentazione. Tutto sommato, questa migliora la competitività delle aziende.

Quali sono i vantaggi per l'utente finale?

Mats:
Prima di tutto, direi che i vantaggi sono dati dal fatto che consente di utilizzare con facilità un prodotto. Se lo si può usare ilin modo facile, efficiente e sicuro, è un grande vantaggio.

Karl:
I vantaggi sono dati dal garantire l'uso ottimale del prodotto, così come scegliere il prodotto giusto per le proprie esigenze.

Come si definisce una buona documentazione tecnica?

Karl:

Personalmente, definirei una buona documentazione tecnica come una documentazione che segue una guida di stile e aiuta a soddisfare gli obiettivi generali, che potrebbero essere diversi a seconda del settore, dell'argomento, ecc.

Per quanto riguarda i criteri: senza dubbio la leggibilità, che assicura anche una buona fruibilità del contenuto, e la traducibilità. Il contenuto è sviluppato per permettere la comunicazione con un pubblico globale? Anche la “portabilità” è importante. Quanto è flessibile il contenuto per essere adattato in un mondo omnicanale? È possibile condividere i propri contenuti con il pubblico in più canali, quellidove si trovano i propri clienti? Un ulteriore criterio sarebbe la riutilizzabilità, ovvero, nel caso dell'organizzazione, valutare se è possibile riutilizzare i contenuti già sviluppati in iniziative future, sfruttando al massimo il proprio investimento.

Mats:

Penso che debba essere oggettiva e basata sui fatti, e non dovrebbe contenere alcuna informazione di marketing. Dovrebbe anche essere di facile accesso e ben strutturata, oltre che facile da capire. Anche l’accuratezza linguistica è importante.

Hai un progetto di traduzione riguardante la documentazione tecnica? Parliamone!

In quali settori si dovrebbe prestare maggiore attenzione alla documentazione tecnica?

Mats:

Dipende dalla complessità e dalla necessità di sicurezza quando si lavora con un prodotto. Si pensi a IKEA, ad esempio, che fornisce le informazioni tecniche senza testo, ma attraverso immagini, le più facili da capire in assoluto.
Non credo che ci siano settori che possano davvero trascurare le informazioni tecniche e la relativa documentazione.

Karl:

Per esempio, alcune aziende di software hanno API come parte integrante della proposta di valore del prodotto, per cui i clienti possono sviluppare le proprie applicazioni sfruttando le interfacce programmabili per le applicazioni. Queste aziende di software dovrebbero prestare maggiore attenzione alla loro documentazione per gli sviluppatori di API, poiché la documentazione stessa è in realtà il prodotto. Quindi bisogna supportare i propri clienti e i propri sviluppatori per riuscire a sfruttare al meglio il prodotto.

Poi ci sono i settori regolamentati, il settore dei macchinari e così via. Questi devono prestare particolare attenzione alla documentazione tecnica e alla traduzione, specialmente per tutta la documentazione relativa alla responsabilità del prodotto.

Ad esempio, esiste una direttiva macchine che è una delle principali legislazioni che regolano l'armonizzazione dei requisiti essenziali di salute e sicurezza a livello UE. Naturalmente, ci possono essere anche regolamenti locali che richiedono ancora più attenzione e di cui tenere conto nella documentazione tecnica.

In che modo altri reparti dell'azienda possono supportare la produzione di documentazione tecnica?

Mats:

Secondo la mia esperienza, è molto importante che le altre parti di un'azienda capiscano cos'è la documentazione tecnica e perché è importante, dato che non è sempre chiaro a tutti.
In precedenza, ho lavorato in una società di software dove gli sviluppatori di software pensavano di aver raggiunto l'obiettivo dopo aver consegnato il programma, che poi sarebbe stato usato da altre persone. È stato necessario un lungo percorso per far capire agli sviluppatori di software l'importanza delle informazioni tecniche e il supporto che devono fornire con esse.
Quando si arriva ai redattori tecnici, questi possono porre domande complesse o porne molte. In ogni caso, è molto importante che gli esperti forniscano risposte a queste domande in modo che i redattori tecnici possano avere tutte le informazioni utili per creare una documentazione tecnica di buona qualità.

Un fattore rilevante è la terminologia. I redattori tecnici sono spesso coinvolti nell'ultima parte del flusso di lavoro in un'azienda. Ad esempio, il flusso di lavoro può iniziare in un settore con i progettisti, e possono essere gli acquirenti a decidere un termine specifico per un prodotto o una parte di un prodotto. E in seguito i progettisti e gli acquirenti potrebbero riferirsi allo stesso elemento in modo diverso. Di conseguenza, questo finisce per avere nomi diversi in ambiti diversi, il che rende molto difficile per un redattore tecnico mantenere una terminologia coerente.

Quindi, in una situazione ottimale, direi che un redattore tecnico dovrebbe essere incluso anche nei processi di acquisto e progettazione per stabilire i termini da utilizzare. Sarebbe decisamente meglio per gli utenti finali se non esistessero due o tre o cinque sinonimi per la stessa parola.

Karl:

Quando si tratta di supportare la produzione della documentazione tecnica, direi che è un bene che siano coinvolti altri colleghi, è uno sport di squadra. Si possono promuovere eventi per scoprire come si presenta una grande esperienza di unboxing o lo sviluppo di una metodologia. Lavorare con i redattori tecnici come un team per assicurare che la documentazione sia della migliore qualità possibile, e poi fornire un feedback di revisione in modo tempestivo, soddisferebbe certamente le aspettative di ogni redattore tecnico.

La documentazione tecnica è parte integrante del prodotto, non è che prima vedano la luce il prodotto o il servizio e poi la documentazione, ma questa ne è parte integrante. Dal punto di vista del cliente è tutto compreso nella stessa esperienza.

Cosa dovrebbero considerare le aziende attive a livello internazionale quando si tratta di documentazione tecnica?

Mats:

Penso che ci siano vari elementi, ma uno è senz'altro la lingua. Naturalmente, se il testo non viene tradotto, occorrerà assicurarsi di utilizzare un linguaggio estremamente semplice. Ad esempio, nel settore aeronautico dove lavoro io, di solito usiamo l'inglese tecnico semplificato, che è appunto un linguaggio controllato e per la stesura di testi in inglese chiari e semplici. Ed è questo che consente a chi non possiede un elevato livello di conoscenza dell’ inglese di capire le istruzioni. Quindi, è più facile avere un tono uniforme in tutta la documentazione, perché rende anche più facile la traduzione.

Un altro elemento da considerare è l'accesso a Internet. Tendiamo a pensare che sia garantito a tutti in tutto il mondo, ma ci sono luoghi in cui questo non avviene, quindi bisogna avere soluzioni di informazione tecnica che possano essere utilizzate offline.
Esistono diverse guide di scrittura e linguaggi semplificati per diversi settori. Pertanto, penso che tutti possano trovare ciò che è adatto al loro business.

Qual è la più grande sfida nel settore della documentazione?

Mats:

Vi sono diverse sfide, una delle fondamentali sarà l'evoluzione tecnica. In altre parole, è necessario mettere a disposizione nuove piattaforme per la fornitura di informazioni tecniche; inoltre, i giovani si aspettano di ricevere le informazioni tecniche e la documentazione tecnica in modi diversi rispetto al passato. Quando ero giovane, l'unico mezzo possibile per sapere come usare o come riparare qualcosa era leggere il manuale fornito con il prodotto. Ma ora si può usare Google per questo. Si può visualizzare immediatamente la documentazione quando si ha un problema, e si può quindi utilizzare la documentazione per risolverlo subito.

Karl:

Noto che i requisiti sui tempi di consegna stanno cambiando. Molte aziende stanno passando a uno sviluppo agile del prodotto e a processi agili al posto dell'"esecuzione a cascata", dove si lavora instancabilmente per mesi e mesi, o magari per anni, per poi lanciare il prodotto sul mercato. Quindi vediamo che lo sviluppo del prodotto si sta spostando verso il lancio di qualsiasi prodotto minimamente utilizzabile sul mercato, ottenendo feedback e lavorando con i clienti per migliorarlo. E l'impatto sullo sviluppo dei contenuti è che le esigenze legate ai tempi di consegna si fanno più pressanti. Questo significa che un team di sviluppo dei contenuti ora ha bisogno di rilasciare contenuti più frequentemente, con piccoli volumi di contenuti pubblicati più spesso. Quelli che prima era  mesi di sviluppo ora si riducono a settimane.

Quindi questa è una sfida. Pubblicare può essere costoso, e questo è qualcosa a cui i team devono pensare: come possono ridurre i costi e al contempo integrare continuamente i contenuti per supportare l’evoluzione continua delle caratteristiche durante lo sviluppo del prodotto.

La trasformazione agile non riguarda solo i prodotti tecnologici. Non c'è un team in qualunque settore che non stia parlando di trasformazione agile e così via. Ad esempio, i contenuti di formazione, la documentazione tecnica, i documenti di marketing, il web, l'e-commerce e così via. Ne sono tutti influenzati.

E per quanto riguarda il futuro del settore, quali cambiamenti possiamo aspettarci?

Karl:

Una cosa che sta rendendo le pubblicazioni costose è il layout, e il fatto di rifarlo molteplici volte nelle pubblicazioni. Per questo, vi è una nuova tendenza verso il contenuto come servizio nell'e-commerce, conosciuto come CMS headless. Applicando il layout nella parte anteriore dell'applicazione, che sia un centro di assistenza o un pacchetto di formazione o una piattaforma di e-commerce, la piattaforma stessa, con il front end, applicherà il layout e gli sviluppatori di contenuti si concentreranno sullo sviluppo del contenuto.
Quindi, il contenuto come servizio e il CMS headless sono certamente una tendenza. Invece di avere ogni autore che lavora sul layout nel suo ambiente di authoring, il lavoro di layout si è spostato a valle del processo.

Un'altra tendenza è il single sourcing del contenuto: riutilizzare il contenuto in tutte le iniziative di sviluppo di un prodotto o di un servizio. Le aziende stanno cercando di sfruttare il loro investimento nei contenuti, sfruttando più e più volte le risorse digitali che sono state sviluppate, che si tratti di sistemi di gestione dei contenuti, sistemi di gestione delle traduzioni o database comuni. Non la chiamerei una tendenza del 2021; direi che è piuttosto un movimento che è in corso da più di un decennio.

La terza tendenza è il supporto dell'IoT nelle attività informative, dove i prodotti e i servizi si spostano nel cloud. Passare dalla carta alle soluzioni digitali è certamente il futuro per il settore.

Infine, la quarta tendenza è l'internazionalizzazione, per cui i prodotti diventano collegati e il mercato diventa globale. Vi è l'opportunità di raggiungere i clienti in ogni parte del mondo.

Mats:

Questo è uno degli obiettivi che abbiamo per i prossimi anni: guardare avanti e vedere davvero quali cambiamenti o quali sfide ci sono in serbo per noi. Si sente molto parlare di nuove parole chiave come intelligenza artificiale, realtà aumentata, realtà virtuale e gemello digitale (digital twin).

Quindi non è facile anticipare come questi fattori influenzeranno la richiesta di informazioni tecniche e i modi di produrre e di utilizzare la documentazione tecnica e le informazioni tecniche. Perciò penso che non si tratti di un singolo fattore, ma di un insieme di molte nuove tecnologie diverse e un'evoluzione più rapida con cui dobbiamo stare al passo.

Cos'è BOTI?

In breve, BOTI è un punto di incontro, nel quale collaboriamo per una migliore informazione tecnica nelle aziende svedesi. BOTI sostiene l'informazione tecnica di qualità nelle aziende svedesi, in tutte le lingue, e naturalmente nelle traduzioni.
Un elemento importante per noi è che i redattori tecnici o il settore delle informazioni tecniche sono spesso solo una piccola parte di un'azienda. Potrebbe esserci un solo redattore tecnico in un'azienda di 100 persone, quindi per i redattori non è facile enfatizzare la propria esperienza e migliorare se sono soli e non hanno nessuno che faccia da guida. Ecco perché pensiamo che sia importante avere un'organizzazione per aiutarci l'un l'altro e anche per aiutare le aziende e, naturalmente, per progredire nel settore delle informazioni tecniche.

Abbiamo molti impegni nella nostra agenda: teniamo una conferenza annuale e numerosi webinar che sono gratuiti per tutti i partecipanti. E abbiamo anche molti gruppi di lavoro, dove si può discutere con persone di diverse aziende e quindi creare un'ottima rete.
L'obiettivo dell'organizzazione è quello di mostrare come la documentazione di alta qualità aggiunge valore e come può aumentare la competitività di un business.
La lingua principale dell'organizzazione è lo svedese, ma tutti sono benvenuti. Ad esempio, la conferenza annuale e la pagina web sono in svedese. Quindi, per ottenere il massimo dai contenuti, sarà utile avere una certa fluidità nello svedese.

Scopri di più su BOTI qui.

Hai una documentazione tecnica che deve essere tradotta? Contattaci!