Szablon dokumentacji projektowej

Celem projektu jest wyłącznie wytworzenie dokumentacji. Nie jest oczekiwana implementacja lub przygotowanie prototypów. Projekt należy sporządzić wyłącznie jako dokument w formacie DOC lub PDF (nie w postaci źródłowej, np.. Viso, JPG, GIF, TeX!)

Spójność

Projekt powinien być spójny i zapewniać możliwość prześledzenia, w jaki sposób elementy poprzednich faz są odwzorowane na fazy następne.

  • Identyfikatory przypadków użycia muszą być odwzorowane na opisy schematów w części projektowej.
  • Nazwy klas powinny opisywać rysunki w specyfikacji interfejsu
  • Nie należy identyfikować zbyt wielu przypadków użycia, należy unikać złożonych relacji i zbyt krótkich scenariuszy.

Przy poszczególnych punktach podano oczekiwaną objętość.

Styl

Należy stosować środki zwiększające czytelność: tabele, wyliczenia, nagłówki. Należy unikać ciągłego tekstu, zwłaszcza przy opisie scenariuszy.

specif/template.txt · Last modified: 2012/10/16 02:56 by pszwed
CC Attribution-Share Alike 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0