Crearea unor manuale de instrucțiuni eficiente din punct de vedere retoric

Manuale de instrucțiuni

Mulți oameni asociază manualele de instrucțiuni cu aparatele electrocasnice, accesoriile pentru calculatoare și produsele care necesită asamblare (de exemplu, mobila). Deoarece nu ne trezim că le folosim în mod regulat sau ajungem să le așteptăm doar în anumite contexte, este ușor să uităm cât de importante sunt acestea. Calitatea unui manual de instrucțiuni bine conceput poate trece neobservată. Cu toate acestea, atunci când ne confruntăm cu frustrări atunci când asamblăm un raft sau o jucărie sau când încercăm să ne dăm seama cum să schimbăm sau să activăm o anumită setare a unui aparat electrocasnic, semnificația unui manual de instrucțiuni bine conceput devine evidentă.

Înțelegerea situației retorice a manualelor de instrucțiuni

Manualurile de instrucțiuni, ca și alte tipuri de texte, sunt modelate de o situație retorică. Alegerile pe care scriitorii tehnici le fac în ceea ce privește conținutul și forma depind de scopul manualului de instrucțiuni, de publicul vizat și de contextul în care este utilizat manualul. Atunci când scrieți propriul manual de instrucțiuni, luați în considerare următoarele idei și întrebări referitoare la situația retorică.

Scop

În general, scopul unui manual de instrucțiuni este de a familiariza utilizatorul cu produsul și/sau de a ghida utilizatorul printr-o serie de pași care duc la îndeplinirea unei sarcini. Cu toate acestea, fiecare manual de instrucțiuni va avea, de asemenea, un rezultat mai specific. Identificarea acelui rezultat specific vă va ajuta să luați decizii retorice mai eficiente cu privire la conținut și design. Întrebați-vă:

• Care sunt rezultatul (rezultatele) specific(e) vizat(e) de instrucțiuni? (de exemplu, coacerea unei prăjituri de la zero, instalarea unui aparat de aer condiționat etc.)
• Pe lângă faptul că îi ajută pe utilizatori să atingă principalul (principalele) rezultat(e) dorit(e), există și alte scopuri pe care le servește manualul? (de exemplu, oferă sfaturi de depanare, îi învață pe utilizatori cum să îndeplinească sarcini suplimentare, simple, necesare pentru atingerea obiectivului principal)

Audiența

Crearea unui profil al audienței dumneavoastră (adică utilizatorul principal vizat de document) este parte integrantă pentru a face alegeri bine gândite cu privire la domeniul de aplicare, conținut și design. Luați în considerare aceste întrebări despre audiență înainte de a scrie:

• Care este familiaritatea sau expertiza audienței în ceea ce privește subiectul manualului de instrucțiuni?
• Care este nivelul general de confort al audienței în ceea ce privește învățarea de noi abilități legate de software, aplicații, rețete etc.?
• Care este abordarea „tipică” a audienței dvs. în ceea ce privește învățarea? Cum va aborda manualul dumneavoastră de instrucțiuni stilul de învățare, obiectivele și nevoile legate de sarcină ale publicului?

Context

Gândiți-vă la context ca la situația temporală, socială, tehnologică și culturală care înconjoară crearea și utilizarea manualului de instrucțiuni. Următoarele întrebări vă vor ajuta să identificați contextul:

• Cât timp veți avea la dispoziție pentru a finaliza acest manual de instrucțiuni?
• Există constrângeri de timp pentru utilizator?
• Ce constrângeri tehnologice trebuie să luați în considerare la crearea manualului de instrucțiuni? Luați în considerare abilitățile dumneavoastră cu tehnologia și nivelul de acces.
• Cum va avea acces publicul dumneavoastră la manual? (de exemplu, publicul poate accesa manualul online prin intermediul unui site web al companiei)
• Ce instrumente sau materiale suplimentare presupuneți că publicul are deja? Vor avea acces la tehnologia sau materialele necesare pentru a urma instrucțiunile? (de exemplu, pentru a construi cu succes o bibliotecă, utilizatorul va avea nevoie de un ciocan, o șurubelniță și o zonă de lucru deschisă)
• Din ce perspectivă culturală scrieți manualul de instrucțiuni? Publicul va împărtăși același context cultural? (de exemplu, o rețetă germană care cere zahăr vanilat, un ingredient care nu este ușor de găsit în Statele Unite, ar putea avea nevoie să fie modificată pentru utilizatorii americani)

