Scriitori tehnici: ce sunt ei și aveți nevoie de unul?

Un scriitor poate ocupa mai multe poziții diferite în lumea scrisului profesional. În timp ce companiile din afara industriei tind să folosească greșit terminologia, fiecare tip de scriitor ocupă un rol specific și are îndatoriri specifice. Este esențial să angajezi tipul corect de scriitor dacă vrei să facă cea mai bună treabă posibilă.

• Autorii, care scriu de obicei conținut mai puțin formal, de formă lungă, cum ar fi cărțile.
• Copywriterii scriu de obicei copii scurte pentru reclame, postări pe rețelele sociale, descrieri de produse și alte media.
• Scriitori tehnici, care de obicei scriu documentația produsului și materialele centrului de ajutor.
• Bloggerii se concentrează de obicei pe conținut de lungime medie pentru publicarea web.

Și, desigur, aveți și tipuri de scriitori specifici industriei, cum ar fi scriitori medicali sau scriitori de granturi pentru sectorul nonprofit. În plus, toți pot fi și scriitori fantomă.

După cum sugerează și titlul postării de astăzi, voi explora unul dintre aceste roluri. Mai exact, să vorbim despre scriitori tehnici.

Ce este un scriitor tehnic?

Să presupunem că ați achiziționat un produs nou. Îl găsești și îl deschideți și găsiți un manual de 50 de pagini plin cu diagrame de piese, specificații și instrucțiuni despre cum funcționează. Este semicomplicat, așa că trebuie să consultați manualul.

Asta face un scriitor tehnic și așa au câștigat titlul de post de scriitor tehnic .

„Un scriitor tehnic scrie documente ale companiei, cum ar fi manuale de instrucțiuni, manuale pentru utilizatorul intermediar până la final, ghiduri de referință, ghiduri de proceduri de operare, documente albe și descrieri de produse specializate.” – Sediul scriitor tehnic.

Conținutul creat de un scriitor tehnic poate fi realizat în diferite scopuri, inclusiv:

• Conținutul de utilizare internă în afaceri include documentație privind procedurile, ghiduri de utilizare, manuale, documente de service sau rapoarte.
• Conținutul de utilizare externă în afaceri include ghiduri de utilizare, ghiduri de reparații, documentație de bază de cunoștințe, documentație de serviciu pentru clienți și documentație de propunere a clienților.

Așadar, scriitorul dumneavoastră tehnic ar putea ajuta la redactarea unui manual al angajaților, la redactarea bazei de cunoștințe interne wiki sau la construirea unei baze de date de servicii pentru clienți sau a întrebărilor frecvente. S-ar putea să scrie un manual pentru utilizarea produsului sau să documenteze procesele de afaceri pentru coerență internă. Ei ar putea, de asemenea, să creeze rapoarte și propuneri pentru echipele executive de la nivelurile superioare și să faciliteze comunicarea între nivelurile C și directori.

După cum v-ați putea aștepta, toate acestea se încadrează sub titlul de „documentație tehnică”, deci scriitori tehnici. Conținutul în sine este, așa cum vă puteți aștepta, tehnic.

Scriitorii tehnici pot fi:

• Antreprenori independenți, lucrând pe proiect.
• Contractori pe termen lung, care lucrează pentru a documenta totul despre o afacere până când aceasta este prinsă din urmă.
• Angajații cu normă parțială sau cu normă întreagă, care documentează totul pe măsură ce este nevoie pe parcursul operațiunilor.

Scriitorii tehnici sunt foarte rar scriitori fantomă. Un ghostwriter schimbă, de obicei, scrisul pe bani, vânzând titlul. Documentația tehnică are rareori o linie de bază, așa că nu este nevoie să angajați un scriitor fantomă în locul unui scriitor obișnuit pentru a o produce. Aşteptările nu sunt acolo.

Ce face, în mod concret, un scriitor tehnic?

Domeniul larg al scrierii tehnice este destul de complex. Un scriitor specializat la o companie poate avea un set complet diferit de responsabilități față de un scriitor de la o altă companie.

