Instrucțiuni

Accentul acestui capitol este una dintre cele mai importante utilizări ale scrierii tehnice – instrucțiunile. După cum știți, instrucțiunile sunt acele explicații pas cu pas despre cum să faci ceva: cum să construiești, să operezi, să repari sau să întreții lucruri.

Asigură-te că verifici exemplele.

Scrierea de instrucțiuni

Una dintre cele mai comune și una dintre cele mai importante utilizări ale scrierii tehnice sunt instrucțiunile – acele explicații pas cu pas despre cum să faci ceva: să asamblezi ceva, să operezi ceva, să repari ceva sau să faci întreținere de rutină la ceva. Dar pentru ceva aparent atât de ușor și intuitiv, instrucțiunile sunt unele dintre cele mai prost scrise documente pe care le puteți găsi. Ca și mine, probabil că ați avut multe experiențe exasperante cu instrucțiuni prost scrise. Este posibil ca ceea ce urmează în acest capitol să nu fie un ghid de redactare a instrucțiunilor care să fie infailibil și fără greșeli, dar vă va arăta ceea ce profesioniștii consideră a fi cele mai bune tehnici.

În ultimă instanță, o bună redactare a instrucțiunilor necesită:

• Scrierea clară și simplă
• O înțelegere temeinică a procedurii în toate detaliile sale tehnice
• Capacitatea dumneavoastră de a vă pune în locul cititorului, a persoanei care încearcă să folosească instrucțiunile dumneavoastră
• Capacitatea dumneavoastră de a vizualiza procedura în mare detaliu și de a capta această conștientizare pe hârtie
• În cele din urmă, dorința dumneavoastră de a merge mai departe și de a testa instrucțiunile dumneavoastră pe tipul de persoană pentru care le-ați scris.

Până acum, probabil că ați studiat titlurile, listele și mențiunile speciale – scrierea unui set de instrucțiuni cu aceste instrumente pare probabil evidentă. Trebuie doar să împărțiți discuția în liste verticale numerotate și să aruncați câteva note speciale în punctele evidente și ați terminat! Ei bine, nu chiar, dar este un bun început. Acest capitol explorează unele dintre caracteristicile instrucțiunilor care le pot face mai complexe. La rândul vostru, puteți folosi aceste considerații pentru a vă planifica propriile instrucțiuni.

Câteva preliminarii

La începutul unui proiect de redactare a unor instrucțiuni, este important să determinați structura sau caracteristicile procedurii particulare despre care veți scrie.

Adresaj și situație. La începutul procesului, definiți publicul și situația instrucțiunilor dumneavoastră. Amintiți-vă că definirea unui public înseamnă definirea nivelului de familiaritate al acestuia cu subiectul, precum și alte detalii de acest gen. Consultați discuția despre audiențe și pașii de utilizat în definirea audiențelor.

Cel mai important, dacă sunteți la un curs de scriere, va trebui să scrieți o descriere a audienței dumneavoastră și să o atașați la instrucțiunile dumneavoastră. Acest lucru îi va permite instructorului dvs. să vă evalueze instrucțiunile din punct de vedere al corectitudinii lor pentru publicul vizat. Și nu uitați, de asemenea, că la un curs de scriere tehnică este preferabil să scrieți pentru un public nespecializat – o provocare mult mai mare pentru dumneavoastră ca scriitor.

Numărul de sarcini. Câte sarcini există în procedura despre care scrieți? Haideți să folosim termenul de procedură pentru a ne referi la întregul set de activități pe care instrucțiunile dvs. sunt destinate să le abordeze. O sarcină este un grup semi-independent de acțiuni din cadrul procedurii: de exemplu, setarea ceasului la un cuptor cu microunde este o sarcină din marea procedură generală de operare a unui cuptor cu microunde.

O procedură simplă, cum ar fi schimbarea uleiului la o mașină, conține doar o singură sarcină; nu există grupări semi-independente de activități. O procedură mai complexă cum ar fi utilizarea unui cuptor cu microunde conține o mulțime de astfel de sarcini semi-independente: setarea ceasului; setarea nivelului de putere; utilizarea temporizatorului; curățarea și întreținerea cuptorului cu microunde, printre altele. (Instrucțiunile de utilizare a unui aparat de fotografiat sunt organizate pe sarcini.)

