Ako napísať manuál?

Ako vyrezať píšťalu potrebuje niekoľko — (Ako píšťalka nepotrebuje, ako vyrezať píšťalu potrebuje niekoľko a ako hrať na flaute potrebuje veľa!).

Písanie návodu na obsluhu sa môže javiť ako náročná úloha, ale je to jednoduchšie, ako si myslíte! Tieto kroky sa vzťahujú na všetky písomné pokyny, od veľmi jednoduchých (Ako tlieskať) až po intenzívne komplikované (Ako zostaviť polovodič).

Časť 1 zo 4: zoznámte sa s predmetom

1

Toto je kľúčové. Môže sa to zdať samozrejmé, ale znalosti sú kľúčom k napísaniu úspešného manuálu. Ak napríklad píšete manuál k fotoaparátu, vediac, že f-stop a rýchlosť uzávierky nie sú iba 2 rôzne funkcie-sú to-ale znalosť ich vzájomnej interakcie vám popis jednotlivých funkcií uľahčí. keďže sa týka celku.
2

Porozprávajte sa s odborníkmi. Ak je vašou úlohou iba spisovateľ, a nie odborník na predmet, zapojte do celého procesu informovaných ľudí a uistite sa, že skontrolujú vašu prácu. Ich vedomosti a rady sú neoceniteľné.
3

Skúste praktický prístup. Ak je to možné, robenie veci, o ktorej píšete, prinajmenšom vám poskytne pocit, že sa používateľ bude chcieť naučiť.
4
Prečítajte si túto tému. Naučte sa rozprávať rozprávanie a osvojte si znalosť produktu, o ktorom píšete.
- Príručky k podobným výrobkom vám ukážu, ako sa k téme dostali iní autori.
  - Hľadajte podobnosti medzi autormi, čo naznačuje bežnú funkčnosť aj bežné prístupy k opisu niečoho.
  - Hľadajte rozdiely, ktoré vynikajú. Ide pravdepodobne o funkcie, ktoré sú pre daný produkt jedinečné. Váš produkt môže, ale nemusí obsahovať tieto funkcie, alebo môže mať alternatívne spôsoby riešenia problému, ktorý môžete popísať, a tým zvýšiť hodnotu vášho produktu. Aj keď je vašou úlohou písať návody, ukázať zákazníkom hodnotu ich nákupu je skvelý spôsob, ako ich povzbudiť, aby pokračovali v čítaní.
- Hltajte obchodné časopisy. Zistite, ako s nimi ľudia, ktorí produkty používajú, každodenne pracujú. Môžu si priať, aby existovala funkcia, ktorá rieši ich konkrétny problém, a ak je riešením váš produkt, je to potrebné zdôrazniť.

Ako vlastniť vlastnú firmu — Ako urobím obsah príručky, ako vlastniť vlastnú firmu?

2. časť zo 4: naplánujte si manuálne rozloženie

1
Rozobrať to Či už je to jednoduchý podrobný návod alebo manuál pre 35 mm digitálny fotoaparát, jeho rozdelenie na stráviteľné kúsky má niekoľko výhod:
- Umožňuje vám zamerať sa na jednotlivé časti celku. Vaším cieľom je zoznámiť používateľa s tým, ako sa tento proces naučiť. Ako je možné vykonať túto funkciu, môžete na konci nechať tutoriál, alebo ho môžete nechať na používateľovi, aby ho objavil sám.
2

Dodržujte logickú postupnosť. Napríklad by nebolo dobré popisovať, ako funguje blesk na fotoaparáte, kým neukážete, ako nasadiť objektív, vložiť film, zapnúť fotoaparát a zaostriť. To je obzvlášť užitočné, ak neovládate dobre učivo.
3

Použite to ako svoju šablónu pre obsah.
4

Skontrolujte svoje kroky. Po definovaní logických častí ich skontrolujte, aby ste sa ubezpečili, že je všetko pokryté.
5

Zhromaždite si zásoby. Majte po ruke položky, ktoré popisujete, a pripravené na použitie, ako je popísané v príručke. Ak vyrábate papierovú škatuľu, majte po ruke papier, nožnice, pásku, lepidlo a pravítko. Ak píšete o fotoaparáte, uistite sa, že je váš fotoaparát rozobratý. Pokiaľ je to možné, produkt, o ktorom píšete, by mal byť v tomto okamihu späť v krabici.

Ak píšete príručku v chronologickom poradí, dokončite najskôr napísanie príručky.

Časť 3 zo 4: začnite písať

1

