Odpowiedź:
Cechy dobrej dokumentacji:
jest dokładna i bezbłędna,
jest kompletna,
jest spójna,
jest napisana w sposób klarowny i jednoznaczny,
użytkownik może łatwo znaleźć informację, której potrzebuje,
ma porządny, ładny wygląd
Etapy tworzenia dokumentacji:
zbieranie informacji na temat opisywanego systemu,
tworzenie projektu dokumentacji,
pisanie dokumentacji,
weryfikacja dokumentacji,
dokonywanie poprawek i uzupełnianie braków.
Dwa ostatnie etapy są zwykle powtarzane kilkakrotnie, aż do usunięcia wszystkich usterek
Informacje na temat opisywanego systemu, można zbierać poprzez:
czytanie już istniejących fragmentów dokumentacji,
pracę z programem i analizę kodu źródłowego,
konsultacje (zazwyczaj z developerami, którzy stworzyli system).
mam nadzieję że pomogłem i że to jest to
