Scrierea instrucțiunilor de utilizare. Exemple și recomandări de instrucțiuni convenabile

Componentă software a unui complex sau sistem

Teluri si obiective

Ghidul utilizatorului este unul dintre documentele principale ale programului. Este imposibil să ne imaginăm vreun produs software de aplicație complex care nu ar fi echipat cu el într-o formă sau alta.

Obiectivul principal al documentului este de a oferi utilizatorilor posibilitatea de a rezolva în mod independent toate sarcinile principale cărora le vizează programul.

Manualul de utilizare conține complet descrierea programului din punctul de vedere al utilizării prevăzute. Manualul de utilizare trebuie să descrie:

• scopul programului;
• principalele provocări și oportunități;
• modul de reflectare a materiei în program;
• interfata utilizator a programului;
• procedura de rezolvare a sarcinilor de bază ale utilizatorului;
• toate funcțiile programului și ordinea utilizării acestora;
• personalizarea programului;
• probleme în timpul utilizării și modalități de rezolvare a acestora.

La documentare programe mici Manualul de utilizare include adesea instrucțiuni pentru instalarea, configurarea, administrarea, actualizarea și alte tipuri de întreținere a programului.

Manualul de utilizare nu este niciodată, sau aproape niciodată, considerat ca ajutor didactic pe tematica.

Metodologia și stilul de prezentare

În funcție de caracteristicile programului și de publicul țintă, manualul de utilizare în ceea ce privește modul în care este prezentat materialul poate fi apropiat de un manual sau, dimpotrivă, de o carte de referință. Se stabilește ordinea de prezentare a materialului în manualul de utilizare perspectiva utilizatorului programe.

Dacă programul este un instrument care vă permite să rezolvați probleme practice dintr-un anumit set finit, manualul oferă proceduri standard pentru rezolvarea fiecăreia dintre ele. De exemplu, utilizator client de mail trebuie să știți cum să scrieți și să trimiteți un mesaj, cum să descărcați mesaje noi de pe server, cum să răspundeți la un mesaj etc. Fiecare dintre aceste acțiuni poate fi împărțită în pași elementari succesivi, cel puțin pentru situații tipice. Într-un program mare ca sarcinile utilizatorului pot fi multe, dar nu infinite. Manualul de utilizare, construit pe principiul sarcinilor utilizatorului, seamănă cu un manual, deși, de regulă, îi lipsește aparatul metodologic inerent manualelor: sarcini de testare, întrebări, exerciții.

Dacă programul reprezintă un mediu în care utilizatorul poate rezolva problemele atribuite de el în mod independent, manualul de utilizare ar trebui să fie mai aproape de o carte de referință. Trebuie să descrie în mod consecvent și sistematic toate funcțiile programului și ordinea utilizării acestora. Ce să facă cu ei, spre ce să-i direcționeze, utilizatorul va gândi singur (sau se va înscrie cursuri de pregatire). Deci, în manualul de utilizare pentru editorul grafic vom găsi o descriere a tuturor primitivelor grafice, instrumentelor, filtrelor, cu toate acestea, nu va spune direct cum să descrie o clădire, o mașină sau, să zicem, un câine. Utilizatorul fie știe să deseneze, fie nu.

Alte perspective ale utilizatorului sunt posibile. Există programe prin care utilizatorul controlează starea unui anumit obiect, să zicem, o instalație industrială. Apoi manualul de utilizare este construit pe principiul unui tabel: mesajul programului - reacția sau posibilele reacții ale utilizatorului.

Dacă utilizatorul folosește programul pentru a rezolva probleme în mod non-trivial domeniile subiectului, este foarte recomandat să includeți o secțiune de concept în manualul de utilizare. Ar trebui să descrie modul în care programul implementează reprezentarea obiectelor din lumea reală, astfel încât utilizatorul să înțeleagă bine care dintre ele și la ce nivel de abstractizare poate lucra.

Structura tipică

Datorită varietatii mari de programe, este dificil să ne imaginăm o structură universală a manualului de utilizare. În fiecare caz specific, acesta va fi determinat în principal de caracteristicile programului descris. Cu toate acestea, structura manualului de utilizare este de obicei similară cu cea de mai jos.

1. Informații generale.
2. Instalare și configurare inițială.
3. Concepte de bază și definiții.
4. Interfața cu utilizatorul.
5. Lucrul cu programul.
6. Setare personalizata.
7. Mesaje de eroare.

O singură secțiune „Lucrul cu programul” este adesea înlocuită cu mai multe secțiuni succesive care descriu grupuri mari de sarcini sau funcții ale utilizatorului.

Particularități

Din cauza unui incident istoric, manualul de utilizare nu este prevăzut de standardele interne pentru documentația software(ESPD). Dintre cele descrise în ESPD, documentul cel mai apropiat ca scop și conținut este manualul operatorului. Cu toate acestea, trebuie să se înțeleagă că operatorul, ceea ce se înțelege în ESPD, are puține în comun cu utilizatorul în înțelegerea actuală.

Crearea Produs nou(serviciu online, magazin online, aplicatie mobila), ne străduim să asigurăm fiabilitatea, performanța și siguranța produsului. Pentru a ieși în evidență față de concurenții noștri, desenăm design neobișnuit, adăugând noi funcții la interfață. Pe baza propriei noastre experiențe, credem că utilizatorii vor înțelege toate inovațiile.

Dar în majoritatea cazurilor soluții nestandardizate duce la pierdere utilizatorii actualiși crește costul atragerii altora noi.

