Scrittori tecnici: cosa sono e ne hai bisogno?

Uno scrittore può ricoprire diverse posizioni nel mondo della scrittura professionale. Mentre le aziende al di fuori del settore tendono ad abusare della terminologia, ogni tipo di scrittore ricopre un ruolo specifico e ha compiti specifici. È essenziale assumere il tipo corretto di scrittore se vuoi che faccia il miglior lavoro possibile.

• Autori, che in genere scrivono contenuti meno formali e di lunga durata come i libri.
• I copywriter in genere scrivono testi in forma abbreviata per annunci, post sui social media, descrizioni di prodotti e altri media.
• Scrittori tecnici, che di solito scrivono documentazione del prodotto e materiali del centro assistenza.
• I blogger in genere si concentrano su contenuti di media lunghezza per la pubblicazione sul Web.

E, naturalmente, hai anche tipi di scrittori specifici del settore, come scrittori medici o scrittori di sovvenzioni per il settore no profit. Inoltre, tutti possono anche essere ghostwriter.

Come suggerisce il titolo del post di oggi, approfondirò uno di questi ruoli. Nello specifico, parliamo di scrittori tecnici.

Che cos'è uno scrittore tecnico?

Diciamo che hai acquistato un nuovo prodotto. Lo trovi e lo apri e trovi un manuale di 50 pagine pieno di diagrammi di parti, specifiche e istruzioni su come funziona. È semi-complicato, quindi è necessario fare riferimento al manuale.

Questo è ciò che fa uno scrittore tecnico, ed è così che si è guadagnato il titolo di lavoro di scrittura tecnica .

"Uno scrittore tecnico scrive documenti aziendali come manuali di istruzioni, manuali intermedi e per l'utente finale, guide di riferimento, guide alle procedure operative, white paper e descrizioni di prodotti specializzati". – Quartier generale dello scrittore tecnico.

Il contenuto creato da uno scrittore tecnico può essere realizzato per diversi scopi, tra cui:

• Il contenuto dell'uso aziendale interno include documentazione sulle procedure, guide per l'utente, manuali, documenti di servizio o rapporti.
• Il contenuto per uso aziendale esterno include guide all'uso, guide alla riparazione, documentazione della knowledge base, documentazione del servizio clienti e documentazione delle proposte del cliente.

Quindi, il tuo scrittore tecnico potrebbe aiutarti a redigere un manuale per i dipendenti, scrivere la tua wiki di base di conoscenza interna o creare un database del servizio clienti o domande frequenti. Potrebbero scrivere un manuale per l'utilizzo del prodotto o documentare i processi aziendali per coerenza interna. Potrebbero anche creare rapporti e proposte per i team esecutivi ai livelli superiori e facilitare la comunicazione tra i livelli C e i direttori.

Come ci si potrebbe aspettare, tutto questo rientra nel titolo di "documentazione tecnica", quindi scrittori tecnici. Il contenuto stesso è, come ci si potrebbe aspettare, tecnico.

Gli scrittori tecnici possono essere:

• Appaltatori freelance, lavorando per progetto.
• Appaltatori a lungo termine, che lavorano per documentare tutto su un'azienda fino a quando non viene raggiunta.
• Dipendenti part-time o full-time, documentando tutto in base alle necessità durante le operazioni.

Gli scrittori tecnici sono molto raramente ghostwriter. Un ghostwriter di solito scambia la scrittura con denaro vendendo il sottotitolo. La documentazione tecnica raramente ha un sottotitolo, quindi non è necessario assumere un ghostwriter anziché uno scrittore normale per produrla. Le aspettative non ci sono.

Cosa fa, in particolare, uno scrittore tecnico?

L'ampio campo della scrittura tecnica è piuttosto complesso. Uno scrittore specializzato in un'azienda potrebbe avere una serie di responsabilità completamente diversa da uno scrittore in un'altra azienda.

