Introt definierar manualen. Förklara vem som ska läsa dokumentet och vem är det inte avsett för , vilka uppgifter som finns och under vilka omständigheter är det bra . För produktmanualer , antar att läsaren har köpt produkten och är redo att lära sig använda den. Håll introduktionen kort så att användaren kommer till de tekniska aspekterna av handboken så snabbt som möjligt .
Konturerna
Tekniska handböcker ofta läggs ut i avsnitt och underavsnitt , vilket också göra en perfekt kontur . Lista alla planerade avsnitt för den manuella och ingår detaljerade underavdelningar vid behov . Var inte rädd för att arrangera om delar som du framsteg . Bara för att du tänkt på ämnet Ett första betyder inte läsaren behöver den biten av information först . Den slutliga ordningen på avsnitten bör återspegla det naturliga förloppet användaren kommer att göra samtidigt lära ämnet . Använd ett substantiv och verb i kapitelingressen definiera objektet och åtgärder inom sektionen . Addera Var aktiv
Varje steg i en teknisk manual instruerar läsare i en enda åtgärd som , när de utförs med andra steg, leder till en fullständig handling. Nummer stegen eller ha en grafisk " kulor" för att indikera stegen . I vissa situationer kan stegen vara delsteg som identifieras med siffror eller bokstäver i enlighet med de grundläggande stegen . Författare har en viss frihet i hur de identifierar åtgärder , men bör vara konsekvent genom hela manualen .
Håll det enkelt
Använd den enklaste språk som på ett adekvat förmedlar informationen . Du vet inte vem som kommer att läsa manualen och hur väl de bevandrade i teknisk jargong i ämnet . Undvik höga detaljnivåer eller detaljer inte nödvändigt att förmedla informationen . Långa meningar , mer än 20 ord , tenderar att avskräcka läsare. Meningar på mindre än 10 ord kan ge dokumentet ett hackljud.
Illustrera Topic
Använd fotografier, tabeller eller diagram för att illustrera ämnet . Dessa bilder kan vara värt mer än tusen ord och tenderar att rikta läsarens öga. Om grafiska bilder är inte möjligt , använda beskrivande meningar . Muntliga exempel och illustrationer gör det också möjligt för läsaren att visualisera ämnet . Addera