Sådan oprettes Bruger dokumentation

Skrivning dokumentation om, hvordan man bruger et computerprogram er kritisk for både slutbrugeren og nogen forsøger at træne individer på det nye program.Dokumentationen skal være klar og let at forstå.Du ønsker ikke dine brugere at skulle gætte på, hvordan du bruger dit program.Bruger dokumentation har brug for en balance af både skriftlige og visuelle trin.De følgende trin vil give et overblik over, hvordan du opretter en standard bruger guidebog.

hvad du har brug

  • Computerprogram
  • Blyant og papir
  • Desktop publishing software

Instruktioner

  1. Skriv en kort beskrivelse af dit nye program --- inkluderer dens formål, hvilke platforme programmet vil køre på, og eventuelle hukommelse.Liste flere punkttegn angivelse store funktioner i programmet.

  2. Sketch ud af, hvordan du ønsker, at brugeren dokumentation skal se ud.Medtag eventuelle sidehoveder og sidefødder til sted inden for den dokumentation, sidetal og hvordan coveret skal se ud.Denne skitse vil o

    gså hjælpe dig med at sætte brochuren sammen.

  3. Skriv dit første sektion - hvordan du installerer programmet.Stat hvert trin klart at indsætte den kompakte disk i computeren til hvad man skal gøre, når softwaren er installeret.Giv skærmbilleder af installationsprocessen.Må ikke udelade nogen foranstaltninger og anføre eventuelle mulige fejl, der måtte opstå.Medtag et diagram over tip til fejlfinding.

  4. klart trinene for at få programmet til at køre.Medtag hvilken ikon for at klikke og hvad hovedskærmen vil se ud.Give et skærmbillede af skærmen åbningen.

  5. Skriv din tredje afsnit - hvordan man opererer med programmet.Beskriv eventuelle menufunktioner, hvordan du får adgang hjælp, hvis tilgængeligt, hvordan man kan gemme filer, hvordan du udskriver, hvordan du afslutte programmet og alle andre grundlæggende funktioner.Medtag skærmbilleder hele også denne sektion.Bruge enkle engelsk og forventer ikke slutbrugeren til at påtage sig noget.Hvis programmet grænseflader med et andet program eller pakke, forklare denne forbindelse.

  6. Komponer en enkel indholdsfortegnelse og et indeks ved hjælp af søgeord fra din dokumentation.Skriv dette afsnit, når du har ovenstående kernesektioner gjort.Indekset giver brugeren en hurtig måde at hente oplysninger uden at skulle søge på hele brochuren.

  7. Opret en ordliste for eventuelle tekniske ord eller jargon, der skal defineres for brugeren.Dernæst designe coveret til at gå på forsiden af ​​brochuren.

  8. Rediger din dokumentation - tjek din stavning, grammatik og overordnede informationsstrøm.Foretag eventuelle ændringer og videregive dokumentationen til en anden, at dobbelttjekke dit arbejde.Print og binde den endelige version.

Ressourcer

  • Metoder og Mekanik for at skabe Pålidelig brugerdokumentation
784
0
0
Anden Computer Software