Îndatoririle tipice pe care le veți găsi în fișa postului unui scriitor tehnic pot include:

• Cercetarea specificațiilor tehnice ale unui departament, proces sau produs de afaceri.
• Planificați documentația tehnică într-o ordine logică.
• Înțelegeți ce este necesar și ce nu pentru publicul țintă.
• Creați, editați și rafinați documentația.
• Creați diagrame și alte ilustrații după cum este necesar.
• Mențineți un glosar relevant, Întrebări frecvente sau o altă bibliotecă de terminologie relevantă.
• Elaborați rapoarte tehnice sau propuneri oficializate pentru utilizare la nivel înalt în afaceri.

Mulți scriitori vor avea un certificat de scriere tehnică, articole de jurnal publicate sau lucrări existente și ani de experiență în domeniul lor. Ar trebui să poată demonstra că au o carieră de scriitor tehnic în industria dvs. specifică.

Manualul care vine cu mașina dvs., care vă învață cum să schimbați o anvelopă sau să folosiți semnalizatoarele, este o scriere tehnică. La fel este și manualul de service, destinat mecanicilor și nu utilizatorului final. Baza de cunoștințe privind autoservirea clienților de pe site-ul web al producătorului de automobile este, de asemenea, plină de conținut tehnic.

Toate manualele Haynes, Centrul de ajutor Google și chiar lucruri precum Studiile de caz sunt exemple de scriere tehnică.

Scriitorii tehnici trebuie să fie experți necruțători în domeniul lor (dar nu neapărat atestați). Un scriitor tehnic pentru un producător de mașini trebuie să înțeleagă designul mașinii în interior și în exterior. Un scriitor tehnic în domeniul medical trebuie să cunoască destule despre biochimie pentru a documenta corect medicația. Un scriitor tehnic pentru o afacere trebuie să înțeleagă cum funcționează afacerea, să scrie documentația procesului în mod corespunzător.

Acestea fiind spuse, autorii tehnici au adesea experți în domeniu să-și revizuiască produsul final și să-l aprobe. De exemplu, un scriitor medical ar putea avea o evaluare reală a biochimistului și poate asigura acuratețea. Un scriitor tehnic care creează un manual de produs ar putea cere unui avocat să-l examineze înainte de a fi publicat pentru a garanta că nu există nimic în el capabil să creeze răspundere pentru companie.

La urma urmei, documentația tehnică trebuie să fie exactă și trebuie să fie scrisă pentru publicul corespunzător.

Pentru a utiliza din nou exemplul producătorului auto, un document cu specificațiile de vânzare, un manual de utilizare și un manual de reparații trebuie să conțină informații tehnice similare. Cu toate acestea, informațiile cu cea mai mare valoare variază, nivelul de detaliu tehnic variază, iar domeniul de aplicare al documentației se modifică.

Furnizarea unui manual Haynes unui utilizator final este inadecvată. Acest lucru se datorează faptului că oamenii care doresc să cumpere o mașină, care caută să-și depaneze vehiculul și oamenii care repară vehiculele profesional au nevoi diferite. Nevoia majorității oamenilor de cunoaștere a automobilelor implică utilizarea semnalizatoarelor și umflarea anvelopelor, nu schimbarea conductelor de aer sau înlocuirea convertorului catalitic.

De ce abilități are nevoie un scriitor tehnic?

Scriitorii tehnici au nevoie de un anumit set de abilități de scriere și abilități de comunicare pentru a fi eficienți.

1. În primul rând, trebuie să fie comunicatori extrem de eficienți. Un scriitor tehnic trebuie să transmită informații precise și tehnice unui utilizator final pentru a le înțelege și analiza. Dacă ghidul este plin de informații complexe, care sunt prea greu de înțeles pentru ei, va fi confuz până la inutilitate. Dacă este prea simplu, utilizatorul nu va primi nicio valoare.