Câteva instrucțiuni au o singură sarcină, dar au mulți pași în cadrul acelei singure sarcini. De exemplu, imaginați-vă un set de instrucțiuni pentru asamblarea unui leagăn pentru copii. În propria mea experiență, au existat mai mult de 130 de pași! Acest lucru poate fi un pic descurajant. O abordare bună este să grupați pașii similari și înrudiți în faze și să începeți să renumerotați pașii la fiecare nouă fază. Astfel, o fază este un grup de pași similari în cadrul unei proceduri cu o singură sarcină. În exemplul leagănului, montarea cadrului ar fi o fază; ancorarea în pământ ar fi o altă fază; asamblarea leagănului în cutie ar fi încă una.

Cea mai bună abordare a discuției pe etape. Un alt considerent, pe care poate 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 sarcini sau vă puteți concentra pe instrumente (sau pe caracteristici ale instrumentelor).

Într-o abordare pe sarcini (cunoscută și ca orientare pe sarcini) a instrucțiunilor privind utilizarea unui serviciu de răspuns la telefon, ați avea aceste secțiuni:

• Înregistrarea salutului
• Redarea mesajelor
• Salvarea mesajelor
• Întoarcerea mesajelor
• Ștergerea mesajelor, și așa mai departe

Acestea sunt sarcini – lucrurile tipice pe care am vrea să le facem cu aparatul. Pentru mai multe discuții, consultați capitolul privind analiza sarcinilor.

Pe de altă parte, într-o abordare a instrumentelor pentru instrucțiunile de utilizare a unui fotocopiator, ar exista aceste secțiuni improbabile:

• Botonul de copiere
• Botonul de anulare
• Botonul de mărire/reducere
• Botonul de copiere/grapare
• Botonul de mărime a copiei, și așa mai departe

Dacă ați proiecta un set de instrucțiuni pe acest plan, ați scrie pași pentru utilizarea fiecărui buton sau funcție a fotocopiatorului. Instrucțiunile care folosesc această abordare a instrumentelor sunt greu de făcut să funcționeze. Uneori, numele butonului nu se potrivește prea bine cu sarcina cu care este asociat; uneori trebuie să folosiți mai mult decât un singur buton pentru a îndeplini sarcina. Totuși, pot exista momente în care abordarea instrumente/caracteristică poate fi preferabilă.

Grupări de sarcini. Este posibil ca enumerarea sarcinilor să nu fie tot ceea ce trebuie să faceți. Este posibil să existe atât de multe sarcini încât trebuie să le grupați pentru ca cititorii să le poată găsi mai ușor pe cele individuale. De exemplu, următoarele sunt grupări obișnuite de sarcini în instrucțiuni:

1. T Sarcini de despachetare și configurare
2. Tarcini de instalare și personalizare
3. Tarcini de operare de bază
4. Tarcini de întreținere de rutină
5. Tarcini de rezolvare a problemelor; și așa mai departe

Secțiuni comune în instrucțiuni

În cele ce urmează este o trecere în revistă a secțiunilor pe care le veți găsi în mod obișnuit în instrucțiuni. Nu presupuneți că fiecare dintre ele trebuie să se regăsească în instrucțiunile reale pe care le scrieți, nici că trebuie să fie în ordinea prezentată aici, nici că acestea sunt singurele secțiuni posibile într-un set de instrucțiuni.

În timp ce citiți cele ce urmează despre secțiunile comune în instrucțiuni, verificați instrucțiunile de exemplu.

Vedere schematică a instrucțiunilor. Rețineți că acesta este un model tipic sau comun pentru conținut și organizare – sunt posibile multe altele.

Introducere. Planificați cu atenție introducerea instrucțiunilor dumneavoastră. Asigurați-vă că face oricare dintre următoarele lucruri (dar nu neapărat în această ordine) care se aplică instrucțiunilor dvs. particulare:

