Brak dokumentacji - co robić?

Dokumentacja projektu pomoga w przeprowadzeniu testów. Ale co robić, gdy tego typu dokument po prostu nie istnieje?

10/18/2023

Dokumentacja projektowa jest świetnym źródłem wiedzy o danej aplikacji. To właśnie w dokumentacji powinny być przechowywane wszystkie najważniejsze informacje o oprogramowaniu - pożądane działanie funkcjonalności czy obsługiwane urządzenia i przeglądarki. Niestety, prawda jest taka, że wiele firm po prostu nie posiada dokumentacji tworzonych przez nią projektów. Powodów może być kilka, ale najczęstszą przyczyną jest ograniczony czas. Od zespołu IT wymaga się ciągłego dostarczania nowości, więc pisanie i utrzymywanie dokumentów schodzi na dalszy plan. Jest to oczywiście negatywne zjawisko i (między innymi) utrudnia wdrażanie nowych pracowników - ale kto by się tam tym przejmował...

Wiedza innych pracowników

W przypadku braku dokumentacji (i nie tylko wtedy) niezwykle pomocni okazują się być współpracownicy. Przede wszystkim są to doświadczeni członkowie zespołu, którzy po prostu znają aplikację, jej problemy i wszelkie inne niuanse. Macie wątpliwości, jak dana funkcjonalność powinna działać? Pytajcie innych pracowników. Nie jesteście pewni, czy poprawnie przetestowaliście dany obszar oprogramowania? Nie wstydźcie się prosić o pomoc. Oczywiście, od strony biznesowej poleganie wyłącznie na wiedzy zatrudnionych jest beznadziejną praktyką - bo co w sytuacji, gdy dana osoba postanowi odejść? Cały zasób wiadomości odejdzie razem z nią.

Testy eksploracyjne

Świetnym źródłem wiedzy o danej aplikacji są testy eksploracyjne. Uważam, że to powinien być jeden z pierwszych kroków testera w nowym projekcie. "Przeklikanie" całego oprogramowania zapozna Was z działaniem poszczególnych obszarów i da Wam ogólne pojęcie o logice aplikacji. Co więcej, być może odkryjecie jakieś błędy. Niejednokrotnie nowi testerzy wykrywają nieznane wcześniej bugi - uwierzcie, świeża głowa (bez wyuczonych już ścieżek klikania) jest niesamowitym wsparciem w szukaniu błędów. Testy eksploracyjne warto połączyć z kontaktem ze współpracownikami - nie bójcie się zadawać pytań, gdy nie rozumiecie działania danej funkcjonalności.

Tworzenie własnej mini-dokumentacji

Na nic zda się proszenie o pomoc zespołu i wykonywanie testów eksploracyjnych, jeśli zebrana wiedza po chwili przepadnie. Firma nie dostarczyła dokumentacji? Twórzcie swoją! Oczywiście, nie mam tu na myśli oficjalnego dokumentu, lecz czegoś prostego do użytku własnego. Ścieżki do wyklikania danego zachowania, wykryte problemy czy obszary aplikacji narażone na błędy - zapisujcie wszystko, co przychodzi Wam do głowy. Forma nie ma tu żadnego znaczenia. Dokument będzie przecież tylko dla Was, więc sprawdzi się tu nawet tradycyjny zeszyt i długopis.

Tego typu notatki wspomogą Was w niejednej sytuacji. Musicie wykonać testy regresji? Nie ma sprawy, własna mini-dokumentacji służy pomocą. Ponadto, współpracownicy docenią, że nie pytacie w kółko o to samo, bo możecie swobodnie wracać do raz omówionego problemu. A gdy ktoś postanowi rozstać się z firmą, to zdobyta od niego wiedza pozostaje w Waszych notatkach.

A Wy jak robicie sobie z brakiem dokumentacji? Napiszcie w komentarzach poniżej!

brak dokumentacji
brak dokumentacji

Dziękuję, że czytasz mojego bloga!

Masz jakieś pytania? Z chęcią odpowiem :)

Radosław Wasik
Radosław Wasik