Hvordan man skriver en brugervejledning til Software

En kvinde arbejder på en computer. Colorblind billeder / Blend Images / Getty Images

ofte fyldt med jargon, akronymer, og retninger, der kræver en Ph.D at forstå, software brugervejledninger undertiden skrevet fra synspunkt en udviklersnarere end en bruger.Som et resultat, kan guide gøre antagelser om læserens færdighedsniveau, der ofte forkert.Det første skridt i at skrive en god brugsanvisning er at få den faktiske skriveprocessen så langt væk fra ingeniørerne som muligt.


Den softwareudvikler ved mere end nogen, hvad der gør softwaren arbejde, men det betyder ikke, at bygherren skulle skrive vejledningen.Tværtimod er det en klar ulempe.Vigtigere end en dyb forståelse af de indre funktioner i softwaren er en forståelse af, hvem slutbrugeren vil være, hvad hans uddannelsesniveau er, og hvordan det slutbrugeren vil bruge softwaren.I de fleste tilfælde behøver slutbrugerne ikke brug for at kende de finere punkter i programmering og back-end arbejdet i softwaren - de skal bare vide, hvordan man bruger det til at gøre deres job lett

ere.

Bruger Test

  • Brugermanualen skal være stort set opgave-orienteret, snarere end stærkt beskrivende.Fordi manual er skrevet for at hjælpe brugerne med at forstå, hvordan man kan udføre bestemte opgaver, forfatteren skal have en forståelse af disse opgaver så godt, og som et resultat, som går gennem hvert diskrete trin i hver funktion er absolut nødvendigt.Det er ikke nødvendigt for forfatteren nødvendigvis vide, hvordan programmet blev skabt af et design eller udvikling synspunkt, men det er vigtigt at have en stærk praktisk kendskab til alle dens funktioner.Under udførelse af hver opgave, tage tid til at skrive ned hver eneste skridt, herunder klik, drop-down menuer, og andre aktioner.

interview processen

  • Selv udvikleren ikke bør være den ene til at skrive manualen, vil hun stadig være en værdifuld ressource til forfatteren, og før skrivning begynder, planlægge et kickoff møde mellem forfatter, udvikler ogingeniører, og potentielle slutbrugere at hjælpe informere forfatterens arbejde fra begyndelsen.Bør registreres Interviews med emne eksperter og ingeniører, med udskrifter lavet til senere brug.

Imagery

  • En brugsanvisning bør ikke være for tekst-tung.Snarere indarbejde liberale brug af grafik og skærm klip.Beskrivelse af en aktion er meget klarere med tekstbaserede retninger ledsaget af en skærm klip, der klart illustrerer den retning.Medtag både før og efter synspunkter, for at vise, hvad skærmen ser ud, før du tager hver aktion og hvad der sker, efter at sagen er blevet truffet.En simpel screen capture hjælpeprogram såsom Snipping Værktøj inkluderet i Microsoft Windows fungerer godt til at indfange disse billeder.Vær sikker på at nummerere hvert billede, og omfatter en billedtekst, der kort beskriver det.Centrere det umiddelbart under det afsnit, der først introducerer afbildet i billedet konceptet.

formatering

  • kommunikere 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ælp undgå forvirring.Skabeloner er tilgængelige og kan være et godt udgangspunkt for ensartethed, selv om disse sikkert kan tilpasses til at passe hver enkelt situation.Ved hjælp af en en-tommer margen med en enkelt kolonne passer bedst til behovet for at tilføje grafik;en to-kolonne indstilling kan synes for overfyldt, og kan gøre placering af billeder forvirrende.

Versionering og sporing

  • Mere end nogen anden type dokument, et software brugerguiden er tilbøjelige til at gå gennem flere iterationer, før den er færdig, og det er sandsynligt, at gå gennem en gennemgang af flere interessenter.Brug af Registrer ændringer-funktionen på Microsoft Word er en nem måde at holde styr på hver enkelte kommentarer og ændringer.Oprette flere versioner efter hver revision cyklus, hver med et andet filnavn, også hjælper processen sammen og sørger for alle interessenter er tilfredse med det endelige resultat.

Ressourcer

  • Techcommunicators.com: Skrivning revideres Manualer
392
0
1
Product Management