Dokumentacja oprogramowania obiektowego

Dokumentacja oprogramowania dostarcza twórcom i użytkownikom oprogramowania przydatny opis tego, co oprogramowanie robi, jak działa, jak jest zbudowane i jak ma być używane. Na przykład, podręcznik użytkownika pokazuje, w jaki sposób użytkownicy powinni wchodzić w interakcję z produktem; natomiast dokument projektowy pomaga programistom w trakcie jego rozwoju i konserwacji. Głównym wyzwaniem jest skonstruowanie zautomatyzowanego narzędzia, które może tworzyć, na żądanie, dynamiczną dokumentację kodu źródłowego oprogramowania. Książka ta przedstawia automatyczne podejście zwane podejściem Al-Msie'deen do generowania dokumentacji oprogramowania na żądanie dla kodu oprogramowania. Nowość tego podejścia polega na tworzeniu dynamicznej dokumentacji kodu oprogramowania na poziomie pakietów, klas, atrybutów i metod. Dokumentacja kodowa jest pisemnym tekstem lub ilustrowanymi schematami, które przedstawiają informacje o wszystkich poziomach ziarnistości kodu, od poziomu pakietów do poziomu metod. Podejście Al-Msie'deen generuje różne rodzaje dokumentacji kodowej, takie jak podsumowania kodu, etykiety, metryki, chmury tagów i dokumenty graficzne.