Wpis z mikrobloga

a kto mi gwarantuje, że dokumentacja jest zgodna z tym co chce klient?


@Saly: nikt, ale wtedy to będzie problem klienta

Poza tym nie chodzi tylko o dokumentację od klienta.
Tu chodzi też o dokumentację np. używanych bibliotek czy API systemu.
Jeśli implementujesz swoje oprogramowanie pod konretne zachowanie systemu, a nie pod dokumentację, to możesz być niemal pewien, że to się posypie po którejś aktualizacji systemu / bibliotek. I będzie to
Różnica jest w tym kogo należy potem winić za niedziałający produkt.


@Krolik: w większości przypadków dokumentację pisze ten sam deweloper/team co kod, więc co za różnica. Nawet jest https://www.hyrumslaw.com/

Jeśli implementujesz swoje oprogramowanie pod konretne zachowanie systemu, a nie pod dokumentację, to możesz być niemal pewien, że to się posypie po którejś aktualizacji systemu / bibliotek. I będzie to wtedy Twoja wina, a klient słusznie będzie reklamował.


@Krolik: ale ja
a kto mi gwarantuje, że dokumentacja jest zgodna z tym co chce klient?


@Saly: może nie kto, ale oficjalny podpis/approve klienta pod dokumentem, który definitywnie i ostatecznie ustala wymagania i/lub informuje, co jest "źródłem prawdy" w projekcie (kod, dokumentacja, prezentacja, zeznania developera lub zespołu developerskiego, etc)? Wtedy jak klient wskaże źle, to będzie jego podpis pod tym i jego problem.
w większości przypadków dokumentację pisze ten sam deweloper/team co kod, więc co za różnica. Nawet jest https://www.hyrumslaw.com/


@Saly: To nadal nie oznacza przecież że kod zawiera dokładnie to samo co dokumentacja.

Podam Ci przyklad. Dostałeś metodkę jakiegoś API, która zwraca listę identyfikatorów użytkowników. W dokumentacji napisane "zwraca listę identyfikatorów użytkowników, którzy coś tam...". Odpalasz tę metodę na testowym systemie i dostajesz [1000, 1001, 1002, 1005, 1034, 1035, 1040]. O fajnie, są
@devopsiarz: mówiąc dokumentacja chodzi mi o is written text or illustration that accompanies computer software or is embedded in the source code. To o czym piszesz to bardziej specyfikacja albo kontrakt
I w ten sposób powstaje kolejny kod, który zamiast na dokumentacji, polega na błędach w kodzie napisanym wcześniej :P


@Krolik: Ale wtedy nikt nie przylatuje do ciebie że robiąc refaktoring #!$%@?ście, bo wcześniej działało to inaczej niż teraz.

Gdybym dostawał ziemniaka za każdym razem gdy widzę biznes który nie wie na jakich zasadach działa bo programiści którzy to pisali odeszli, to bym miał dziś więcej ziemniaków niż łukaszenka.
@Krolik: oczywiście się zgadzam. To o czym mówię to szukanie bibliotek na githubie jak porównujesz różne alternatywy i chcesz na szybkości ogarnąć co dany lib robi. Jak biblioteka nie ma ładnych przykładów albo benchmarków to po kodzie czasami idzie szybciej ogarnąć czy dany lib ma sens i co robi. Oczywiście warto potem przejrzeć dokumentację jak chcesz użyć kodu produkcyjnie.