Programisto nie lekceważ dokumentacji!

Każdy początkujący programista nie zwraca uwagi na takie „pierdoły” jak pisanie różnego rodzaju dokumentacji. Niestety, ale większość książek uczy jedynie składni danego języka programowania, a nie wspominają nic o potrzebnie robienia dokumentacji…
Owszem – tworzenie dokumentacji do programu, który ma raptem 20 linijek i wykonuje jakąś bardzo prostą rzecz mija się z celem. Jednak sprawa wygląda zupełnie inaczej, gdy pisze się program mający kilka tysięcy linijek kodu wykonujący wiele drobnych czynności. Jeśli praca trwa kilka miesięcy, to trudno po tym czasie przypomnieć sobie jakieś szczególiki dotyczące funkcjonalności. Załóżmy, że piszę program wystawiający faktury. Jedną z funkcjonalności może być naliczanie np. x% rabatu gdy zamówienie jest na kwotę 1000 zł. Tylko czy to 1000 zł ma być kwotą brutto czy netto??

Pisząc nawet na kartce papieru ogólne założenia projektu przed rozpoczęciem pracy oszczędzam sobie różnych problemów w przyszłości, gdyż w razie wątpliwości rzucam okiem na swoje notatki. Nad im większym projektem pracuję, tym bardziej zaczynam doceniać fakt, że gdzieś wcześniej napisałem prosty dokument na kilka stron. Oczywiście w owej dokumentacji należy opisać takie rzeczy jak ogólne informacje co ma dany program robić, wymienić wszystkie opcje, które się planuje zrobić, opisać różne wątpliwości jakie mogą się nasunąć w przyszłości (np. czy dane obliczenia mają być na kwotach netto, czy brutto) i najważniejsze: dokładnie opisać strukturę bazy danych. Oczywiście dokumentacja jest z czasem aktualizowana (np. podczas pracy stwierdzam, że założenia są OK, ale brakuje jakiejś funkcjonalności i muszę nieco zmienić strukturę bazy danych – to wtedy trzeba koniecznie zaktualizować dokumentację).

Niestety, ale książki nie zawsze wspominają o takich drobiazgach jak pisanie dokumentacji. Na początku nikt nie pisze dokumentacji, gdyż pierwsze programiki są proste i wykonują jedną banalną czynność. Z czasem pisze się coraz większe programiki, aż dochodzi się do większych projektów, ale zły nawyk nie pisania dokumentacji pozostaje.

Dlatego zachęcam każdego programistę, który pisze jakiś nieco większy projekt, aby zaczął pisać dokumentacje jeśli jeszcze tego nie robi. Mnie pisanie dokumentacji kilka razy uratowało tyłek.

Comments are closed.