Oavsett hur genial en uppfinnare, programmerare eller rationaliserare kan vara, ibland kan hans skapelser helt enkelt inte användas för det avsedda syftet. Anledningen till detta är den felaktigt utarbetade bruksanvisningen eller dess fullständiga frånvaro. Men även geniala uppfinnare skriver ibland sådana instruktioner att, förutom smala specialister, kan ingen läsa dessa tidningar. Så hur skapar du ett sådant nödvändigt dokument ordentligt?
Det är nödvändigt
- - hundra procent kunskap om den enhet eller programvara som handboken skrivs för;
- - kunskap inom lingvistikområdet;
- - skrivkunskaper.
Instruktioner
Steg 1
En användarmanual eller, med andra ord, en bruksanvisning är ett dokument som är utformat för att hjälpa sina användare att använda ett visst system. För att sammanställa en användarmanual måste du känna till det beskrivna systemet hundra procent, men titta på det genom en okunnig student. Anta att en användarmanual är skriven för ett programverktyg som inte har några analoger ännu. Tänk dig att det här är första gången du använder detta program. Var börjar du? Vad är det första du ska veta? Organisera denna kunskap i viktiga kategorier.
Steg 2
Genom att dela upp all information om din skapelse i grupper har du upprättat en plan för att skriva en användarmanual. Börja beskriva arbetet i ditt program från grunden och lämna de svåraste detaljerna, till exempel omprogrammeringsfunktioner eller hantera kritiska fel. I detta skede bör du ha innehållet i användarhandboken redo - en av de nödvändiga delarna av detta dokument.
Steg 3
Om handboken du skapar är avsedd att användas i ett stort företag bör du vara uppmärksam på de företagsstandarder som antagits där. I många ryska företag accepteras till exempel användarhandböcker inte utan illustrativt stöd, med andra ord bilder som förklarar vad som skrivs. Utöver innehållet ska användarhandboken innehålla andra obligatoriska delar: - Kommentarer, det vill säga en förklaring av de allmänna målen för handboken och den beskrivna produkten. - En introduktion som beskriver dokumenten relaterade till användarmanualen och hur att använda handboken; - avsnitt som förklarar användningen av produkten i olika användningsfaser, till exempel första steg, reparation eller underhåll; - avsnitt med vanliga frågor och svar på dem; - ordlista eller ämnesindex.
Steg 4
Vanligtvis är en teknisk författare involverad i skapandet av en användarhandbok - en person som har all nödvändig kunskap både på språket och i den produkt som beskrivs. Som teknisk författare utan utbildning finns det några regler att tänka på. För det första får du inte missbruka specialvillkor som inte är förståliga för en vanlig användare. För det andra måste varje term som används detaljeras och förklaras. För det tredje måste du skriva så tydligt och koncist som möjligt. Slutligen måste en teknisk skribent kunna titta på sin egen text genom en vanlig användares ögon för att se bristerna i sin egen text.
Steg 5
Det är bra att testa den färdiga texten i användarmanualen i praktiken genom att erbjuda den till en person som inte hade något att göra med den beskrivna produkten. Genom gemensamma ansträngningar är det möjligt att eliminera alla brister och fallgropar i dokumentet.
