Odkryłem, ŻADNA dokumentacja jest lepsza niż BRAK dokumentacji. Odpowiednia ilość jest zwykle określana przez czas, jaki musimy to zrobić, lub przez to, jak bardzo nienawidzimy obsługi połączeń telefonicznych i e-maili.
Wygląda na to, że twoi obecni członkowie zespołu mają pewne nierealistyczne oczekiwania wobec swoich wspomnień lub wstydzą się swoich umiejętności pisania i nie chcą ćwiczyć.
Zdaję sobie sprawę, że jestem w mniejszości (angielski, który rozpoczął studia inżynierskie w szkole wyższej), ponieważ nie uważam dokumentacji za obowiązek. To cenne profesjonalne narzędzie. Pisanie może być dla mnie trudniejsze niż niektórych moich współpracowników, ale dzieje się tak głównie dlatego, że mam w tym więcej praktyki. Nie uważam projektu za skończony, chyba że ma dokumentację, i zwykle piszę go z czysto egoistycznych powodów: dlatego mogę dać ludziom coś do przeczytania zamiast odbierać telefony i e-maile, lub żeby zapamiętać, o czym rozmawialiśmy ostatnio mniej więcej miesiąc mogę odnieść się do tego, jak coś zrobiłem, jeśli muszę to wesprzeć w środku nocy.
Najlepszym sposobem na zbliżenie się do dokumentacji jest napisanie jej JAK TYLKO, dokładnie tak jak pisanie kodu testowego. To niesamowite, jak kilka gotowych szablonów (z nagłówkami, fragmentami kodu itp.) Może ułatwić i przyspieszyć tworzenie dokumentacji. W ten sposób możesz uchwycić zmiany, które się zdarzają, i masz mniej przestrzeni do pokrycia w czasie. W ten sposób jesteś bardziej wydajny, ponieważ możesz odwoływać się do potrzebnej dokumentacji i zmieniasz ją po drodze. Robiąc to na przykład na wiki, ułatwia aktualizację i możesz uniknąć problemów z wersją dokumentu, jeśli najnowsze i najlepsze są zawsze dostępne online w tym samym miejscu, i możesz po prostu wysyłać linki do osób, które muszą je przeczytać.
Jeśli poświęcisz trochę czasu na dokumentowanie, WSZYSTKO będzie działać szybciej, szczególnie gdy ktoś nowy dołączy do zespołu, ponieważ nie będzie musiał spędzać całego czasu na rozpracowywaniu wszystkiego. Odkrywanie rzeczy jest fajną częścią naszych zadań, ale nie jest fajne, gdy trzeba to robić w pośpiechu, aby naprawić produkcję. Wszyscy zaoszczędzilibyśmy dużo czasu, gdybyśmy wszyscy napisali jeszcze kilka notatek.
Czy Twój zespół ma takie same problemy z testowaniem lub pisaniem kodu testowego? Jeśli nie, będzie to łatwiejsza sprzedaż.
Twoja dokumentacja jest przydatna na wiele sposobów:
1) Dla ciebie, teraz i dla twoich współpracowników, podczas pracy nad projektem.
2) Do twoich klientów. Posiadanie dokumentacji (w tym diagramów), którą można pokazać użytkownikom, ułatwia dyskusje na spotkaniach, zwłaszcza jeśli omawia się skomplikowane systemy. Nawet jeśli dokumentacja jest niekompletna, warto zacząć od niej.
3) Do ludzi, którzy odziedziczą twoją pracę (którym może być ty, za trzy lata). Wielu moich młodszych współpracowników uważa, że zapamiętają rzeczy na zawsze. Wiem, że nie zapamiętam tego w tym tygodniu, jeśli tego nie zapiszę. Posiadanie dokumentacji pozwala uniknąć konieczności spędzania pół dnia na pamiętaniu, jak coś ustrukturyzowałeś, i konieczności ponownego rozpracowywania tego wszystkiego.
4) Tobie i innym, jeśli sytuacja stanie się polityczna lub kontrowersyjna. Jako ktoś, kto robi notatki na spotkaniach, aby nie zasnąć i walczyć z nudą, często byłem jedynym, który napisał wersję decyzji. Osoba, która go zapisała, wygrywa spór. Pamiętasz to następnym razem, gdy ktoś mówi: „Pamiętasz to spotkanie, które mieliśmy zeszłej zimy w sali konferencyjnej 4, kiedy jechaliśmy nad X? Fred tam był i kim jest ten facet z księgowości?”