De ce așteptările nu sunt egale cu rezultatele după lansarea unui proiect?

Observațiile privind promovarea diferitelor servicii online arată aproape aceleași rezultate. Dacă, după lansarea serviciului, chestionăm primii 100 de utilizatori, vom obține așa ceva:

• 40 de persoane nu vor folosi serviciul până nu citesc instrucțiunile, capturile de ecran și videoclipurile create de consultanții de service. Ei vor contacta suportul tehnic pentru instrucțiuni;
• 20 de persoane vor citi în mod independent instrucțiunile și vor studia funcțiile serviciului;
• alți 20 nu vor înțelege de unde să înceapă și nu vor folosi serviciul;
• doar 10 utilizatori vor completa corect toate setările, nu voi citi instrucțiunile și nu voi contacta serviciul suport tehnic;
• restul de 10 persoane au evaluat serviciul, l-au comparat cu concurenții, până când au decis dacă îl vor folosi.

Majoritatea utilizatorilor nu înțeleg funcțiile și navigarea serviciului online; 40% dintre utilizatori nu citesc instrucțiunile de pe site și apelează la consultanți pentru ajutor. Doar 10% încep să lucreze cu serviciul fără ajutor suplimentar, pentru că au necesarul experiența utilizatorului.

Cum să faceți serviciul mai ușor de înțeles

Renumitul expert în utilizare, Jakob Nielsen, susține că „un sistem ar trebui să fie la fel de acceptabil pentru două grupuri de utilizatori - începători și experimentați” (principiul flexibilității și eficienței, una dintre „10 reguli euristice de proiectare” interfața cu utilizatorul”).

Într-un sistem de înțeles, atât începătorii cât și utilizatori experimentați se va da seama la fel de repede. Dacă un dezvoltator proiectează o interfață bazată pe propria experiență, puțini oameni vor putea folosi soluția. Nu sunt multi specialisti cu experienta de acelasi nivel :-)

Dacă începătorii nu înțeleg cum funcționează serviciul fără instrucțiuni și contactând asistența tehnică, găsiți o modalitate de a le explica cum să folosească sistemul corect. Pentru început, analizează ce anume nu înțeleg oamenii și ce întrebări pun. Apoi scrieți instrucțiuni clare și plasați indicii în locurile potrivite.

Despre ce întreabă utilizatorii începători

Utilizatorii noi pun două întrebări:

1. De unde să începeți să utilizați serviciul? (utilizatorul nu înțelege bine serviciul).
2. Cum să finalizezi aceasta sau acea sarcină? (nu înțelege succesiunea acțiunilor, scenariul de lucru).

Aceste date înseamnă că utilizatorii nu primesc informatie necesara din instrucțiuni și manuale de lucru cu serviciul:

• Utilizatorul nu a găsit instrucțiunile.
• Utilizatorul nu a înțeles documentația cu mai multe pagini.

Jakob Nielsen a formulat regula încă din 1995: „cel mai bine este dacă sistemul poate fi utilizat fără a citi documentația, dar, dacă este necesar, trebuie să furnizați informații de fundal care să nu fie prea voluminoase și să ofere o listă de acțiuni specifice”.

Oferiți utilizatorilor instrucțiuni accesibile și ușor de înțeles

„10 euristici pentru proiectarea interfeței cu utilizatorul” de Jakob Nielsen conține întreaga linie recomandări și reguli pentru proiectarea instrucțiunilor de utilizare.

Am adaptat aceste sfaturi.

Regulile specialistului american de utilizare sunt completate de un specialist rus, autorul cărții „Shareware: Dezvoltarea profesională și promovarea programelor” Stanislav Zharkov:

„Când descrieți o soluție la o problemă, ca atunci când scrieți orice documentație, trebuie să evitați să scrieți prea mult texte voluminoase, pentru că utilizatorii le vor răsfoi pur și simplu fără să se adâncească în sensul a ceea ce este scris, la fel cum o persoană care se uită printr-un ziar își oprește mai întâi privirea pe notițe scurte, sărind peste materialele mari. Cel mai bine este să scrii ceva de genul instrucțiuni pas cu pas, din care fiecare pas este de 1-2 propoziții” („Shareware: dezvoltare profesională și promovare a programelor”, Sankt Petersburg, 2001).

Scurt și instrucțiuni clare sunt ușor de implementat sub formă de indicii. Utilizatorul percepe mai ușor sfaturile mici acțiuni cheieși învață cum să lucreze cu sistemul mai rapid.

Crearea de instrucțiuni folosind indicii

Ne-am uitat la reacțiile utilizatorilor, le-am înregistrat și studiat întrebările și am identificat funcții pe care nu le înțelegeau. Pentru fiecare moment neclar vom crea scurte indicii.

Companii cunoscute, precum Google și Facebook, ajută utilizatorii cu sfaturi. I-ai întâlnit dacă i-ai creat pagina de Facebook companii sau a lucrat cu text în Google Docs.

Și acesta este un exemplu de indiciu pentru utilizatori Google Plus .

Instrucțiunile scurte din sfaturi instrumente atrag atenția utilizatorilor asupra noilor sau funcții suplimentare. Sistemul le arată automat noilor utilizatori atunci când încep să lucreze. Ele sunt afișate o singură dată, le puteți închide (le săriți) sau mergeți la secțiunea de ajutor a resursei și citiți mai multe. Pentru a explica succesiunea de acțiuni, dezvoltatorii de servicii combină astfel de sfaturi în tururi demonstrative. Instructiuni similare oferi lor utilizatorii Google Plus și Youtube.

