Ako napísať skvelú používateľskú príručku pre takmer všetko

Obsah:

Anonim

Kedysi, pevné používateľské príručky sprevádzali nové produkty všetkých druhov, poskytujúce rozsiahle pokyny na to, ako sa naučiť všetky funkcie a maximalizovať svoje využitie. V dnešnej dobe sú však výrobné príručky dodávané v továrňach oveľa rýchlejšie a často vo viacerých jazykoch, čo komplikuje vašu krivku učenia. Ak chcete mať dôstojnú používateľskú príručku, je vzácna komodita a ak viete, ako napísať jeden, je to veľký talent. Ide len o zvládnutie niekoľkých kľúčových princípov.

Položky, ktoré budete potrebovať

  • Program Microsoft Word alebo iný program na spracovanie textu

  • Zbierka klipartov alebo digitálnych fotografií

  • Jednoduchý softvér na tvorbu webových stránok

Rozhodnite sa pre formát, či už tlačené dokumenty, webové stránky, e-maily alebo nejakú kombináciu. Akonáhle píšete v jednom formáte, je ľahké ho preniesť do iného formátu. Niektorí ľudia sú pohodlnejšie čítať vytlačený dokument, ktorý môžu držať a odložiť. Ostatní môžu uprednostňovať URL alebo odkaz na dokument na vašej webovej stránke.

Byť organizovaný, jasný a stručný. Predvídať a vysvetľovať nielen to, čo používatelia produktov urobia, ale aj to, čo nerobiť. Musíte písať s ohľadom na oboje.

Začnite na začiatku, rozvíjajte iba potrebné informácie logicky. Napíšte do aktívneho hlasu, nie pasívne. Udržujte svoju kópiu štíhle, čím odstraňujete cudzie slová. Udržujte to jednoduché a metodické.

Zlomte text s fotografiami, ilustráciami alebo diagrammi čo najviac. Vytváranie čitateľov cez nekonečný text s monštruóznymi odsekmi je istý spôsob, ako ich stratiť. Dlhé, zložité odseky a stránky sú v technických príručkách v poriadku, ale nevhodné pre jednoduché používateľské príručky. Udržujte to krátke a sladké.

Upozornite čitateľa, čo nemá robiť v rôznych intervaloch. To pomáha minimalizovať frustráciu pri učení nového produktu alebo aplikácie.

Poskytnite čitateľom ďalšie zdroje, ktoré môžu použiť na doplnenie vášho sprievodcu.

Tipy

  • Píšte veľmi jednoducho. Nepredpokladajte žiadnu úroveň vedomostí. Zdá sa, že to, čo sa vám zdá jednoduché a dobre informované, nemusí byť pre vašich čitateľov taká. Používajte vysokokvalitnú grafiku, kliparty a fotografie, aby ste zlepšili vzhľad dokumentu a zvýšili jeho čitateľnosť. Udržujte odseky a popisy krátke.

Výstraha

Nikdy nepredpokladajte, že čitateľ je so zariadením oboznámený. Napíšte každú príručku, ako keby ste ju ešte nikdy nevideli.