Mentionsy Mentionsy
Everything as code
Everything as code

Odcinek 16 - Generowanie dokumentacji z kodu źródłowego

07.01.2025 ·7 min 11 s

Jak można ulepszyć lub uprościć tworzenie dokumentacji ? Jak zadbać o aktualność danych zawartych w dokumentacji ? Na te pytania odpowiem w odcinku, a materiały znajdziesz na https://github.com/sebastianczech/podcast-everything-as-a-code/tree/main/episode-016.

Co zrobić, by tę dokumentację mieć najświeższą, by była powiązana z kodem źródłowym aplikacji, nad którą pracujemy. Istnieje szereg rozwiązań, które pozwolą Ci to osiągnąć. Pozwolą Ci mieć dokumentację zawsze aktualną, usunąć niektóre czynności manualne, czyli zamiast aktualizować Confluenza czy jakiś dokument na SharePointie, aktualizujemy ją bezpośrednio w kodzie źródłowym, który piszemy. Ponadto dzięki temu nasz kod, nad którym pracujemy, staje się bardziej czytelny, przejrzysty, bowiem zaraz obok tego kodu, nad którym pracujemy, jest też fragment dokumentacji, który opisuje właśnie ten kawałek kodu.

Pokazano wszystkie 1 dopasowanie. Transkrypcja generowana automatycznie i niesprawdzana ręcznie — może zawierać błędy.