Utilizarea cunoștințelor despre situația retorică pentru a face alegeri retorice eficiente

Chiar dacă majoritatea manualelor de instrucțiuni se bazează pe anumite convenții standard, fiecare manual de instrucțiuni ar trebui să fie adaptat pentru a atinge un scop specific pentru o anumită audiență într-un anumit context. Următoarea secțiune prezintă câteva caracteristici comune ale manualelor de instrucțiuni, luând în același timp în considerare situația retorică și modul în care aceasta poate necesita abaterea de la anumite convenții.

Scop

Situația retorică ajută la determinarea cantității de detalii care trebuie incluse într-un manual de instrucțiuni. De exemplu, domeniul de aplicare al unui manual de instrucțiuni pentru asamblarea unui birou este ușor de determinat, deoarece are un singur rezultat: asamblarea biroului. Cu toate acestea, un manual de instrucțiuni pentru un aparat de fotografiat Digital Single Lens Reflex (DSLR) poate fi scris atât pentru utilizatorii amatori cât și pentru cei mai experimentați și poate fi necesar să includă instrucțiuni pentru îndeplinirea sarcinilor de bază (de exemplu, instalarea bateriei și a cardului de memorie), precum și a sarcinilor mai avansate (de ex, reglarea setărilor pentru medii de fotografiere specifice).

Contenit

Câteva secțiuni standard ale manualelor de instrucțiuni includ partea frontală, o introducere, o serie de pași, o concluzie și partea din spate, deși este posibil ca unele manuale să nu folosească toate aceste secțiuni sau să nu le eticheteze în acest mod. Materia de față și cea din spate extinse, de exemplu, se găsesc adesea în manuale mai lungi și mai complexe. Cu toate acestea, majoritatea seturilor de instrucțiuni conțin o introducere care oferă informațiile necesare pentru parcurgerea pașilor în mod sigur și eficient. Introducerea poate include o explicație cu privire la persoana care ar trebui să efectueze sarcina (poate că utilizatorul trebuie să aibă competențe într-o anumită abilitate), materialele necesare, orice precauții pe care utilizatorul ar trebui să le ia (sfaturi de siguranță sau alte avertismente) și, în unele cazuri, o estimare a duratei de timp pe care o va dura procesul (o caracteristică comună a rețetelor). În unele cazuri, este necesar să se includă o explicație a motivului pentru care utilizatorul ar trebui să urmeze instrucțiunile. De exemplu, instrucțiunile pentru schimbarea uleiului la o mașină pot explica de ce sarcina este necesară pentru buna funcționare a vehiculului.

După acest material introductiv urmează secvența de instrucțiuni pas cu pas. Consultați următoarea secțiune „Limbajul” pentru a afla cum să redactați pași clari și eficienți. În cele din urmă, un manual de instrucțiuni poate include un „Ghid de rezolvare a problemelor” sau o secțiune pentru „Sfaturi” pentru a ajuta utilizatorii să abordeze problemele comune pe care le pot întâmpina în timp ce urmează instrucțiunile sau după finalizarea procesului.

Limbajul

Întrebările despre „Audiență” și „Context” de mai sus vă pot ajuta să vă ghidați în realizarea unor alegeri lingvistice eficiente. Următoarele subsecțiuni includ explicații ale caracteristicilor lingvistice comune ale manualelor de instrucțiuni, împreună cu sfaturi pentru a scrie clar și concis în acest gen.

Modul imperativ

Instrucțiile, ca și comenzile, utilizează adesea modul imperativ. Pentru a scrie în acest mod, adresați-vă direct publicului folosind vocea activă și verbe specifice. Care dintre următoarele oferă cel mai clar pas instructiv?

• „Apăsați butonul roșu pentru a începe jocul”
• „Când butonul roșu este apăsat, jocul va începe”
• „Operatorul trebuie să apese butonul”

Chiar dacă un utilizator ar putea, probabil, să înțeleagă oricare dintre aceste propoziții, prima oferă cea mai clară explicație a acțiunii pe care trebuie să o efectueze utilizatorul. Cea de-a doua construcție, pasivă, nu specifică cine ar trebui să apese butonul. Al treilea exemplu se referă la un subiect vag, „operatorul”, ceea ce poate deruta utilizatorul.

alegerea cuvintelor