I compiti tipici che troverai nella descrizione del lavoro di uno scrittore tecnico possono includere:

• Ricerca delle specifiche tecniche di un reparto, processo o prodotto aziendale.
• Pianificare la documentazione tecnica in un ordine logico.
• Capire cosa è necessario e cosa non lo è per il pubblico di destinazione.
• Crea, copia e perfeziona la documentazione.
• Crea diagrammi e altre illustrazioni se necessario.
• Mantenere un glossario pertinente, FAQ o un'altra libreria di terminologia pertinente.
• Sviluppare relazioni tecniche o proposte formalizzate per un uso aziendale di alto livello.

Molti scrittori avranno un certificato di scrittura tecnica, articoli pubblicati su riviste o opere esistenti e anni di esperienza nel loro campo. Dovrebbero essere in grado di dimostrare di avere una carriera di scrittore tecnico nel tuo settore specifico.

Il manuale che viene fornito con la tua auto, che ti insegna come sostituire una gomma o utilizzare gli indicatori di direzione, è un pezzo di scrittura tecnica. Così anche il manuale di servizio, pensato per i meccanici e non per l'utente finale. Anche la base di conoscenza self-service per i clienti sul sito Web della casa automobilistica è ricca di contenuti tecnici.

Tutti i manuali Haynes, il Centro assistenza di Google e persino cose come Case Studies sono esempi di scrittura tecnica.

Gli scrittori tecnici devono essere esperti implacabili nel loro campo (ma non necessariamente certificati). Uno scrittore tecnico per una casa automobilistica deve comprendere il design dell'auto dentro e fuori. Uno scrittore tecnico in campo medico deve conoscere abbastanza la biochimica per documentare correttamente i farmaci. Uno scrittore tecnico per un'azienda deve capire come funziona l'azienda, per scrivere la documentazione del processo in modo appropriato.

Detto questo, gli scrittori tecnici spesso hanno esperti in materia che esaminano il loro prodotto finale e lo approvano. Ad esempio, uno scrittore medico potrebbe avere una vera revisione del biochimico e garantire l'accuratezza. Uno scrittore tecnico che crea un manuale di prodotto potrebbe far esaminare a un avvocato prima che venga pubblicato per garantire che non ci sia nulla in esso in grado di creare responsabilità per l'azienda.

Dopotutto, la documentazione tecnica deve essere accurata e deve essere scritta per il pubblico appropriato.

Per utilizzare nuovamente l'esempio della casa automobilistica, un documento di specifiche di vendita, un manuale utente e un manuale di riparazione devono contenere informazioni tecniche simili. Tuttavia, le informazioni con il valore maggiore variano, il livello di dettaglio tecnico varia e l'ambito della documentazione cambia.

Fornire un manuale Haynes a un utente finale è inappropriato. Questo perché le persone che stanno cercando di acquistare un'auto, che cercano di risolvere i problemi del proprio veicolo e le persone che riparano i veicoli in modo professionale hanno tutte esigenze diverse. Il bisogno di conoscenza automobilistica della maggior parte delle persone implica l'uso di indicatori di direzione e il gonfiaggio delle gomme, non la sostituzione dei condotti dell'aria o la sostituzione del convertitore catalitico.

Di quali competenze ha bisogno uno scrittore tecnico?

Gli scrittori tecnici hanno bisogno di un insieme particolare di abilità di scrittura e capacità di comunicazione per essere efficaci.

1. In primo luogo, devono essere comunicatori altamente efficaci. Uno scrittore tecnico deve trasmettere informazioni tecniche e accurate a un utente finale per capirle e analizzarle. Se la guida è piena di informazioni complesse che sono troppo difficili da capire per loro, sarà confusa fino al punto di inutilità. Se è troppo semplice, l'utente non otterrà alcun valore.

