Ofte fyldt med jargon, akronymer og retninger, der kræver en Ph.D. at forstå, software brugerhåndbøger bliver nogle gange skrevet ud fra en udvikleres synsvinkel frem for en bruger. Som et resultat heraf kan guiden gøre antagelser om læserens færdighedsniveau, der ofte er forkerte. Det første skridt i at skrive en god brugervejledning er at få den faktiske skriveproces så langt væk fra ingeniører som muligt.
Softwareudvikleren kender mere end nogen, hvad der gør softwaren til at fungere, men det betyder ikke, at udvikleren skal skrive vejledningen. Tværtimod er det en klar ulempe. Mere vigtig end en dyb forståelse af softwareets indre virkninger er en forståelse af, hvem slutbrugeren vil være, hvad hans uddannelsesniveau er, og hvordan slutbrugeren skal bruge softwaren. I de fleste tilfælde behøver slutbrugerne ikke at vide de finere programmeringspunkter og softwares back-end-funktioner - de skal bare vide, hvordan man bruger det til at gøre deres job lettere.
Bruger Testing
Brugermanualen skal i høj grad være opgaveorienteret, snarere end stærkt beskrivende. Fordi manualen er skrevet for at hjælpe brugerne med at forstå, hvordan de skal udføre specifikke opgaver, skal forfatteren også have en forståelse for disse opgaver, og som følge heraf er det absolut nødvendigt at gennemgå hvert enkelt trin i hver funktion. Det er ikke nødvendigt for forfatteren at nødvendigvis vide, hvordan programmet blev skabt ud fra et design eller udviklingssynspunkt, men det er vigtigt at have et stærkt arbejdskendskab til alle dens funktioner. Når du udfører hver opgave, tager du tid til at skrive ned hvert trin, herunder klik, rullemenuer og andre handlinger.
Interviewprocessen
Selv om udvikleren ikke bør være den, der skriver håndbogen, vil hun stadig være en værdifuld ressource for forfatteren, og inden der begynder at skrive, planlægger et kickoff-møde mellem forfatteren, udvikleren og ingeniører og potentielle slutbrugere at hjælpe med at informere forfatterens arbejde fra begyndelsen. Interviews med fageksperter og ingeniører bør registreres, med udskrifter foretaget til senere reference.
Imagery
En brugervejledning må ikke være for tekst-tung. Snarere indarbejde liberal brug af grafik og skærmklip. Beskrivelse af en handling er meget tydeligere med tekstbaserede retninger ledsaget af et skærmklip, som klart illustrerer den retning. Inkluder både før og efter visninger for at vise, hvordan skærmen ser ud, før du tager hver handling, og hvad der sker efter at handlingen er taget. Et simpelt skærmoptagelsesværktøj som Snipping Tool, der er inkluderet i Microsoft Windows, fungerer godt til at fange disse billeder. Sørg for at nummerere hvert billede og medtage en billedtekst, der kort beskriver det. Centrer det umiddelbart under det afsnit, der først introducerer konceptet afbildet i billedet.
Formatering
Kommunikation klart i et teknisk dokument kræver planlægning og omhyggelig overholdelse af standarder i hele vejledningen. Standarder i både præsentation, sprog og nomenklatur hjælper med at undgå forvirring. Skabeloner er tilgængelige og kan være et godt udgangspunkt for ensartethed, selv om disse sikkert kan tilpasses til enhver situation. Brug en 1-tommers margin med en enkelt kolonne passer bedst til behovet for at tilføje grafik; en indstilling med to kolonner kan blive for presset og kan gøre placeringen af billeder forvirrende.
Versioning og Tracking
Mere end nogen anden type dokument, en software brugervejledning sandsynligvis vil gennemgå flere iterationer, før det er færdigt, og det vil sandsynligvis gennemgå en gennemgangsproces af flere interessenter. Brug af sporændringsfunktionen på Microsoft Word er en nem måde at holde styr på hver enkelt persons kommentarer og ændringer. Oprettelse af flere versioner efter hver evalueringscyklus, hver med et andet filnavn, hjælper også processen sammen og sikrer, at alle interessenter er tilfredse med det endelige resultat.