Când se scriu instrucțiuni, este importantă o analiză atentă a alegerii cuvintelor, deoarece, în unele cazuri, siguranța utilizatorului este în pericol. Din acest motiv, depuneți eforturi pentru claritate și concizie. Pentru a lua decizii eficiente în ceea ce privește alegerea cuvintelor, luați în considerare nivelul de expertiză și mediul cultural al publicului dvs. primar. S-ar putea să considerați necesar să

• definiți termeni complecși.
• pronunțați acronimele prima dată când sunt introduse (de ex, digital single-lens reflex camera digitală cu un singur obiectiv, DSLR).
• evitați să folosiți similitudini, metafore, argou sau substituiri care pot deruta utilizatorii.
• utilizați un limbaj simplu, deoarece, în unele cazuri, pot apărea consecințe juridice grave atunci când un set de instrucțiuni este neclar. Pentru mai multe informații despre limbajul simplu, consultați http://www.plainlanguage.gov/index.cfm
• includeți traduceri ale instrucțiunilor în mai multe limbi.
• utilizați titluri și subtitluri scurte și informative

Consistență și paralelism

Structura paralelă, sau paralelism, înseamnă utilizarea aceleiași structuri gramaticale pentru a prezenta informații sau idei. Paralelismul este adesea folosit pentru a îmbunătăți lizibilitatea și a crea coerență.

Această listă numerică de instrucțiuni conține un pas care încalcă structura paralelă. Care dintre acești pași pare diferit de ceilalți?

1. Îndepărtați șurubul pentru a deschide compartimentul pentru baterii.
2. Inserați bateriile urmărind imaginea de pe compartimentul pentru baterii.
3. Acum puteți închide compartimentul și înșurubați-l.

Pasul trei rupe structura paralelă a listei pentru că nu începe cu un verb directiv.

Următoarele rubrici folosesc structura paralelă? De ce sau de ce nu?

• „Instalarea bateriilor”
• „Oprirea/pornirea dispozitivului”
• „Cum să vă încărcați dispozitivul”

Design

Designul documentului se referă la modul în care este organizată și prezentată informația. Deoarece elementele vizuale necesită mai puțin timp pentru a fi procesate, utilizatorii vor observa de obicei – și vor reacționa la – calitatea designului înaintea calității conținutului. Chiar dacă alegeți să nu includeți imagini sau grafice, va trebui să luați în considerare designul. În mod minimal, acest lucru include luarea unor decizii privind aspectul, ordinea informațiilor, dimensiunea fontului, fontul, caracterele, titlurile, culoarea și spațiul alb. Elementele de design ar trebui să ghideze utilizatorul prin manual fără probleme. Aceasta înseamnă că documentul trebuie să poată fi scanat; un document scanabil permite utilizatorilor să navigheze prin conținut pentru a localiza informații specifice. Ca și în cazul oricărui document, deciziile privind designul trebuie să ia în considerare publicul, scopul și ușurința generală de utilizare.

Consistență/Repetiție

Utilizarea unui element de design într-un mod uniform pe parcursul întregului document ghidează utilizatorii dându-le un sentiment de ce să se aștepte (de exemplu, același tip de caractere și aceeași dimensiune pentru toate titlurile; aceeași prezentare de la o pagină la alta).

Contrast

Utilizarea unui element de design pentru a evidenția informații sau caracteristici specifice ale manualului (de exemplu, scrierea cu majuscule a unui cuvânt pentru accentuare; plasarea unei cutii sau a unei margini în jurul unui element; schimbarea culorilor pentru accentuare). Contrastul este eficient în primul rând atunci când un document folosește coerența în general. Dacă există o lipsă de consecvență, este mai dificil de creat contrast.

Aliniere

Organizarea elementelor pe o pagină cu aliniere orizontală și/sau verticală creează ierarhie și structură și poate fi utilizată pentru a ajuta la obținerea echilibrului, contrastului sau consecvenței. De exemplu, acest document utilizează alinierea verticală pentru a crea o ierarhie între numele unui element de design, care este aliniat la stânga, și descrierea acestuia, care este indentată.

Egalitate

Distribuția uniformă a elementelor pe un anumit spațiu. Pentru a realiza acest lucru, trebuie să se țină cont de greutatea fiecărui element – adică de tendința ochiului de a gravita spre un element. De exemplu, deoarece o imagine cântărește mai mult decât textul, deciziile privind amplasarea imaginii ar trebui să ia în considerare modul de echilibrare a greutății acesteia în raport cu alte elemente pentru a preveni confuzia vizuală.

Spațiu alb

