Co powinno znaleźć się w dokumentacji UŻYTKOWNIKA aplikacji?
Źle. To element dokumentacji technicznej (dla programisty).
Źle. To dokumentacja techniczna.
Dobrze. Użytkownik potrzebuje wiedzieć, JAK korzystać z programu.
Źle. To informacja techniczna, nie dla zwykłego użytkownika.
Dokumentacja UŻYTKOWNIKA jest pisana dla osoby obsługującej program, więc zawiera instrukcję obsługi jego funkcji - jak wykonać typowe zadania, krok po kroku, bez wnikania w kod. Dlatego znajdzie się w niej instrukcja obsługi funkcji systemu.
Pozostałe treści należą do dokumentacji TECHNICZNEJ, przeznaczonej dla programisty. Szczegółowy opis kodu źródłowego, użyte technologie i biblioteki oraz algorytmy nie są potrzebne użytkownikowi końcowemu. Dokumentacja użytkownika zawiera instrukcję obsługi funkcji systemu.