Dokumentowanie procesu wytwarzania oprogramowania

<right>Łukasz Lechert</right>

Tworzenie oprogramowania wiąże się z ryzykiem, które jest tym większe im większe jest przedsięwzięcie. Aby zmniejszyć ryzyko niepowodzenia, umożliwić zapanowanie nad komponentami systemu, ułatwić modyfikacje systemu w przyszłości, tworzy się dokumentację. Dokumentacja, ogół dokumentów papierowych i elektronicznych powstających podczas prac nad oprogramowaniem i podczas jego konserwacji. Można wyróżnić kilka typów dokumentów, które powstają w trakcie trwania projektu:

• Protokoły posiedzeń zespołu nadzoru i innych posiedzeń roboczych
• Raporty przesyłane do kierownika projektu
• Raporty kierownika projektu kierowane do rady projektu
• Raporty kierownika projektu kierowane do zarządu firmy
• Specyfikacje
• Żądania zmiany wymagań lub naprawy błędów
• Plany testów
• Wyniki testów
• Podręczniki użytkownika i administratora

Dokumentacja powinna posiadać cechy, wskazujące na jej jakość. Aby wytworzyć dokument dobrej jakości należy spełnić wybrane podstawowe warunki:

• Kompletność - Nie można dopuścić do sytuacji, gdy pewne części systemu zostaną pominięte w opisie,
• Spójność - Nie można dopuścić do sprzeczności poszczególnych fragmentów treści w dokumentacji.
• Poprawność formalna - Dokumentowanie projektu musi być prowadzone zgodnie z przyjętym w firmie standardem, szczególnie, gdy komponenty systemu są wytwarzane przez różne zespoły.
• Zrozumiałość - Należy uważać na język i styl stosowany przy tworzeniu dokumentów. Stosowanie języka technicznego należy wyważyć, gdyż dokumentacja tworzona jest dla ludzi i powinna być dla nich zrozumiałą,
• Aktualność - Dokumenty muszą podlegać procesowi zarządzania oraz posiadać aktualną zawartość.

Projekt informatyczny to z reguły wiele plików i dokumentów powiązanych ze sobą w ścisły i skomplikowany sposób. Zarządzanie taką ilością informacji bez wspomagania ze strony systemu komputerowego jest zadaniem skomplikowanym, dlatego wprowadza się do użytku tzw. systemy kontroli wersji, systemy do wspomagania pracy grupowej, systemy do zarządzania dokumentami i treścią. Są to narzędzia pozwalające osobie lub grupie osób pracujących nad projektem na śledzenie modyfikacji plików, szybkie i dokładne anulowanie wprowadzonych zmian a także prowadzenie dziennika, w którym opisywane są przyczyny wprowadzenia poprawek. W wielu wypadkach systemy te są udostępniane na licencjach open source.

Do najbardziej znanych należą:

• SVN (Subversion)
• CVS (Concurrent Version System)
• TYPO3
• Liferay Portal
• EGroupWare

Nie istnieje uniwersalny, ogólnie przyjęty format dokumentacji. Praktycznie duża liczba firm wytwarzających oprogramowanie korzysta z formatów wywodzących się z konkretnej metodyki zarządzania projektami lub używa własnego, wewnętrznie opracowanego sposobu przetwarzania dokumentów. Dokumentacja procesu wytwarzania oprogramowania jest istotnym czynnikiem sukcesu projektu informatycznego, zwłaszcza przy dzisiejszym postępie i szybkości produkcji.