Osoba odpowiedzialna za dokumentacje powinna wygenerować odpowiedni JavaDoc dla wszystkich klas i metod w nich zawartych. Treść powinna pokrywać się z założoną przez devów implementacją, tak więc osoba tworzącą JavaDoc powinna dokładnie omówić jego treść z devami. Może ona również skorzystać z opisu projektu i opisu klas w sekcji Issue, z czego, musi uwzględnić, że założenia mogą odbiegać od implementacji.
Przykładowy skład JavaDoc:
Opis klasy
Dokładny opis metod klasy zawierający: poprawny sposób wywołania, cel metody, oczekiwany wynik, co uzyskanie danego wyniku oznacza dla korzystającego z metody, możliwe niepowodzenia i ewentualne wyjątki
Funkcjonalność.
Osoba od dokumentacji powinna przygotowywać się z opisem zaimplementowanej funkcjonalności w programie z uwzględnieniem w jaki sposób jest ona spełniona.
Ponieważ program jest w trakcie rozwoju, opis ten będzie ulegał zmianie, aż do końca jego pisania.
JavaDoc
Osoba odpowiedzialna za dokumentacje powinna wygenerować odpowiedni JavaDoc dla wszystkich klas i metod w nich zawartych. Treść powinna pokrywać się z założoną przez devów implementacją, tak więc osoba tworzącą JavaDoc powinna dokładnie omówić jego treść z devami. Może ona również skorzystać z opisu projektu i opisu klas w sekcji Issue, z czego, musi uwzględnić, że założenia mogą odbiegać od implementacji.
Przykładowy skład JavaDoc:
Funkcjonalność.
Osoba od dokumentacji powinna przygotowywać się z opisem zaimplementowanej funkcjonalności w programie z uwzględnieniem w jaki sposób jest ona spełniona.
Ponieważ program jest w trakcie rozwoju, opis ten będzie ulegał zmianie, aż do końca jego pisania.