• Indicați sarcinile specifice sau procedura care urmează să fie explicată, precum și domeniul de acoperire (ceea ce nu va fi acoperit).
• Indicați de ce are nevoie audiența în termeni de cunoștințe și context pentru a înțelege instrucțiunile.
• Faceți 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.
• Faceți o prezentare generală a conținutului instrucțiunilor.

Vezi secțiunea privind introducerile pentru discuții suplimentare.

Avertismente generale de avertizare, precauție, pericol. Adesea, instrucțiunile trebuie să avertizeze cititorii asupra posibilității de a-și strica echipamentul, de a da peste cap procedura și de a se răni. De asemenea, instrucțiunile trebuie adesea să sublinieze punctele cheie sau excepțiile. Pentru aceste situații, folosiți anunțuri speciale – note, avertismente, atenționări, atenționări de precauție și de pericol. Observați cum sunt folosite aceste avize speciale în instrucțiunile de exemplu enumerate mai sus.

Fondamente tehnice sau teorie. La începutul anumitor tipuri de instrucțiuni (după introducere, bineînțeles), 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. De exemplu, este posibil să fi avut ceva experiență cu acele applet-uri software în care vă definiți propriile culori prin deplasarea barelor glisante roșii, verzi și albastre. Pentru a înțelege cu adevărat ceea ce faceți, trebuie să aveți ceva cunoștințe despre culori. În mod similar, vă puteți imagina că, pentru anumite instrucțiuni care folosesc aparate de fotografiat, ar putea fi nevoie și de puțină teorie.

Echipamente și consumabile. Observați că 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ă cu două coloane. Folosiți lista cu două coloane dacă trebuie să adăugați unele 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, există câteva lucruri de care trebuie să țineți cont: (1) structura și formatul acestor etape, (2) informațiile suplimentare care ar putea fi necesare și (3) punctul de vedere și stilul general de scriere.

Structura și formatul. În mod normal, ne imaginăm un set de instrucțiuni ca fiind formatat sub forma unor liste verticale numerotate. Și majoritatea sunt, de fapt, așa. În mod normal, formatați instrucțiunile reale pas cu pas în acest fel. Cu toate acestea, există unele variații, precum și alte considerații:

• Pașii cu ordine fixă sunt pași care trebuie să fie executați în ordinea prezentată. De exemplu, dacă schimbați uleiul la o mașină, golirea uleiului este un pas care trebuie să vină înainte de a pune uleiul nou. Acestea sunt liste numerotate (de obicei, liste numerotate pe verticală).
• Pașii cu ordine variabilă sunt pași care pot fi executați practic în orice ordine. Exemple bune sunt acele ghiduri de depanare care vă spun să verificați asta, verificați aia atunci când încercați să reparați ceva. Puteți efectua acest tip de pași practic în orice ordine. Cu acest tip, lista punctată este formatul adecvat.
• Pașii alternativi sunt cei în care sunt prezentate două sau mai multe moduri de a realiza același lucru. Pașii alternativi sunt, de asemenea, utilizați atunci când pot exista diverse condiții. Utilizați liste cu puncte cu acest tip, cu OR inserat între alternative, sau lead-in-ul care indică faptul că urmează să fie prezentate alternative.
• Etape imbricate. În unele cazuri, etapele individuale din cadrul unei proceduri pot fi destul de complexe în sine și trebuie să fie împărțite în subetape. În acest caz, se face o indentare mai mare și se secvențiază subetapele ca a, b, c, și așa mai departe.
• Instrucțiuni „fără trepte”. Și, în cele din urmă, există instrucțiuni care chiar nu pot folosi lista verticală numerotată și care nu fac decât foarte puțin sau chiar deloc dirijarea directă a cititorului în stil instructiv. Unele situații trebuie să fie atât de generalizate sau atât de variabile încât nu pot fi enunțate etape.

Vezi capitolul despre liste pentru stilul și formatul acestor posibilități.

