Istnieją trzy rodzaje dokumentacji. Przy czym pierwszy rodzaj to taki, który… nie istnieje. A o dwóch pozostałych dowiesz się z tego odcinka.
Dziś moim gościem jest Marcin Markowski, a rozmawiać będziemy o dokumentacji i sposobach na utrzymanie jej aktualności. Bo niestety, mało co tak przeszkadza podczas pracy jak dokumentacja, na której nie można polegać.
W tym odcinku rozmawiamy z Marcinem m.in. o:
- co i dlaczego warto dokumentować podczas prac nad projektem,
- typowych problemach z dokumentacją, w tym
- koncepcie Living Documentation autorstwa Cyrille Martraire,
- strategiach i konwencjach pozwalających utrzymać aktualność dokumentacji wbudowanej w projekt,
- założeniach modelu P3 i różnych perspektywach dokumentacji.
Nie mogło oczywiście zabraknąć wątku związanego z utrzymywaniem wiedzy projektowej na Confluence… A w kilku miejscach wodze fantazji zostaną delikatnie puszczone.
Materiały dodatkowe:
- Living Documentation: Continuous Knowledge Sharing by Design, 2015, wspomniana w odcinku książka Cyrille Martraire
- Leaving Documentation, or Living Documentation?, prezentacja na wspomniany temat autorstwa Cyrille'a z konferencji SoCraTes
- Documenting Software Architectures: Views and Beyond, Felix Bachmann, Len Bass, David Garlan, 2002
- P3 Model, strona projektu Marcina i Łukasza Szydło na GitHubie, na ten moment informacyjnie o projekcie
- Dokumentacja, która sama się pisze, prezentacja Marcina z Boiling Frogs i 4Developers 2023
- marcin@twitter, profil Marcina na Twitterze
Zapraszam!
