Dobre praktyki pisania notatek o wersji

Przy dostawie każdej wersji oprogramowania musimy napisać notatkę o wersji. Oto na przykład niektóre z warunków, które dodaję, pisząc notatkę o wersji:

Data wydania
Błąd rozwiązany

Czy to wystarczy, czy jest coś jeszcze?

release

— CoolProgrammer
źródło

To wygląda jak duplikat programmers.stackexchange.com/questions/66377/…

nie zapomnij o dodanych funkcjach

— maniak zapadkowy

Odpowiedzi:

Myślę, że następujące postępowanie da drogę do dobrych praktyk

// Data związana

Data wydania

// Funkcja związana

Dodano funkcje
Polecane usunięte
Funkcje zmienione

// Błąd związany

Rozwiązane błędy
Nierozwiązane błędy

// Zależność zależna

Lista zależności

// Testowanie związane

Wyniki testu jednostkowego
Wyniki testu akceptacyjnego

// Kontrola wersji powiązana

Tag Note
Numer wersji

Czasami warto również podkreślić rzeczy, które użytkownik końcowy może chcieć zmienić w swoich konfiguracjach lub przepływie pracy.

Większość użytkowników końcowych nie dba o wynik testu. Oczekują, że będzie wysokiej jakości bez względu na to, co mówi informacja o wydaniu.

Najważniejszą rzeczą w informacjach o wydaniu jest świadomość, że każde dodatkowe zdanie traci kolejne 10% czytelników. Dlatego musisz ściśle ustalić, co Twoi obecni użytkownicy powinni wiedzieć o wydaniu.

— Md Mahbubur Rahman
źródło

czasami warto podkreślić rzeczy, które użytkownik końcowy może chcieć zmienić w swoich konfiguracjach lub przepływie pracy

— jk.

@jk. Tak masz rację. Zredagowałem swoją odpowiedź jako dobry komentarz.

— Md Mahbubur Rahman

Większość użytkowników końcowych nie dba o wynik testu. Oczekują, że będzie wysokiej jakości bez względu na to, co mówi informacja o wydaniu.

— Henrik,

Informacje o wersji @Henrik mogą być przydatne dla osób innych niż użytkownicy końcowi

— jk.

Najważniejszą rzeczą w informacjach o wydaniu jest świadomość, że każde dodatkowe zdanie traci kolejne 10% czytelników. Dlatego musisz ściśle ustalić, co Twoi obecni użytkownicy powinni wiedzieć o wydaniu.

— ddyer
źródło

każda linia może stracić 10% zwykłych, niezainteresowanych (lub leniwych) czytelników. Ci czytelnicy są tymi, dla których nie napisano informacji o wydaniu. Ci, którym zależy na tym, co zrobiłeś, przeczytają je wszystkie i będą ci wdzięczni za każdą odpowiednią linię - musisz tylko uważać na włączenie puchu, który naprawdę musi przejść do właściwej dokumentacji.

— gbjbaanb