Ako napísať manuál od začiatku?

Príklad: Píšete manuál „Ako nainštalovať dvere“.

Písanie manuálu o dôležitej funkcii v práci môže vašim nadriadeným predviesť vaše schopnosti. Ukazuje vašu schopnosť dokončiť projekt sami.

Kroky

1

Rozhodnite sa o svojom predmete. Uveďte konkrétny rozsah a rozsah.
2
Rozhodnite sa, pre aké publikum píšete.
- Píšete manuál pre začiatočníkov alebo odborníkov (alebo niekde medzi tým)?
- Zúčastní sa publikum na hodine (pomocou manuálu) alebo samoštúdiu?
3
V návode presne definujte, o čom budete hovoriť.
- Príklad: Píšete manuál „Ako nainštalovať dvere“. Jedna časť môže byť o posuvných dverách. Ďalšia časť môže byť o predných dverách. Ešte ďalšia časť môže byť o zadných dverách.
4

Rozhodnite sa podľa logického poradia a predložte svoju príručku. Nejde o logické poradie akcií. Niektoré témy možno bude potrebné najskôr predstaviť. Úlohy, ktoré budú zahrnuté vo všetkých častiach manuálu, by mali byť najskôr prediskutované. Ak máte pocit, že čitateľ by už mal mať schopnosti na dokončenie úlohy, zvážte popísanie úlohy v prílohe.
5
Ak sa v príručke bude používať odborná terminológia alebo žargón, pripravte si slovník. Ak je nepravdepodobné, že čitateľ už bude poznať žargón, umiestnite glosár bezprostredne za obsah. Aktualizujte glosár pri písaní manuálu.
- Definície pojmov v slovníku musia byť čo najpresnejšie. Ak je tento výraz skratkou, napríklad „Potápač“, úplne vysvetlite, že v definícii znamená „sebestačný podvodný dýchací prístroj “.
Príklad: Píšete manuál o takom a takom počítači.
6

Rozhodnite sa, ktoré predmety potrebujete na ďalší výskum. Nepresný manuál je zbytočný manuál. Pred spustením príručky dokončite svoj predbežný prieskum.
7
Rozhodnite sa pre organizáciu pre každú sekciu, ktorú budete písať.
- Príklad: Píšete manuál o takom a takom počítači. Máte sekciu s názvom „Riešenie problémov“. Môžete napísať jeho časť o problémoch s miestom na disku. O nadmernom využití pamäte môžete napísať ďalšie.
8

Usporiadajte každú sekciu a podsekciu v logickom poradí, čím zúžite rozsah témy.
9
Začnite písať! Používajte svoju organizáciu ako sprievodcu, ale ak nefunguje, zmeňte ju.
1. Napíšte popisy rôznych úloh.
2. Napíšte príklady, ktorými sa môže čitateľ riadiť, aby získal poučenie.
3. Pripravte si vhodné ilustrácie. Nepridávajte ich, kým nie je manuál dokončený. Ilustrácie bude potrebné prispôsobiť textu.
- Upravte ilustrácie tak, aby poskytovali rady, ktoré naznačujú, čo používateľ hľadá.
  1. Príklad 1: (Pri pohľade na číslovaný zoznam) Spisovateľ by spojil problém s číslom „13“.
  2. Príklad 2: (Triedenie) Spisovateľ zväčší riadok textu, ktorý bol mimo poradia.
10
Neplagiujte písanie niekoho iného! Majte referenčnú a/alebo citačnú sekciu obsahujúcu knihy, príručky a ľudí, ktorí vám poskytli informácie.
- Nič nezničí dôveryhodnosť spisovateľa rýchlejšie ako plagiátorstvo. Jedného dňa môže niekto citovať vaše texty. Ako by ste vnímali niekoho, kto vám „ukradne“ prácu?
Ak sa v príručke bude používať odborná terminológia alebo žargón, pripravte si slovník.
11

Pridajte vhodné ilustrácie. Vložte ich do dokumentu. Nebojte sa použiť biele miesto.
12
Korektúry, korektúry a ešte raz korektúry. Korektúry by mali prebiehať. Robte si poznámky o chybách alebo opomenutiach. Opravte ich. Robte si poznámky o pasážach, ktoré ostatní považujú za mätúce. Prepíšte úryvok, aby bol čitateľnejší. Nechajte si príručku prečítať množstvo ľudí, aby ste zaistili najlepší možný výsledok.
- - Toto je poradie, ktoré vám odporúčam, aby ste mali dokončenú manuálnu korektúru:
    1. Dokážte svoju prácu sami.
    2. Nechajte priateľa skontrolovať ho.
    3. Nechajte si to skontrolovať odborníkom (v oblasti, o ktorej píšete).
    4. (Ak je príručka pre vašu spoločnosť), nechajte si ju prekontrolovať šéfom.
    5. Nechajte si to prečítať nováčikom.
    - Prečo to má nováčik kontrolovať? Príručka musí byť zrozumiteľná na minimálnej úrovni znalostí, ktorú od nej očakávate.

Tipy

Uistite sa, že titulná stránka a päty na každej strane uvádzajú ako autora VÁS! Pred elektronickým odoslaním si vytlačte kópie manuálu. Nechajte si korektormi robiť poznámky na stránky. Do päty zahrňte „c“ obklopené zátvorkami. Väčšina programov bude interpretovať toto označenie ako autorské právo a umiestni správny symbol. Päta by mala znieť (c) podľa vášho mena. Vašej spoločnosti to nezabráni v kopírovaní, ale zaručí váš nárok na autorstvo.

Prečítajte si tiež: Ako bojovať proti kompenzáciám MasterCard?