Uživatelská příručka - User guide

Nesmí být zaměňována s uživatelskou příručkou .

Uživatelská příručka , také obyčejně známý jako uživatelské příručce , má pomoci uživatelům při používání konkrétního výrobku, služby nebo aplikace. Obvykle je napsán technikem, vývojářem produktu nebo pracovníkem zákaznického servisu společnosti.

Uživatelská příručka je často součástí nákupu domácích spotřebičů. Nyní je to ale běžné v obou službách, softwaru, aplikacích ... Vychází v tištěné podobě, nebo v tištěné podobě (dokument nebo aplikace).

Většina uživatelských příruček obsahuje jak písemnou příručku, tak související obrázky. V případě počítačových aplikací je obvyklé přidávat screenshoty rozhraní (rozhraní) člověk-stroj a hardwarové manuály často obsahují jasné, zjednodušené diagramy . Použitý jazyk je přizpůsoben zamýšlenému publiku , přičemž žargon je omezen na minimum nebo důkladně vysvětlen.

Obsah uživatelské příručky

Sekce uživatelské příručky často obsahují:

  • Titulní stránka
  • Titulní a autorská stránka
  • Předmluva obsahující podrobnosti o souvisejících dokumentech a informace o tom, jak se pohybovat v uživatelské příručce
  • Stránka s obsahem
  • Účelová sekce. Toto by měl být spíše přehled než detail cíle dokumentu
  • Sekce Publikum, která výslovně uvádí, kdo je zamýšleným publikem, které je povinno číst, včetně nepovinných
  • Sekce rozsahu je klíčová, protože slouží také jako zřeknutí se odpovědnosti a uvádí, co je mimo rozsah a co je zahrnuto
  • Návod, jak používat alespoň hlavní funkci systému
  • Část pro řešení potíží s podrobnostmi o možných chybách nebo problémech, které mohou nastat, spolu s postupem, jak je opravit
  • FAQ (Často kladené otázky)
  • Kde najdete další pomoc a kontaktní údaje
  • Slovníček a pro větší dokladů, index

Dějiny

Uživatelská příručka je vyryta do modelu mechanismu Antikythéry.

U starověkých zařízení byly nalezeny uživatelské příručky. Jedním z příkladů je Antikythera Mechanism , 2 000 let starý řecký analogový počítač, který byl nalezen u pobřeží řeckého ostrova Antikythera v roce 1900. Na obálce tohoto zařízení jsou pasáže textu, které popisují funkce a fungování mechanismu.

Jak se vyvíjel softwarový průmysl, otázka, jak nejlépe dokumentovat softwarové programy, nebyla rozhodnuta. To byl jedinečný problém pro vývojáře softwaru, protože uživatelé byli často frustrovaní aktuálními dokumenty nápovědy. Některé úvahy o psaní uživatelské příručky, která byla v tuto chvíli vyvinuta, zahrnují:

  • používání prostého jazyka
  • délka a obtížnost čtení
  • role tištěných uživatelských příruček pro digitální programy
  • design zaměřený na uživatele

Příručky a příručky k počítačovému softwaru

Uživatelské příručky a uživatelské příručky pro většinu netriviálních softwarových aplikací jsou dokumenty podobné knize s obsahem podobným výše uvedenému seznamu. Mohou být distribuovány v tištěné nebo elektronické podobě. Některé dokumenty mají tekutější strukturu s mnoha vnitřními odkazy. Google Earth Uživatelská příručka je příklad tohoto formátu. Termín průvodce se často používá k dokumentu, který se zabývá konkrétním aspektem softwarového produktu. Některé zvyklosti jsou Instalační příručka , příručka Začínáme a různé Jak průvodců. Příkladem je příručka Začínáme s programem Picasa .

V některých aplikacích podnikového softwaru , kde skupiny uživatelů mají přístup pouze k podmnožině plné funkčnosti aplikace, může být pro každou skupinu připravena uživatelská příručka. Příkladem tohoto přístupu je dokument Autodesk Topobase 2010 Help , který obsahuje samostatné příručky pro správce , uživatelské příručky a příručku pro vývojáře .

Viz také

Reference