Scrierea tehnică comunică cititorilor informații tehnice despre o abilitate sau un produs. Este utilizat în mod obișnuit în domeniile tehnice și profesionale. În calitate de redactor tehnic, deseori scrieți documente precum ghiduri de utilizare, documentație pentru interfața de programare a aplicațiilor (API) și manuale de reparații și produse.

Ca și alte nișe de scris, scrisul tehnic are linii directoare specifice nișei. Respectarea acestor linii directoare vă va ajuta să scrieți documente bine structurate și să optimizați modul în care cititorii vă înțeleg munca. Iată câteva reguli de urmat pentru a deveni un bun scriitor tehnic.

1. Definiți-vă publicul

Analiza audienței este un factor indispensabil într-un document tehnic bun. Cunoașterea publicului vă ajută să determinați tipul de informații despre care să scrieți, cum ar trebui să le structurați și caracterul tehnic al limbajului dvs. Există patru segmente de public majore pentru scrierea tehnică: directori, experți, tehnicieni și nespecialiști.

Directorii sunt persoane care finanțează produsul și iau deciziile politice, administrative și economice care îl guvernează. Tehnicienii sunt oamenii care construiesc, operează și repara aceste produse. Experții proiectează, testează și știu totul despre produs, în timp ce nespecialiștii sunt utilizatorii finali ai produselor. Trebuie să luați în considerare publicul pentru a determina cel mai bun ton și stil de scriere pe care să le folosiți.

2. Identificați nevoile publicului dvs

Pe lângă cunoașterea și definirea publicului dvs., este esențial să înțelegeți obiectivele, interesele și nevoile acestora. Finalizarea analizei audienței este esențială în pregătirea documentelor, deoarece este mai puțin probabil să scrieți fără sughițuri și să cunoașteți bine nevoile publicului.

Pentru a efectua o analiză completă a audienței, trebuie să luați în considerare antecedentele publicului dvs., cunoștințele existente produsul, experiența, nevoile, interesele, caracteristicile demografice, preferințele culturale și de comunicare și obiective. Aceste informații vă vor ajuta să vă prezentați ideile cel mai eficient și eficient.

3. Cunoașteți limita cunoștințelor audienței dvs

Ca tehnică de analiză a audienței, puteți utiliza sondaje și chestionare pentru a cunoaște limita cunoștințelor audienței dvs. De asemenea, puteți obține opinii și stereotipuri populare, experiență personală, brainstorming și feedback al publicului, de la departamentul de marketing.

Dacă utilizați în mod corespunzător instrumentele enumerate mai sus, veți ști cât de mult înțelege publicul țintă informațiile pe care intenționați să le transmiteți. Aceste informații vor determina în mare măsură structura documentului, limitele și domeniul de aplicare, oferindu-vă un sentiment de direcție.

4. Păstrează-ți limbajul simplu

Scrierea tehnică ar trebui să prezinte un subiect prea complicat. Face acest lucru folosind un ghid simplu de stil de scriere. Ar trebui să vă asigurați că cititorul obișnuit vă poate înțelege cu ușurință scrisul.

Cu toate acestea, trebuie să rețineți că înțelegerea publicului dvs. este, de asemenea, cheia pentru stilul lingvistic pe care îl alegeți. De exemplu, jargonul profesional într-un document despre interfețe de programare a aplicațiilor (API) poate fi adecvat pentru tehnicieni, dar nu pentru utilizatorii finali. În consecință, trebuie să utilizați un limbaj ușor de înțeles pentru a ajuta la înțelegerea publicului. Poate doriți să învățați cum să utilizați un instrument precum Microsoft Editor pentru a vă verifica munca și pentru a vă asigura că scrisul este corect.

5. Utilizați Contururi

Contururile oferă cititorilor dvs. o idee despre ce să se aștepte în document. Un document fără contur copleșește cititorii, deoarece îi obligă să citească întregul text atunci când sunt interesați doar de dobândirea unor cunoștințe specifice.

