Dokumentacja programowa
Nazywa się każdy tekst, ilustracje lub wideo, które opisują oprogramowanie lub program jego użytkownikom program or software document. Użytkownikiem może być każdy, od programisty, analityka systemu i administratora do użytkownika końcowego. Na różnych etapach rozwoju można stworzyć wiele dokumentów dla różnych użytkowników. W rzeczywistości,software documentation to krytyczny proces w całym procesie tworzenia oprogramowania.
W programowaniu modułowym dokumentacja nabiera jeszcze większego znaczenia, ponieważ różne moduły oprogramowania są opracowywane przez różne zespoły. Jeśli ktoś inny niż zespół programistów chce lub musi zrozumieć moduł, dobra i szczegółowa dokumentacja ułatwi zadanie.
Oto kilka wskazówek dotyczących tworzenia dokumentów -
Dokumentacja powinna być z punktu widzenia czytelnika
Dokument powinien być jednoznaczny
Nie powinno być powtórzeń
Należy stosować standardy branżowe
Dokumenty należy zawsze aktualizować
Każdy nieaktualny dokument powinien zostać wycofany po należytym zarejestrowaniu wycofania
Zalety dokumentacji
Oto niektóre z zalet dostarczania dokumentacji programu -
Śledzi wszystkie części oprogramowania lub programu
Konserwacja jest łatwiejsza
Programiści inni niż deweloper mogą zrozumieć wszystkie aspekty oprogramowania
Poprawia ogólną jakość oprogramowania
Pomaga w szkoleniu użytkowników
Zapewnia decentralizację wiedzy, zmniejszając koszty i wysiłek, jeśli ludzie nagle opuszczą system
Przykładowe dokumenty
Z oprogramowaniem może być skojarzonych wiele typów dokumentów. Niektóre z ważnych to:
User manual - Opisuje instrukcje i procedury dla użytkowników końcowych dotyczące korzystania z różnych funkcji oprogramowania.
Operational manual - Wymienia i opisuje wszystkie wykonywane operacje oraz ich wzajemne zależności.
Design Document- Zawiera przegląd oprogramowania i szczegółowo opisuje elementy projektu. Dokumentuje szczegóły, takie jakdata flow diagrams, entity relationship diagramsitp.
Requirements Document- Zawiera listę wszystkich wymagań systemu, a także analizę wykonalności wymagań. Może mieć przypadki użytkowników, scenariusze rzeczywistego życia itp.
Technical Documentation - Jest to dokumentacja rzeczywistych komponentów programistycznych, takich jak algorytmy, schematy blokowe, kody programów, moduły funkcjonalne itp.
Testing Document - Zapisuje plan testów, przypadki testowe, plan walidacji, plan weryfikacji, wyniki testów, itp. Testowanie to jedna z faz tworzenia oprogramowania, która wymaga intensywnej dokumentacji.
List of Known Bugs- Każde oprogramowanie zawiera błędy lub błędy, których nie można usunąć, ponieważ zostały wykryte bardzo późno lub są nieszkodliwe lub ich naprawienie zajmie więcej wysiłku i czasu niż jest to konieczne. Te błędy są wymienione w dokumentacji programu, aby można je było usunąć w późniejszym terminie. Pomagają również użytkownikom, wdrażającym i konserwatorom, jeśli błąd zostanie aktywowany.