Kuidas käsiraamatut kirjutada

Autor: Eugene Taylor
Loomise Kuupäev: 12 August 2021
Värskenduse Kuupäev: 12 Mai 2024
Anonim
Kuidas käsiraamatut kirjutada - Vihjeid
Kuidas käsiraamatut kirjutada - Vihjeid

Sisu

Kasutusjuhendi kirjutamine võib tunduda keeruline ülesanne, kuid see on lihtsam kui arvate! Need sammud kehtivad iga kirjaliku juhendi kohta alates kõige lihtsamast (kuidas plaksutada õpetada) kuni kõige keerukamateni (kuidas ehitada pooljuht).

Sammud

1. ja 4. meetod: tundke subjekti

  1. See on võti. See võib tunduda üsna ilmne, kuid eduka käsiraamatu kirjutamise võti on teadmised. Näiteks kui kirjutate kaamera kasutusjuhendit, on teadmine, et avatus ja säriaeg pole lihtsalt kaks eraldiseisvat funktsiooni - ehkki nad on ka -, kuid teadmine, kuidas nad üksteisega suhtlevad, muudab kirjeldamise palju lihtsamaks iga funktsioon ja kuidas see on seotud tervikuga.

  2. Rääkige asjatundjatega. Kui teie roll on lihtsalt kirjutada ja mitte olla asjatundja, kaasake protsessi inimesed, kes teavad, mida kirjutate, ja veenduge, et nad vaataksid teie töö üle. Selles valdkonnas on hindamatud teadmised ja nõuanded.

  3. Proovige praktilist lähenemist. Võimalusel annab see, millest kirjutate, vähemalt ettekujutuse sellest, mida kasutaja soovib õppida.
  4. Loe sellest. Õppige rääkima ja saate tuttavaks tootega, millest kirjutate.
    • Kasutusjuhendid või muud sarnased tooted näitavad teile, kuidas teised kirjanikud lähenesid teemale.
      • Otsige sarnasusi kirjanike vahel, mis näitab nii ühist funktsionaalsust kui ka ühist lähenemisviisi millegi kirjeldamiseks.
      • Otsige erinevusi, mis silma paistavad. Need on antud toote puhul tõenäoliselt ainulaadsed funktsioonid. Teie toode võib nende funktsioonide hulka kuuluda või mitte, või võib neil olla alternatiivseid võimalusi teie kirjutatava probleemi lahendamiseks, suurendades toote väärtust. Kuigi ülesandeks on kirjutada artikkel, kuidas midagi teha, on klientidele teie ostu väärtuse näitamine suurepärane viis julgustada neid lugemist jätkama.
    • Süüa tooteajakirjad. Siit saate teada, kuidas tooteid kasutavad inimesed igapäevaselt nendega töötavad. Nad võivad soovida, et neil oleks funktsioon, mis lahendab konkreetse probleemi ja kui lahendus on teie toode, tuleb see esile tõsta.

2. ja 4. meetod: kavandage oma käsiraamatu kujundus


  1. Eraldi asjad. Ükskõik, kas see on lihtne samm-sammult leht või 35-mm digitaalkaamera kasutusjuhend, on tekstide jagamisel väikesteks tükkideks mitu eelist:
    • See võimaldab teil keskenduda terviku üksikutele osadele. Selle eesmärk on tutvustada kasutajale toote käsitsemise õppimisprotsessi. Toote funktsionaalsuse õpetamine tuleks soovi korral jätta juhendi lõpus olevasse õpetusesse või lasta kasutajal endal teada saada.
  2. Järgige loogilist jada. See ei aita näiteks kirjeldada kaamera välklampi, kuni olete näidanud, kuidas objektiivi kinnitada, filmi laadida, kaamerat sisse lülitada ja fookust reguleerida. See on väga kasulik, kui te pole teemaga tuttav.
  3. Kasutage seda oma indeksi mudelina.
  4. Vaadake oma sammud üle. Kui olete loogilised jaotised määratlenud, vaadake need üle ja veenduge, et kataksite kõik.
  5. Ta kogus oma varusid. Laske kirjeldatavad esemed valmis olla ja laske need kasutamisvalmis vastavalt juhendis kirjeldatule. Paberikasti loomisel on käes paber, käärid, lint, liim ja joonlaud. Kui kirjutate kaameraga, veenduge, et kaamera on lahti võetud. Kui võimalik, peaks teie kirjeldatud toode olema praeguseks kasti jõudnud.

