Kasutusjuhendi kirjutamine võib tunduda hirmuäratava ülesandena, kuid see on lihtsam, kui arvate! Need sammud kehtivad iga kirjaliku juhise kohta, alates väga lihtsast (kuidas plaksutada) kuni väga keeruliseni (Kuidas ehitada pooljuhti.)
1
See on võtmetähtsusega. See võib tunduda iseenesestmõistetav, kuid teadmised on eduka käsiraamatu kirjutamise võti. Näiteks kui kirjutate kaamera käsiraamatut, siis teades, et f-stop ja säriaega ei ole ainult kaks eraldi funktsiooni, vaid teadmine, kuidas need omavahel suhtlevad, teeb iga funktsiooni kirjeldamise palju lihtsamaks. tervikule.
2
Rääkige ekspertidega. Kui teie roll on lihtsalt kirjanik, mitte asjatundja, kaasake asjatundlikud inimesed kogu protsessi ja veenduge, et nad teie tööd üle vaataksid. Nende teadmised ja nõuanded on hindamatud.
3
Proovige praktilist lähenemist. Võimaluse korral annab selle asja tegemine, millest kirjutate, vähemalt aimu, mida kasutaja soovib õppida.
4
Lugege teemal läbi. Õppige juttu rääkima ja tutvuge tootega, millest kirjutate.Sarnaste toodete juhendid näitavad teile, kuidas teised kirjanikud on selle teemaga tegelenud. Otsige kirjanike vahel sarnasusi, mis näitavad nii ühiseid funktsioone kui ka ühiseid lähenemisviise millegi kirjeldamisel .Otsige erinevusi, mis silma paistavad. Tõenäoliselt on need funktsioonid, mis on konkreetse toote jaoks ainulaadsed. Teie toode võib või ei pruugi sisaldada neid funktsioone või võib probleemi lahendamiseks olla alternatiivseid viise, mida saate kirjeldada, suurendades teie toote väärtust. Kuigi teie töö võib olla juhiste kirjutamine, on klientidele nende ostu väärtuse näitamine suurepärane viis julgustada neid lugemist jätkama. Õgige kaubandusajakirju. Uurige, kuidas tooteid kasutavad inimesed nendega igapäevaselt töötavad. Nad võivad soovida, et oleks funktsioon, mis lahendaks nende konkreetse probleemi, ja kui teie toode on lahendus, tuleb see esile tõsta.
5
Murra see maha. Olenemata sellest, kas tegemist on lihtsa samm-sammulise juhisega või 35 mm digikaamera juhendiga, on selle seeditavateks tükkideks jagamisel mitmeid eeliseid: see võimaldab teil keskenduda terviku üksikutele osadele. Teie eesmärk on tutvustada kasutajale, kuidas protsessi õppida. Funktsiooni teostamise võib soovi korral jätta õpetuseks lõppu või jätta kasutaja enda avastada.
6
Järgige loogilist järjestust. Näiteks ei oleks hea kirjeldada, kuidas kaamera välklamp töötab, kuni olete näidanud, kuidas objektiivi kinnitada, filmi laadida, kaamera sisse lülitada ja fookust reguleerida. See on eriti kasulik, kui te ei tunne teemat hästi.
7
Kasutage seda oma sisukorra mallina.
8
Vaadake oma sammud üle. Kui olete loogilised jaotised määratlenud, vaadake need üle, veendumaks, et kõik on kaetud.
9
Koguge oma varud kokku. Hoidke kirjeldatavad esemed käepärast ja kasutusvalmis, nagu juhendis kirjeldatud. Kui valmistate paberkarpi, võtke käepärast paber, käärid, teip, liim ja joonlaud. Kui kirjutate kaamerast, veenduge, et kaamera oleks lahti võetud. Võimalusel peaks toode, millest kirjutate, sel hetkel tagasi karbis olema.
10
Kirjuta sissejuhatus. See määrab kogu juhendi tooni ja annab kasutajale aimu, millist juhendit ta hakkab seedima. Kas see on kerge ja lõbus või otsekohene ja mõttetu? See sõltub teie lugejaskonnast. Verbaalsele mängule, mis õpetab lapsi paberkarpi valmistama, on palju rohkem ruumi kui arstile, kuidas avatud südameoperatsiooniga edasi minna. Määrake toon varakult ja hoidke seda tooni kogu juhendis.
11
Tehke iga samm kirjutamise ajal. See mitte ainult ei anna teie kirjutamisele aususe ja autentsuse õhkkonda, vaid ka tagate, et midagi ei jääks välja. Kui samme ei ole mingil põhjusel võimalik teha, mõelge need põhjalikult läbi ja konsulteerige mõne asjatundjaga. .
12
Nummerdage sammud. Nii on inimestel lihtsam teksti jälgida ja oma koha kaotamise korral neile tagasi pöörduda. Kui kirjutate paberile, jätke iga sammu vahele kindlasti ruumi lisamiseks. Ärge unustage oma samme ümber nummerdada, kui lisate rohkem.
13
Kaasake näpunäiteid ja hoiatusi. Kirjutades võite mõista, et kui kasutaja sooritab mõne sammu hooletult, võib see põhjustada probleeme. Kui aga on teadmisi, mis muudavad kasutaja ülesande lihtsamaks või huvitavamaks, lisage see.
14
Katsetage seda. Kasutage ainult oma kirjalikke juhiseid, tehke seda, millest kirjutate. Kui leiate kohti, kus teie juhised puuduvad, lisage vajalik teave. Korrake seda sammu, kuni teil on kõik toimingud tehtud ja saate teha seda, mida õpetate, ilma et peaksite märkmeid lisama. Kaaluge, kas sõber või kaks seda juhendit kasutavad. Jälgige neid tähelepanelikult, kui nad õpivad toodet kasutama. Vaadake, kust nad selle läbivad. Vaadake, kus nad eksivad, segadusse lähevad või ülesande täitmisel ebaõnnestuvad. Kuulake, mida nad ütlevad, ja seejärel kohandage oma kasutusjuhendit vastavalt.
15
Lugege oma käsiraamat läbi. Te ei soovi oma lõplikule korrektorile (olgu see siis teie agentuurile või abikaasale) saata räigeid vigu täis käsiraamatut.
16
Alustage tipptasemelt. Kui olete kõik vajalikud toimingud üksikasjalikult kirjeldanud, lugege läbi oma juhend, et leida ilmsed kategooriapead. Pealkirjastage need ja märkige üles nende asukohad.
17
Vajadusel kirjutage sisukord. Vaata näiteks Selgitatud küljendamist. Avaleht pakub palju jaotiste päid. Kui avate jaotise, loetleb see palju alamkategooriaid ja alamkategooriad loetlevad artiklid. Mida üksikasjalikum on teie käsiraamat, seda rohkem kategooriaid ja alamkategooriaid vajate. (How to Whistle ei vaja ühtegi, How to Carve a Whistle vajab mõnda ja How to Play flööti vajab palju!)
18
Korrektuur uuesti läbi. Jah, sa tegid seda juba korra põhjalikult. Kui teete seda teist korda, avastate kahtlemata veel mõned väiksemad vead või kohad, kus teie juhend pole lihtsalt selge. Põhjalikuma juhendi saamiseks võite kasutada ka võimalust, et märkida üles kõik väikesed teemad ja kasutada seda teavet juhendi loomiseks. indeks.
19
Valige pealkiri.