Lista de verificare pentru dezvoltarea instrucțiunilor eficiente sub formă de sfaturi

1. Descrieți pașii specifici utilizatorului cu sugestii.

2. Creați tururi de instruire pentru scenarii de locuri de muncă.

3. Explicați scopul cu indicii funcții complexeși condiții speciale.

4. Spuneți utilizatorilor cum să accelereze acțiunile repetate frecvent.

5. Afișați sfaturile instrumente automat o singură dată, la prima vizită a utilizatorului.

6. Permiteți utilizatorului să activeze tururi demonstrative în orice moment.

7. Proiectați vârfurile într-un design uniform pentru serviciu.

Instrumente pentru crearea de sfaturi cu instrumente

Pentru a crea instrucțiuni de o pagină (pentru o fereastră de interfață), bibliotecile de cod Java Script gata făcute sunt potrivite: Intro.js și Bootstro.js. Serviciile Hintarea și Walkme.com sunt potrivite pentru crearea de indicii încrucișate.

Sfaturile îi pot ajuta pe cei care:

• instalat o nouă aplicație mobilă;
• a folosit un serviciu online (sistem de rezervare, avizier);
• plasează o comandă în magazinul online;
• funcționează cu o aplicație de afaceri (CMS, CRM).

Exemplu: Sfaturi pentru instruirea utilizatorilor CMS Wordpress

Să ne imaginăm situație tipică. Studioul web a dezvoltat site-ul și l-a predat companiei proprietare. Managerul companiei va umple site-ul cu conținut. Cel mai probabil, nu are experiență serioasă de lucru cu un CMS (să fie WordPress în exemplul nostru). Panoul de administrație îi va adresa o serie de întrebări:

• unde să încep;
• ce înseamnă numele și termenii;
• unde să găsești informații de referință;

Studioul web va face mult mai ușor pentru clienți să lucreze cu site-ul dacă le creează în avans indicii în locuri dificile.

Puteți veni cu zeci de sfaturi și le puteți combina în tururi demonstrative, pentru a nu forța utilizatorul să deruleze paginile de documentație sau să vizioneze tutoriale video. Pentru a înțelege ce fel de sfaturi există, vom scrie explicații pentru sarcinile cheie.

Vom explica utilizatorului de unde să înceapă

Utilizatorul face clic pe butonul „Adăugați nou”. Apare fereastra de editare pagina nouași următorul sfat.

Vă vom învăța cum să completați corect formularele

Să acordăm atenție funcțiilor importante

Formarea unei înțelegeri a lucrului cu conținut

Să explicăm termenii speciali

Nu solicitați utilizatorilor să citească documentatie tehnica. Sfatul explicativ din captură de ecran explică semnificația noilor termeni. Conține doar câteva propoziții, nu se suprapune elementelor sistemului și este compatibil cu designul interfeței.

Încă o dată despre beneficii

Valoarea sugestiilor pentru utilizatori este evidentă - cei care anterior aveau nevoie de ajutor pentru a stăpâni singuri serviciul sau aplicația.

Dezvoltatorii de aplicații sau servicii vor economisi la pregătirea și publicarea documentației tehnice și materiale de referinta. Sfaturile vor reduce sarcina serviciului de suport tehnic.

Proprietarii de magazine online care plasează bacșișuri, de exemplu, pe pagina de checkout, vor scăpa de niște „cărucioare abandonate” și vor crește veniturile din conversie și din magazin.

Studiați reacțiile utilizatorilor la produs, creați și ușor de înțeles instrucțiuni disponibile. Acest lucru va reduce pierderile potențiali cliențiși va reduce costul de atragere a acestora.

Aceasta este traducerea unui articol publicat anterior în revista americană pentru antreprenorii de pe internet sandhill.com.

În special pentru publicația online „ProGrably”, materialul a fost extins semnificativ, în principal prin includerea de informații despre aspecte ale designului UX atunci când se dezvoltă un produs web.

Eh... asta e „viața”!

Pe exemplu personal M-am convins că scrierea manualelor de utilizare nu este o problemă atât de mare. sarcină simplă... Mai ales dacă nu cunoașteți produsul software cu care trebuie să îl compuneți!

Deci, cum scrieți un manual de utilizare?

Nu cu mult timp în urmă, am primit un loc de muncă nou loc de muncă unei companii angajate în dezvoltarea și implementarea unui produs software... totul ar fi bine.. dar m-am împiedicat deja de prima mea misiune..

Mi s-a dat sarcina de a scrie un manual de utilizare pentru un program pe care nu îl mai văzusem până acum (cred că era ceva legat de contabilitate, la care nu mă pricep prea bine). Fără versiuni vechi ale manualelor de utilizare, fără exemple.. doar eu și programul.. În timpul lucrului am dat peste câteva capcanele, pe care voi încerca să o descriu în acest articol.

S-ar părea că ar putea fi dificil! Există un program... puțin brainstorming- si totul este gata!!! Desigur, cea mai ideală opțiune este dacă manualul de utilizare este scris de către dezvoltatorul „miracolului naturii” însuși, sau cel puțin de un utilizator care a lucrat în sistemul descris de mult timp.

