Cześć Wszystkim!
Pod opiekę dostałem dużą stronę internetową. Generalnie większość to php plus kilka jakichś wstawek javascript. Jeśli chodzi o webdev to daleko mi do bycia wyjadaczem (jestem w trakcie studiów i jakoś specjalnie dużo nie programowałem w php/javascript). Do tej strony nie mam żadnej dokumentacji, a pewne zmiany trzeba wprowadzać i tutaj pojawia się moje pytanie: jak sobie poradzić w takich przypadkach? Robić dokumentację równolegle z wprowadzanymi zmianami? Spróbować pierw zrobić dokumentację? W ogóle nie robić i wprowadzać zmiany jak leci i się nie przejmować? Napisanie od początku raczej odpada, przynajmniej jako projekt dla jednej osoby. Poproszę o jakieś rady, sugestię. Jak Wy sobie radziliście w takich sytuacjach?
Za jakiekolwiek odpowiedzi z góry dziękuję!
Dokumentacja jest dla osób, które będą pracować nad tym projektem po Tobie więc skoro inni mieli to w d... to ja na Twoim miejscu też bym się nie przejmował.
Jeżeli nikt Ci tego nie zlecił to dlaczego niby miałbyś to robić?
Jeżeli będzie Ci tak łatwiej to dokumentuj zmiany, które wprowadzasz żebyś później szybciej coś znalazł/zrozumiał.
W każdym razie to od Ciebie zależy czy Ci się chce to robić. Jeżeli się chce to wiadomo, że zawsze lepiej mieć dokumentacje niż nie mieć;)
Miałem do czynienia z taką sytuacją - dostałem "pod opiekę" stronę napisaną przez amatora w PHP4, do której musiałem dodawać kolejne funkcje i usprawniać działanie istniejących.
Dokumentacji tego co zastałem nie zrobiłem, ale:
- część czasu pracy została przeznaczona na optymalizację istniejących rozwiązań (za zgodą pracodawcy - na przykład przy dodawaniu elementów do front page ulepszyłem zapytania SQL przez co strona była znacznie szybsza - a przy okazji podmieniłem mysql_query na własną klasę - to było przez PDO);
- niektóre rzeczy, które zostały z poprzednich wersji, były usuwane jeżeli znalazło się pliki bez żadnych dowiązań do nich;
- wszystko zostało wrzucone do repozytorium kodu, więc dało się w razie potrzeby wrócić zmiany;
- każdy nowy fragment kodu był opatrzony komentarzami - zarówno nowe klasy i pliki (PHPDoc), jak i zmiany w istniejących plikach.
Poza tym bardzo przydatne było narzędzie findstr.exe i wiersz poleceń w Windows, do wyszukiwania gdzie tu jeszcze są jakieś odwołania do danego pliku na przykład ;-)