Hogyan kell kézikönyvet írni (képekkel)

Tartalomjegyzék:

Hogyan kell kézikönyvet írni (képekkel)
Hogyan kell kézikönyvet írni (képekkel)

Videó: Hogyan kell kézikönyvet írni (képekkel)

Videó: Hogyan kell kézikönyvet írni (képekkel)
Videó: MANUEL - BALENCIAGA | OFFICIAL VISUALIZER MUSIC VIDEO 2024, Március
Anonim

A használati utasítás megírása ijesztő feladatnak tűnhet, de könnyebb, mint gondolná! Ezek a lépések minden írásos utasításra vonatkoznak, az egészen egyszerűtől (Hogyan tapsoljon) a rendkívül bonyolultig (Hogyan építsünk félvezetőt).

Lépések

Rész 1 /4: Ismerje meg a témát

Kézikönyv írása 1. lépés
Kézikönyv írása 1. lépés

1. lépés. Ez a kulcs

Magától értetődőnek tűnhet, de a tudás a kulcsa a sikeres kézikönyv megírásának. Például, ha fényképezőgép kézikönyvet ír, annak tudatában, hogy az f-stop és a zársebesség nem csak két külön funkció-ezek-, hanem ha tudja, hogyan hatnak egymásra, sokkal könnyebb lesz leírni mindegyiket funkciója az egészre vonatkozik.

Kézikönyv írása 2. lépés
Kézikönyv írása 2. lépés

2. lépés. Beszéljen szakértőkkel

Ha az Ön szerepe egyszerűen az író, nem pedig a téma szakértője, vonjon be hozzáértő embereket a folyamat során, és győződjön meg arról, hogy áttekintik a munkáját. Tudásuk és tanácsaik felbecsülhetetlen értékűek.

Kézikönyv írása 3. lépés
Kézikönyv írása 3. lépés

Lépés 3. Próbáljon ki gyakorlati módszert

Ha lehetséges, ha azt teszi, amiről ír, akkor legalább érezni fogja, hogy a felhasználó mit akar tanulni.

Kézikönyv írása 4. lépés
Kézikönyv írása 4. lépés

4. lépés Olvassa el a témát

Tanuljon meg beszélni a beszédről, és ismerkedjen meg azzal a termékkel, amelyről ír.

  • A hasonló termékek kézikönyvei megmutatják, hogyan dolgoztak más írók a témával.

    • Keresse meg a hasonlóságokat az írók között, ami jelzi mind a közös funkcionalitást, mind a leírás közös megközelítéseit.
    • Keresse meg a kiemelkedő különbségeket. Ezek valószínűleg olyan funkciók, amelyek csak egy adott termékre jellemzőek. A termék tartalmazhatja ezeket a funkciókat, vagy nem, vagy alternatív megoldásokat kínálhat a probléma megoldására, amelyeket Ön leírhat, növelve a termék értékét. Bár az Ön feladata egy útmutatás írása, az ügyfelek vásárlásuk értékének bemutatása nagyszerű módja annak, hogy ösztönözze őket az olvasás folytatására.
  • Feldolgozza a szaklapokat. Tudja meg, hogy a termékeket használó emberek hogyan dolgoznak velük nap mint nap. Lehet, hogy azt kívánják, hogy legyen olyan funkció, amely megoldja az adott problémát, és ha az Ön terméke a megoldás, akkor ezt ki kell emelni.

2. rész a 4 -ből: Tervezze meg a kézi elrendezést

Kézikönyv írása 5. lépés
Kézikönyv írása 5. lépés

1. lépés. Bontsa szét

Akár egy egyszerű, lépésről lépésre szóló használati utasítás, akár egy 35 mm-es digitális fényképezőgép kézikönyve, emészthető darabokra bontása számos előnnyel jár:

Lehetővé teszi, hogy az egész egyes részeire összpontosítson. A cél az, hogy megismertesse a felhasználót a folyamat elsajátításával. A funkció végrehajtásának módját a végén hagyhatjuk egy oktatóanyagnak, ha szükséges, vagy hagyhatjuk, hogy a felhasználó saját maga fedezze fel