Ce să faci dacă nu este așa?! Primul pas este să alergi la dezvoltator și să „stai cu adevărat pe gât” astfel încât să-și „mestece” „creiala” de la început până la nivelul extrem!!! În astfel de cazuri, este mai bine să vă imaginați ca un „De ce” și să ajungeți la fundul celor mai mici detalii. Din păcate, nervii programatorului nu vor aprecia un astfel de impuls! Dar și aici alegerea este simplă ghid bun, sau face schimb de plăcere și numai...

În orice caz, trebuie să priviți programul „din exterior” prin ochii unui pionier! După ce au identificat anterior modulele funcționale și modulul care prezintă cel mai mare interes pentru utilizatorul final (cel mai bine este descris în detaliu!), este necesar să se determine nivelul de detaliu al manualului proiectat. De obicei, această problemă este discutată cu conducerea organizației în curs de dezvoltare, dar se poate face la propria discreție.

Din experiența mea, atunci când scriu un manual de utilizare, este mai bine să petreci puțin timp pe design structura generala notă explicativă, apoi scrieți pentru fiecare modul functional manuale separate. Cert este că, cu cât manualul este mai standardizat (structurat), cu atât este mai ușor pentru utilizator să navigheze și cu atât mai ușor de descris! Cu o structură de descriere bine gândită, probabilitatea de a „uita” să afișați unele moment cheie redus semnificativ!

Există și unul ca acesta buna observatie- acestea sunt GOST-uri! Pentru a descrie manualele de utilizare, există un GOST atât de minunat ca GOST 19.505-79 ( pentru o descriere, consultați secțiunea site-ului web).

Cum se scrie un manual de utilizare:

Principalul ghid pentru scrierea acestui manual este următoarea descriere:

• scopul programului (de ce este necesar, cui i se adresează etc.);

• mesaje către operator (descriere posibile erori, mesajele utilizatorului etc.).

• conditii de executie a programului (cerinte hardware si software minime si maxime);

• executarea programului (descrierea funcționalității programului, secvența acțiunilor operatorului etc.);

Ca exemplu, pot oferi propria mea metodă de descriere a execuției programului. Mai întâi trebuie să analizați întregul produs software descris și să determinați defalcarea după module individuale(secțiuni etc.).

În același timp, trebuie să definiți funcții de meniu, nume de câmpuri repetate și alte funcționalități care sunt standard în întregul modul, secțiunea produsului software etc.

1. Scurtă descriere

2.Modulul A

• Submodulul A.1
• Submodulul A.2

3.Modulul B

• Submodulul B.1
• Submodulul B.2

Secțiunea „Scurtă descriere” conține scurta descriere modulele A și B și, de asemenea, descrie acele elemente de meniu repetate, nume de câmpuri etc., caracteristice ambelor module. Mai mult, în descrierea modulului/submodulului în sine, este descris un scurt algoritm pentru lucrul cu modulul/submodulul (descărcare, vizualizare, adăugare, editare, ștergere, generare de rapoarte etc.), după care mai multe descriere detaliata toate funcționalitățile și toate câmpurile disponibile.. Cu alte cuvinte, totul este în detalii!

Sunt descrise specificul câmpurilor, ce operațiuni sunt implicate în completarea lor, ce valori sunt atribuite automat, în ce cazuri sunt afișate câmpurile, tipurile de câmpuri, toate butoanele, casetele de selectare.. În general, aici poti descrie la infinit!!!

Dacă un modul conține submodule, atunci este mai bine să descrii totul într-o secvență strictă.. I.e. la început, descrieți modulul în sine (de la început până la sfârșit), în timp ce faceți o legătură către submodulul corespunzător, iar mai jos - descrieți în detaliu întregul submodul! Se dovedește suficient Frumoasă poză! Utilizatorul nu trebuie să sară dintr-o parte a documentului în alta și înapoi.

Și așa este descris întregul produs software. La sfârșit, puteți scrie o listă de abrevieri utilizate atunci când descrieți manualul de utilizare.

Nu există nicio îndoială că această tehnică este generalizată! Dar din experiența mea pot spune cu siguranță că este foarte convenabil! Convenabil pentru utilizator, convenabil pentru dezvoltatorul manualului de utilizare! Toată lumea este fericită.. 😉

Dar, după cum se spune, nu există nici un prieten după gust! Nu putem decât să vă dorim evoluții de succes!

Există multe tipuri de prevederi informații de referință utilizatorului - aceasta include Întrebări frecvente (întrebări frecvente, întrebări frecvente) și ajutor online și ghid de utilizare (ghidul utilizatorului) și sfaturi populare de astăzi (marca de antrenor, vezi exemplul de mai jos), videoclipuri de antrenament și altele.

Exista motive diferite, pentru care trebuie să scrieți un manual de utilizare a sistemului. Pornind de la solicitările clientului (în practica mea a existat un caz când clientul trebuia să furnizeze un manual de utilizare după fiecare iterație, astfel încât cu ajutorul acestuia să poată efectua testarea de acceptare a funcționalității iterației) și terminând cu termenii contractului referitor la livrarea de software finit, daca vorbim de dezvoltare software la comanda. În cazul dezvoltării propriului produs, deseori are loc și scrierea unui manual de utilizare.

Un analist este adesea implicat în crearea manualului dacă nu este posibil să-l delege unui scriitor tehnic. În majoritatea covârșitoare a cazurilor, analistul este cel care are cele mai complete cunoștințe despre sistem și, de asemenea, are capacitatea de a-și exprima clar gândurile în scris datorită specificului profesiei. Prin urmare, am avut de-a face cu crearea de manuale de utilizare de mai multe ori.

