Tipy na písanie používateľských príručkách

Zamedzenie mätúce žargón a sústrediť sa na jasný , presný popis technológií , ktoré popisujúci vám umožnia vytvoriť jednoduché a intuitívne návod, bez ohľadu na predmet prírody . Predtým , než písať manuál, pripraviť obsah starostlivo plánovať , ako sa bude vyvíjať do náučnej prózy a posúdiť úroveň ich podrobností . Vždy dbajte na to , aby sa čitateľ cíti zaplavení komplexný , prepracovaný popis . Prvé dojmy

škaredý , ťažký , pestrofarebné manuál s množstvom ilustrácií , vtipov a zbytočných detailov bude klásť väčšina čitateľov preč i jeho otvorenie na požadovanú stránku . Ako taký , kryt , veľkosť a dizajn manuálu , a prvých pár stránok zohrávajú dôležitú úlohu . Vytvorenie jednoduchej , informatívne kryt a zavedenie a udržanie všeobecnej čitateľa v mysli po celú dobu . Efektívne použitie bude mať dobre napísaný , ľahký-k - použitie stránku s obsahom s presným zoznamom príslušných okruhov kapitol , čísla stránok a sekcií pre rýchle a jednoduché vyhľadávanie .
Podrobnosti o dizajne a rozvrhnutie

Hard - kópie užívateľské manuály s jednoduchými , priestranné , čierno - biela rozloženie je najjednoduchšie čítať a stráviť . Príručka by mala obsahovať dostatok informácií , aby umožnili čitateľovi dokončiť všetky nevyhnutné povinnosti súvisiace s produktom alebo úlohu v otázke ( napríklad inštrukcie , ako pracovať a opraviť mikrovlnná rúra ) , ale to by nemalo byť tak veľké a technicky detailné , že sa stáva ťažký , a tak ťažko na prepravu po celom dome . Usilovať o dosiahnutie správnej rovnováhy medzi dizajnom a obsah; nespadajú do pasce vytvorenie krásne manuál s nekoncepční koncepcie a zlé písanie . Rovnaký princíp platí pre všetky diagramy a obrázky : Uchovávajte je jednoduchý , jasný , dobre umiestnený na stránke a relevantné . PNG súbory majú malé , zvládnuteľné veľkosti súborov , ale nezabudnite skontrolovať reprodukovať obraz pre prehľadnosť a čitateľnosť .
Poznaj svojho Predmet

Nemôžeme všetci používali rovnaký mikrovlnná rúra , počítač alebo strúhadlo . Vypracovať jasnú predstavu o tom , ako jeden alebo dva modely zariadení práce , potom začať premýšľať o tom , ako najlepšie môžete popíšeme každú komponentu . Použite štandardnú terminológiu , a nikdy sa mená pre rôzne komponenty . Vždy zaobchádzajte potencionálnych čitateľov , ako by mať znalosti o položky na určitej úrovni , ale potrebujú ďalšiu pomoc s podrobnosťami; inak by ste mohli riskovať odcudziť im urážky ich inteligencia . Pridať tak podrobne , ako je to možné , ale prezentovať to jednoducho a priateľsky , ústretovo .
Color Coding

Ak si myslíte , že môžete pridať do základného manuálu vás vytvorili , jemne farebne kódu určité skutočnosti , a prepojiť ich v celom texte . ( Nepoužívajte fluorescenčné ružová , držať sa svetlom , jednoduché farby , ako pastelové zelené a modré ) . Táto väzba je druh " indexovanie " a využíva spoznávanie ľudí a psychológiu čítania . To im umožňuje vyvinúť lepšie pochopenie fungovania a funkcií so zariadením , skôr než dávať im zjednodušujúce alebo " ploché " krajinu myslenie .
Rôzne štýly próze

rozvíjať a zlepšiť efektivitu vášho manuálu experimentovať s mierne odlišnými štýlmi písania . Prestávka jednotlivé sekcie a subkategórie dole do krátkeho popisného odseku pre zavedenie , čo je základný opis prvkov zapojených , a potom pridajte krok - za - krokom sadu inštrukcií , potom, čo sa prvý odsek vysvetliť čitateľovi presne , ako dokončiť určité opravy alebo funkcie . Táto technika vedie k použitiu tečúcou a zaujímavé pričom prenášajú najväčšie znalosti v krátkom čase . Aj keď sa snažia pokročilé techniky pre vytváranie návod, vždy vrátiť k základom : Skontrolujte pravopis , gramatiku , konzistenciu , jazyk a formátovanie pravidelne
.