Discuție suplimentară. Adesea, nu este suficient să le spunem pur și simplu cititorilor să facă asta sau să facă aia. Ei au nevoie de informații explicative suplimentare, cum ar fi cum ar trebui să arate lucrul înainte și după pas; de ce ar trebui să le pese să facă acest pas; ce principiu mecanic se află în spatele a ceea ce fac; chiar și mai multe explicații la nivel micro al pasului – discutarea acțiunilor specifice care alcătuiesc pasul.

Problema cu discuțiile suplimentare, totuși, este că acestea pot ascunde pasul propriu-zis. Vreți ca pasul real – acțiunile specifice pe care cititorul trebuie să le facă – să iasă în evidență. Nu vreți ca totul să fie îngropat într-o grămadă de cuvinte. Există cel puțin două tehnici pentru a evita această problemă: puteți despărți instrucțiunea de supliment în paragrafe separate; sau puteți scrie cu bold instrucțiunea.

Boldingul pașilor reali ai utilizatorului în instrucțiuni. Textul bold ajută la distingerea acțiunii efective de informațiile suplimentare.

Stilul de scriere. Modul în care scrieți efectiv instrucțiunile, propoziție cu propoziție, poate părea în contradicție cu ceea ce v-au învățat cursurile anterioare de scriere. Cu toate acestea, observați cum sunt scrise instrucțiunile din „lumea reală” – ele folosesc mult tip de scriere imperativă (comandă sau adresare directă); ele folosesc mult „tu”. Acest lucru este pe deplin adecvat. Vreți să intrați în fața cititorului dumneavoastră, să-i atrageți întreaga atenție. Din acest motiv, propozițiile de tip instructiv sună ca acestea: „Acum, apăsați butonul Pauză de pe panoul frontal pentru a opri temporar afișajul” și „Trebuie să aveți grijă să nu …”

O problemă deosebită implică utilizarea vocii pasive în instrucțiuni. Dintr-un motiv ciudat, unele instrucțiuni sună în felul următor: „Trebuie apăsat butonul Pauză pentru a opri temporar afișajul”. Nu numai că suntem îngrijorați de sănătatea mintală a butonului Pauză, dar ne întrebăm și cine ar trebui să apese pe el (cu mine vorbești?). Sau luați în considerare acest exemplu: „Butonul Timer este apoi setat la ora 3:00.” Din nou, în calitate de persoană care urmează aceste instrucțiuni, s-ar putea să nu observați acest lucru; s-ar putea să credeți că este pur și simplu o referință la o stare existentă, sau să vă întrebați: „Cu mine vorbesc?”. Aproape la fel de rău este utilizarea persoanei a treia: „Utilizatorul trebuie să apese apoi butonul Pauză.” Din nou, este vorba de vechea dublă luare de vederi: te uiți prin cameră și te întrebi: „Cine eu?”. (Pentru mai multe detalii, vezi problema vocii pasive.)

O altă problemă tipică a stilului de scriere în instrucțiuni este că oamenii par să vrea să omită articolele: „Apăsați butonul Pauză de pe panoul frontal pentru a opri temporar afișarea informațiilor” sau „Persoană de pe Pământ, vă rugăm să furnizați adresa celei mai apropiate pizzerii”. De ce facem acest lucru? Oare ne dorim cu toții în secret să fim roboți? Oricum, asigurați-vă că includeți toate articolele (a, an, the) și alte astfel de cuvinte pe care le-am folosi în mod normal în instrucțiuni.

Grafica în instrucțiuni

Probabil mai mult decât în orice altă formă de scriere (cu excepția poate a benzilor desenate), grafica este crucială pentru instrucțiuni. Uneori, cuvintele pur și simplu nu pot explica pasul. Ilustrațiile sunt adesea esențiale pentru capacitatea cititorilor de a vizualiza ceea ce trebuie să facă.

