Tipy na psaní uživatelských příručkách

Zamezení matoucí žargon a soustředit se na jasný, přesný popis technologií , které popisující vám umožní vytvořit jednoduché a intuitivní uživatelskou příručku , bez ohledu na předmět přírody . Předtím, než psát manuál , připravit obsah pečlivě plánovat , jak se bude vyvíjet do naučné prózy a posoudit úroveň jejich podrobností . Vždy dbejte na to, aby sečtenář cítí zaplaveni komplexní , přepracovaný popis . První dojmy

ošklivý , těžký , pestrobarevné manuál se spoustou ilustrací , vtipů a zbytečných detailů bude klást většina čtenářů pryč i jeho otevření na požadovanou stránku . Jako takový ,kryt , velikost a design manuálu , a prvních pár stránek hrají důležitou roli . Vytvoření jednoduché , informativní kryt a zavedení a udržení všeobecné čtenáře v mysli po celou dobu . Efektivní použití bude mít dobře napsaný , snadný - k - použití stránku s obsahem s přesným seznamem příslušných okruhů kapitol , čísla stránek a sekcí pro rychlé a snadné vyhledávání .
Podrobnosti o designu a rozvržení

Hard - kopie uživatelské manuály s jednoduchými , prostorné , černo- bílá rozložení jenejjednodušší číst a strávit . Příručka by měla obsahovat dostatek informací , aby umožnilačtenáři dokončit všechny nezbytné úkoly související s produktem nebo úkol v otázce ( například instrukce , jak pracovat a opravit mikrovlnná trouba ) , ale to by nemělo být tak velké a technicky detailní , že se stává těžký , a tak těžko k přepravě po celém domě . Usilovat o dosažení správné rovnováhy mezi designem a obsah ; nespadají do pasti vytvoření krásně manuál s nekoncepční koncepce a špatné psaní . Stejný princip platí pro všechny diagramy a obrázky : Uchovávejte je jednoduchý , jasný , dobře umístěný na stránce a relevantní . PNG soubory mají malé , zvládnutelné velikosti souborů , ale nezapomeňte zkontrolovat reprodukovat obraz pro přehlednost a čitelnost .
Poznej svého Předmět

Nemůžeme všichni používali stejný mikrovlnná trouba , počítač nebo ořezávátko . Vypracovat jasnou představu o tom, jak jeden nebo dva modely zařízení práce , pak začít přemýšlet o tom, jak nejlépe můžete popíšeme každou komponentu . Použijte standardní terminologii , a nikdy se jména pro různé komponenty . Vždy zacházejte potenciální čtenáře , jako by mít znalosti o položky na určité úrovni , ale potřebují další pomoc s podrobnostmi ; jinak byste mohli riskovat odcizit jim urážky jejich inteligence . Přidat tak podrobně, jak je to možné , ale prezentovat to jednoduše a přátelsky , vstřícně .
Color Coding

Pokud si myslíte, že můžete přidat do základního manuálu vás vytvořili , jemně barevně kódu určité skutečnosti, a propojit je v celém textu . ( Nepoužívejte fluorescenční růžová , držet se světlem , jednoduché barvy, jako pastelové zelené a modré ). Tato vazba jedruh " indexování " a využívá poznávání lidí a psychologii čtení . To jim umožňuje vyvinout lepší pochopení fungování a funkcí se zařízením , spíše než dávat jim zjednodušující nebo " ploché " krajinu myšlení .
Různé styly próze

rozvíjet a zlepšit efektivitu vašeho manuálu experimentovat s mírně odlišnými styly psaní . Přestávka jednotlivé sekce a subsekce dolů do krátkého popisného odstavce pro zavedení , což je základní popis prvků zapojených , a pak přidejte krok-za - krokem sadu instrukcí, poté, co se první odstavec sdělit čtenáři přesně, jak dokončiturčité opravy nebo funkce . Tato technika vedek použití tekoucí a zajímavé zároveň vyvozující největší znalosti v krátkém čase . I když se snaží pokročilé techniky pro vytváření uživatelskou příručku , vždy vrátit k základům : Zkontrolujte pravopis , gramatiku , konzistenci , jazyk a formátování pravidelně

.