Pisanje priručnika može izgledati kao težak zadatak, ali lakše je nego što mislite! Ovi se koraci primjenjuju na bilo koju pisanu uputu, od vrlo jednostavnih (Kako pljeskati) do izuzetno kompliciranih (Kako izgraditi poluvodič.)
Koraci
1. dio od 4: Upoznajte temu
Korak 1. Ovo je ključno
Možda djeluje samo po sebi razumljivo, ali znanje je ključ za pisanje uspješnog priručnika. Na primjer, ako pišete priručnik za kameru, znajući da f-stop i brzina zatvarača nisu samo dvije zasebne funkcije-one jesu-ali će vam znati kako međusobno djeluju biti mnogo lakše opisati svaku funkcionira u odnosu na cjelinu.
Korak 2. Razgovarajte sa stručnjacima
Ako je vaša uloga samo pisac, a ne stručnjak za teme, uključite obrazovane ljude u cijeli proces i pobrinite se da pregledaju vaš rad. Njihovo znanje i savjeti neprocjenjivi su.
Korak 3. Isprobajte praktičan pristup
Ako je moguće, ako radite ono o čemu pišete, u najmanju ruku ćete osjetiti šta će korisnik htjeti naučiti.
Korak 4. Pročitajte temu
Naučite govoriti razgovor i postanite upoznati s proizvodom o kojem pišete.
-
Priručnici o sličnim proizvodima pokazat će vam kako su se drugi pisci pozabavili tom temom.
- Potražite sličnosti među piscima, što ukazuje i na zajedničku funkcionalnost i na zajedničke pristupe opisivanju nečega.
- Potražite razlike koje se ističu. To će vjerojatno biti funkcije koje su jedinstvene za dati proizvod. Vaš proizvod može, ali i ne mora uključivati te funkcije, ili može imati alternativne načine rješavanja problema koji možete opisati, povećavajući vrijednost vašeg proizvoda. Iako vaš posao možda piše upute, pokazivanje kupcima vrijednosti njihove kupnje odličan je način da ih potaknete da nastave čitati.
- Proždirete trgovačke časopise. Saznajte kako ljudi koji koriste proizvode svakodnevno rade s njima. Možda bi voljeli da postoji funkcija koja je riješila njihov određeni problem, a ako je vaš proizvod rješenje, to treba istaknuti.
Dio 2 od 4: Planirajte svoj ručni izgled
Korak 1. Podijelite ga
Bilo da jednostavan upute korak po korak, ili priručnik za 35-milimetarski digitalni fotoaparat, njegovo razlaganje na probavljive komade ima nekoliko prednosti:
Omogućuje vam da se usredotočite na pojedine dijelove cjeline. Vaš cilj je upoznati korisnika s načinom učenja procesa. Način izvođenja funkcije može se ostaviti vodiču na kraju, ako to želi, ili ostaviti korisniku da sam otkrije
Korak 2. Slijedite logički slijed
Ne bi bilo dobro, na primjer, opisati kako blic radi na kameri dok ne pokažete kako pričvrstiti objektiv, umetnuti film, uključiti kameru i podesiti fokus. Ovo je posebno korisno ako ne poznajete dobro temu.
Korak 3. Koristite ovo kao predložak za sadržaj
Korak 4. Pregledajte svoje korake
Nakon što definirate logičke sekcije, pregledajte ih kako biste bili sigurni da je sve pokriveno.
Korak 5. Prikupite zalihe
Imajte pri ruci predmete koje opisujete i spremni za upotrebu kako je opisano u priručniku. Ako pravite kutiju od papira, neka vam pri ruci budu papir, škare, traka, ljepilo i ravnalo. Ako pišete o kameri, provjerite je li kamera rastavljena. Ako je moguće, proizvod o kojem pišete trebao bi se vratiti u kutiju u ovom trenutku.
3. dio od 4: Počnite pisati
Korak 1. Napišite uvod
Ovo će postaviti ton cijelom priručniku i dati korisniku ideju o tome kakav priručnik će probaviti. Hoće li biti lagano i zabavno, ili jednostavno i bez besmislica? Zavisi od vaše čitalačke publike. Postoji mnogo više prostora za verbalnu igru koja uči djecu da izrađuju kutiju od papira nego za učenje doktora kako nastaviti s operacijom na otvorenom srcu. Rano uspostavite ton i zadržite ga tokom čitavog priručnika.
Korak 2. Izvršite svaki korak dok pišete
Ovo ne samo da vašem pisanju daje dojam iskrenosti i autentičnosti, već također osiguravate da ništa neće biti izostavljeno.
Ako iz nekog razloga nije moguće izvesti korake, dobro ih razmislite i posavjetujte se s nekim stručnjakom
Korak 3. Označite korake brojevima
Ovo olakšava ljudima da prate i da se vrate ako izgube mjesto.
Ako pišete na papiru, ostavite prostor za dodavanje između svakog koraka. Ne zaboravite ponovno numerirati svoje korake ako dodate još
Korak 4. Uključite savjete i upozorenja
Dok pišete, možda ćete shvatiti da ako korisnik neoprezno izvede korak, to bi moglo uzrokovati problem.
Nasuprot tome, ako postoji malo znanja koje će učiniti korisnički zadatak lakšim ili zanimljivijim, dodajte ga
Korak 5. Testirajte ga
Koristeći samo svoja pisana uputstva, radite ono o čemu pišete. Ako pronađete mjesta na kojima nedostaju vaša uputstva, dodajte potrebne podatke. Ponavljajte ovaj korak dok ne dovršite sve korake i ne možete raditi ono što podučavate bez dodavanja bilješki.
Razmislite o tome da imate prijatelja ili dvoje koji će koristiti priručnik. Pažljivo ih promatrajte kada nauče kako koristiti proizvod. Pogledajte gdje prolaze kroz njega. Pogledajte gdje se gube, zbunjuju ili neuspješno obavljaju zadatak. Slušajte šta imaju za reći, a zatim prilagodite svoj priručnik u skladu s tim
Korak 6. Lektorirajte svoj priručnik
Ne želite svom konačnom lektoru (bilo da je riječ o vašoj agenciji ili vašem supružniku) poslati priručnik s očiglednim greškama.
4. dio 4: Formatiranje
Korak 1. Počnite na najvišem nivou
Nakon što detaljno opišete sve potrebne korake, prođite kroz priručnik da biste pronašli očigledne glave kategorije.
Naslovite ih i zabilježite njihovu lokaciju
Korak 2. Napišite sadržaj ako je primjenjivo
Kao primjer pogledajte način na koji je wikiHow postavljen. Glavna stranica nudi mnogo poglavlja. Kada pristupite odjeljku, on navodi mnoge potkategorije, a potkategorije članke. Što je vaš priručnik detaljniji, bit će vam potrebno više kategorija i potkategorija. (Kako zviždati ne treba ništa, Kako iskviždati potrebno je nekoliko, a Kako svirati flautu potrebno je mnogo!)
Korak 3. Ponovo lektorirajte
Da, već ste to jednom temeljito uradili. Ako to učinite drugi put, nesumnjivo ćete uhvatiti još nekoliko manjih grešaka ili mjesta na kojima vaš priručnik jednostavno nije jasan.
Za opsežniji priručnik možete iskoristiti ovu priliku da zabilježite sve male teme i upotrijebite te podatke za kreiranje indeksa
Korak 4. Odaberite naslov
Savjeti
- Čak i ako vam se nešto čini očiglednim, napišite korake! Pomoći će vam da izbjegnete zamagljivanje nečega što vaš korisnik ne zna. Bolje je unijeti dodatne informacije nego izostaviti važne korake.
- Ako pišete vrlo detaljan priručnik koji zahtijeva poglavlja, kao što je Kako svirati flautu, vaš prvi korak mogao bi zapravo biti popis svih poglavlja, poput Odabira flaute, Sklapanje i njega, Proizvodnja tonova, Metode prstiju, Prvi komad itd. Zatim biste primijenili osnovna pravila za pisanje priručnika za svako poglavlje jer je svako poglavlje kao zaseban priručnik za sebe!
- Kad god je to moguće, ilustrirajte svoja uputstva! Ako ne možete umetnuti slike, uputite učenika na primjer uobičajenog. Na primjer, u Formatiranje, korak 2 ovih uputstava, izgled wikiHow izgleda koristi se za ilustraciju načina na koji bi se mogao stvoriti Sadržaj.
- Pisanje svakog odjeljka na zasebnoj stranici (ili na računaru) olakšat će uređivanje. Možete lakše preurediti ako imate prostora za rad i možete pronaći oznake za uređivanje. Na računaru ostavite 3 ili 4 linije (pritiskom na enter nekoliko puta) između svakog koraka, tako da možete lako pronaći pauze.
- Ako možete, neka novajlija uradi test vašeg priručnika i zapiše svako pitanje koje vam postave! To će vam pomoći da popunite prazna polja i učinite vaš priručnik mnogo korisnijim.