Allo stesso tempo, lo scrittore tecnico potrebbe dover porre domande pratiche a esperti in materia. Nella loro documentazione, potrebbero incontrare domande che non hanno e a cui non riescono a trovare la risposta. Devono chiedere a un esperto pertinente cosa devono sapere per la documentazione. E, poiché l'esperto potrebbe non sapere quando fermarsi, lo scrittore tecnico deve anche sapere come estrarre il valore specifico da una risposta potenzialmente lunga.

2. Allo stesso modo, gli scrittori tecnici hanno bisogno di una solida conoscenza della loro lingua. Devono essere precisi con ciò che stanno dicendo e scrivere a un livello di lettura pratico, mirato specificamente al loro pubblico. Errori tecnici, scarsa scelta delle parole, significati confusi; sono tutti terribili per la documentazione tecnica.

3. Successivamente, devono avere una prospettiva orientata ai dettagli. Uno scrittore tecnico ha bisogno di un occhio per i dettagli minori perché i dettagli minori devono essere accurati. Non possono ignorare dettagli specifici perché potrebbero essere necessari.

Ad esempio, in una delle mie guide pratiche su un servizio Web o un altro, potrei scrivere qualcosa del tipo:

"Accedi alla tua dashboard e trova la sezione Rapporti nella barra laterale."

Questo è abbastanza buono per me perché non sto scrivendo documentazione tecnica; Sto scrivendo una guida pratica piuttosto semplice. Nel frattempo, uno scrittore tecnico potrebbe scrivere:

"Dalla dashboard, fai clic sull'intestazione Rapporti nella barra laterale di sinistra, la terza dall'alto."

Sono più specifici perché parte della documentazione tecnica è la specificità. Naturalmente, questo è un esempio generico.

4. Anche gli scrittori tecnici hanno bisogno di una comprensione del flusso logico. Quando si documenta un processo aziendale, lo scrittore richiede capacità di pensiero critico e i passaggi devono essere ordinati in modo appropriato. Si consideri, ad esempio, una ricetta. Scrivi le istruzioni dettagliate su come cuocere una pagnotta una dopo l'altra, nell'ordine in cui sono fatte. Tuttavia, potresti essere in grado di riorganizzarne alcuni; ad esempio, non c'è motivo di mettere "preriscaldare il forno" all'inizio quando c'è un'ora di lievitazione dell'impasto prima della cottura; nessuno vorrà lasciare il proprio forno in funzione per così tanto tempo senza niente all'interno.

Diverse case automobilistiche hanno modelli diversi. Più lungo o grande è un pezzo di documentazione, più opzioni ci sono e più diventa critico stabilire una convenzione. I manuali automatici potrebbero iniziare con l'usabilità, quindi passare a funzionalità nascoste e piccole riparazioni.

5. Questo si collega a un altro requisito per i redattori tecnici, che è l' approvvigionamento unico. Un singolo sourcing significa prendere un corpus di informazioni e produrre più contenuti rivolti a un pubblico diverso. L'esempio dell'auto di un manuale utente e un manuale Haynes è un buon esempio; entrambi contengono informazioni sulla stessa auto dalla stessa fonte (il produttore), ma una è molto più tecnica.

6. Alcuni scrittori tecnici potrebbero anche aver bisogno di codice di base o conoscenza dello sviluppo web. Ad esempio, uno scrittore tecnico che crea documentazione per il servizio clienti potrebbe aver bisogno di conoscere abbastanza sintassi HTML, CSS, JavaScript o Wiki per avviare la documentazione basata sul Web da zero o all'interno di un framework. Gli scrittori tecnici raramente scrivono una pura copia di testo: generalmente è richiesta un'altra abilità per essere considerati scrittori tecnici.

Ad esempio, uno scrittore tecnico sullo sviluppo full-stack ha probabilmente due abilità: scrittura tecnica e programmazione. Non c'è altro modo per uno scrittore di creare questo tipo di contenuto programmatore accurato senza essere un programmatore.

