Czy tworzenie dokumentacji technicznej Magento jest istotne podczas tworzenia sklepu internetowego?

Czy tworzenie dokumentacji technicznej Magento jest istotne podczas tworzenia sklepu internetowego?

Jak wszystkim wiadomo Magento jest jedną z najbardziej popularnych platform do prowadzenia sklepów internetowych. Firmy wybierają Magento z różnych powodów, jednym z nich jest łatwa możliwość zmiany firmy tworzącej naszą platformę na inną - lepszą, tańszą. I właśnie w tym momencie najczęściej pojawia się kwestia dokumentacji do Magento.

Jaką rolę pełni dokumentacja techniczna w rozwoju naszego sklepu internetowego opartego o Magento?

Zmiana firmy rozwijającej nasz sklep internetowy oparty o Magento to nie takie łatwe zadanie jakby się mogło wydawać. Każda instalacja Magento jest inna, w każdej instancji są użyte inne moduły pochodzące od różnych dostawców, a także jest wprowadzane szereg różnych zmian w skórce sklepu, ale także w jego mechanizmach i wszelkich funkcjonalnościach. Każdy programista robi to na swój własny sposób, który tylko jemu jest znany.

I w tym własnie momencie powinna każdemu z nas zapalić się czerwona lampka: ... każdy programista Magento robi to na swój własny sposób, który tylko jemu jest znany...

Co to oznacza w praktyce?

W praktyce oznacza to, że inny developer Magento tą samą czynność, by osiągnąć postawiony przez klienta cel z 99% prawdopodobieństwem zrobi inaczej.

Co się dzieje gdy zmienimy firmę/programistę rozwijającego nasze Magento?

Nowy deweloper musi gruntowanie zapoznać się z naszą instancją Magento, by móc ją dalej rozwijać, a by mu to ułatwić powinniśmy mu dostarczyć szczegółową dokumentację techniczną rozwoju naszej instancji Magento.

Jeśli mu tego nie dostarczymy może to oznaczać, iż nasz nowy deweloper musi prześledzić tysiące linijek kodu, by znaleźć jakiś szczegół powodujący błędy przy wprowadzaniu jakichkolwiek, choćby najmniejszych modyfikacji.

Ponadto należy pamiętać, że wiele modułów w naszym sklepie opartym na Magento jest zapewne modułami autorskimi tej firmy i ich modyfikacja czy wręcz najprostsza aktualizacja może być wielce kłopotliwa bez dokładnej dokumentacji technicznej, nie wspominając już o aspektach prawnych modyfikowania kodu źródłowego przez innego programistę (a to już wątek na osobny artykuł jakie zapisy powinna zawierać umowa z deweloperem by nie było przeszkód prawnych w rozwoju autorskiego rozwiązania przez innego programistę).

Tak więc jak z powyższego widać rola dokumentacji technicznej tworzonej przez dewelopera jest często niedoceniana i nie jest jej poświęcana wystarczająca uwaga. Problem ten dopiero pojawia się w momencie kiedy zmieniamy dewelopera i okazuje się, ze nasza dokumentacja jest szczątkowa, niepełna lub wręcz jej w ogóle nie ma.

Efektem braku dokumentacji technicznej lub jej niekompletności są dodatkowe koszty po stronie nowego dewelopera na analizę dotychczasowego kodu, które w skrajnych przypadkach kończą się czasem napisaniem lub wdrożeniem nowego modułu wykonanego przez naszego nowego dewelopera, bo może się okazać iż będzie to tańsze rozwiązanie niż analiza dotychczasowego kodu w celu wprowadzenia jakiś choćby najdrobniejszych zmian.

Reasumując, w tym momencie powinniśmy się zastanowić czy zawsze zmiana dewelopera pozwoli nam zaoszczędzić pieniądze, jeśli wcześniej nie zadbaliśmy o dobrą dokumentację techniczną przy rozwoju naszej platformy e-commerce opartej o Magento.