3. meetod 4-st: alustage kirjutamist

  1. Kirjutage sissejuhatus. See seab kogu teie juhendi tooni ja annab kasutajale ettekujutuse, millist juhendit ta kavatseb lugeda. Kas see on kerge ja lõbus või on see otsene ja mõttetu? See sõltub teie trükist. Lastele paberikasti loomise õpetamisel on sõnadega mängimiseks palju rohkem ruumi kui siis, kui üritatakse arstile õpetada, mida teha avatud rindkere operatsiooni korral. Valige heli varakult ja hoidke seda kogu oma teksti ulatuses.
  2. Tehke iga samm tippimise ajal. See mitte ainult ei anna teie kirjatööle aususe ja autentsuse õhku, vaid tagab ka selle, et te pole midagi unustanud.
    • Kui mingil põhjusel pole samme võimalik järgida, mõelge neile täielikult ja pöörduge eksperdi poole.
  3. Nummerdage sammud. See hõlbustab inimestel jälgedes liikumist ja võib hiljem naasta, kui nad lõpuks eksivad.
    • Kui kirjutate paberil, jätke iga sammu vahele lisamiseks kindlasti ruumi. Ärge unustage samme ümber nummerdada, kui lisasite nende vahele veel ühe sammu.
  4. Lisage näpunäiteid ja hoiatusi. Kirjutades võite avastada, et kui kasutaja järgib ettevaatlikult ühte neist toimingutest, võib see põhjustada probleemi.
    • Teisest küljest, kui on veel muid teadmisi, mis muudavad kasutaja ülesande lihtsamaks või huvitavamaks, lisage need teadmised.
  5. Test. Tehke seda, mis olete kirjutanud, kasutades ainult oma kirjalikke juhiseid. Kui leiate kohti, kus juhised on puudulikud, lisage vajalik teave. Korrake seda sammu, kuni teil on kõik toimingud ja saate teha seda, mida õpetate, märkmeid tegemata.
    • Kaaluge ühe või kahe sõbra palumist kasutusjuhendit lugeda. Vaadake tähelepanelikult, kui nad õpivad toodet kasutama. Vaadake, kas nad saavad käsiraamatu täita. Ülesande täitmisel näete, kus nad eksivad, on segaduses või ebaõnnestuvad. Kuulake, mida neil öelda on, ja tehke siis kommentaaride järgi muudatusi.
  6. Vaadake oma kasutusjuhend üle. Te ei soovi oma lõplikule ülevaatajale (olgu see agentuur või teie naine) saata juhendit, mis on täis silmatorkavaid vigu.

4. meetod 4-st: vormindamine

  1. Alustage tipptasemel. Kui olete kõik sammud üksikasjalikult tutvunud, vaadake oma käsiraamatut ja otsige kategooria pealkirju.
    • Pange neile pealkiri ja pange kirja nende asukohad.
  2. Kui vaja, kirjutage register. Vaadake, kuidas näiteks wikiHow on paigutatud. Pealeht pakub külastajale jaotiste päiseid. Jaotisele sisenemisel leiate alamkategooriate loendi ja seejärel kategooriate artiklite loendi. Mida üksikasjalikum on teie käsiraamat, seda rohkem kategooriaid ja alamkategooriaid te vajate. Näiteks ei vaja lihtsad artiklid, näiteks kuidas vilet, alamkategooriaid, samas kui selline tekst nagu "Kuidas vilet moodustada", vajaks seda.
  3. Vaadake uuesti üle. Jah, olete kogu materjali juba korra üle vaadanud. Uuesti tehes leiate kindlasti käsiraamatust väikseid vigu või kohti, mis pole veel nii selged.
    • Põhjalikuma käsiraamatu saamiseks võite seda võimalust kasutada ka kõigi väiksemate teemade üleskirjutamiseks ja kasutada seda teavet indeksi loomiseks.
  4. Valige pealkiri.

Näpunäited

  • Kui kirjutate väga üksikasjalikku juhendit, mis nõuab peatükke, näiteks juhendit, kuidas õpetada flööti, peate esmalt loetlema kõik peatükid, näiteks Flöödi valimine, montaaž ja hooldus, heli tootmine, mängimisviisid, teie esimene flööt, jne. Alles siis peaksite rakendama iga peatüki jaoks juhendi kirjutamise põhireegleid, sest igaüks neist on nagu eraldi juhend!
  • Isegi kui miski tundub teile ilmne, kirjutage sammud üles! See aitab teil mitte unustada midagi, mida kasutaja ei tea. Parem on saada lisateavet kui oluliste toimingute vahelejätmine.
  • Kui vähegi võimalik, illustreerige juhiseid! Kui te ei saa pilte sisestada, siis andke oma õpilasele näide. Näiteks sisse Vormindamine, 2. samm Selles artiklis kasutatakse indeksi loomise illustreerimiseks WikiHow-paigutuse välimust.
  • Võimalusel paluge kellelgi, kellel pole vastava ala kogemusi, teie juhend läbi lugeda ja kõik küsimused üles kirjutada! See aitab teil lüngad täita ja muudab teie käsiraamatu palju kasulikumaks.
  • Iga jaotise kirjutamine eraldi lehel (või arvutis) muudab redigeerimise hõlpsamaks. Kui teil on ruumi tööks ja saate oma redigeerimismärke leida, saate hõlpsalt ümber korraldada. Jätke arvutis 3 kuni 4 rida (vajutades Sisenema mitu korda) iga sammu vahel, et pausid leida.

Fontide lisamine Photoshopi

Robert White

Mai 2024

Adobe Photo hop on ük kuul amaid piltidega manipuleerimi e tarkvara maailma , mida ka utavad nii harra tajad kui ka profe ionaalid. Tek ti li amine piltidele ja fotodele on programmi väga po...

Kuidas linke Excelis lisada

Robert White

Mai 2024

Micro oft Excel on arvutu tabeli haldami e programm, mi võimaldab ka utajal korraldada, hooldada ja analüü ida erinevat tüüpi andmeid. ama e faili aate li ada linke veebi aiti...

Väljaanded