# Felhasználói kézikönyv

A felhasználói kézikönyvbe/dokumentációba leírásra kerül minden lényeges felület és funkció, illetve folyamat ami elérhető az alkalmazásban.

A dokumentumot alapvetően az alkalmazásban található menüpontok szerint csoportosítjuk fejezetekbe.

A fogalmazás során képzeljük magunkat egy olyan felhasználó helyére, aki most tanulja a rendszer használatát.

A dokumentáció írása során törekedjünk a következőkre:

- Használjuk a beépített stílusokat (Header, Callouts, stb., ezekhez [vannak keyboard shortcutok is](https://defkey.com/bookstack-shortcuts)):

[![image-1660490595951.png](https://kb.szelence.eu/uploads/images/gallery/2022-08/scaled-1680-/kLWYSkiOBg9YSUy0-image-1660490595951.png)](https://kb.szelence.eu/uploads/images/gallery/2022-08/kLWYSkiOBg9YSUy0-image-1660490595951.png)

- A funkció elérését formázhatjuk mint "Inline Code" (CTRL+8):

[![image-1660491038237.png](https://kb.szelence.eu/uploads/images/gallery/2022-08/scaled-1680-/oXo0b8Fr2EvVkYXO-image-1660491038237.png)](https://kb.szelence.eu/uploads/images/gallery/2022-08/oXo0b8Fr2EvVkYXO-image-1660491038237.png)

- Szúrjunk be képernyőképeket, képernyőkép készítéséhez ajánlom az [Faststone Capture](https://www.faststone.org/FSCaptureDownload.htm) alkalmazást:

[![image-1660491181123.png](https://kb.szelence.eu/uploads/images/gallery/2022-08/scaled-1680-/UKzBeXRTsnadt0EZ-image-1660491181123.png)](https://kb.szelence.eu/uploads/images/gallery/2022-08/UKzBeXRTsnadt0EZ-image-1660491181123.png)

<p class="callout info">Miután megírtuk a dokumentációt, mutassuk meg és kérjük ki annak a munkatársnak a véleményét aki használja fogja (pl. Tünde, Benjámin, stb.). Ha felmerülnek kérdések, amikre nem egyértelmű a válasz, akkor bővítsük a dokumentációt egy "kérdés-válasz" részleggel.</p>