Nikt nie lubi pisać dokumentacji. I pewnie niewiele osób lubi ją czytać. Jeszcze stosunkowo niedawno byłem przekonany, że jakakolwiek dokumentacja jest zbędna jeśli soft jest dobrze napisany. Okazało się to nie do końca prawdą.
Trzeba umieć znaleźć złoty środek w dokumentowaniu swojego kodu. Proste to nie jest. Zainteresowanych tematem odsyłam do tego video z prezentacją o tym “jak MOŻNA podejść do tworzenia dokumentacji”: Simon Brown – Software Architecture as Code.
A wszystkich zostawiam z poniższą myślą:
Documentation is like sex. When it’s good, it’s very good. When it’s bad, it’s better than nothing
Źródło: Dick Brandon
Zgadzam sie, od lat mam zawsze doca a od dwóch, trzech lat onenote max 5stron a4 z opisem i dokumentacja. Nie jest ona super wyczes hiper coś tam, ale jest i mówi to co trzeba.