Mai jos sunt câteva practici pentru scrierea unui manual de utilizare bun. Unele dintre ele pot fi utile cuiva atunci când scrieți specificațiile cerințelor.

1. Standarde

De multe ori este necesar să scrieți un document care să îndeplinească cerințele standardelor actuale. Poate fi:

• IEEE Std 1063-2001, IEEE Standard pentru Documentația utilizatorului de software”;
• GOST 19:
  • GOST 19.402-78 ESPD. Descrierea programului;
  • GOST 19.502-78 ESPD. Descriere generala. Cerințe pentru conținut și design;
  • GOST 19.503-79 ESPD. Ghidul programatorului de sistem. Cerințe pentru conținut și design;
  • GOST 19.504-79 ESPD. Ghidul programatorului. Cerințe pentru conținut și design;
  • GOST 19.505-79 ESPD. Manual de utilizare. Cerințe pentru conținut și design.

Dacă nevoile proiectului vă permit să nu respectați standarde rigide, în orice caz, studierea acestor documente poate servi ca punct de plecare pentru redactarea unui document de calitate.

Cartea lui Yuri Kagarlitsky MetaGuide poate fi, de asemenea, utilă. Ghid pentru dezvoltatorii de documentație tehnică pentru software.

2. Structura

Gândiți-vă cu atenție la structura documentului: ar trebui să acopere toate funcționalitățile sistemului, să fie complet și ușor de înțeles.

Un manual de utilizare bun ar trebui să conțină:

• Abstract, Care oferă rezumat conținutul documentului și scopul acestuia. De asemenea, este recomandat să scrieți rezumat scurt la începutul fiecărei secțiuni majore.
• Introducere, care conține informații despre cum să utilizați cel mai bine acest ghid.
• Conţinut
• Capitole, descriind cum utilizare DE
• GlosarȘi
• Index de subiect

Manualul de utilizare poate conține, de asemenea:

• FAQși răspunsurile la acestea
• Legături pe Informații suplimentare conform sistemului
• Capitol, descriind posibil Problemeși modalități de a le rezolva

Este mai bine să numerotați toate capitolele și paragrafele, precum și figurile și tabelele, astfel încât să se poată face referire la acestea în cadrul acestui document sau dintr-un alt document.

3. Utilizatori

Gândiți-vă la utilizatorii tipici ai acestui software: doriți ca documentul să-i ajute să-și rezolve problemele zilnice.

Ar putea chiar să aibă sens să faci diferite secțiuni (sau chiar diverse documente) Pentru grupuri diferite utilizatorii dacă interacțiunea lor cu sistemul este radical diferită. De exemplu, administratorii de sistem (persoanele responsabile pentru Conturi, drepturi de acces etc.) vor fi interesați de funcționalități complet diferite față de utilizatorii obișnuiți.

Respectați utilizatorii sistemului, nu scrieți instrucțiuni într-un stil disprețuitor.

4. Caracteristici de prezentare

Amintiți-vă că stilul de prezentare în vorbirea orală sau în scrisoare de afaceri diferă de aceasta în documentația tehnică și, în special, în manualul de utilizare.

Stilul manualului ar trebui să fie neutru și formal - utilizarea cuvintelor colorate stilistic distrage atenția utilizatorului de la esență.

A compila document bun cunoștințele de gramatică și puțină psihologie vor fi de folos.

4.1 Scrieți pe scurt și logic. Nu lăsa detalii inutile, nu duplicați informațiile. Secvența de menționare a informațiilor în manualul de utilizare trebuie să coincidă cu succesiunea acțiunilor utilizatorului:

Amenda: În meniul Fișier, selectați Salvațiarticol.
Mai rau: Selectați Salvați element din meniul Fișier.

4.2 Folosiți starea de spirit imperativă, nu folosiți expresii politicoase (vă rog, ar putea etc.) - politețea excesivă va fi o piedică aici.

Amenda: Clic Deconectare.

Mai rau: Este necesar să faceți clic Deconectare pentru a deconecta curent contul utilizatorului din sistem .

Mai rau: Dacă utilizatorul dorește să se deconecteze utilizator curent contul din sistemul (sistemele) pe care trebuie să facă clic Deconectare.

4.3 Informații despre structură. Puteți întâlni adesea sfaturi pe care ar trebui să încercați să evitați listele, cu toate acestea, informațiile structurate pas cu pas sunt întotdeauna mai bine percepute.

Amenda:
Lacreaproiect:

1. Apasă pe Crea butonul de pe bara de instrumente.
2. Pe Crea Proiect suprapunere completați toate câmpurile obligatorii.
3. Apasă pe Salvațibuton pentru a salva proiectul.

Mai rau: Pentru a crea un proiect, faceți clic pe Crea butonul de pe bara de instrumente, de pe Creați proiect suprapunere completați toate câmpurile obligatorii, faceți clic pe Salvați butonul pentru a salva proiectul.

4.4 Nu folosiți timpul viitor sau trecut. De exemplu, există adesea manuale în care reacția sistemului la acțiunea unui utilizator este transmisă în fraze formulate la timpul viitor. Software-ul nu are trecut sau viitor: totul se întâmplă în prezent ca rezultat direct acțiune specifică utilizator. Imediat ce are loc un eveniment, software-ul reacţionează.

Amenda: Când utilizatorul face clic pe start butonul, programul începe procesul.

