Co powinno znaleźć się w dokumentacji UŻYTKOWNIKA aplikacji?
A. instrukcja obsługi funkcji systemu
Dobrze. Użytkownik potrzebuje wiedzieć, JAK korzystać z programu.
B. opis algorytmów zastosowanych w kodzie
Źle. To dokumentacja techniczna.
C. opis użytych technologii i bibliotek
Źle. To informacja techniczna, nie dla zwykłego użytkownika.
D. szczegółowy opis kodu źródłowego
Źle. To element dokumentacji technicznej (dla programisty).
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.