Utilizarea spațiului alb pentru a crea un document profesional, echilibrat. Mai degrabă decât să indice culoarea spațiului, acest element de design se referă la o absență de imagini și text. Spațiul alb ajută la distincția dintre elementele individuale și grupurile de elemente (de exemplu, secțiunile manualului) și facilitează scanarea documentelor.

Gruparea/Proximitatea

Plasarea imaginilor sau a conținutului înrudit aproape unul de celălalt. De exemplu, gruparea laolaltă a imaginilor tuturor materialelor necesare pentru a îndeplini o anumită sarcină.

Culoare

Selectarea culorilor pentru a crea contrast și accent, pentru a ghida cititorii prin spațiu și pentru a proiecta un document plăcut din punct de vedere vizual. Trebuie să aveți în vedere documentul în ansamblu pentru a crea o schemă de culori coerentă. De exemplu, dacă doriți să folosiți albastru în document, veți dori să vă asigurați că acesta este folosit în mod consecvent și că se completează cu alte culori ale documentului. Acest lucru este deosebit de important atunci când se integrează grafice și/sau imagini color.

Imagini

Scoaterea imaginilor adecvate pentru contextul dat și scopul manualului. Trebuie să luați în considerare dacă imaginile sunt destinate să fie de sine stătătoare sau să completeze instrucțiunile scrise. Luați în considerare tipurile de imagini, cum ar fi desenele, fotografiile și ilustrațiile grafice și dacă sunt necesare indicații sau adnotări suplimentare pentru a evidenția anumite părți ale imaginii. Imaginile ar trebui să fie alese pentru a completa alte elemente de design din manual.

Concluzie

Un manual de instrucțiuni bun începe cu o analiză atentă a situației retorice – scop, audiență și context. Aceste informații sunt esențiale pentru a face alegeri adecvate și eficiente în ceea ce privește conținutul, limbajul și designul. Într-o cronologie ideală, redactorii tehnici au posibilitatea de a efectua teste de utilizabilitate, care sunt concepute pentru a evalua cât de bine un document își îndeplinește scopul. După ce manualul dumneavoastră de instrucțiuni este testat, veți încorpora feedback-ul primit pentru a finaliza designul și conținutul acestuia.

Exercițiu 1 – Familiarizați-vă cu manualele de instrucțiuni

Site-ul următor conține mai multe exemple de manuale de instrucțiuni cu sursă deschisă. Urmați acest link, parcurgeți lista și alegeți un manual pe care să îl analizați în profunzime. Parcurgeți manualul pentru a vă familiariza cu conținutul și designul acestuia. Apoi, într-un memoriu adresat instructorului dumneavoastră sau colegilor de clasă, abordați următoarele.

Identificați situația retorică

• Cine este publicul? De unde știți cine este publicul? Ce puteți presupune despre public pe baza conținutului și a alegerilor de design din manual?
• Care este scopul documentului? De unde știți că acesta este scopul principal (de exemplu, ce alegeri de conținut și de design semnalează scopul)?
• Ce context informează conținutul scris și designul acestui manual?

Examinați alegerile de compoziție

• Descrieți domeniul de aplicare și organizarea generală a manualului. Cât de detaliat este manualul? Ce cuprinde acesta? Cum este organizată informația?
• Toate „caracteristicile standard” de conținut sunt acoperite în acest manual? De ce sau de ce nu? Există caracteristici suplimentare? Care sunt acestea și care este (sunt) scopul (scopurile) lor?
• Localizați și descrieți exemple de alegere eficientă a limbajului. Explicați de ce le considerați eficiente.
• Localizați și descrieți exemple de proiectare eficientă. Explicați de ce le considerați eficiente.
• Dacă ați fi autorul acestui manual, ce ați fi făcut diferit și de ce?

Exercițiu 2 – Planificarea unui manual de instrucțiuni

Imaginați-vă că scrieți un manual de instrucțiuni pentru un proces sau un produs pe care îl cunoașteți și răspundeți la următoarele solicitări.

Identificați situația retorică

• Selectați un public și creați un 2-3 propoziții de profil
• Identificați scopul specific al manualului dvs. de instrucțiuni
• Enumerați orice informație contextuală importantă de luat în considerare

Creați un plan

• Enumerați secțiunile pe care le veți include
• Identificați cei mai importanți factori de luat în considerare pentru publicul și scopul dvs.g., utilizarea limbii, încorporarea imaginilor, dimensiunea textului etc.)
• Creați o schiță care să arate aspectul documentului, să identifice locația secțiunilor scrise și să arate unde vor fi încorporate imaginile.