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 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):
- A funkció elérését formázhatjuk mint "Inline Code" (CTRL+8):
- Szúrjunk be képernyőképeket, képernyőkép készítéséhez ajánlom az Faststone Capture alkalmazást:
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.)