W każdej dokumentacji uważam, że podejście zwinne jest dobre. Istnieją pewne nieporozumienia, że zwinny oznacza „brak dokumentacji lub analizy”, ale tak nie jest. Rzeczy, które czytałem o zwinnym, mówią: „użyj tego, co działa”. Rozumiem, że oznacza to, że dokument powinien mieć długość i szczegółowość proporcjonalną do zadania.
Szablony mogą być pomocne jako lista kontrolna, ale nie wymagałbym wypełniania każdej sekcji w przypadku zmian o małym lub niskim ryzyku. W przypadku zmiany jednej linii może w ogóle nie potrzebujesz dokumentu. Nigdy nie korzystałem z szablonu dokumentu analizy wpływu, ale regularnie mam do czynienia z wymaganiami biznesowymi lub specyfikacjami technicznymi. Szablon może być zbyt restrykcyjny; dobrą wytyczną jest zamiast tego zastanowienie się, kim będzie publiczność. Jeśli dotyczy to menedżerów, którzy nie są techniczni, skoncentruj się na biznesowym uzasadnieniu zmiany. Jeśli jest to dla ludzi technicznych, podaj trochę tła, aby nowa osoba w zespole nie zginęła i daj im wystarczająco dużo, aby mogli zacząć, jeśli będą musieli wesprzeć zmianę. Ponadto, jeśli chcesz czegoś jeszcze bardziej pozbawionego tarcia i lekkiego, nie używaj w ogóle dokumentu, umieść go na wiki.
Informacje, które należy uwzględnić:
- Krótki opis problemu
- Wyjaśnij lub pokaż przykład, w jaki sposób wada powoduje awarię i / lub nieefektywność
- Uwzględnij oszacowanie złożoności
- Uwzględnij szacunkowy koszt i czas naprawy
To przyzwoite minimum. W drugim poście podkreślono niektóre dość ciężkie materiały CMMi od IBM; to świetnie, jeśli masz na to czas i zasoby (a gdy budujesz systemy dla NASA, w których zagrożone jest życie ludzkie, ludzie powinni poważniej o to mówić), ale w małych zespołach prawdopodobnie nie musisz być taki ciężki . Ostrożnie z oszacowaniem, jak zawsze. Menedżerowie mają skłonność do zakładania, że oszacowanie jest faktyczne.
Zwróć uwagę, że podejście zwinne wiąże się z niebezpieczeństwami. Niektórzy programiści uważają, że oznacza to: „nie potrzeba żadnych dokumentów, po prostu zacznij się hakować” (co może być OK w niektórych sytuacjach). Ponadto inni wezmą swobodę, biorąc pod uwagę zadanie, i po prostu napiszą naprawdę kiepskie dokumenty, które tak naprawdę nie pomagają (niekoniecznie OK w większości sytuacji). Część problemu polega na tym, że dobre pisanie wymaga wysiłku, umiejętności i czasu; większości z nas brakuje co najmniej dwóch z tych rzeczy;)
Zawsze bardzo lubiłem dokumentację, ponieważ dowodzi to, że przynajmniej tyle się zastanowiłeś, aby zakwalifikować się jako posiadający plan. Ale na starość zdałem sobie również sprawę, że zbyt dużo dokumentacji może stać się kłopotem z utrzymaniem i że zbyt mało ludzi dba o to, aby dokumentacja była aktualizowana.