Una dintre cele mai comune și mai importante utilizări ale scrierii tehnice este aceea de a furniza instrucțiuni, acele explicații pas cu pas despre cum să asamblezi, să operezi, să repari sau să faci întreținerea de rutină a unui lucru. Deși pot părea intuitive și simplu de redactat, instrucțiunile sunt unele dintre cele mai prost scrise documente pe care le puteți găsi. Cei mai mulți dintre noi au avut probabil multe experiențe exasperante cu instrucțiuni prost scrise. Acest capitol vă va arăta ceea ce profesioniștii consideră a fi cele mai bune tehnici în furnizarea de instrucțiuni.
Un set eficient de instrucțiuni necesită următoarele:
- Scriere clară, precisă și simplă
- O înțelegere temeinică a procedurii în toate detaliile sale tehnice
- Capacitatea de a vă pune în locul cititorului, a persoanei care încearcă să folosească instrucțiunile dumneavoastră
- Capacitatea de a vizualiza procedura în detaliu și de a surprinde această conștientizare pe hârtie
- Disponibilitatea de a vă testa instrucțiunile pe tipul de persoană pentru care le-ați scris.
La începutul unui proiect de redactare a unui set de instrucțiuni, este important să determinați structura sau caracteristicile procedurii particulare despre care urmează să scrieți. Iată câțiva pași de urmat:
Faceți o analiză atentă a audienței și a sarcinii
La începutul procesului, definiți audiența și situația instrucțiunilor dumneavoastră. Amintiți-vă că a defini un public înseamnă a defini nivelul de familiaritate pe care cititorii dumneavoastră îl au cu subiectul.
Determinați 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 dumneavoastră sunt destinate să le abordeze. O sarcină este un grup semi-independent de acțiuni în cadrul procedurii: de exemplu, setarea ceasului la un cuptor cu microunde este o sarcină în 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 mai multe sarcini semi-independente: setarea ceasului; setarea nivelului de putere; utilizarea temporizatorului; curățarea și întreținerea cuptorului cu microunde, printre 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. Î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 lucrului în pământ ar fi o altă fază; asamblarea leagănului din cutie ar fi încă una.
3. Determinați cea mai bună abordare a discuției pas cu pas
Pentru majoritatea instrucțiunilor, vă puteți concentra pe sarcini sau vă puteți concentra pe instrumente (sau caracteristici ale instrumentelor). Într-o abordare bazată pe sarcini (cunoscută și sub numele de orientare spre sarcini) a instrucțiunilor privind utilizarea unui serviciu de răspuns la telefon, ați avea aceste secțiuni:
- Înregistrarea salutului
- Redactarea mesajelor
- Salvarea mesajelor
- Întoarcerea mesajelor
- Ștergerea mesajelor, și așa mai departe
Acestea sunt sarcini – lucrurile tipice pe care am dori să le facem cu aparatul.
Pe de altă parte, într-o abordare a instrumentelor pentru instrucțiuni de utilizare a unui fotocopiator, probabil că ar exista secțiuni despre cum să folosim anumite funcții specifice:
- Botonul de copiere
- Botonul de anulare
- Botonul de mărire/reducere
- Botonul de colaționare/aruncare
- 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. Cu toate acestea, pot exista momente în care abordarea instrumente/funcții poate fi preferabilă.
4. Proiectați grupări de sarcini
Listarea sarcinilor poate 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 astfel încât 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:
- T Sarcini de despachetare și configurare
- Tarcini de instalare și personalizare
- Tarcini de operare de bază
- Tarcini de întreținere de rutină
- Tarcini de depistare a defecțiunilor.
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.
Pentru formate alternative, consultați instrucțiunile de exemplu.
Introducere: Planificați cu atenție introducerea instrucțiunilor dumneavoastră. Aceasta ar putea include oricare dintre următoarele (dar nu neapărat în această ordine):
- Indicați sarcinile specifice sau procedura care urmează să fie explicată, precum și domeniul de aplicare (ce va fi și ce nu va fi acoperit)
- 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 realizează aceasta
- Indicați condițiile în care aceste instrucțiuni ar trebui (sau nu) să fie utilizate
- Dă o imagine de ansamblu a conținutului instrucțiunilor.
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, precauții și anunțuri de pericol. Observați cum sunt folosite aceste avize speciale în exemplele de instrucțiuni enumerate mai sus.
Context tehnic sau teorie: la începutul anumitor tipuri de instrucțiuni (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. 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ă cu lucrurile pe care trebuie să le adunați înainte de a începe procedura. Aceasta include echipamente, 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 consumabile, 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 pași, (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. Există totuși unele variații, precum și alte considerații:
- Pașii cu ordine fixă sunt pași care trebuie 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.
- Etapele imbricate pot fi utilizate în cazurile în care etapele individuale dintr-o procedură sunt destul de complexe în sine și trebuie să fie împărțite în subetape. În acest caz, faceți o indentare mai mare și secvențiați sub-etapele ca a, b, c și așa mai departe.
- Instrucțiunile „fără etape”. pot fi utilizate atunci când chiar nu puteți utiliza lista verticală numerotată sau oferiți o dirijare directă a cititorului în stil instructiv. Unele situații trebuie să fie atât de generalizate sau atât de variabile încât nu se pot enunța pașii.
Discuție suplimentară: adesea, nu este suficient să le spui 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 împărți instrucțiunile din supliment în paragrafe separate; sau puteți scrie instrucțiunile cu bold.
Stilul de redactare
Punerea pașilor cheie pentru utilizator cu bold poate fi o modalitate foarte utilă de a semnala clar ce trebuie să facă cititorul. Adesea, verbul de comandă este scris cu bold; uneori, fontul bold evidențiază componenta cheie despre care se discută.
Utilizarea vocii pasive în instrucțiuni poate fi problematică. Dintr-un motiv ciudat, unele instrucțiuni sună astfel: „Butonul Pauză trebuie apăsat pentru a opri temporar afișajul”. Nu numai că suntem îngrijorați de sănătatea mintală a butonului de pauză, dar ne întrebăm și cine ar trebui să apese pe el (ninja?). Ar fi mai util să se indice când cititorul trebuie „să apese butonul Pauză”. Luați în considerare acest exemplu: „Butonul Cronometru este apoi setat la ora 3:00.” Din nou, ne putem întreba: „este setat de către cine? De ninja?” Persoana care urmează aceste instrucțiuni ar putea crede că este pur și simplu o referință la o stare existentă, sau s-ar putea întreba: „Vorbește cu mine?”. Folosirea persoanei a treia poate duce, de asemenea, la stângăcii: „Utilizatorul ar trebui apoi să apese butonul Pauză”. Instrucțiunile ar trebui să fie scrise de obicei folosind forme verbale de comandă și folosind „tu” pentru a face perfect clar ce trebuie să facă cititorul.
Ilustrarea instrucțiunilor dumneavoastră
Poate mai mult decât în orice altă formă de scriere tehnică, grafica este crucială pentru instrucțiuni. Uneori, cuvintele pur și simplu nu pot explica un pas. Ilustrațiile sunt adesea esențiale pentru capacitatea cititorilor de a vizualiza ceea ce trebuie să facă. Asigurați-vă că graficele reprezintă imaginea din perspectiva cititorului.
Formatul instrucțiunilor dumneavoastră
Din moment ce oamenii rareori doresc să citească instrucțiuni, dar adesea trebuie să o facă, formatați instrucțiunile dumneavoastră pentru o lizibilitate reticentă. Încercați să vă faceți cititorul să dorească să le citească, sau cel puțin să nu fie rezistent la ideea de a le consulta. Formatul foarte ușor de citit va permite cititorilor care și-au dat seama singuri de o parte din instrucțiuni să sară la secțiunea în care sunt blocați. Folosiți ceea ce ați învățat despre titluri, liste, elemente vizuale și spațiu pasiv pentru a crea instrucțiuni eficiente și ușor de citit:
Titluri: î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-zise și subtitluri pentru sarcinile sau fazele individuale din cadrul acestei secțiuni.
Liste: în mod similar, instrucțiunile folosesc în mod obișnuit pe scară largă 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 privire de ansamblu asupra lucrurilor care vor urma.
Anunțuri speciale: este posibil să trebuiască să-i alertați pe cititori 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 anunțuri speciale, pentru anunțuri speciale prost redactate sau pentru anunțuri 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.
În timp ce recitiți și revizuiți instrucțiunile dumneavoastră, verificați dacă acestea îndeplinesc următoarele:
- Descrieți clar procedura exactă care trebuie explicată
- Furnizați o prezentare generală a conținutului
- Indicați cerințele publicului
- Utilizați diverse tipuri de liste ori de câte ori este cazul; în special, utilizați liste numerotate pentru etapele secvențiale
- Utilizați titluri și subtitluri pentru a împărți secțiunile și subsecțiunile principale într-o ordine logică și coerentă
- Utilizați anunțuri speciale, după caz
- Utilizați elemente grafice pentru a ilustra acțiunile și obiectele cheie
- Furnizați explicații suplimentare suplimentare ale etapelor, dacă este necesar
- Creați o secțiune care să enumere echipamentele și consumabilele, dacă este necesar.
.