[Historia programisty SI] 10. Co to jest dokumentacja w projekcie SI?

Historia programisty SI
#10. Czym jest dokumentacja w projekcie SI?

W projektach SI konieczne jest dostarczenie klientowi dokumentacji potwierdzającej prawidłowe wykonanie projektu.

Począwszy od propozycji (briefu), poprzez specyfikację ekranów, dokumentację projektową, instrukcje obsługi użytkownika, itd. – na każdym etapie projektu, od propozycji, przez projektowanie, rozwój, testowanie, wdrożenie aż po późniejszą eksploatację, istnieją dokumenty, które należy przygotować. Zazwyczaj zadanie to przypada na barki początkujących programistów.

Podczas tworzenia dokumentacji zdarza się, że zaczynamy się zastanawiać, czy aby na pewno chcieliśmy być programistami, czy może jednak urzędnikami. W Polsce bardzo często wszystkie wymagane dokumenty tworzone są tuż przed zakończeniem projektu. Wynika to z kilku przyczyn:

• Krótki czas trwania projektu wymusza jak najszybsze jego wykonanie, a dokumentacja ma być jedynie „ładnym opakowaniem” pozwalającym na dopełnienie formalności w ustalonym terminie.
• I tak wymagania będą się zmieniać i pojawiać nowe, więc łatwiej jest przygotować dokumenty na końcu, dopasowując je do finalnego produktu, niż tworzyć je na bieżąco i później modyfikować.

Paradoksalnie, choć kolejność działań jest nieprawidłowa, taki sposób postępowania stał się w polskiej kulturze SI czymś naturalnym i ewoluował w ten sposób.

Narzędzi do tworzenia specyfikacji ekranów jest wiele, ale można też zobaczyć cuda, jak np. tworzenie specyfikacji ekranów na podstawie zrzutów ekranu z gotowej aplikacji.

Zazwyczaj programiści nie przepadają za pisaniem dokumentacji, ale co zrobić, skoro jesteś świeżo upieczonym programistą?

Najłatwiej jest powierzyć zadanie tworzenia dokumentacji nowym pracownikom. Skoro i tak nie można im od razu powierzyć poważniejszych zadań programistycznych, to niech chociaż piszą dokumentację.

Skoro i tak będziesz musiał to kiedyś zrobić, to warto się przyłożyć i stworzyć dobrą dokumentację, którą później będzie można wykorzystać dla kolejnych pracowników.