Kézikönyv írása 6. lépés
Kézikönyv írása 6. lépés

2. lépés Kövesse a logikai sorrendet

Nem lenne jó például leírni, hogyan működik a vaku a fényképezőgépen, amíg meg nem mutatta, hogyan kell rögzíteni az objektívet, betölteni a filmet, bekapcsolni a fényképezőgépet és beállítani a fókuszt. Ez különösen akkor hasznos, ha nem ismeri jól a témát.

Kézikönyv írása 7. lépés
Kézikönyv írása 7. lépés

3. Használja ezt sablonként a tartalomjegyzékhez

Kézikönyv írása 8. lépés
Kézikönyv írása 8. lépés

4. lépés Tekintse át lépéseit

Miután definiálta a logikai szakaszokat, tekintse át azokat, és győződjön meg arról, hogy minden le van fedve.

Kézikönyv írása 9. lépés
Kézikönyv írása 9. lépés

5. lépés Gyűjtse össze kellékeit

Tartsa kéznél a leírásban leírt elemeket, és készen áll a használatra, amint azt a kézikönyv leírja. Ha papírdobozt készít, legyen kéznél papír, olló, szalag, ragasztó és vonalzó. Ha fényképezőgépről ír, győződjön meg arról, hogy a fényképezőgépet szétszerelte. Ha lehetséges, a terméknek, amelyről írsz, vissza kell térnie a dobozba.

Rész 3 /4: Kezdje el az írást

Kézikönyv írása 10. lépés
Kézikönyv írása 10. lépés

1. lépés. Írja be a bevezetőt

Ez meghatározza a teljes kézikönyv hangvételét, és képet ad a felhasználónak arról, hogy milyen kézikönyvet fog megemészteni. Könnyű és szórakoztató lesz, vagy egyszerű és értelmetlen? Ez az olvasóközönségedtől függ. Sokkal több tere van a verbális játéknak, amely megtanítja a gyerekeket papírdoboz készítésére, mint az orvosnak a nyitott szívműtétet. Állítsa be a hangot korán, és tartsa meg ezt a hangot a kézikönyvben.

Kézikönyv írása 11. lépés
Kézikönyv írása 11. lépés

2. lépés Írás közben hajtsa végre az egyes lépéseket

Ez nemcsak az őszinteség és a hitelesség légkörét kelti írásában, hanem azt is biztosítja, hogy semmi ne maradjon ki.

Ha valamilyen oknál fogva nem lehetséges a lépések végrehajtása, alaposan gondolja át azokat, és konzultáljon valakivel, aki szakértő

Kézikönyv írása 12. lépés
Kézikönyv írása 12. lépés

3. lépés Számozza meg a lépéseket

Ez megkönnyíti az emberek számára a követést, és arra hivatkoznak, ha elveszítik a helyüket.

Ha papírra ír, minden lépés között hagyjon helyet a kiegészítésekhez. Ne felejtse el újraszámolni a lépéseit, ha többet ad hozzá

Kézikönyv írása 13. lépés
Kézikönyv írása 13. lépés

4. lépés. Tippeket és figyelmeztetéseket is mellékeljen

Írás közben rájöhet, hogy ha a felhasználó gondatlanul hajt végre egy lépést, az problémát okozhat.

Ezzel szemben, ha van némi tudás, amely megkönnyíti vagy érdekesebbé teszi a felhasználó feladatát, adja hozzá

Kézikönyv írása 14. lépés
Kézikönyv írása 14. lépés

5. lépés. Tesztelje

Csak írásbeli utasításait használva tegye azt, amiről ír. Ha olyan helyeket talál, ahol az utasítások hiányoznak, adja meg a szükséges információkat. Ismételje meg ezt a lépést, amíg meg nem teszi az összes lépést, és nem tudja jegyzetek hozzáadása nélkül megtenni azt, amit tanít.