Qualcuno può essere uno scrittore tecnico?

Onestamente, no.

Ad esempio, supponiamo che una società di sviluppo software abbia una guida troppo confusa o difficile da comprendere per gli utenti. In tal caso, il loro tasso di abbandono sarà superiore alla media e perderanno una grande manciata di clienti, il tutto a causa della scarsa scrittura.

Gli scrittori tecnici hanno bisogno di un mix specifico di personalità orientata ai dettagli e socievolezza per interagire con esperti in materia. Spesso, uno scrittore tecnico richiede anche una laurea o un certificato tecnico nella loro materia per scriverne in modo appropriato.

Ad esempio, uno scrittore medico potrebbe ottenere una laurea in infermieristica o una laurea di 4 anni in scienze mediche o informatica. Lo scrittore può anche seguire corsi di scrittura tecnica specifici per contenuti medici. Non hanno bisogno di seguire un programma di master o dottorato, ma hanno bisogno almeno di un'istruzione formalizzata come una laurea.

Molti autori di contenuti tecnici scelgono un settore di interesse e si specializzano in esso.

Detto questo, gli scrittori tecnici non hanno sempre bisogno di questi gradi per entrare in un campo. Spesso, tutto ciò di cui hanno bisogno è una laurea in inglese o scrittura, in giornalismo, in comunicazione tecnica o un campo tecnico come ingegneria (anche se tende ad essere meno comune).

Sono uno scrittore da oltre un decennio, ma come blogger, non prospererei come scrittore tecnico. Potrei imparare come, certo, ma dovrei sopprimere molte delle mie abitudini (come scrivere in prima persona o casualmente).

Hai bisogno di uno scrittore tecnico?

Forse!

Quasi tutte le aziende hanno esigenze di un certo livello di scrittura aziendale e documentazione tecnica. Conduco una piccola operazione, ma produco comunque cose come una guida allo stile della casa, riassunti dei contenuti o l'informativa sulla privacy del mio sito.

Tuttavia, non direi di aver bisogno di uno scrittore tecnico. Riesco a scrivere tecnico tra i modelli online e gli standard inferiori necessari per la mia documentazione interna.

Supponiamo che la tua azienda operi in un campo in cui hai esigenze di servizio clienti oltre a rispondere al telefono e parlare con i clienti. In tal caso, potresti trarre vantaggio dalla creazione della documentazione da parte di uno scrittore tecnico. Se disponi di grandi reparti con processi specifici per la generazione di report o per l'utilizzo di un ATS, uno scrittore tecnico può documentare tali processi.

E, naturalmente, se la tua azienda produce un prodotto tecnico e quel prodotto è qualcosa di più complicato di una penna o di una scarpa, è probabile che creare un manuale utente o un centro assistenza online per i tuoi utenti sia una buona idea.

Anche allora, non tutte le aziende utilizzano uno scrittore tecnico per i loro manuali. Considera Ikea; sono famosi per utilizzare solo pittogrammi nelle loro istruzioni di montaggio, in parte perché vogliono che un singolo pezzo di documentazione sia rilevante per il mondo intero, indipendentemente dalla lingua. Uno scrittore tecnico potrebbe averli prodotti, ma non si tratta tanto di scrivere quanto di grafica.

Gli scrittori tecnici guadagnano in media circa $ 75.000 all'anno, secondo il Bureau of Labor Statistics degli Stati Uniti, con scrittori tecnici di fascia alta e altamente qualificati che superano $ 100.000 all'anno, ed è per una buona ragione. Valgono il loro peso in oro nelle giuste circostanze.

Stai pensando di assumere uno scrittore tecnico? Hai delle domande per noi sugli scrittori tecnici e su come si differenziano dai copywriter o dai content writer? Per favore fatemelo sapere nella sezione commenti! Sarei felice di aiutare e avviare una conversazione su questo argomento.