print
A A A

Dokumentacja projektu

Elementem uzyskiwania wysokiej jakości oprogramowania jest prawidłowa dokumentacja procesu wytwarzania i samego oprogramowania.

Dokumentację można i powinno się (wymagają tego np. normy ISO9000) prowadzić na wszystkich etapach wytwarzania. Dokumentacja jest najczęściej tworzona zgodnie z pewnymi standardami (także udokumentowanymi). Dokumentacja jest elementem najbardziej lubianym przez urzędników, a najmniej lubianym przez programistów (dlatego popularne są metody dokumentowania w oparciu o kod źródłowy).

W fazie realizacji procesu wytwarzania oprogramowania dokumentacja może obejmować:

  • plany, harmonogramy, szacunki
  • wszelkiego typu projekty i modele systemu oraz jego elementów (różnorodne diagramy, schematy, algorytmy) związane z wszystkimi fazami procesu wytwarzania oprogramowania
  • raporty
  • kod źródłowy
  • korespondencja, wymiana informacji na temat projektu między członkami zespołu realizującego

W skład dokumentacji końcowej (dostarczanej odbiorcom) najczęściej wchodzą:

  • ogólny funkcjonalny opis systemu
  • przewodnik użytkownika (user's guide)
  • pełny opis systemu (reference manual)
  • przewodnik instalacji i podręcznik administratora
  • dokumentację wersji (wydania, release notes)

Zaletą dobrej dokumentacji jest posiadanie szczegółowego spisu treści, słownika pojęć i bogatego indeksu. Coraz częściej dokumentacja dostarczana jest wyłącznie w formie elektronicznej wraz z systemem. Alternatywnie dokumentacja dostępna jest przez sieć

«Zarządzanie jakością     Zarządzanie wersjami i zmianami»