scrierea tehnică este practica procesării documentelor și a imaginilor, a informațiilor verbale și a demonstrațiilor la materialele de instruire instructivă. Scopul scrierii tehnice este de a oferi materiale care explică un proces sau de a face un concept complex mai ușor de înțeles pentru un anumit public. Prin scrierea tehnică eficientă și eficientă, scriitorul va putea explica și asista cititorul cum să înțeleagă informațiile și să îndeplinească sarcini specifice. Există cinci principii etice universale ale scrierii tehnice. Principiile sunt conținutul de calitate, publicul și scopul, accesibilitatea, gramatica și stilul de scriere.
conținut de calitate
conținutul de calitate este subiectiv. Definiția MATC a conținutului de înaltă calitate este un produs care îndeplinește standardele unui client sau depășește și depășește scopul inițial al proiectului. Pentru a produce un proiect de înaltă calitate, trebuie să scrieți cu publicul dorit în minte. Scriitorul trebuie să cerceteze cunoștințele suplimentare necesare înainte ca documentul sau materialul să fie finalizat. Scriitorul trebuie să știe ce format sau platformă va fi utilizată pentru a reprezenta informațiile. Scriitorul trebuie să determine informații specifice care variază de la cunoașterea termenelor limită până la cunoașterea motivului pentru care informațiile trebuie scrise.
audiența și scopul
scriitorul trebuie să înțeleagă atât scopul, cât și publicul pentru a crea o piesă tehnică remarcabilă. Publicul tehnic de scriere variază în funcție de industrie și de clientul particular. De exemplu, publicul unui raport tur ar fi fabricarea produsului care ne-a angajat ca scriitori. Publicul pentru un modul de formare eLearning poate fi un furnizor bancar sau ipotecar care are nevoie de formare de conformitate. Scriitorul trebuie să știe cât de mult vor ști cititorii și ce responsabilități trebuie să îndeplinească scriitorul atunci când vine vorba de comunicarea cu cititorii.
accesibilitate
este esențial ca publicul să poată accesa cu ușurință informațiile pe care scriitorul le-a creat. Accesibilitatea include orice se află într-un document, cum ar fi anteturile și subsolurile sau modulele iLearn ale computerului, care îmbunătățesc formatarea accesibilității pentru a fi mai universală și mai clară. Scriitorul tehnic trebuie să-și dea seama de cea mai bună metodă pentru a ajuta cititorii să navigheze documentația cu notații de la o bibliografie la numere de pagină la un cuprins. Scriitorul ar putea chiar să adauge imagini, cum ar fi diagrame și figuri, pentru a explica informații suplimentare.
gramatică
scrierea clară, concisă și directă cu o utilizare corectă a gramaticii este vitală în scrierea oricărei piese tehnice. Scriitorul trebuie, de asemenea, să corecteze și să editeze orice piesă tehnică scrisă pentru a corecta orice erori sau neconcordanțe cu gramatica, stilul și aspectul. Un scriitor tehnic ar trebui să scrie întotdeauna la timpul prezent, cu excepția cazului în care Clientul își indică preferința altfel. Cititorul piesei tehnice ar trebui să facă exact ceea ce dați instrucțiuni. Scriitorul ar trebui să scrie întotdeauna în propoziții simple care includ substantive neutre de gen. Propozițiile Simple îi ajută pe cititori să înțeleagă clar și eficient sarcinile pe care trebuie să le întreprindă pentru a-și îndeplini obiectivele.
stil de scriere
stilul de scriere diferă pentru fiecare piesă tehnică, deoarece depinde foarte mult de cine este publicul și de scenariul pentru care este scrisă piesa tehnică. Tonul unei piese tehnice de scriere este esențial, deoarece ajută cititorul să înțeleagă ce fel de ton este necesar pentru a finaliza sarcina. Alegerea cuvintelor este, de asemenea, o parte esențială a stilului în a ajuta la asigurarea nevoilor publicului, deoarece se conectează la cine este publicul tău. Când faceți referire la secțiuni de informații sau site-uri web, este esențial să furnizați modalități clare și vizibile de a accesa informațiile folosind instrumente, cum ar fi figuri și tabele.
alte sfaturi tehnice de scriere
faceți cercetări suplimentare și aflați mai multe
cunoașterea minimului ar putea să nu obțină cea mai bună piesă tehnică pentru a ajuta publicul să înțeleagă informațiile. Ar putea exista o mulțime de terminologie pe care atât scriitorul, cât și cititorul ar putea să nu o înțeleagă. De regulă, dacă tu, ca cititor, nu înțelegi un concept sau un termen, definește-l. Prea multe informații pot fi întotdeauna reduse în recenziile ulterioare. Aceste informații ar trebui cercetate pentru a înțelege cum funcționează cu ceea ce scriitorul scrie în ansamblu. Cercetați un mic tată și aflați ce alte informații ar putea fi folosite pentru a îmbunătăți piesa tehnică scrisă.
deveniți publicul și subestimați publicul
puneți-vă în locul publicului. Puteți înțelege și urma în mod clar instrucțiunile sau informațiile pe care le-ați scris pentru public? Dacă da, puteți oferi mai multe informații dacă credeți că are nevoie de puțin mai mult ajutor. Dacă nu, trebuie să găsiți părțile care nu sunt clare și să găsiți o modalitate de a furniza informațiile în mod corespunzător. O mare problemă pe care scriitorii tehnici o au adesea este că supraestimează cunoștințele publicului lor. Publicul ar putea fi mai mulți oameni la diferite niveluri de cunoaștere. Este perfect acceptabil să furnizați pe scurt informații care ar putea fi asumate sau deja declarate ca o perfecționare pentru public.
cere un al doilea și al treilea aviz și Peer Review
scriitori tehnice sunt resurse. Cea mai mare resursă pe care o aveți este experții dvs. în materie. Asigurați-vă că întrebați IMM-ul dvs. dacă văd lacune sau erori de cunoștințe. Scriitorii verifică cu clienții lor pentru a vedea dacă există lacune de cunoștințe sau erori pe care scriitorul le-ar putea trece cu vederea. Având un supervizor sau coleg uita-te peste și să dea un aviz ar putea ajuta, de asemenea, spori o piesă tehnică. Evaluarea inter pares este atunci când un grup de oameni se întâlnesc pentru a citi, a comenta și a recomanda îmbunătățiri ale muncii celuilalt. Mai multe puncte oarbe devin descoperite atunci când mai multe persoane revizuiesc un document, ceea ce asigură informații exacte și concise.
scriitorii tehnici învață informații noi pentru fiecare proiect la care lucrează. Scriitorii obține o mai bună înțelegere a ceea ce clienții au nevoie, deoarece acestea încep sub nivelul de cunoștințe de cititorii lor, înainte de toate de cercetare și discuții cu experții subiect. Acest lucru devine un avantaj important pentru companii, deoarece se deschid mai puține ipoteze pentru o formare mai eficientă. Combinația dintre scriitorii care învață materialul și aceste principii etice ale standardelor tehnice de scriere conduc la angajați mai încrezători și mai eficienți.