Pieprzyć dokumentację
Dosyć.
Straciłem mnóstwo czasu na pisanie dokumentacji. Spis wymagań, projekt … i mnóstwo innych pierdół. Efekt jest taki, że straciłem mnóstwo czasu nie posuwając się wcale do przodu.
Trzeba wziąć się za kod a nie za głupoty.
Advertisement
Przy projekcie jednoosobowym faktycznie nie ma co przesadzać z dokumentacją, ale zaplanować sobie pracę warto.. szczególnie wypisanie funkcjonalności i podstawowych założeń projektowych (obiekty, workflow, sposoby przechowywania danych itp.). Wtedy wiele kwiatków wychodzi już w tym etapie, i nie trzeba potem całego projektu od nowa przepisywać – a to zwykle jest dużo bardziej irytujące
Dokumentacji się nie pisze, no a później jest płacz…
A tak na poważnie to nie warto się rozpisywać co do wymagań, ale na przykład diagram klas bardzo ułatwia sprawę. Postaraj się głównie o to, żeby program było łatwo rozszerzyć o nową funkcjonalność.
? Diagram klas ulatwia sprawe? Diagram klas jest dla ludzi nie umiejacych czytac kodu. Kompletnie nie jest potrzebny, bo wszystko jest w kodzie. Czy jest sens tracic czas na cos co nowy VS generuje? Dokumentacja powinna stanowic niezbedne minimum. Tak jak napisal kolega bigfun – funkcjonalnosci! Inaczej trudno stwierdzic, czy system udalo sie zrealizowac, czy nie. Diagramy przypadkow uzycia, specyfikacje wymagan i inne takie powinny stanowic NARZEDZIE wspomagajace wytwarzanie oprogramowania, a nie produkt! Jesli system jest wdrazany, szczegolnie widac to w duzych firmach, to kazda zmiana kodu deaktualizuje dokumentacje. Posiadajac szczegolowa dokumentacje, albo bezpowrotnie tracimy czas na jej tworzenie (bo poprawianie bledow i zmieny ja zdeaktualizuja), albo zwiekszamy koszt poprawki przynajmniej 2krotnie – wykonanie zmiany, aktualizacja dokumentacji. Zamiast inwetsotwac czas w dokumentacje, lepiej pojsc w kierunku dobrze przygotowanych, zautomatyzowanych testow jednostkowych i integracyjnych. Tego typu dokumentacja jest zdecydowanie lepsza, poniewaz nie dosc ze od razu zaklada nam kontrakt na kod, to pokazuje jak ten kod wykorzystac, bez zadnych nieprzydatnych do niczego diagramow.
Pozdrawiam.
Co powiesz na wymianę linków ? Twój już u mnie jest.