Ako napísať príručku od nuly: 15 krokov (s obrázkami)

Napísanie príručky o dôležitej funkcii v práci môže preukázať vaše schopnosti nadriadeným. Preukazuje vašu schopnosť dokončiť projekt samostatne.

Kroky


Rozhodnite sa pre svoj predmet. Buďte konkrétni v rozsahu a dosahu.[1]


Rozhodnite sa, pre aké publikum píšete.

  • Píšete príručku pre začiatočníkov alebo odborníkov (alebo niečo medzi tým)?
  • Či bude publikum zapojené do výučby (s použitím príručky) alebo do samoštúdia?


Presne definujte, o čom budete v príručke hovoriť.

  • Príklad: Píšete príručku „Ako inštalovať dvere“. Jedna časť by sa mohla týkať posuvných dverí. Ďalšia časť môže byť o vchodových dverách. Ešte ďalšia časť sa môže týkať zadných dverí.


Rozhodnite sa pre logické poradie, v akom budete príručku prezentovať. Nejde o logické poradie činností. Niektoré témy môže byť potrebné najskôr predstaviť. Úlohy, ktoré budú zahrnuté vo všetkých častiach príručky, by ste mali pravdepodobne prediskutovať ako prvé. Ak máte pocit, že čitateľ by už mal mať zručnosti na splnenie úlohy, potom zvážte opis úlohy v prílohe.[2]


Ak sa v príručke bude používať odborná terminológia alebo žargón, pripravte si slovník pojmov. Ak je nepravdepodobné, že čitateľ už bude poznať žargón, umiestnite slovník hneď za obsah. Aktualizujte slovník v priebehu písania príručky.[3]

  • Definície pojmov v slovníku musia byť čo najpresnejšie. Ak je termín skratkou, napríklad „Scuba“, potom v definícii plne vysvetlite, že znamená „Samostatný podvodný dýchací prístroj“.


Rozhodnite sa, aké témy potrebujete ďalej preskúmať. Nepresný manuál je nepoužiteľný manuál. Pred začatím manuálu dokončite predbežný prieskum.


Rozhodnite sa pre organizáciu každej časti, ktorú budete písať.

  • Píšete príručku o takom a takom počítači. Máte časť s názvom „Riešenie problémov“. Môžete napísať časť o problémoch s miestom na disku. Môžete napísať ďalší o nadmernom využívaní pamäte.


Usporiadajte jednotlivé časti a podčasti v logickom poradí a zúžte rozsah témy.


Začnite písať! Použite svoju organizáciu ako návod, ale zmeňte ju, ak nebude fungovať.[4]

  • Napíšte opisy rôznych úloh.
  • Napíšte príklady, ktoré môže čitateľ sledovať, aby získal návod.
  • Pripravte si vhodné ilustrácie. Nepridávajte ich, kým nie je príručka dokončená. Ilustrácie bude potrebné prispôsobiť textu.
    • Upravte ilustrácie tak, aby poskytovali náznaky, ktoré naznačujú, čo používateľ hľadá.
    • Príklad 1: (pri pohľade na očíslovaný zoznam) Pisateľ by spojil problém s číslom „13“.
    • Príklad 2: (Triedenie) Pisateľ by zväčšil riadok textu, ktorý nebol v poriadku.


    Neplagátujte písanie niekoho iného! Pripravte si odkaz a/alebo časť s citáciami, v ktorej uvediete knihy, príručky a osoby, ktoré vám poskytli informácie.

    • Nič nezničí dôveryhodnosť autora rýchlejšie ako plagiátorstvo. Jedného dňa môže niekto citovať vaše písanie. Ako by ste sa cítili, keby niekto „ukradol“ vašu prácu?


    Pridajte vhodné ilustrácie. Zaradiť ich do dokumentu. Nebojte sa používať biele miesta.


  • Opravujte, opravujte a ešte raz opravujte. Korektúry by mali prebiehať priebežne. Urobte si poznámky o chybách alebo opomenutiach. Opravte ich. Robte si poznámky k pasážam Ostatní nájsť mätúce. Prepracujte pasáž tak, aby sa ľahšie čítala. Dajte príručku prečítať rôznym ľuďom, aby ste si zabezpečili čo najlepší výsledok.

      • V tomto poradí vám odporúčam dať si skontrolovať hotovú príručku:
      • Sami si svoju prácu skontrolujte.
      • Nechajte si ju skontrolovať priateľom.
      • Nechajte si text skontrolovať odborníkom (v oblasti, o ktorej píšete).
      • (Ak je príručka určená pre vašu spoločnosť), dajte ju skontrolovať svojmu šéfovi.
      • Dajte ju skontrolovať nováčikovi.
        • Prečo si nechať urobiť korektúru od začiatočníka? Príručka musí byť zrozumiteľná pre minimálnu úroveň znalostí, ktorú očakávate, že ju bude čítať.
  • Odkazy