Mai rau: Când utilizatorul face clic pe start butonul, programul o sa inceapa procesul.

4.5 Verificați sensul cuvintelor. Dacă trebuie să scrieți un document în limbă străină, trebuie să încercăm pe cât posibil să evităm greșelile asociate cu cunoașterea insuficientă a limbii.

De exemplu, verbul „apăsați” înseamnă apăsarea unei taste de pe tastatură, iar „click” înseamnă apăsarea unui buton sau pictogramă dintr-o fereastră de program folosind mouse-ul, iar „loviți” este în general un cuvânt argou.

Desigur greseli de scriere inacceptabil.

4.6 Nu folosiți sinonime pentru același termen.În literatura IT în limba engleză (sau orice altă limbă) există set standard verbe care denotă acțiuni (clic, dublu clic, selectați, tastați, apăsați etc.) și același set standard de nume de elemente de control. Decideți terminologia și respectați-o pe tot parcursul documentului.

De exemplu, nu permiteți ca o listă derulantă dintr-o parte a documentului să fie numită drop-down, iar în altă parte exact același element - combobox sau dropdown list. Acest lucru derutează utilizatorul.

4.7 Folosiți abrevierile cu înțelepciune și evitați jargonul.

Se crede că abrevierile nu ar trebui folosite, dar dacă un termen lung este folosit de mai multe ori, atunci la prima mențiune în text ar trebui să scrieți numele complet și lângă el - abrevierea între paranteze și mai departe în text. poate folosi doar abrevierea. Dacă documentul are un glosar sau o secțiune cu abrevieri, acestea trebuie explicate acolo.

Nu utilizați jargon, metafore sau termeni împrumutați dintr-o altă limbă decât cea din manual.

5. Aspectul

5.1 Gândiți-vă la stilul documentului. Ar putea fi șablon corporativ sau o schemă de culori software sau un design special realizat pentru document.

Când scrieți, nu ezitați să evidențiați lucruri importante cu stiluri sau culori (de exemplu, evidențiați numele butoanelor cu aldine). Dar este important să înțelegeți că fonturile și culorile selectate incorect pot face dificilă perceperea conținutului documentului.

5.2 Nu economisiți spațiu– împărțiți textul în paragrafe scurte, folosiți titluri relativ mari, începeți noua sectiune dintr-o pagină nouă. Acest lucru va face mai ușor pentru utilizator să citească informațiile.

5.3 Utilizați pictograme și ilustrații. Există o părere că nu ar trebui să vă lăsați dus de ilustrații și să includeți, de asemenea, pictograme în textul manualului de utilizare. in orice caz informatii grafice este întotdeauna mai bine perceput și reținut, astfel încât capturile de ecran și pictogramele necesare ar trebui să fie prezente într-un manual bun în cantități suficiente, dar rezonabile.

6. Suport

Nu pierdeți din vedere faptul că software-ul se modifică în timp, ceea ce înseamnă că și documentul dvs. trebuie să se schimbe pentru a rămâne relevant.

Concluzie

Vă rugăm să rețineți că iritația de la un document de proastă calitate poate fi proiectată pe software de către utilizator și, prin urmare, poate influența decizia de a utiliza produsul.

Amintiți-vă principalul lucru: documentul ar trebui să ajute utilizatorii.

Am pregătit articolul

Nadezhda Tarasyuk, membru al comunității site-ului,

analist cu 6 ani de experienta in domeniu.

Manualul de utilizare este o carte de referință pe suport hârtie sau digital (în format PDF sau XPS) care oferă instrucțiuni pentru operarea ceva sau descrie ordinea corectă acțiuni pentru a finaliza un proces. Deși atunci când o persoană aude expresia „manual de utilizare”, de obicei își imaginează un manual pentru utilizare program specific, instrucțiunile de utilizare sunt disponibile de pe computer și aparate electrocasnice(televizoare, sisteme stereo, telefoane, playere MP3, echipamente de grădină etc.). Un manual de utilizare bun explică funcțiile de bază ale dispozitivului sau programului și explică cum să-l folosească corect, iar informațiile sunt de obicei bine organizate. Acest articol vă va spune ce este important de reținut atunci când creați și proiectați un manual de utilizare.

Pași

Partea 1

Stabilește cine este cititorul tău. Pentru a crea un manual de utilizare bun, trebuie să înțelegeți ce fel de persoană va cumpăra dispozitivul pentru care creați instrucțiuni. Vă puteți nota gândurile sau pur și simplu vă puteți imagina această persoană. Acest lucru este util dacă faceți parte dintr-o echipă de documentare și dacă sunteți implicat în dezvoltarea unui produs de la început până la sfârșit. Luați în considerare următoarele:

• Unde va folosi o persoană manualul de instrucțiuni: acasă, la serviciu, în mașină, pe internet? Acest lucru va determina nu numai conținutul, ci și stilul documentației.
• Cum va folosi o persoană instrucțiunile? Dacă o persoană trebuie să se uite doar ocazional la manualul de utilizare, atunci instrucțiunile ar trebui să fie prezentate într-o formă concisă. Dacă manualul va fi folosit frecvent, mai ales la început, ar trebui să includeți o secțiune întreagă despre cum să începeți să utilizați dispozitivul sau produs softwareși descrieți în detaliu toate cele mai importante funcții.
• Câtă experiență ar trebui să aibă o persoană? Dacă produsul dvs. este relativ nou sau diferit semnificativ de produsele similare, va trebui să includeți informații despre modul în care acest produs diferă de produsele similare și să oferiți utilizatorului instrucțiuni detaliate. Dacă produsul este asociat cu probleme frecvente(de exemplu, cu o cantitate mare programe), descrieți ce trebuie făcut atunci când apare o problemă.