În același timp, scriitorul tehnic poate avea nevoie să pună întrebări practice experților în domeniu. În documentația lor, aceștia pot întâlni întrebări pe care nu le au și la care nu pot găsi răspunsul. Ei trebuie să întrebe un expert relevant ce trebuie să știe pentru documentație. Și, deoarece expertul ar putea să nu știe când să se oprească, scriitorul tehnic trebuie, de asemenea, să știe cum să extragă valoarea specifică dintr-un răspuns potențial lung.

2. În mod similar, scriitorii tehnici au nevoie de o înțelegere fermă a limbajului lor. Ei trebuie să fie precisi cu ceea ce spun și să scrie la un nivel practic de lectură, direcționat în mod special către publicul lor. Greșeli tehnice, alegere proastă a cuvintelor, înțelesuri confuze; toate sunt groaznice pentru documentația tehnică.

3. În continuare, trebuie să aibă o perspectivă orientată spre detalii. Un scriitor tehnic are nevoie de ochi pentru detalii minore, deoarece detaliile minore trebuie să fie exacte. Ei nu pot trece peste detalii specifice, deoarece aceste detalii ar putea fi necesare.

De exemplu, într-unul dintre ghidurile mele despre un serviciu web sau altul, aș putea scrie ceva de genul:

„Conectați-vă la tabloul de bord și găsiți secțiunea Rapoarte din bara laterală”.

Asta e suficient de bun pentru mine pentru că nu scriu documentație tehnică; Scriu un ghid destul de simplu. Între timp, un scriitor tehnic ar putea scrie:

„Din tabloul de bord, faceți clic pe titlul Rapoarte din bara laterală din stânga, al treilea din partea de sus”.

Sunt mai specifice, deoarece o parte a documentației tehnice este specificitatea. Desigur, acesta este un exemplu generic.

4. Scriitorii tehnici au nevoie și de o înțelegere a fluxului logic. Când documentezi un proces de afaceri, scriitorul tău va avea nevoie de abilități de gândire critică, iar pașii trebuie ordonați corespunzător. Luați în considerare, de exemplu, o rețetă. Scrieți instrucțiunile pas cu pas despre coacerea unei pâini una după alta, în ordinea în care sunt gata. Cu toate acestea, este posibil să puteți reorganiza unele; de exemplu, nu există niciun motiv să puneți „preîncălziți cuptorul” la pornire când este o oră de întărire aluatul înainte de coacere; nimeni nu va dori să-și lase cuptorul să funcționeze atât de mult timp fără nimic în el.

Diferiți producători de automobile au modele diferite. Cu cât o documentație este mai lungă sau mai mare, cu atât există mai multe opțiuni și cu atât devine mai importantă stabilirea unei convenții. Manualele auto ar putea începe cu gradul de utilizare, apoi trec la funcții ascunse și la reparații minore.

5. Acest lucru se leagă de o altă cerință pentru scriitorii tehnici, care este aprovizionarea unică. Aprovizionarea unică înseamnă preluarea unui corp de informații și producerea mai multor piese de conținut destinate unui public diferit. Exemplul de mașină al unui manual de utilizare și al unui manual Haynes este un bun exemplu; ambele conțin informații despre aceeași mașină din aceeași sursă (producător), dar una este mult mai tehnică.

6. Unii scriitori tehnici pot avea nevoie și de cunoștințe de bază de cod sau dezvoltare web. De exemplu, un scriitor tehnic care creează documentație pentru serviciul clienți poate avea nevoie să cunoască suficient HTML, CSS, JavaScript sau sintaxă Wiki pentru a începe documentația bazată pe web de la zero sau într-un cadru. Scriitorii tehnici scriu rareori copii de text pur - în general, există o altă abilitate necesară pentru ca ei să fie considerați scriitori tehnic.

De exemplu, un scriitor tehnic despre dezvoltarea full-stack are probabil două abilități: scriere tehnică și programare. Nu există altă modalitate pentru un scriitor de a crea acest tip de conținut de programator precis fără a fi programator.

Poate oricine să fie un scriitor tehnic?

Sincer, nu.