Napíš úvod. Toto nastaví tón celého manuálu a poskytne užívateľovi predstavu o tom, aký druh manuálu sa chystá stráviť. Bude to ľahké a zábavné, alebo priamočiare a nezmyselné? Závisí to od vašej čitateľskej základne. Existuje oveľa väčší priestor na verbálne hry, ktoré učia deti vyrábať papierové škatule, ako na učenie lekára, ako postupovať pri chirurgickom zákroku na otvorenom srdci. Nastavte tón včas a udržujte ho v celej príručke.
2
Každý krok vykonajte počas písania. Toto nielen dáva vášmu písaniu atmosféru čestnosti a autenticity, ale tiež zaisťujete, aby nič nevynechalo.
- Ak z nejakého dôvodu nie je možné vykonať tieto kroky, dôkladne ich premyslite a poraďte sa s niekým, kto je odborníkom.
3
Počet krokov. Ľahšie to ľuďom umožňuje nasledovať a odkazovať späť, ak stratia miesto.
- Ak píšete na papier, medzi jednotlivými krokmi určite nechajte priestor na dodatky. Ak pridáte ďalšie kroky, nezabudnite prečíslovať svoje kroky.
4
Zahrňte tipy a varovania. Pri písaní si môžete uvedomiť, že ak používateľ vykoná krok nedbalo, môže to spôsobiť problém.
- Naopak, ak existuje trochu vedomostí, vďaka ktorým bude používateľova úloha ľahšia alebo zaujímavejšia, doplňte ju.
5
Vyskúšajte to. Robte to, o čom píšete, iba pomocou svojich písomných pokynov. Ak nájdete miesta, kde chýbajú vaše pokyny, doplňte potrebné informácie. Tento krok opakujte, kým nebudete mať všetky kroky a budete môcť robiť to, čo učíte, bez pridávania poznámok.
- Zvážte, či by príručku nemal použiť kamarát alebo dvaja priatelia. Keď sa naučia používať výrobok, pozorne ich sledujte. Pozrite sa, kde sa cez to zapínajú. Pozrite sa, kde sa stratili, zmätení alebo neúspešní v úlohe. Vypočujte si, čo hovoria, a potom tomu prispôsobte manuál.
6

Preverte svoju príručku. Nechcete poslať svojmu konečnému korektorovi (či už je to vaša agentúra alebo váš manžel) manuál plný do očí bijúcich chýb.

Časť 4 zo 4: formátovanie

1
Začnite na najvyššej úrovni. Keď máte podrobne popísané všetky potrebné kroky, prečítajte si príručku a nájdite zrejmé hlavy kategórií.
- Pomenujte ich a poznačte si ich umiestnenie.
2

Prípadne napíšte obsah. Pozrite sa, ako je sprievodca usporiadaný ako príklad. Hlavná stránka ponúka mnoho sekcie hláv. Keď vstúpite do sekcie, zobrazí sa v nej zoznam mnohých podkategórií a články v podkategóriách. Čím podrobnejšia je vaša príručka, tým viac kategórií a podkategórií budete potrebovať. (Ako na píšťalku nepotrebujete nič, Na to, ako vyrezávať píšťalku stačí pár, a na to, ako hrať na flaute, potrebujete veľa!)
3
Opäť korektúra. Áno, už ste to raz dôkladne urobili. Druhýkrát to nepochybne zachytí niekoľko ďalších drobných chýb alebo miest, kde vaša príručka jednoducho nie je jasná.
- Pre získanie komplexnejšieho manuálu môžete pri tejto príležitosti poznamenať všetky malé témy a použiť ich na vytvorenie indexu.
4

Vyberte názov.

Nechajte si začiatočníkom vyskúšať svoju príručku — Ak môžete, nechajte si začiatočníkom vyskúšať svoju príručku a zapíšte si všetky otázky, ktoré kladú!

Tipy

Aj keď sa vám zdá niečo zrejmé, napíšte kroky! Pomôže vám to vyhnúť sa prehliadaniu niečoho, čo váš používateľ nevie. Je lepšie vložiť ďalšie informácie, ako nevynechávať dôležité kroky.
Ak píšete veľmi podrobný manuál, ktorý vyžaduje kapitoly, ako napríklad Ako hrať na flaute, prvým krokom môže byť skutočne zoznam všetkých kapitol, ako napríklad Výber flauty, Montáž a starostlivosť, Produkcia tónov, Metódy prstovania, Váš First Piece, etc. Potom by ste použili základné pravidlá pre napísanie manuálu na každú kapitolu, pretože každá kapitola je sama o sebe ako samostatná príručka!
Kedykoľvek je to možné, ilustrujte svoje pokyny! Ak nemôžete vložiť obrázky, odkážte svojho študenta na príklad niečoho bežného. Napríklad vo formáte 2, krok 2 týchto pokynov, vzhľad rozloženia sprievodcu slúži na ilustráciu toho, ako možno vytvoriť obsah.
Úpravy uľahčíte zapísaním každej časti na samostatnú stránku (alebo do počítača). Ľahšie môžete zmeniť usporiadanie, ak máte priestor na prácu a nájdete svoje značky úprav. Na počítači nechajte medzi každým krokom 3 alebo 4 riadky (niekoľkokrát stlačte kláves Enter), aby ste ľahko našli medzery.
Ak môžete, nechajte si začiatočníkom vyskúšať svoju príručku a zapíšte si všetky otázky, ktoré kladú! Pomôže vám to vyplniť prázdne miesta a vaša príručka bude oveľa užitočnejšia.

Prečítajte si tiež: Ako vytvoriť obchodný e-mail pre niekoho, koho nepoznáte?

Ako napísať manuál?

Kroky

Časť 1 zo 4: zoznámte sa s predmetom

2. časť zo 4: naplánujte si manuálne rozloženie

Časť 3 zo 4: začnite písať

Časť 4 zo 4: formátovanie

Tipy

Otázky a odpovede

Prečítajte si tiež: