Adesea umplute cu jargon, acronime și instrucțiuni care necesită un doctorat pentru a înțelege, manualele de utilizare a software-ului sunt uneori scrise din punctul de vedere al dezvoltatorului mai degrabă decât al unui utilizator. Ca urmare, ghidul poate face presupuneri despre nivelul de calificare al cititorului care sunt adesea incorecte. Primul pas în elaborarea unui manual de utilizare bun este de a obține procesul real de scriere cât mai departe de ingineri.
Dezvoltatorul de software știe mai mult decât oricine ce face munca software-ului, dar asta nu înseamnă că dezvoltatorul ar trebui să scrie ghidul. Dimpotrivă, este un dezavantaj distinct. Mai important decât o înțelegere profundă a funcționării interne a software-ului este o înțelegere a utilizatorului final, a nivelului său educațional și a modului în care acel utilizator va folosi software-ul. În majoritatea cazurilor, utilizatorii finali nu au nevoie să cunoască punctele mai fine ale programării și operațiunile back-end ale software-ului - trebuie doar să știe cum să-l folosească pentru a-și ușura activitatea.
Testarea utilizatorilor
Manualul de utilizare ar trebui să fie în mare parte orientat spre sarcini, mai degrabă decât foarte descriptiv. Deoarece manualul este scris pentru a ajuta utilizatorii să înțeleagă cum să execute anumite sarcini, scriitorul trebuie să aibă o înțelegere a acestor sarcini, de asemenea, și, prin urmare, trecerea fiecărui pas individual al fiecărei caracteristici este absolut esențială. Nu este necesar ca scriitorul să știe în mod necesar cum a fost creat programul dintr-un punct de vedere al designului sau dezvoltării, dar este esențial să aibă o cunoaștere solidă a tuturor caracteristicilor sale. În timpul executării fiecărei sarcini, faceți timp pentru a scrie fiecare pas, inclusiv clicuri, meniuri derulante și alte acțiuni.
Procesul de interviu
Deși dezvoltatorul nu ar trebui să fie cel care va scrie manualul, ea va fi în continuare o resursă valoroasă pentru scriitor și, înainte de a începe să scrie, planificați o întâlnire de kickoff între scriitor, dezvoltator și ingineri și potențialii utilizatori finali pentru a ajuta la informarea munca scriitorului de la început. Trebuie înregistrate interviuri cu experți și ingineri în materie, cu transcrieri făcute pentru referință ulterioară.
Imagini
Un manual de utilizare nu ar trebui să fie prea greu pentru text. Mai degrabă, încorporați utilizarea liberă a imaginilor grafice și a ecranelor. Descrierea unei acțiuni este mult mai clară cu instrucțiunile bazate pe text, însoțite de un clip pe ecran care ilustrează în mod clar această direcție. Includeți atât înainte, cât și după vizualizări, pentru a arăta cum arată ecranul înainte de a lua fiecare acțiune și ce se întâmplă după ce a fost întreprinsă acțiunea. Un utilitar simplu de captare a ecranului, cum ar fi instrumentul Snipping inclus în Microsoft Windows, funcționează bine pentru captarea acestor imagini. Asigurați-vă că numerotați fiecare imagine și includeți o legendă care o descrie pe scurt. Centrează-o imediat sub paragraful care introduce mai întâi conceptul descris în imagine.
Formatarea
Comunicarea clară într-un document tehnic necesită planificare și respectarea cu atenție a standardelor în cadrul ghidului. Standardele în prezentare, limbă și nomenclatură ajută la evitarea confuziei. Sunt disponibile șabloane și pot fi un bun punct de plecare pentru uniformitate, deși acestea pot fi adaptate cu siguranță pentru a se potrivi fiecărei situații. Folosind o margine de un inch cu o singură coloană, se potrivește cel mai bine nevoii de a adăuga grafică; o setare cu două coloane poate părea prea aglomerată și poate face confuzie cu plasarea imaginilor.
Versiuni și urmărire
Mai mult decât orice alt tip de document, este posibil ca un ghid de utilizare a software-ului să treacă prin mai multe iterații înainte ca acesta să fie complet și este probabil să treacă printr-un proces de revizuire de către mai multe părți interesate. Utilizarea funcției Track Changes în Microsoft Word este o modalitate ușoară de a urmări comentariile și modificările fiecărui individ. Crearea de versiuni multiple după fiecare ciclu de examinare, fiecare cu un nume de fișier diferit, ajută de asemenea procesul și garantează că toate părțile interesate sunt mulțumite de rezultatul final.