De exemplu, să presupunem că o companie de dezvoltare de software are un ghid care este prea confuz sau greu de înțeles pentru utilizatori. În acest caz, rata lor de pierdere va fi mai mare decât media și vor pierde o mână mare de clienți - toate din cauza scrisului slab.

Scriitorii tehnici au nevoie de un amestec specific de personalitate orientată spre detalii și sociabilitate pentru a se angaja cu experți în domeniu. Adesea, un scriitor tehnic necesită, de asemenea, o diplomă sau un certificat tehnic în materia lor pentru a scrie despre aceasta în mod corespunzător.

De exemplu, un scriitor medical ar putea obține o diplomă de asistent medical sau o diplomă de 4 ani în științe medicale sau informatică. Scriitorul poate chiar să urmeze cursuri specifice de scriere tehnică pentru conținut medical. Nu trebuie să urmeze un program de master sau doctorat, dar au nevoie de cel puțin o educație oficială, cum ar fi o diplomă de licență.

Mulți scriitori de conținut tehnic aleg o industrie de interes și se specializează în ea.

Acestea fiind spuse, scriitorii tehnici nu au întotdeauna nevoie de aceste grade pentru a intra într-un domeniu. Adesea, tot ce au nevoie este o diplomă în limba engleză sau scris, în jurnalism, în comunicare tehnică sau într-un domeniu tehnic precum Inginerie (deși asta tinde să fie mai puțin obișnuit.)

Sunt scriitor de peste un deceniu, dar ca blogger, nu m-aș descurca ca scriitor tehnic. Aș putea să învăț cum, sigur, dar ar trebui să-mi suprim multe dintre obiceiurile (cum ar fi să scriu la persoana întâi sau ocazional).

Ai nevoie de un scriitor tehnic?

Poate!

Aproape fiecare afacere are nevoie de un anumit nivel de scriere de afaceri și documentație tehnică. Derulez o operațiune mică, dar încă produc lucruri precum un Ghid de stil al casei, rezumate de conținut sau Politica de confidențialitate a site-ului meu.

Cu toate acestea, nu aș spune că am nevoie de un scriitor tehnic. Pot scrie tehnic între șabloanele online și standardele inferioare necesare pentru documentația mea internă.

Să presupunem că afacerea dvs. operează într-un domeniu în care aveți nevoie de servicii pentru clienți, dincolo de a răspunde doar la telefon și de a vorbi cu clienții. În acest caz, ați putea beneficia de faptul că un scriitor tehnic creează documentație. Dacă aveți departamente mari cu procese specifice pentru generarea de rapoarte sau pentru lucrul cu un ATS, un redactor tehnic poate documenta aceste procese.

Și, bineînțeles, dacă afacerea ta produce un produs tehnic, iar acel produs este ceva mai complicat decât un pix sau un pantof, sunt șanse ca crearea unui manual de utilizare sau a unui centru de ajutor online pentru utilizatorii tăi să fie o idee bună.

Chiar și atunci, nu toate companiile folosesc un redactor tehnic pentru manualele lor. Luați în considerare Ikea; sunt faimoși pentru că folosesc doar pictograme în instrucțiunile lor de asamblare, parțial pentru că doresc ca o singură documentație să fie relevantă pentru întreaga lume, indiferent de limbă. Un scriitor tehnic poate să le fi produs, dar nu scrie atât de mult, cât este design grafic.

Scriitorii tehnici câștigă în medie aproximativ 75.000 de dolari pe an, conform Biroului de Statistică a Muncii din SUA, scriitorii tehnici de înaltă calificare depășesc 100.000 de dolari pe an și asta cu un motiv întemeiat. Își merită greutatea în aur în circumstanțele potrivite.

Te gândești să angajezi un scriitor tehnic? Aveți întrebări pentru noi despre scriitorii tehnici și despre cum diferă aceștia de redactorii sau scriitorii de conținut? Vă rog să-mi spuneți în secțiunea de comentarii! Aș fi bucuros să vă ajut și să încep o conversație pe acest subiect.