În cadrul unui curs de scriere tehnică, este posibil ca instrucțiunile să vă ceară să includeți ilustrații sau alte tipuri de grafică – orice ar fi folosit în mod normal în instrucțiuni. Problema ar putea fi, desigur, că nu aveți acces la o grafică adecvată pentru instrucțiunile dumneavoastră și că nu vă simțiți foarte încrezător în abilitățile dumneavoastră artistice. Există modalități de a depăși aceste probleme! Aruncați o privire la sugestiile din domeniul graficii. În acel capitol, veți vedea nu numai sugestii pentru crearea de grafice, ci și cerințe privind formatul acestora.

Format în instrucțiuni

Capitole. În instrucțiunile dumneavoastră, folosiți bine titlurile. În mod normal, veți dori titluri pentru orice secțiune de fond pe care ați putea să o aveți, secțiunea de echipamente și consumabile, un titlu general pentru secțiunea de instrucțiuni propriu-zisă și subtitluri pentru sarcinile sau fazele individuale din cadrul acestei secțiuni. Aruncați o privire la exemplele de la începutul acestui capitol. Consultați rubricile pentru cerințele comune.

Liste. În mod similar, instrucțiunile folosesc de obicei foarte mult listele, în special listele verticale numerotate pentru explicațiile propriu-zise pas cu pas. Listele verticale simple sau listele cu două coloane sunt de obicei bune pentru secțiunea de echipamente și consumabile. Listele în propoziții sunt bune ori de câte ori oferiți o imagine de ansamblu a lucrurilor care urmează. Consultați listele pentru cerințe comune.

Avizări speciale. În instrucțiuni, trebuie să atenționați cititorii asupra posibilităților în care aceștia pot deteriora echipamentul, risipi consumabilele, face ca întreaga procedură să eșueze, se pot răni pe ei înșiși sau pe alții – chiar grav sau mortal. Companiile au fost date în judecată pentru lipsa acestor mențiuni speciale, pentru mențiuni speciale prost redactate sau pentru mențiuni speciale care nu erau la locul lor. A se vedea mențiuni speciale pentru o discuție completă despre utilizarea corectă a acestor mențiuni speciale, precum și despre formatul și plasarea lor în cadrul instrucțiunilor.

Indentarea avizelor în instrucțiuni. În primul exemplu, observați cum nota este indentată față de textul pasului precedent. În cel de-al doilea exemplu, observați că nota severă este plasată la început, înainte de oricare dintre etape.

Numere, abrevieri și simboluri. Instrucțiunile folosesc, de asemenea, o mulțime de numere, abrevieri și simboluri. Pentru îndrumări privind aceste domenii.

Listă de verificare a revizuirii instrucțiunilor

În timp ce recitiți și revizuiți instrucțiunile, fiți atenți la probleme cum ar fi următoarele:

• Asigurați-vă că furnizați instrucțiuni reale-explicații despre cum să construiți, să folosiți sau să reparați ceva.
• Scrieți o introducere bună-în ea, indicați procedura exactă care urmează să fie explicată, indicați cerințele publicului și oferiți o prezentare generală a conținutului.
• Asigură-te că folosești diferitele tipuri de liste ori de câte ori este cazul. În special, folosiți liste verticale numerotate pentru etapele secvențiale.
• Utilizați titluri pentru a delimita toate secțiunile principale și subtitluri pentru subsecțiuni. (Amintiți-vă că nu este nevoie de titlul „Introducere” între titlu și primul paragraf. Nu uitați să nu folosiți titluri de primul nivel în această lucrare; începeți cu cel de-al doilea nivel.)
• Utilizați mențiuni speciale, după caz.
• Asigurați-vă că folosiți stilul și formatul pentru toate titlurile, listele, mențiunile speciale și graficele prezentate în aceste capitole. Dacă este o problemă, luați legătura cu instructorul dumneavoastră.
• Utilizați grafice pentru a ilustra orice acțiuni sau obiecte cheie.
• Furnizați explicații suplimentare suplimentare ale pașilor, după cum este necesar.
• Nu uitați să creați o secțiune în care să enumerați echipamentele și consumabilele, dacă este necesar.

Aș aprecia gândurile, reacțiile, criticile dumneavoastră cu privire la acest capitol: Răspunsul dumneavoastră-David McMurrey.