Tehnoredactare pentru tehnicieni

Una dintre cele mai comune și importante utilizări ale tehnoredactării este reprezentată de instrucțiuni – acele explicații pas cu pas despre cum să faci lucruri: să asamblezi ceva, să operezi ceva, să repari ceva sau să explici un proces personal (înscrierea la facultate, de exemplu) astfel încât cititorii să îl înțeleagă mai bine și eventual să îl folosească ei înșiși.

Textele de proces sunt extrem de comune în școală și în profesii. În școală, profesorii atribuie frecvent sarcini de proces. De exemplu, profesorii de științe umaniste pot cere o descriere a modului în care a evoluat o perioadă artistică sau literară; profesorii de istorie, contribuțiile liderilor unei culturi de-a lungul timpului; profesorii de științe sociale, cronologia invențiilor; profesorii de inginerie, explicații privind modul în care sunetul este transformat în semnale electrice; profesorii de afaceri, modul în care funcționează Rezerva Federală sau cum se vinde un produs.

În mod cotidian, citim procese descriptive, inclusiv rețete, manuale de utilizare pentru un nou software sau rubrici de sfaturi despre cum să slăbești sau cum să reușești la școală sau într-o profesie. Aceste texte se concentrează pe răspunsul la una dintre următoarele întrebări:

„Cum se face asta?”
„Cum pot face asta?”

În timp ce subiectele unui raport de proces sau ale unui set de instrucțiuni pot varia, multe dintre ele au asemănări: majoritatea sunt scrise pentru a explica cum funcționează ceva, majoritatea sunt structurate în ordine cronologică folosind pași numerotați și majoritatea se bazează în mare măsură pe elemente vizuale. În scrierea instrucțiunilor pentru învățarea unui nou program software, de exemplu, scriitorii ar putea folosi capturi de ecran și/sau clipuri video de pe ecran pentru a-i ghida pe utilizatori prin tutorial.

În general, este bine să aveți atât text, cât și elemente vizuale în instrucțiunile dumneavoastră, deoarece publicul dumneavoastră este probabil format din persoane cu stiluri de învățare diferite. Cu toate acestea, utilizarea elementelor vizuale poate varia în funcție de publicul dvs. și de utilizarea preconizată a instrucțiunilor. Elementele vizuale ajută la clarificarea unui concept care este dificil de explicat folosind doar cuvinte. Elementele grafice pot fi utilizate pentru a arăta cum arată ceva, cum ar trebui să arate ceva odată ce etapa a fost finalizată, cum se face sau se construiește ceva, pentru a arăta tendințe sau relații, pentru a adăuga vivacitate proiectului sau pur și simplu pentru a ajuta la organizarea informațiilor. Grafica este utilă deoarece aproape toată lumea (inclusiv copiii și alte persoane de altă limbă) poate înțelege instrucțiunile vizuale și poate vedea exact ceea ce trebuie să finalizeze.

Tipuri de instrucțiuni

Există trei tipuri principale de texte de proces:

- - Procese descriptive: acestea răspund la întrebarea: „Cum se face acest lucru?”. Aceste texte descriu modul în care are loc un proces, astfel încât cititorii să îl poată înțelege mai bine. De exemplu, scrierea unui proces descriptiv despre modul în care v-ați înscris la un curs online, mai degrabă decât în persoană, ar putea fi utilă pentru cineva care nu a făcut niciodată înscrieri online.

- - Procese descriptive: acestea sunt de natură explicativă; ele prescriu cum se face (sau ar trebui să se facă) ceva, astfel încât cititorii să poată face singuri acest lucru. Acestea sunt cel mai frecvent tip de documente instructive. De exemplu, ați putea scrie un ghid de procese prescriptive pentru utilizatori care să explice cum să efectueze întreținerea de bază a mașinilor lor, cum ar fi schimbarea uleiului propriu, verificarea bujiilor sau înlocuirea plăcuțelor de frână. *Eșantioanele enumerate mai jos sunt exemple de procese prescriptive.

