Mirki, tworzymy w #pracbaza projekt watchdocs.io, który ma pomagać #programista15k utrzymywać w ryzach dokumentację projektów. Jesteśmy na etapie walidowania pomysłu i testowania wersji alpha. Dajcie znać co myślicie na ten temat. Będziemy bardzo wdzięczni każdemu, kto znajdzie chwilę, żeby porozmawiać o problemie, który próbujemy rozwiązać! #webdev #programowanie #javascript #startup
@fegwegw: w największym skrócie - utrzymania dokumentacji API zawsze up to date. Z naszego doświadczenia dokumentacja zwykle jest gdzieś tam po drodze porzucana, co boli szczególnie przy większych zmianach funkcjonalności.
@fegwegw: istniejące rozwiązania działają w ten sposób: projektujesz API -> implementujesz -> zmieniasz API -> implementujesz zmianę. my oprócz tego dostarczamy middleware'y, które same zasugerują Ci konieczność zmiany w dokumentacji na podstawie zmian funkcjonalności / testach.
@rbielawski: jak wyżej - wspomniane przez Ciebie narzędzia służą do ręcznego projektowania API - my próbujemy rozszerzyć to o automatyzację na podstawie kodu
@szola: szczerze osobiście bym wolał coś co by np wyłapywało by zmiany w pull requestach i np przy dodaniu nowej metody/zmiany argumentów/dodaniu nowej klasy itp by wykrywało to i pisało te powiadomienia, przypominało na slacku itp bajery, chyba że to już robi?
@Jurigag: Dokładnie o to chodzi. wszystko zależy, w którym miejscu to wepniesz, w tym przypadku o którym mówisz - wystarczy, że podepniesz middleware do swojego CI i będzie działać jak mówisz :)
@Jurigag: będziemy mieć otwarty "protokół", każdy będzie mógł sobie stworzyć middleware dla technologii, której jeszcze nie wspieramy relatywnie szybko :)
@szola: A jaki to problem, może tak zacznijmy?
@fegwegw: w największym skrócie - utrzymania dokumentacji API zawsze up to date. Z naszego doświadczenia dokumentacja zwykle jest gdzieś tam po drodze porzucana, co boli szczególnie przy większych zmianach funkcjonalności.