Slipping mellom permene av en teknisk dokument

December 9  by Eliza

Når du forbereder en lang bruksanvisningen, inkluderer alle informasjons leserne trenger og gjøre informasjonen lett å finne. Følgende er retningslinjer for hva som skal inkluderes.

Innholdsfortegnelsen

Når den manuelle er mer enn 15 sider, inkluderer en innholdsfortegnelse for å hjelpe leserne får vite det de trenger. Bruk ledere (.......) For å koble fagene til sidetall, slik at leserne kan kjøre sine øyne over hele siden.

Noen forfattere bruker interne kapittelnumre. For eksempel er kapittel 1 nummerert 1-1, 1-2, 1-3, 1-4; Kapittel 2 er nummerert 2-1, 2-2, 2-3, 2-4, og så videre. Dette er forskjellig fra fortløpende nummerering (1, 2, 3, 4). Bruk interne kapittelnumre når du forventer å oppdatere ett eller flere kapitler. Gjør du det holder deg fra omnummerering (og opptrykk) hele håndboken.

Ordliste

Hvis det er et hint om at leserne ikke kan forstå all terminologien i manualen, har en ordliste på slutten. Definere et ord første gang du bruker det er ikke alltid tilstrekkelig fordi leserne ikke vil lese din bruksanvisning fra perm til perm som om det er den store amerikanske romanen. De vil bruke den som referanse når de har et spørsmål.

Hvis du skriver elektronisk hjelp, bruke pop-up vinduer for vilkår. Hvis du skriver web-dokumenter, opprette en kobling til ordlisten.

Indeks

Ikke alle manualer trenger en indeks. Innholdet i manualen er gating faktor, ikke lengden. Sett deg selv i tankegangen til leseren og spør: Hvis jeg skulle lese dette dokumentet, vil en indeks være nyttig? Hvis du tror en indeks vil hjelpe deg, inkluderer en. Vær veldig følsom for de logiske søkeord at leseren kan se etter.

Her er en historie om en kvinne som kjøpte en ny bil. Hun kjørte ca 25 miles da hun kjørte over noe glass og fikk et punktert dekk. Kvinnen ønsket å endre dekk selv og trakk ut i brukerveiledningen. Hun sjekket under følgende bokstaver i indeksen:

  • f for flat
  • t for dekk
  • j for jack
  • c for endring

Kvinnen kunne ikke finne den informasjonen og kunne ikke tro at den manuelle neglisjert en så viktig oppføring. Hun til slutt ga opp og ringte American Automobile Association (AAA). Da hun kom hjem, begynte hun å sjekke hver stikkordet. Ja, det var en oppføring for å endre et flatt dekk. Det var under h for "Hvordan endre..."

Når du skriver for web, inkluderer et nettsted kart eller noe tilsvarende.

Feilsøking

Uansett hvor godt du skriver en teknisk manual, vil leserne ha problemer. Måten å løse disse problemene er å inkludere et avsnitt om feilsøking. Tabell 1 er en stor feilsøkingsdelen fra Kodak DC215 digitalt kamera med zoom Brukerhåndbok. Det bryter ut problemet, årsaken, og løsning.

Tabell 1: Feilsøking en Kodak DC215 digitalt kamera med zoom


Problem


Årsak


Oppløsning


Bildet er for lyst.


Flash er ikke nødvendig.


Bytt til automatisk blits. Se side 13.


Temaet var for nær da blitsen ble brukt.


Flytt deg slik at det er minst 1,6 m (0,5 m) mellom kameraet og motivet.


Lyssensoren er dekket.


Hold kameraet slik at hendene eller andre gjenstander ikke dekker lyssensoren.


Den Eksponeringskompensasjon er feil innstilt.


Reduser eksponeringskompensasjon. Se side 14.


Lagrede bilder er skadet.


Kameraets minnekort ble fjernet når Klar-lampen blinket.


Kontroller at Klar-lampen ikke blinker før du tar ut kortet.


Bilder som gjenstår, reduseres ikke etter å ha tatt et bilde.


Oppløsning og kvalitet innstillinger tar ikke opp nok plass til å redusere antall gjenværende bilder.


Kameraet fungerer normalt. Fortsette å ta bilder.


Bildet er ikke klart.


Objektivet er skittent.


Rengjøre linsen. Se side 65.


Objektet var for nært når bildet ble tatt.


Stå minst 1,6 m (0,5 m) i vidvinkel, 3,3 fot (1m) i tele.


Objektet eller kameraet beveget seg da bildet ble tatt.


Hold kameraet stødig til bildet er tatt.


Motivet er for langt unna til at blitsen kan være effektive.


Flytt deg slik at motivet er mindre enn 10 fot (.3m) unna.

Når du inkludere et avsnitt om feilsøking - eller ofte stilte spørsmål (FAQ) i et elektronisk dokument - du spare folk på hjelpesentralen blomkål øret. Her er hvordan du skal tenke gjennom hva som skal inkluderes i feilsøkingsdelen:

  • Hvis dette er den første utgaven av håndboken, tenk på de spørsmål eller problemer leserne måtte ha. Sørg for å inkludere spørsmål som testere hadde i løpet av alfa og beta testing.
  • Hvis dette er en andre eller tredje utgave, spør folk på helpdesk for de mest vanlige spørsmål.

Tilbakemeldingsskjema

For å forbedre kvaliteten på din bruksanvisning for neste utskrift og for å forbedre kvaliteten på din egen skriving, inkluderer et tilbakemeldingsskjema. Denne formen gir leserne en mulighet til å fortelle deg hva de likte og ikke likte om manualen og for å fortelle deg om eventuelle feil de fant.

Ikke bli forstyrret hvis du får i hovedsak negative tilbakemeldinger. Lesere som er fornøyd med den manuelle vanligvis ikke gidder å svare. Lesere som ikke er fornøyd vil fortelle deg. Ta denne tilbakemeldingen som konstruktiv og bruke det som en mulighet til å forbedre skriveteknikk. Ikke ta det personlig.