- - Procesele descriptive și prescriptive îmbinate fac din axa principală a documentului un proces descriptiv, având în același timp câteva secțiuni care rezumă modul în care cititorii pot efectua procesul. Cu alte cuvinte, scriitorii pot aborda atât „Cum pot face acest lucru?”, cât și „Cum se face acest lucru?” în diferite părți ale unui text. În mod alternativ, ei ar putea dezvolta versiuni diferite ale aceluiași document pentru două audiențe – o audiență de utilizatori și o audiență de părți interesate.

Pentru început

La începutul unui proiect sau al unei sarcini de redactare de instrucțiuni, este important să luați în considerare publicul dumneavoastră și să determinați caracteristicile (numărul de sarcini și etape) ale procedurii particulare despre care intenționați să scrieți.

Publicul și situația: La începutul procesului, definiți publicul și situația instrucțiunilor dumneavoastră. Amintiți-vă că definirea unui public înseamnă definirea nivelului de cunoștințe și familiaritate al acestuia cu subiectul. Uneori este util să vă descrieți mai întâi audiența dvs. pentru dvs. înșivă, iar apoi să folosiți acest lucru pentru a vă evalua mesajul la final, pentru a fi siguri că este adecvat pentru publicul dvs.

Numărul de sarcini: Un considerent important este cât de multe sarcini există în procedura pentru care scrieți instrucțiuni. Termenul de procedură poate fi folosit pentru a se referi la întregul set de activități despre care vorbesc instrucțiunile dumneavoastră, în timp ce sarcina poate fi folosită pentru a defini un grup semi-independent de acțiuni din cadrul procedurii. De exemplu, configurarea modemului este o sarcină în cadrul procedurii generale de conectare a unui calculator la internet.

Ca un alt exemplu, o procedură simplă, cum ar fi schimbarea uleiului unei mașini, conține o singură sarcină; nu există grupări semi-independente de alte activități. O procedură mai complexă, cum ar fi utilizarea unui cuptor cu microunde, conține o mulțime de sarcini semi-independente, cum ar fi setarea ceasului, setarea nivelului de putere, utilizarea temporizatorului, curățarea și întreținerea cuptorului cu microunde și altele.

Câteva instrucțiuni au o singură sarcină, dar au mai multe etape în cadrul acelei sarcini unice. De exemplu, imaginați-vă un set de instrucțiuni pentru asamblarea unui leagăn pentru copii. O abordare eficientă ar fi să grupați pașii similari și înrudiți în faze și apoi să renumerotați pașii la fiecare nouă fază. O fază este un grup de etape similare în cadrul unei proceduri pentru o singură sarcină. În exemplul setului de leagăn, montarea cadrului ar fi o fază; ancorarea lucrului în pământ ar fi o altă fază; și asamblarea leagănului din cutie ar fi încă una.

Concentrarea instrucțiunilor

Un alt considerent, pe care poate că nu îl puteți determina de la început, este cum să vă concentrați instrucțiunile. Pentru majoritatea instrucțiunilor, vă puteți concentra pe sarcinile implicate sau vă puteți concentra pe instrumentele necesare.

- - Într-o abordare prin sarcini a instrucțiunilor de utilizare a unui robot telefonic, ați avea secțiuni privind înregistrarea salutului, redarea mesajelor, salvarea mesajelor, transmiterea mesajelor și ștergerea mesajelor. Acestea sunt sarcini – lucrurile tipice pe care utilizatorii ar dori să le facă cu aparatul.

- - Pe de altă parte, într-o abordare bazată pe instrumente a instrucțiunilor privind utilizarea unui fotocopiator, ar exista secțiuni privind butonul de copiere, butonul de anulare, butonul de mărire/reducere, butonul de îmbinare/agrafare, tava de hârtie, butonul de mărime a copiei și așa mai departe. Dacă ați concepe un set de instrucțiuni pe acest plan, probabil că ați scrie pași pentru utilizarea fiecărui buton sau funcție a fotocopiatorului.

Contenutul instrucțiunilor

