Znaczenie dokumentacji w projektach software'owych
Znaczenie dokumentacji w projektach software'owych
Dokumentacja jest kluczowym elementem każdego projektu oprogramowania, a w szczególności w przypadku projektów open source. W Yoast wierzymy, że dobra dokumentacja buduje dziedzictwo, które pozwala innym kontynuować pracę nad projektem.
Bez względu na to, czy dopiero zaczynasz, czy jesteś doświadczonym programistą, zawsze istnieje potrzeba jasnych wyjaśnień i wskazówek. Często zdarza się, że wracamy do kodu, który napisaliśmy lata temu, i czujemy wstyd za jakość naszej pracy. Zdarzało mi się prosić, by usunięto moje imię z stopki stron, które stworzyłem.
Niektórzy programiści sądzą, że dokumentacja pisze się sama, ponieważ ich kod jest na tyle dobry, że nie potrzebują dodatkowych wyjaśnień. To może być ambitny cel, ale w praktyce często okazuje się, że wsparcie w postaci dokumentacji jest niezbędne.
Na podstawie: Źródła