1. Scrieți în așa fel încât cititorul să vă înțeleagă. Cu excepția cazului în care produsul dvs. solicită utilizatorului să aibă cunoștințe specifice, este mai bine să evitați termenii tehnici și să descrieți totul în mod simplu, într-un limbaj clar. Structura textului ar trebui să corespundă secvenței de întrebări pe care utilizatorul le poate avea. Este mai corect să grupați funcțiile dispozitivului în funcție de sarcinile pe care le îndeplinește și să renunțați la ideea de a combina cele mai populare funcții într-un singur grup.

   • Uneori este imposibil să excludeți complet termenii tehnici (de exemplu, dacă scrieți instrucțiuni pentru un program pentru crearea de grafice și diagrame, unde, în plus față de mijloace standard folosit de asemenea instrumente grafice Fibonacci). În acest caz, este util să definiți termenul și să oferiți o scurtă descriere (adică, ce sunt diagramele Fibonacci și cum sunt ele utilizate în analiza performanței financiare).

2. Partea 2

   Componentele manualului de utilizare

   1. Luați în considerare coperta și designul primelor pagini ale secțiunilor. Va trebui să creați o copertă dacă instrucțiunile au mai multe pagini. De asemenea, va fi necesar să creați pagini cu numele secțiunilor pentru instrucțiuni în care cantitatea totală de informații ocupă mai mult de 4 pagini.

      • Dacă manualul de utilizare este protejat de drepturi de autor, o notificare trebuie să apară pe coperta și pe paginile secțiunilor.
      • Dacă manualul de utilizare oferă condiții specifice de utilizare a produsului și instrucțiuni pentru acesta, postați aceste informații cu interior acoperă.

   2. Plasați linkuri către documentație suplimentară în introducere. Dacă manualul constă din mai multe broșuri, enumerați toate numerele de broșuri la început. În plus, ar trebui să includeți aici și o secțiune „Cum să utilizați aceste instrucțiuni de utilizare” dacă decideți că o astfel de secțiune este necesară.

      Dacă numărul de pagini depășește 10, veți avea nevoie de un cuprins.

   3. Manualul de utilizare ar trebui să se bazeze pe instrucțiuni și informații despre componente bunuri. De regulă, instrucțiunile sunt împărțite în blocuri, iar în fiecare bloc puteți indica în ce secțiuni ar trebui să caute utilizatorul cutare sau cutare informație. Acest lucru va face mai ușor și mai rapid pentru utilizator să găsească informațiile de care are nevoie.

      • Procesele trebuie descrise clar și consecvent. Începe cu descriere generala sarcină, apoi explicați ce va trebui să facă utilizatorul și ce rezultat ar trebui să obțină. Toți pașii trebuie numerotați, iar propozițiile trebuie să înceapă cu verbe.
      • Materialele de ajutor ar trebui să includă o listă de caracteristici, tehnici de depanare și întrebări frecvente. Un scurt glosar de termeni și un index pot fi incluse la sfârșitul ghidului utilizatorului, deși termenii cheie sunt adesea incluși la început. Se recomandă un index alfabetic pentru instrucțiunile mai lungi de 20 de pagini.

   4. Folosiți imagini și diagrame. Desenele și capturile de ecran pot descrie anumite procese mai bine decât textul, mai ales dacă despre care vorbim din procese complexe, unde este necesar să existe o confirmare vizuală că o persoană face totul corect. Imaginile grafice pot fi create în programe speciale: în sisteme de desen bi și tridimensional, în editori grafici, în aplicații de procesare foto etc. Dacă trebuie să faceți capturi de ecran, le puteți obține folosind fonduri regulate calculator și program de grafică cu posibilitatea de a salva capturi de ecran.

      • Odată ce aveți graficul, salvați-l într-un format comprimat. De asemenea, poate fi necesar să reduceți dimensiunea desenului pentru a se potrivi pe pagină, dar dimensiunea nu trebuie să fie prea mică, altfel utilizatorul nu va putea vedea cum și ce să facă. Dacă este necesar, puteți împărți imaginea în mai multe părți și puteți descrie fiecare dintre ele.
      • Dacă utilizați mai multe imagini, acestea trebuie să aibă aceeași mărime, proporții și rezoluție. Astfel de imagini vor fi mai înțelese și mai plăcute cititorului. Când faceți capturi de ecran, asigurați-vă că utilizați standardul schema de culori(pentru cazurile în care manualul este tipărit color).
      • Cu toate că editor grafic(de exemplu, Photoshop și Paint Shop Pro) sunt convenabile pentru crearea de capturi de ecran, este mai bine să le utilizați programe speciale(cum ar fi SnagIt), deoarece vă permit să editați, să salvați și să subtitrați rapid și ușor toate imaginile dvs. imediat.

      Partea 3

      Întocmirea manualului de instrucțiuni

      1. Alegeți un font care poate fi citit. Deși computerele acceptă fonturi diferite, manualul de utilizare ar trebui să fie ușor de citit, așa că alegeți-le pe cele mai simple. Cel mai bine este să alegeți mai multe fonturi care arată bine împreună. Există două tipuri de fonturi: serif și sans serif.

         • Fonturile serif au linii mici de-a lungul marginilor liniilor. Aceste fonturi includ Times New Roman, Baskerville și Book Antiqua. Astfel de fonturi sunt potrivite pentru volume mari de text tipărite la dimensiunea 10 sau 12 și care formează baza manualului de utilizare.
         • Fonturile sans serif au linii simple fara decoratiuni. Acestea sunt fonturi precum Arial, Calibri și Century Gothic. Fonturile sans serif arată mai bine în textele tipărite cu dimensiunea fontului 8 sau 10 în manualele PDF sau documentele web. Cum font mai mare, cu atât este mai dificil de citit sans serif. Cu toate acestea, aceste fonturi pot fi folosite și pentru text mare - de exemplu, pentru tastarea titlurilor. Fonturile sans serif sunt potrivite pentru tastarea numerelor în tabele și coloane.
         • Ar trebui să aleagă fonturi simple precum Arial sau Times New Roman, deși un font mai complex ar fi potrivit pentru citate. Dacă scrieți un manual de utilizare pentru un joc fantasy, este posibil să doriți să evidențiați titlurile capitolelor într-un font plin. Citatele pot fi, de asemenea, scrise cu italice.
         • După ce ați ales fonturile, creați pagina de testare pentru a vă asigura că fonturile se potrivesc pe hârtie. Afișați această pagină persoanei care aprobă machetele înainte de a trimite manualul de utilizare la imprimare.

      2. Gândiți-vă la aspectul blocurilor de informații.În acest moment, trebuie să decideți în ce ordine să plasați informațiile.

         • De obicei, titlul manualului de utilizare și titlurile capitolelor sunt plasate în partea de sus sau de jos a paginii, împreună cu numerele paginii. Numerele pot fi amplasate în exterior (pentru partea de sus și de jos a paginii) sau în mijloc (pentru partea de jos). Prima pagină a fiecărei secțiuni poate fi diferită de restul, așa că vă recomandăm să plasați numărul paginii în mijloc în partea de jos și toate celelalte numere de pagină în exterior.
         • Fragmentele de text individuale pot fi evidențiate în culoare prin plasarea lor în blocuri speciale. Este important să alegeți o nuanță care să nu înfunde textul.
         • Lasă destul liniuțe mari din toate părţile. Pe partea de legare, indentarea ar trebui să fie mai largă.

      3. Luați în considerare tipul de legare. Dacă manualul de utilizare are mai mult de 4 pagini, veți avea nevoie de un liant. Documente pentru uz intern De obicei capsat în colț, dar dacă puneți manualul în cutia cu produsul, va trebui să fiți mai responsabil cu această problemă. Există trei tipuri de legare:

         • Închidere cu capse. Acest tip este potrivit pentru broșuri care măsoară 21 x 27,5 cm, 21 x 35 cm sau 11 x 27,5 x 42,5 cm Cele mai ieftine manuale de instrucțiuni care au 48 de pagini sau mai puțin sunt legate în acest fel.
         • Legătură cu cusătura în șa. Așa se împletesc cele mai multe instrucțiuni regulate manuale, fără a număra manualele auto, deși unele manuale lungi sunt și ele legate în acest fel. (Paint Shop Pro a fost livrat inițial cu acest manual de utilizare.)
         • Legatura cu spirala de sarma. Manualele care sunt folosite în medii mai dure, cum ar fi în aer liber, unde capsele se pot rupe sau se desfășoară cu ușurință, sunt legate în acest mod. Unele instrucțiuni de utilizare cu această legare conțin și pagini laminate care nu se udă sau se murdăresc cu murdărie.

      4. Așezați documentul. Majoritatea editorilor de text și a programelor pentru publicarea textului pe Internet oferă capabilități de aspect. Pe măsură ce introduceți text, acesta va apărea automat în fontul selectat. (Acest articol a fost scris inițial folosind un șablon în Microsoft Word.) Aceste programe au, de asemenea, deja șabloane gata făcute, pe care îl puteți modifica pentru a se potrivi nevoilor dvs. în loc să creați un șablon de la zero.

         • ÎN editori de text iar programele de publicare a textului pe Internet au, de asemenea, funcția de a crea „stiluri”, salvarea fonturilor și setarea dimensiunilor pentru cuprins, anteturi și subsoluri și textul corpului. Puteți alege dintre stilurile existente ("Heading1", "Normal", "Citat") sau puteți crea propriile stiluri propriul stilși dă-i numele tău. Se recomandă să denumiți stilurile folosind același sistem prevăzut în program. (De exemplu, Microsoft Word creează titluri precum „Heading1”, „Heading2”; există și subtitluri.) Configurați programul în avans, astfel încât să nu fie nevoie să vă întoarceți la el când începeți să scrieți textul.
      • Folosiți coduri de câmp sau variabile text ori de câte ori este posibil. Le puteți modifica semnificațiile (de exemplu, numele produsului, titlul capitolului manual de utilizare) și le puteți plasa în locurile din documentul dvs. unde, în mod normal, ați introduce cuvinte de mână. Când previzualizați documentul sau îl pregătiți pentru imprimare, textul solicitat substituit în variabile. Dacă numele produsului se schimbă sau dacă decideți să schimbați titlul capitolului, vă va fi mai ușor să schimbați textul prin înlocuirea valorii variabilei.

      Ce vei avea nevoie

      • Editor de text sau program pentru publicarea textului pe Internet
      • Editor grafic sau program de captură de ecran