ZWROT
kod jest dokumentacją
Stanowisko, że opis systemu jest zbędny. Prawdziwe co do faktów i bezużyteczne co do intencji: z kodu widać, co robi, nie widać, dlaczego.
po ludzku: dokumentacji nie ma i tak to nazwiemy
Podaj dalej
Powiązane hasła
to tylko zmiana konfiguracjiUzasadnienie wdrożenia bez zwykłej ścieżki. Konfiguracja jest kodem pod każdym względem poza jednym: nie ma testów.
rozwiązanie jest nieoczywisteOpis działającego kodu albo procesu. Bywa komplementem dla pomysłowości i bywa uczciwym przyznaniem, że nikt nie wie, czemu to działa — a druga wersja jest częstsza i groźniejsza.
dokumentacja jest nieaktualnaStwierdzenie prawdziwe niemal zawsze i rzadko użyteczne. Nieaktualna dokumentacja pozostaje jedyną, więc ostrzeżenie nie zmienia tego, że ktoś i tak będzie z niej korzystał.
nieustrukturyzowana dokumentacjaOpis dokumentacji, w której nie da się nic znaleźć. Problem rzadko polega na braku treści — częściej na tym, że pisał ją ktoś, kto już wiedział, czego szuka.
dokumentacja jest w trakcie porządkowaniaOdpowiedź na pytanie o opis procesu. Czas teraźniejszy sugeruje trwającą pracę, a stan faktyczny opisuje krócej: dokumentacji nie ma i nikt nie ma jej w zakresie obowiązków.
to działa u mnieOdpowiedź na zgłoszony błąd. Prawdziwa i bezużyteczna naraz: opisuje jedno środowisko, a zgłoszenie dotyczy innego — różnicę robi wersja, dane albo konfiguracja, czyli dokładnie to, czego zdanie nie…