Fontolja meg, hogy egy vagy két barátja használja a kézikönyvet. Figyelje őket alaposan, amikor megtanulják a termék használatát. Nézze meg, hol cippelnek át rajta. Nézze meg, hol vesznek el, zavarodnak össze vagy buknak el a feladatban. Hallgassa meg mondanivalójukat, majd ennek megfelelően módosítsa a kézikönyvet

Kézikönyv írása 15. lépés
Kézikönyv írása 15. lépés

6. lépés. Olvassa el újra a kézikönyvet

Nem szeretné elküldeni a végső lektorát (legyen az ügynöksége vagy a házastársa) egy kézikönyvet, amely tele van kirívó hibákkal.

4. rész a 4 -ből: Formázás

Kézikönyv írása 16. lépés
Kézikönyv írása 16. lépés

1. lépés: Kezdje a legfelső szintről

Miután minden szükséges lépést megtett, nézze át a kézikönyvet, hogy megtalálja a nyilvánvaló kategóriafejeket.

Adja meg a címet, és jegyezze fel a helyüket

Kézikönyv írása 17. lépés
Kézikönyv írása 17. lépés

2. lépés Ha szükséges, írjon tartalomjegyzéket

Nézze meg példaként a wikiHow módját. A főoldal számos szakaszfejet kínál. Amikor megnyit egy szakaszt, az számos alkategóriát, az alkategóriák pedig cikkeket sorol fel. Minél részletesebb a kézikönyv, annál több kategóriára és alkategóriára lesz szüksége. (Hogyan kell fütyülni semmire, hogyan kell sípot faragni néhányra, és hogyan kell furulyázni sokra!)

Kézikönyv írása 18. lépés
Kézikönyv írása 18. lépés

Lépés 3. Ismét lektorálás

Igen, egyszer már alaposan megcsináltad. Ha másodszor is elvégzi, kétségtelenül néhány kisebb hibát észlel, vagy olyan helyeket, ahol a kézikönyv nem egyértelmű.

Egy átfogóbb kézikönyvhez használhatja ezt az alkalmat, és megjegyezheti az összes apró témát, és felhasználhatja ezeket az információkat egy index létrehozásához

Kézikönyv írása 19. lépés
Kézikönyv írása 19. lépés

4. lépés. Válasszon egy címet

Tippek

  • Még akkor is, ha valami nyilvánvalónak tűnik számodra, írd le a lépéseket! Segítségével elkerülheti, hogy a felhasználó ne tudjon valamit, amit nem tud. Jobb, ha további információkat adunk meg, és nem hagyjuk ki a fontos lépéseket.
  • Ha nagyon részletes kézikönyvet ír, amely fejezeteket igényel, mint például a Fuvola lejátszása, akkor az első lépés valójában az összes fejezet felsorolása lehet, például a fuvola kiválasztása, összeszerelés és ápolás, a hangszín előállítása, az ujjlenyomat módszerei Első darab, stb. Ezután minden fejezetre alkalmazná a kézikönyv írásának alapvető szabályait, mert minden fejezet önmagában olyan, mint egy külön kézikönyv!
  • Amikor csak lehetséges, illusztrálja az utasításokat! Ha nem tud képeket beszúrni, hivatkozzon tanulójára valami gyakori példára. Például ben Formázás, 2. lépés ezen utasítások közül a wikiHow elrendezésének megjelenése illusztrálja a tartalomjegyzék létrehozásának módját.
  • Ha minden részt külön oldalra (vagy számítógépre) ír, megkönnyíti a szerkesztést. Könnyebben átrendezheti, ha van helye dolgozni, és megtalálja a szerkesztési jeleket. A számítógépen hagyjon 3 vagy 4 sort (ütéssel belép többször) az egyes lépések között, így könnyen megtalálhatja a szüneteket.
  • Ha teheti, kérjen egy kezdőtől egy tesztfuttatást a kézikönyvből, és írja le minden kérdését! Ez segít kitölteni az üres helyeket, és sokkal hasznosabbá teszi a kézikönyvet.

Ajánlott: