Dažnai užpildyti žargonais, akronimais ir kryptimis, kurių reikia, kad būtų suprantama, programinės įrangos vartotojo vadovai kartais rašomi kūrėjo, o ne naudotojo požiūriu. Todėl vadovas gali daryti prielaidas apie skaitytojo įgūdžių lygį, kuris dažnai yra neteisingas. Pirmasis žingsnis, rašant gerą vartotojo vadovą, yra, kad faktinis rašymo procesas būtų kuo toliau nuo inžinierių.
Programinės įrangos kūrėjas žino daugiau nei kas nors, kas daro programinę įrangą, tačiau tai nereiškia, kad kūrėjas turėtų parašyti vadovą. Priešingai, tai yra aiškus trūkumas. Svarbesnis už gilų supratimą apie programinės įrangos vidinį veikimą yra supratimas apie tai, kas bus galutinis vartotojas, koks jo išsilavinimo lygis ir kaip šis galutinis vartotojas naudojasi šia programine įranga. Daugeliu atvejų galutiniams vartotojams nereikia žinoti geresnių programinės įrangos taškų ir programinės įrangos „back-end“ veikimo - jie tiesiog turi žinoti, kaip jį naudoti, kad jų darbas būtų paprastesnis.
Vartotojo testavimas
Naudotojo vadovas turėtų būti orientuotas į užduotis, o ne labai apibūdinantis. Kadangi vadovas yra parašytas padėti vartotojams suprasti, kaip vykdyti konkrečias užduotis, rašytojas taip pat turi suprasti šias užduotis, todėl kiekvienos savybės atskiras žingsnis yra būtinas. Rašytojui nebūtina žinoti, kaip programa buvo sukurta projektavimo ar vystymosi požiūriu, tačiau labai svarbu, kad būtų gerai žinomos visos jos savybės. Vykdydami kiekvieną užduotį, užsirašykite kiekvieną žingsnį, įskaitant paspaudimus, išskleidžiamuosius meniu ir kitus veiksmus.
Interviu procesas
Nors kūrėjas neturėtų rašyti vadovo, ji vis tiek bus vertingas šaltinis rašytojui, o prieš pradedant rašyti, suplanuokite rašytojo, kūrėjo ir inžinierių susitikimą su potencialiais galutiniais vartotojais, kad galėtumėte informuoti rašytojo darbas nuo pat pradžių. Turėtų būti užfiksuoti pokalbiai su dalykų ekspertais ir inžinieriais, o jų nuorašai turi būti parengti vėliau.
Vaizdai
Naudotojo vadovas neturėtų būti pernelyg didelis tekstas. Atvirkščiai, naudokite liberalų grafikos ir ekrano klipų naudojimą. Veiksmo aprašymas yra daug aiškesnis tekstinėmis kryptimis, kartu su ekrano klipu, kuris aiškiai iliustruoja tą kryptį. Įtraukite prieš ir po peržiūros, kad parodytumėte, kaip atrodo ekranas prieš kiekvieną veiksmą, ir kas atsitiks po to, kai veiksmas buvo atliktas. Paprastas ekrano užfiksavimo įrankis, pvz., „Snipping“ įrankis, įtrauktas į „Microsoft Windows“, puikiai tinka užfiksuoti šiuos vaizdus. Būtinai įrašykite kiekvieną vaizdą ir įtraukite antraštę, kuri trumpai ją apibūdina. Centruokite jį iš karto po ta dalimi, kuri pirmą kartą įveda vaizdą vaizduojamą sąvoką.
Formatavimas
Ryšiuose su techniniais dokumentais reikia aiškiai planuoti ir kruopščiai laikytis standartų. Tiek pateikimo, tiek kalbos, tiek nomenklatūros standartai padeda išvengti painiavos. Šablonai yra prieinami ir gali būti geras vienodumo pradžios taškas, nors jie tikrai gali būti pritaikyti kiekvienai situacijai. Naudojant vieno colio paraštę su vienu stulpeliu geriausiai tinka poreikis pridėti grafiką; dviejų stulpelių nustatymas gali pasirodyti pernelyg perkrautas, ir gali padaryti klaidingą vaizdų išdėstymą.
Versija ir stebėjimas
Daugiau nei bet kuris kitas dokumento tipas, programinės įrangos vadovas, greičiausiai, eis per kelis pakartojimus, kol jis bus baigtas, ir tikėtina, kad jį peržiūrės keli suinteresuotieji subjektai. Naudojant „Microsoft Word“ funkciją „Track Changes“, galite lengvai sekti kiekvieno asmens pastabas ir pakeitimus. Sukūrę kelias versijas po kiekvieno peržiūros ciklo, kurių kiekvienas turi kitą failo pavadinimą, taip pat padeda procesas ir užtikrinama, kad visi suinteresuotieji subjektai būtų patenkinti galutiniu rezultatu.
