Dokumentacja projektów programistycznych

Dawid — Thu, 26 Mar 2009 19:55:12 +0000

Tak się jakoś (szczęśliwie?) złożyło, że staram się skończyć z programowaniem czegokolwiek na zasadach tzw. cowboy-coding’u – czyli pisania kodu na podstawie kilku świstków, które – w zamierzeniu ich autorów – stanowić miały dokumentację techniczno-funkcjonalną, do tego – całkowicie wyjaśniać, co się po mnie jako wykonawcy projektu zleceniodawca spodziewa.
Zazwyczaj był to po prostu świstek papieru z ogólnym opisem, co serwis zawiera, jakaś jedna, bądź dwie mindmapy i to wszystko, na co mogłem liczyć.
Niestety, trudno na takiej podstawie cokolwiek zrobić. Oczywiście dochodzi po czymś takim do rozmowy w stylu: to co Pan/Pani/Państwo opisał/a – kompletnie nic mi nie mówi. Czy mógłbym otrzymać jakiś, hmmm… poważniejszy dokument, pod którym moglibyśmy złożyć nasze podpisy, i który dokładnie by wyjaśniał, o czym my w ogóle rozmawiamy?
Jeśli trafia się na poważnego zleceniodawcę, pewnie po dłuższych lub krótszych negocjacjach taki dokument dostaniemy, a przynajmniej da się go wspólnie „wypracować”. Ale są również takie osoby, które w ogóle nie wiedzą, o co nam chodzi; co gorsza, uważają, że wymagamy od nich Bóg wie czego! „Przecież wszystko jest w tym ^projekcie^, który Pan dostał!”
Niestety, ale często bywa tak, że kiedy człowiek oponuje, często zrywa się z nim kontakt, uznaje za dziwaka, a projekt albo nigdy nie dochodzi do fazy „narodzin”, albo wykonuje go jakiś licealista za 200 złotych („okazyjnie”, bez zbędnych „opisów”).
Trafiłem właśnie na dyskusję na ten ważny temat: http://www.goldenline.pl/forum/webdesign/815801/s/1#16184536
W każdym razie z tej dyskusji można się dowiedzieć więcej na ten temat, niż z takiej Wikipedii, która ogranicza się do podania podziału dokumentacji, jakiś ogólnych haseł i tyle (czytaj tutaj).

Gdzie więc najlepiej szukać informacji na temat najbardziej interesujący programistów, ale też (albo – PRZEDE WSZYSTKIM) – Zleceniodawców?

Nieco akademickiego żargonu można znaleźć tutaj (nie doczytałem do końca, bo mnie to po prostu przeraziło…).
Można również przeczytać ten artykuł, który powinien nam trochę przybliżyć temat, albo przynajmniej nakreślić ogólny obra, czyli wyjaśnić, co się składa na taką dokumentację, co w niem być powinno, itd.
Zanim zabierzecie się za tworzenie własnej dokumentacji, Szanowni Zleceniodawcy, proponuję lekturę tego materiału. Zobaczycie, co Was czeka, jeśli dokumentacja nie zostanie przemyślana, albo w ogóle będziecie unikać jej stworzenia!
Można się oczywiście wesprzeć tym mini-poradnikiem.
Więcej informacji (jak zwykle) znaleźć można w sieci (zresztą, powyższe przykłady również wyszukane zostały za pomocą „gugli”…). Jeśli ktoś z czytelników zna jakiś, bądź napisał dobry manual, który z czystym sumieniem można by upowszechnić wśród Szanownych Zleceniodawców – proszę pisać! Chętnie dołączę tutaj stosowny link!

Dawid pisze... » programiści

Dokumentacja projektów programistycznych