Conţinut
- Pune-te în pantofii cititorului
- Ce trebuie să înțelegeți despre cititorii dvs.
- Cititorii dvs. sunt deja frustrați
- O notă înainte de a începe să scrieți instrucțiuni
- Formula magică pentru a scrie instrucțiuni
- Formula magică: metoda dată-nouă
- Acum sunteți gata să scrieți instrucțiuni bune
- Curățarea finală
- Utilizare Testează-ți instrucțiunile
- Concluzii și generalizări
Laura este un scriitor tehnic. Îi place să cânte la pian, să călătorească, să facă artă plastică și să facă bijuterii.
Pune-te în pantofii cititorului
Pentru a scrie instrucțiuni sau proceduri mai bune pentru computer, trebuie mai întâi să vă puneți în locul cititorului sau al utilizatorului.
Utilizatorul nu știe nimic despre site-ul sau software-ul dvs. și nu va (și nu ar trebui să aibă nevoie) să-și ia timpul să citească întregul set de instrucțiuni înainte de a începe munca. Utilizatorul pur și simplu folosește produsul dvs. pentru a atinge un anumit obiectiv al lor (face o achiziție, caută informații și așa mai departe).
Ce trebuie să înțelegeți despre cititorii dvs.
Să începem cu începutul. Trebuie să acceptați faptul că foarte probabil cititorii dvs. nu vor să citească ceea ce ați scris. Aceasta înseamnă că, pentru a scrie instrucțiuni eficiente și utile, trebuie mai întâi să acceptați toate următoarele adevăruri:
- Cititorii / utilizatorii dvs. nu vor să învețe cum să utilizeze produsul / serviciul dvs.; vor să-și îndeplinească o sarcină sau un scop propriu.
- Au citit documentația doar cu disperare, după ce ceea ce au încercat să facă nu a reușit.
- Acum sunt frustrati.
- Ei sunt pierduți în legătură cu modul de procedare pentru a-și îndeplini scopul / sarcina.
Cititorii dvs. sunt deja frustrați
În calitate de scriitor de instrucțiuni, începeți într-o situație proastă, deoarece utilizatorii (pe care probabil nu îi cunoașteți și pe care nu îi veți întâlni niciodată) sunt deja frustrați de produsul / serviciul dvs. în momentul în care apelează la instrucțiunile pe care le-ați scris cum se realizează fiecare sarcină. Așadar, fiți amabili cu ei și dați-le instrucțiuni clare, concise, definitive, exacte, care îi vor readuce pe calea către atingerea obiectivului cât mai repede posibil: este o formă de bun serviciu pentru clienți!
Modelul devine destul de ușor și se aplică majorității tipurilor de instrucțiuni pas cu pas, nu doar instrucțiunilor computerului.
O notă înainte de a începe să scrieți instrucțiuni
Înainte de a începe să scrieți instrucțiuni, trebuie să știți în ce stil ar trebui să fie scrise.
Cereți în jur un „Ghid pentru stilul casei” (departamentul de marketing este un loc bun pentru a începe) și obțineți cea mai recentă copie a Manualului de stil Microsoft pentru publicații tehnice.Dar ce zici de utilizatorii Apple Macintosh? Ori sunt deja familiarizați cu stilul de scriere Microsoft sau nu vor fi confundați de acesta, deoarece veți implementa stilul de scriere în mod constant pe tot parcursul manualului de instrucțiuni.
Un dicționar și un tezaur nu fac niciodată rău, deși acestea pot fi găsite și pe Internet, și care dintre ele trebuie utilizate trebuie să fie specificate în Ghidul de stil al casei. Dacă aveți dubii, folosiți Merriam Webster, „standardul de aur” al dicționarelor.
Formula magică pentru a scrie instrucțiuni
| Unde sunt? | Ce ar trebuii să fac? | Ce s-a întâmplat? |
|---|---|---|
Spuneți cititorului unde se află → | Spune-le ce să facă → | Descrieți rezultatele acțiunilor lor |
Formula magică: metoda dată-nouă
Acum știți unul dintre elementele de bază ale comunicării tehnice, indiferent dacă sunteți sau nu scriitor profesionist. Este cunoscută și sub denumirea de metodă nouă, deoarece începeți prin a-i spune cititorului ceva ce știu deja, un „dat”, apoi le dați ceva „nou”. Titlurile / titlurile clare sunt cheia succesului aici.
Rețineți că această metodă îl ajută pe cititorul / utilizatorul deja frustrat să înțeleagă rapid dacă procedura dvs. particulară se aplică situației lor pentru că i-ați dat un titlu clar, dacă sunt în locul potrivit de plecare (pentru că le-ați spus de unde să începeți), ce să faceți în acel moment și cum ar trebui să arate rezultatele.
Acum sunteți gata să scrieți instrucțiuni bune
Acum, că cunoașteți regulile de scriere, puteți începe să scrieți instrucțiunile ținând cont în permanență de perspectiva utilizatorului.
Denumiți instrucțiunile „Cum se face sarcina ABC”, asigurându-vă că instrucțiunile de sub această rubrică au toate legătură cu îndeplinirea sarcinii ABC (și nimic altceva). Acum sunteți gata să scrieți singuri instrucțiunile.
Primul lucru de făcut este de a orienta utilizatorii: spuneți utilizatorilor unde sunt și ce ar trebui să vadă pe ecranul lor, cum ar fi numele ferestrei la care ar trebui să se uite. Apoi, spuneți-le ce buton (butoane) trebuie să apese pe fereastra curentă și / sau ce text trebuie să introducă în ce câmp (uri). Apoi, spuneți-le cum să ajungă la următorul pas / locație și descrieți ce ar trebui să vadă pe ecran atunci când iau acea acțiune.
De exemplu:
- De la Fereastra principala, selectați toate opțiunile pe care doriți să le activați. Clic O.K. A doua fereastră apare starea curentă a opțiunilor selectate.
- Pe A doua fereastră, verificați dacă toate opțiunile selectate sunt corecte.
- Dacă toate opțiunile sunt corecte, faceți clic pe Activați Opțiuni. A treia fereastră apare.
- Dacă opțiunile nu sunt toate corecte, faceți clic pe Înapoi a reveni la Fereastra principala și selectați diferite opțiuni.
Curățarea finală
Când ați terminat de scris, rulați verificatorul de ortografie și gramatică, apoi solicitați unul sau mai mulți experți în materie (IMM-uri) - persoane care cunosc produsul - să revizuiască documentul. Efectuați orice modificări, rulați din nou verificatorul de ortografie și gramatică și cereți ca cineva să corecteze / editeze documentul.
După ce ați introdus orice modificări pe care editorul le-a făcut, în general ați terminat (cu excepția cazului în care compania dvs. are un proces oficial de eliberare a documentelor, pe care ar trebui să îl urmați).
Rețineți că modificările făcute de experții în materie și de editor (exportul subiectului pe formularea și stilul exact) ar trebui acceptate aproape fără îndoială: este al lor job pentru a-și cunoaște aria de expertiză. daca tu puternic nu sunteți de acord cu o modificare, doar apoi aduceți-o în atenția IMM-ului sau a editorului, după caz. În caz contrar, efectuați modificările sugerate.
Utilizare Testează-ți instrucțiunile
După ce aveți o schiță foarte bună, recrutați mai multe persoane pentru a vă testa instrucțiunile - să le parcurgeți de la început până la sfârșit și să notați (și să vă permiteți să notați) toate zonele în care se pierd sau se confundă sau în care instrucțiunile sunt greșite.
În mod ideal, testerii de utilizare ar trebui să fie clienții / utilizatorii reali ai produsului / site-ului pe care l-ați documentat. Cu toate acestea, recrutarea câtorva oameni din jurul biroului care nu sunt familiarizați cu ceea ce ați scris și să le testați documentul este mai bine decât nimic. În acest caz, rețineți că testerii sunt utilizatorii experți în materie, astfel încât modificările lor sunt la fel de valoroase ca și cele ale produsului IMM-urilor și editorului (IMM).
Testarea utilizabilității în sine este o întreagă disciplină care este prea largă pentru a fi acoperită în acest articol.
Cu toate acestea, odată ce ați făcut modificări de testare a utilizabilității, rulați modificările dincolo de editor și, dacă este cazul, de IMM-urile dvs. de produs / serviciu: poate că o mică modificare a produsului / serviciului, fie acum, fie într-o versiune viitoare, ar face o mare diferență către utilizatori.
Concluzii și generalizări
Putem face următoarele concluzii și generalizări despre scrierea instrucțiunilor software:
- Cititorii sunt frustrați când vă citesc lucrarea.
- Trebuie să liniștiți cititorul spunându-le unde sunt, ce să facă și unde vor ajunge.
- Trebuie să aveți experți care să revizuiască documentul pentru a vedea exactitatea produsului, precum și precizia scrierii.
- Trebuie să acceptați modificările făcute de experții dvs., cu excepția cazului în care dvs. semnificativ nu sunt de acord, caz în care discutați cu expertul în cauză despre această problemă.
- Testarea utilizabilității este cel mai bun mod de a vă asigura că documentul dvs. va fi un succes la satisfacerea nevoilor utilizatorilor / cititorilor. Poate duce chiar la îmbunătățiri ale produsului!
Acest articol este corect și fidel, după cunoștințele autorului. Conținutul are doar scop informativ sau de divertisment și nu înlocuiește consilierea personală sau sfatul profesional în probleme de afaceri, financiare, juridice sau tehnice.
