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

W projektach si, dokumenty są przedstawiane klientowi jako dowód na to, że projekt został dobrze zrealizowany.

Zaczynając od propozycji, poprzez specyfikację ekranów, dokumentację projektową, podręczniki użytkownika, po każdą fazę projektu od propozycji, poprzez projektowanie, rozwój, testowanie, uruchomienie, aż po operacje, istnieje wiele dokumentów, które należy sporządzić, a zwykle są one przypisywane nowym programistom.

Podczas tworzenia dokumentacji może pojawić się myśl, że to nie tak chciałem być programistą, a raczej pracownikiem biurowym. W Polsce często zdarza się, że dokumentacja dla poszczególnych etapów projektu jest przygotowywana tuż przed zakończeniem projektu, a powody są następujące:

• Krótkie terminy realizacji projektu wymuszają jak najszybsze tworzenie produktu, a dokumentacja jest tworzona na szybko, aby sprostać wymogom terminowym.
• Nawet jeśli dokumenty są tworzone etapami, wymagania i tak są dodawane i zmieniane, dlatego szybsze jest ich sporządzenie po zakończeniu projektu, niż tworzenie i edycja w trakcie pracy.

Choć kolejność jest nieprawidłowa, to w polskiej kulturze si jest to naturalnie rozwijany sposób działania.

Istnieje wiele narzędzi do tworzenia specyfikacji ekranów, ale można też zobaczyć prawdziwy cud - specyfikację ekranów zrobioną na podstawie zrzutów ekranu z gotowego oprogramowania.

Programistom zazwyczaj nie podoba się tworzenie dokumentacji, ale cóż, jesteś nowym pracownikiem.

Nowi pracownicy stają się łatwym celem do delegowania zadań związanych z dokumentacją. I tak nie będziesz od razu programował, więc można ci zlecić tworzenie dokumentów.

I tak, jeśli sam się tego nauczysz, będziesz mógł zlecić to zadanie następnemu nowemu pracownikowi, więc spróbuj stworzyć coś dobrego, kiedy masz okazję.