Korzyści wynikające z prowadzenia dokumentacji

Etap wykonywania dokumentacji do projektu może z pozoru wydawać się zupełnie niepotrzebny, a za razem czasochłonny. Formalizacja i archiwizacja bieżącego stanu wiedzy jest jednak bardzo ważnym etapem, gdyż nie ma możliwości zapamiętania wszystkich szczegółów, które w przyszłości mogą okazać się bardzo pomocne. Tworzenie opisów można podzielić na trzy zasadnicze grupy:

  • Dokumentacja badawcza
  • Dokumentacja użytkownika
  • Dokumentacja techniczna
  • skalowanie pionowe

    Dokumentacja badawcza

    Tworzenie nowych rozwiązań wymaga wybierania konkretnych rozwiązań spośród wachlarza technologii oraz możliwości technicznych. Decyzja o finalnie zastosowanym rozwiązaniu dla konkretnej sytuacji wymaga szczegółowej analizy oraz testów porównawczych. Zakończone badanie koniecznie należy udokumentować notując informacje odnośnie: warunków badawczych, infrastruktury, przebiegu badania, wynikach i na końcu oczywiście wnioski. Poprawnie stworzony dokument pozwala na dokładne odtworzenie badania i uzyskanie niemal identycznych wyników przez osobę która nie robiła tego wcześniej. Ogromną zaletą jest możliwość szczegółowej analizy wyników po upływie czasu, bez konieczności powtarzania procesu testu.

    Dokumentacja użytkownika

    Choć wiadomo jak jest w praktyce - nieliczni ją otwierają :-), to z całą pewnością warto pisać jak i czytać instrukcje obsługi. Większość produkowanych urządzeń oraz oprogramowania sama w sobie jest intuicyjna. "Paint", jest skonstruowany w taki sposób, że użytkownik otwiera go pierwszy raz w życiu i jest w stanie samodzielnie go ujarzmić. Dobrze przygotowana, szczegółowa dokumentacja pozwala na zapoznanie się dodatkowymi możliwościami, oraz uproszczeniami w produkcie.

    skalowanie poziome

    Dokumentacja techniczna

    Większość przygotowanych rozwiązań z czasem wymaga albo rozwoju w celu dostosowania do zmieniających się potrzeb, albo wsparcia. Tutaj nie pomoże ani dokumentacja badawcza, ani zwykła instrukcja obsługi. Aby móc dokonać wszelakich zmian w projekcie potrzebna jest szczegółowa dokumentacja, pozwalająca zapoznać się z technicznymi aspektami danego rozwiązania. Może to być opis oprogramowania w formacie ERD, UML, diagramy, opisy algorytmu, funkcji, zmiennych, a także schematy elektryczne i mechaniczne które znacznie przyspieszają proces modyfikacji.

    Przygotowanie dokumentacji ma widoczny wpływ na czas trwania projektu. Rezygnacja z tego etapu niesie jednak za sobą ogromne konsekwencję. Brak solidnej dokumentacji, z czasem zawsze wróci w postaci marnowania jeszcze większych zasobów.