Co powinno znaleźć się w dokumentacji TECHNICZNEJ aplikacji (dla programisty)?
Dobrze. To informacje potrzebne programiście.
Źle. To również dokumentacja użytkownika.
Źle. To materiał dla użytkownika końcowego.
Źle. To dokumentacja użytkownika.
Dokumentacja TECHNICZNA jest przeznaczona dla programisty, więc opisuje wnętrze aplikacji: zastosowane algorytmy, strukturę kodu źródłowego, architekturę i zależności między modułami. Ma ułatwić rozwój i utrzymanie programu. Dlatego znajdzie się w niej opis algorytmów i struktury kodu.
Pozostałe treści należą do dokumentacji UŻYTKOWNIKA. Instrukcja obsługi krok po kroku, przewodnik pierwszego uruchomienia i opis funkcji „z perspektywy obsługującego” są pisane dla użytkownika końcowego, a nie programisty. Dokumentacja techniczna zawiera opis algorytmów i struktury kodu źródłowego.