În calitate de scriitor tehnic, conturarea documentului vă oferă, de asemenea, un sentiment de direcție atunci când scrieți. Vă ține pe drumul cel bun și vă asigură că nu pierdeți sau subapreciați punctele relevante. În plus, îmbunătățește structura documentului și servește drept feedback cu privire la ceea ce intenționați să acoperiți.

6. Utilizați grafica acolo unde este necesar

Atenția celor mai mulți cititori este atrasă în mod natural de grafică în comparație cu text. În documentele tehnice, graficele adecvate pot îmbunătăți înțelegerea de către cititori a textului prin prezentarea informațiilor clar și emfatic.

Cu toate acestea, ca scriitor tehnic, ar trebui să aveți grijă să nu folosiți grafică pentru a decora documentele. Tabelele, graficele, diagramele, fotografiile și ilustrațiile sunt grafice utilizate în mod obișnuit și pot îmbunătăți structura generală a documentului și pot atrage cititorii. Acestea fiind spuse, dacă sunteți nou în Google Docs, iată cum să creați și să editați tabele în Google Docs.

7. Implicați-vă cititorii

Deși este posibil să încercați să transmiteți informații tehnice cititorilor dvs., este important să îi implicați și pe aceștia. Fiecare document tehnic este centrat pe cititor și trebuie scris după gustul cititorului și nu al scriitorului. Curiozitatea intelectuală a cititorului dumneavoastră trebuie să fie satisfăcută pentru ca documentul dumneavoastră să fie util.

Îți poți angaja în mod activ cititorul scriind pentru a exprima, nu a impresiona și a ajunge direct la obiect. Evitați abrevierile și jargonul, folosiți mult spațiu alb pentru a îmbunătăți prezentarea vizuală și folosiți titluri pentru a vă ghida cititorul.

8. Nu faceți referire la informații sensibile la timp

Evitarea referințelor la informații sensibile la timp, în special la cele dintr-o perioadă comparabilă, este întotdeauna de preferat. Este mai sigur și mai înțelept să utilizați analize care au rezistat testului timpului, ceea ce o face veșnic verde și întotdeauna potrivită pentru cei care vă vor citi documentul în viitor.

De asemenea, trebuie să rețineți că atașarea anumitor ani, cum ar fi „2019”, pentru a sublinia punctul dvs. poate reduce utilitatea documentului dvs. în timp, cu excepția cazurilor specifice. Puteți preveni acest lucru utilizând un interval de timp mai larg, cum ar fi „În ultimii șapte ani”, astfel, oferindu-vă lucrării un nivel de credibilitate.

9. Folosiți exemple relevante

Când scrieți un document tehnic, utilizați instanțe live pentru a vă sublinia punctele. Deoarece publicul dvs. citește scrisul dvs. pentru a dobândi o abilitate, pentru a rezolva o problemă sau pentru a învăța câteva linii directoare, trebuie să le oferiți exemple practice și care să poată fi identificate.

Aceste exemple îmbunătățesc lizibilitatea lucrării dvs. și comunică informații complexe cititorului dvs., oferind context produselor și proceselor. În acest fel, este mai probabil să folosească produsele în mod intenționat și în siguranță.

10. Obțineți o evaluare terță parte înainte de publicare

Un document tehnic ar trebui să treacă întotdeauna printr-un proces de colaborare care implică scriitorul și recenzentul. O revizuire terță parte ajută la generarea unui document axat pe public, fără erori și cu impact.

În calitate de autor original al documentului, este posibil să fi scris multe schițe înainte de a crea documentul final. Cu toate acestea, indiferent cât de bine ar fi documentul dvs., nu depindeți numai de inteligența dvs.

Deveniți un scriitor tehnic profesionist astăzi

Înțelegerea regulilor esențiale care ghidează scrierea tehnică vă va face mai priceput și foarte căutat. Multe organizații știu cât de important este ca produsele sau serviciile lor să fie bine comercializate pentru utilizatorii finali și să-i ajuți să atingă acest lucru este scopul tău ca scriitor tehnic.