În general, sarcina unui scriitor tehnic este una - să pregătească un astfel de text care să permită unui nou utilizator să utilizeze corect programul sau dispozitivul.
Un scriitor tehnic se poate conecta la un grup de lucru în faza de dezvoltare a unui viitor produs. Produsul trebuie testat, caracteristicile și toate funcțiile posibile trebuie studiate. Rezultatul muncii este o instrucțiune completă, cu o descriere detaliată a utilizării produsului, însoțită de ilustrații clare.
Principalele instrumente ale unui scriitor tehnic sunt un editor de text, un înregistrator de voce, precum și, în funcție de specificul proiectului, MS Manual of Style, Apple Style Manual, Chicago Manual of Style, MS Word, Adobe FrameMaker (pentru crearea materiale offline), Adobe RoboHelp, MadCapFlare (pentru documentare online) și altele.
Cunoașteți-vă domeniul de activitate
Toată lumea este conștientă de expresia „Dacă toate celelalte eșuează, citiți în cele din urmă instrucțiunile”. Dar cum puteți scrie instrucțiuni, astfel încât dorința de a le citi apare chiar înainte de a începe să lucrați cu produsul software? Cum îl faceți informativ atât pentru utilizatorii experimentați, cât și pentru începători? Ca scriitor tehnic, ar trebui să stăpâniți următoarele și puțin mai mult
- determină compoziția și structura documentelor incluse în setul de documentare;
- determina cerințele pentru documentare și fii ghidat de acestea în lucru;
- să prezinte în mod eficient conținutul documentelor;
- întocmește documentația în stilul solicitat;
- asigurați relevanța documentației, urmăriți modificările acesteia.
Unele companii IT necesită ca un scriitor tehnic să cunoască limbaje de markup sau unul dintre limbajele de programare la nivelul citirii codului, în timp ce altele necesită abilități în lucrul cu baze de date sau sisteme de gestionare a interogărilor.
Arătați interes și rămâneți implicat
Ceea ce va fi la îndemână sigur este interesul pentru zona despre care scrieți: Dacă un scriitor tehnic nu este interesat de domeniul în care lucrează, îi va fi dificil. O astfel de profesie nu este potrivită pentru cei care nu sunt pregătiți să-și îmbunătățească nivelul de limbă - atât nativ, cât și străin. Dacă o persoană este interesată de toate acestea, atunci se va regăsi în această profesie.
Maestrul DITA
Formatul DITA, în general, sa dovedit a fi un instrument foarte convenabil pentru dezvoltarea documentației tehnice cu conținutul său specific. De exemplu, putem reutiliza orice bloc de text sau o secțiune întreagă dintr-un document într-un alt document. Și aceasta nu va fi „copierea-lipirea” obișnuită, ci utilizarea unui bloc în documente diferite. Dacă se schimbă ceva în acest bloc, ne va fi suficient să schimbăm textul o dată - modificarea va merge automat la toate documentele. De asemenea, putem aplica filtre - scrieți o secțiune universală, introduceți-o în mai multe documente și apoi filtrați conținutul acesteia în funcție de tipul de document, client, sistem și alți parametri. Și, de asemenea, nu ne gândim la referințe încrucișate între secțiuni - este suficient să indicăm la locul potrivit cheia secțiunii la care dorim să ne referim. Când asamblați un document, Toolkit va numera secțiunile în sine și va crea hyperlinkuri frumoase.
Corectat: funcționează în continuare
… Și pentru scrierea tehnică profesională!
Când un scriitor termină de lucrat la un document, el / ea trebuie să îl trimită spre examinare. Analiștii de afaceri, dezvoltatorii, testerii verifică documentația. Aceasta este o etapă foarte importantă, deoarece un scriitor poate face întotdeauna o greșeală - să înțeleagă ceva greșit, să nu ia în considerare unele caracteristici de implementare nedocumentate.
Nu ezitați să cereți ajutor
Dacă sunteți doar un începător sau dacă scrierea tehnică face parte din programul dvs. de facultate sau nu aveți suficient timp pentru a vă termina temele tehnice înainte de termenul limită, luați în considerare delegarea acesteia unui serviciu de asistență profesională, cum ar fi Laboratorul meu de atribuire. În primul rând, cu siguranță nu sunteți primul student care are nevoie de ajutor de specialitate pentru a face teme tehnice, iar serviciile sunt pe deplin pregătite să vă ofere asistență, chiar dacă proiectul este complex și termenul este foarte aproape. Este timpul să recunoaștem că este mai bine să delegați decât să eșuați. Plasarea unei comenzi de scriere tehnică nu va dura mult - veți lista doar detaliile comenzii, veți atașa materialele suplimentare, veți specifica cerințele și termenul, veți alege o metodă de plată. Cu cât comanzi mai devreme, cu atât plătești mai puțin. Comenzile urgente sunt cele mai scumpe. Cu toate acestea, comandarea unor piese de scriere tehnică de la autori experimentați vă ajută să deveniți un scriitor mai bun. Studiați materialele primite și folosiți-le ca eșantion pentru sarcini suplimentare.
Participați la TW-Quest online
Există multe lucruri pe care le puteți învăța concurând. Specialiștii IT au hackatoni și alte competiții. Căutările de scriere tehnică nu sunt atât de populare pentru moment, dar puteți găsi una sau două în orice sezon. Este distractiv să participi la astfel de evenimente și, de asemenea, te ajută la dezvoltarea stilului tău unic, la învățarea de la cei mai buni și mai strălucitori și la perfecționarea abilităților tale. Ideea principală este să rămâi angajat și creativ, să devii o parte a comunității de scriere tehnică.
Scrierea tehnică este o parte valoroasă a traducerii dintr-o limbă în aceeași limbă - de la limbajul tehnic la utilizarea limbii. Este o slujbă plină de satisfacții și interesantă care necesită învățare constantă, concentrare, studiu de programe noi și participarea la comunitate.
