Dokumentacja zmiany czy zmiany dokumentacji?

0

W jakiej formie dostajecie dokumentację w projektach gdy macie wykonać zmianę?

0

Jaka dokumentacje? :D

Jedynie co to mamy jakas tam historie na VSTS (i podzielone epic/feature/pbi/task), ale dokumentacji nie ma

0

Myślę, że i to, i to jest przydatne.

Czyli jakiś skrócony changelog (commity w git czasem wystarczą, chyba, że to coś większego - to warto wrzucić dokument napisany np. w Markdown do repo, w jakimś specjalnie wydzielonym folderze i nazwać go po dacie czy w inny sposób, który umożliwi chronologiczne odtworzenie historii projektu).

Ale również przyda się dokumentacja w postaci tekstu ujednoliconego (taka analogia - Sejm ustala ustawy w trybie event sourcing, czyli "ustawa o zmianie ustawy..." ale jednak i tak można podejrzeć tekst ujednolicony bez tych wszystkich delt/patchy typu "artykuł 123 przyjmuję formę taką i taką", tylko już końcowy wynik, snapshot danej ustawy)

Zmienione dokumenty pod jednym ticketem (np. jira)

uważam wrzucanie dokumentacji do Jira(czy innego issue trackera) za antypattern. A przynajmniej w tym sensie, że nie powinno to być jedyne/główne źródło dokumentacji (vendor locking - twój projekt robi się zależny od Jira czy innego konkretnego issue trackera, co może ci uniemożliwiać jego zmianę. Albo choćby swobodne wyszukiwanie w dokumentacji, bo jesteś zależny od szukajki danego issue trackera, a te bywają słabe (nie wiem jaką szukajkę ma Jira, ale tak ogólnie piszę)).

0

Chyba nie rozumiem trochę tego pytania. Dostaję w Jirze opis zadania z docelowym wejściem i wyjściem. Jeśli podczas implementacji zadania zrobię coś, co wymaga zmiany albo warte jest wspomnienia w dokumentacji naszego systemu, to też to robię.

1 użytkowników online, w tym zalogowanych: 0, gości: 1