Wkono

Hvordan skrive en manual fra scratch

Utarbeide en håndbok i en viktig funksjon i arbeid kan vise dine evner til dine overordnede. Det viser din evne til å fullføre et prosjekt på egen hånd.

Trinn

Hvordan skrive en manual fra scratch. Bestem deg for motivet.
Hvordan skrive en manual fra scratch. Bestem deg for motivet.
  1. 1
    Bestem deg for motivet. Vær konkret i omfang og rekkevidde.
  2. 2
    Bestem hva målgruppen du skriver for.
    • Skriver du en manual for nybegynnere eller eksperter (eller et sted i mellom)?
    • Er publikum kommer til å bli involvert med en klasse (ved hjelp av manuell) eller selvstudium?
  3. 3
    Definere nøyaktig hva du skal snakke om i manualen.
    • Eksempel: Du skriver en manuell "Slik installerer Doors". En del kan dreie seg om skyvedører. En annen inndeling kan være om fordørene. Fremdeles en annen del kan dreie seg om bakdører.
  4. 4
    Bestem deg på en logisk rekkefølge for å presentere manualen. Dette handler ikke om en logisk rekkefølge av handlinger. Noen fag må kanskje bli presentert først. Oppgaver som skal inkluderes i alle deler av manualen bør nok diskuteres først. Hvis du føler at leseren skal allerede ha kompetanse til å fullføre oppgaven, og deretter vurdere beskriver oppgaven i et vedlegg.
  5. 5
    Hvis den manuelle kommer til å bruke teknisk terminologi eller sjargong, utarbeide en ordliste. Dersom det er usannsynlig at leseren allerede vet sjargong, plasserer ordliste umiddelbart etter innholdsfortegnelsen. Oppdatere ordliste som du skriver den manuelle.
    • Definisjoner av begreper i ordlisten trenger å være så presis som mulig. Hvis begrepet er et akronym, som "Scuba", deretter fullt ut forklare at det betyr "selvforsynte Underwater Breathing Apparatus" i definisjonen.
  6. 6
    Bestemme hvilke fag du trenger til videre forskning. En unøyaktig manual er en ubrukelig manual. Fullfør foreløpige undersøkelser før du starter den manuelle.
  7. 7
    Bestem deg for en organisasjon for hver del du skal skrive.
    • Eksempel: Du skriver en håndbok om slik og slik datamaskin. Du har en seksjon kalt "Feilsøking". Du kan skrive en del av det om disk plassproblemer. Du kan skrive en annen om overdreven bruk av minne.
  8. 8
    Organiser hver seksjon og ledd i en logisk rekkefølge, innsnevring omfanget av emnet.
  9. 9
    Begynner å skrive! Bruk din organisasjon som en guide, men endre det hvis det ikke fungerer.
    1. Skriv beskrivelser av ulike oppgaver.
    2. Skriv eksempler som leseren kan følge for å få instruksjon.
    3. Forberede aktuelle illustrasjoner. Ikke legg dem før manualen er fullført. Illustrasjonene må være montert på teksten.
    • Endre illustrasjoner for å gi tips for å indikere hva brukeren er ute etter.
      1. Eksempel 1: (Ser på en nummerert liste) En forfatter ville koble et problem med tallet 13.
      2. Eksempel 2: (Sortering Out) En forfatter ville forstørre en tekstlinje som var ute av drift.
    • 10
      Ikke plagiere andres skriving! Ha en referanse og / eller et sitat seksjon oppføringen bøker, manualer og folk som ga deg den informasjonen.
      • Ingenting ødelegger en forfatter troverdighet raskere enn plagiat. En dag, kan noen være siterer skrivingen. Hvordan ville du føle om noen "stjeler" ditt arbeid?
    • 11
      Legge til passende illustrasjoner. Passe dem inn i dokumentet. Ikke vær redd for å bruke mellomrommet.
    • 12
      Korrekturlese, korrekturlese og korrekturlese igjen. Korrekturlesing bør være pågående. Gjør notater av feil eller mangler. Korrigere dem. Gjør notater av passasjene andre finner forvirrende. Omskrive passasje for å gjøre det lettere å lese. Har en rekke personer lese manualen for å sikre et best mulig resultat.
        • Dette er den rekkefølgen jeg anbefaler at du har en fullført manuell korrekturlese:
          1. Proof arbeidet ditt,. Selv
          2. Har en venn korrekturlese den.
          3. Har en ekspert (i feltet du skriver om) korrekturlese den.
          4. (Hvis den manuelle er for din bedrift), har sjefen din korrekturlese den.
          5. Ha en nybegynner korrekturlese den.
          • Hvorfor korrekturlese en nybegynner har det? Manualen skal være forståelig for den minste kunnskap nivået du forventer å lese den.

          Tips

          • Sørge for at tittelen side og bunntekst på hver side navnet du som forfatter! Skriv ut kopier av manualen før du sender inn elektronisk. Har korrekturlesere gjøre notater på sidene. Inkludere en "c" omgitt av parentes i bunnteksten. De fleste programmer vil tolke at merking for opphavsrett og plassere det riktige symbolet. Bunnteksten bør lese (c) ved navn Din. Det vil ikke stoppe selskapet fra å kopiere det, men det vil garantere ditt krav til forfatterskap.