Introen definerer den manuelle . Forklar hvem som skal lese dokumentet , og hvem er det ikke ment for , hva slags informasjon er inkludert og under hvilke omstendigheter er det nyttig . For produkthåndbøker , forutsetter at leseren har kjøpt produktet , og er klar til å lære å bruke den. Hold innføringen kort slik at brukeren får til de tekniske aspektene av manualen så raskt som mulig.
Outlines
Tekniske håndbøker er ofte lagt ut i og underseksjoner , som også gjør en ideell disposisjon . List alle de planlagte seksjoner for den manuelle og inkludert detaljerte ledd der det er nødvendig . Ikke vær redd for å omorganisere seksjonene som du avanserer. Bare fordi du tenkt på emne Et første betyr ikke leseren trenger det litt informasjon først . Den endelige rekkefølgen på seksjonene bør gjenspeile den naturlige progresjon brukeren vil gjøre mens du lærer emnet. Bruk et substantiv og verb i avsnittet overskriften å definere elementet og handling innenfor seksjonen.
Være aktiv
Hvert trinn i en teknisk manual instruerer leseren i en enkelt handling som, når den utføres med andre trinn, fører til en fullstendig handling. Antall trinn eller har Graphic " kuler " for å indikere trinnene . I noen situasjoner kan trinnene være sub-trinn identifisert av tall eller bokstaver i henhold til de grunnleggende trinnene. Forfattere har noen skjønn i hvordan de identifiserer trinnene, men bør være konsekvent gjennom hele håndboken.
Keep It Simple
Bruk den enkleste språket som i tilstrekkelig grad formidler informasjon . Du vet ikke hvem som vil lese manualen og hvor godt de er bevandret i teknisk sjargong av emnet. Unngå høye nivåer av detaljer eller detaljer som ikke er nødvendig for å formidle informasjon . Lange setninger , mer enn 20 ord , har en tendens til å ta motet fra lesere. Setninger på mindre enn 10 ord kan gi dokumentet en hakking lyd.
Illustrer Topic
Bruk fotografier, diagrammer eller grafer for å illustrere temaet. Disse bildene kan være verdt tusen ord, og en tendens til å trekke leseren øye. Hvis grafiske bilder er ikke mulig , bruke beskrivende setninger . Verbale eksempler og illustrasjoner også gi leseren å visualisere temaet.