Uanset hvor genial en opfinder, programmør eller rationalizer kan være, kan hans kreationer undertiden simpelthen ikke bruges til det tilsigtede formål. Årsagen til dette er den forkert udarbejdede brugsanvisning eller dens fuldstændige fravær. Men selv geniale opfindere skriver undertiden sådanne instruktioner, at bortset fra snævre specialister kan ingen læse disse papirer. Så hvordan udarbejder du korrekt et sådant nødvendigt dokument?
Er det nødvendigt
- - hundrede procent kendskab til det udstyr eller softwareprodukt, som manualen skrives til;
- - viden inden for lingvistik
- - Skrive evner.
Instruktioner
Trin 1
En brugermanual eller med andre ord en betjeningsvejledning er et dokument designet til at yde hjælp til at bruge et bestemt system til sine brugere. For at kompilere en brugervejledning skal du kende det beskrevne system hundrede procent, men se på det gennem en uvidende studerendes øjne. Antag, at en brugervejledning er skrevet til et softwareprogram, der endnu ikke har nogen analoger. Forestil dig, at det er første gang du bruger dette program. Hvor starter du? Hvad er den første ting at vide? Organiser denne viden i kategorier af betydning.
Trin 2
Ved at opdele al information om din oprettelse i grupper har du lavet en plan for at skrive en brugervejledning. Begynd at beskrive arbejdet i dit program fra bunden, og lad de sidste være de sværeste detaljer, såsom omprogrammeringsfunktioner eller håndtering af kritiske fejl. På dette tidspunkt skal du have indholdet i brugervejledningen klar - en af de krævede dele af dette dokument.
Trin 3
Hvis manualen, du opretter, er beregnet til brug i et stort firma, skal du være opmærksom på de virksomhedsstandarder, der er vedtaget der. For eksempel accepteres brugervejledninger i mange russiske virksomheder ikke uden illustrativ support, med andre ord billeder, der forklarer, hvad der er skrevet. Ud over indholdet skal brugervejledningen indeholde andre obligatoriske dele: - Kommentar, det vil sige en forklaring på de generelle mål for manualen og det beskrevne produkt - en introduktion, der beskriver de dokumenter, der er relateret til brugervejledningen, og hvordan at bruge manualen - afsnit, der forklarer brugen af produktet på forskellige stadier af dets anvendelse, for eksempel første trin, reparation eller vedligeholdelse - afsnit med ofte stillede spørgsmål og svar på dem - ordliste eller emneindeks.
Trin 4
Normalt er en teknisk forfatter involveret i oprettelsen af en brugervejledning - en person, der har al den nødvendige viden både på sproget og i det produkt, der beskrives. Som teknisk forfatter uden uddannelse er der et par regler, man skal huske på. For det første må du ikke misbruge specielle vilkår, der ikke er forståelige for en almindelig bruger. For det andet skal hvert anvendt udtryk være detaljeret og forklaret. For det tredje skal du skrive så klart og kortfattet som muligt. Endelig skal en teknisk forfatter være i stand til at se på deres egen tekst gennem en almindelig brugers øjne for at se manglerne ved deres egen tekst.
Trin 5
Det er godt at teste den færdige tekst i brugervejledningen i praksis ved at tilbyde den til en person, der ikke havde noget at gøre med det beskrevne produkt. Ved fælles bestræbelser er det muligt at fjerne alle mangler og faldgruber i dokumentet.