Asigurați-vă că ați citit secțiunea „Proiectarea documentului” înainte de a crea instrucțiunile dumneavoastră. Includeți următoarele elemente:

Introducere: În planificarea atentă a introducerii instrucțiunilor dumneavoastră, asigurați-vă că:

- - - Indicați sarcinile specifice sau procedura care urmează să fie explicată.
    - Indicați de ce are nevoie publicul în ceea ce privește cunoștințele și contextul pentru a înțelege instrucțiunile.
    - Dă o idee generală despre procedură și despre ceea ce se realizează.
    - Indicați condițiile în care aceste instrucțiuni ar trebui (sau nu ar trebui) să fie utilizate.
    - Dă o imagine de ansamblu a conținutului instrucțiunilor.

Avertismente generale de avertizare, precauție, pericol: Instrucțiunile trebuie, de asemenea, să avertizeze cititorii asupra posibilității de a-și strica echipamentul, de a greși procedura și/sau de a se răni. De asemenea, instrucțiunile trebuie să sublinieze punctele cheie sau excepțiile. Pentru aceste situații, trebuie să folosiți anunțuri speciale, cum ar fi Notă, Avertisment, Atenție, Prudență și/sau Pericol.

Fondamente tehnice sau teorie: La începutul unor instrucțiuni (de obicei după introducere), este posibil să aveți nevoie de o discuție despre contextul legat de procedură. Pentru anumite instrucțiuni, acest context este esențial – în caz contrar, pașii din procedură nu au sens. În unele cazuri, este posibil ca autorii instrucțiunilor să fie nevoiți să petreacă un timp semnificativ explicând lucrurile cititorilor înainte de a trece la pașii efectivi implicați în procedură.

Echipamente și consumabile: Majoritatea instrucțiunilor includ o listă a lucrurilor pe care trebuie să le adunați înainte de a începe procedura. Aceasta include echipamentul, adică uneltele pe care le folosiți în cadrul procedurii (cum ar fi boluri de amestecat, linguri, tigăi de pâine, ciocane, burghie și ferăstraie) și consumabilele, adică lucrurile care se consumă în cadrul procedurii (cum ar fi lemn, vopsea, ulei, făină și cuie). În instrucțiuni, acestea sunt enumerate de obicei fie într-o listă verticală simplă, fie într-o listă pe două coloane la începutul instrucțiunilor. Folosiți lista cu două coloane dacă trebuie să adăugați specificații la unele sau la toate elementele – de exemplu, nume de marcă, dimensiuni, cantități, tipuri, numere de model și așa mai departe.

Discutarea etapelor: Când ajungeți la scrierea propriu-zisă a etapelor, asigurați-vă că analizați cu atenție structura și formatul acestor etape, orice informații suplimentare care ar putea fi necesare, precum și punctul de vedere și stilul general de redactare a instrucțiunilor. Un punct de vedere utilizat în scrierea tehnică este persoana a doua, care se adresează publicului ca și cum ați fi dumneavoastră.

*În general, scriitorii de instrucțiuni ar trebui să se străduiască să facă următoarele:

- - Utilizați o scriere clară și simplă ori de câte ori este posibil.

- - Aveți o înțelegere temeinică a procesului în toate detaliile sale tehnice.

Eșantioane de instrucțiuni pentru elevi

Exemplu de instrucțiuni de sudură (eșantion de elev)

Exemplu de instrucțiuni de mecatronică – Testarea diodelor & Tranzistoare (probă pentru elevi)

Instrucțiuni Auto/Diesel – Cum să înlocuiți o bară stabilizatoare spate la o Toyota Corolla (probă pentru elevi)

Pat Instrucțiuni de transfer (probă pentru elevi)

Cum se schimbă corzile la chitară (probă pentru elevi)

Eșantioane de instrucțiuni profesionale

Sudură Instrucțiuni eșantion 1 (eșantion profesional)

Casa de vis a lui Barbie (eșantion profesional)

Asamblarea trambulinei (eșantion profesional)