Maciej Dusza

Maciej Dusza

Wszystkie artykuły autora

Jak poprawnie tworzyć dokumentację

118
Pisanie dokumentacji często traktowane jest przez programistów, jak ciężka kara i dopust boży. Z nieco większym zrozumieniem odnoszą się do tego kierownicy projektów, zwłaszcza ci, którzy kiedyś w połowie projektu stracili pracownika będącego "guru od systemu/programu/modułu" i musieli w trybie nagłym wdrażać do pracy nową osobę, przegryzając się przez tysiące linii nieudokumentowanego i często pozbawionego komentarzy kodu.

Jak porządnie opisać znaleziony defekt?

686
Defekty znalezione w oprogramowaniu można dokumentować na różne sposoby, używając różnych narzędzi. Istnieje jednak kilka uniwersalnych cech, niezależnych od techniki prowadzenia dokumentacji, które decydują o jakości opisu defektu.