Darmowy generator informacji o wydaniach

Czym są informacje o wydaniach?

Informacje o wydaniach to krótkie podsumowanie zmian w nowej wersji produktu: nowe funkcje, ulepszenia i poprawki, napisane tak, aby czytelnik wiedział, co teraz może zrobić. Generator informacji o wydaniach zamienia surową listę, którą już posiada Twój zespół, taką jak commity lub zgłoszenia, w takie podsumowanie, dzięki czemu notatki trafiają do użytkowników wraz z wydaniem, a nie tydzień później.

Dobre informacje o wydaniach mówią klientom, dlaczego aktualizacja jest dla nich ważna. Komunikaty commitów mówią programistom, jaki kod się zmienił. Cała praca polega na przetłumaczeniu jednego na drugie.

Informacje o wydaniach czy changelog?

Ludzie używają tych terminów zamiennie. Przydatny podział:

To narzędzie działa również jako generator changeloga: generuj notatki dla każdego wydania i dodawaj je na górę strony changeloga.

Co zawrzeć w informacjach o wydaniach

• Tytuł z produktem i wersją: „Informacje o wydaniu Acme Analytics 3.2”.
• Jednoliniowe podsumowanie: jedna lub dwie zmiany, które najbardziej interesują czytelników.
• Nowe, Ulepszone, Naprawione: w tej kolejności, pomijając puste sekcje.
• Punkty skupione na korzyściach: co użytkownik może teraz zrobić, a nie co robi kod.
• Zmiany powodujące błędy: dokładnie to, co ktoś musi zrobić, wyraźnie zaznaczone.
• Linki: do artykułu pomocy lub filmu dla wszystkiego, co wymaga wyjaśnienia.

Krótki przykład informacji o wydaniu

Trzy commity: „feat: export reports to CSV”, „fix: dashboard timezone off by one hour” oraz „chore: bump dependencies” mogą stać się:

Acme Analytics 3.2
Możesz teraz zabrać swoje raporty wszędzie, a pulpity nawigacyjne pokazują właściwe czasy.

Nowe

• Eksport CSV: pobierz dowolny raport jako plik CSV, aby otworzyć go w Excelu lub Arkuszach Google.

Naprawione

• Czasy na pulpicie nawigacyjnym: wykresy teraz poprawnie używają Twojej strefy czasowej.

Aktualizacja zależności jest pominięta w wersji dla klienta, ponieważ użytkownicy jej nie zauważą. Wersja wewnętrzna ją zachowuje.

Jak przygotować zmiany dla generatora

Nie musisz najpierw czyścić swojej listy, ale kilka nawyków pozwoli uzyskać lepsze notatki. Wklej jedną zmianę na linię, niezależnie od tego, czy jest to komunikat commita, tytuł zgłoszenia czy zdanie. Zachowaj konwencjonalne prefiksy, takie jak „feat:” i „fix:”, jeśli ich używasz; pomagają one sortować zmiany na nowe i naprawione. Dodaj słowo kontekstu do enigmatycznych pozycji, na przykład „fix: export (CSV był pusty dla dużych raportów)”. Wypełnij nazwę produktu i wersję, aby tytuł był gotowy do publikacji. Następnie uruchom go dwukrotnie, jeśli potrzebujesz obu wersji: raz dla klientów, raz dla zespołu wewnętrznego.

Najlepsze praktyki dotyczące informacji o wydaniach

Pisz dla osoby korzystającej z produktu

„Raporty ładują się szybciej” brzmi lepiej niż „Zoptymalizowano planer zapytań”. Nazwij funkcję tak, jak pojawia się w interfejsie.

Zacznij od tego, co najważniejsze

Umieść zmianę, którą większość ludzi zauważy jako pierwszą. Małe poprawki mogą być wymienione w jednej linii na końcu.

Pokaż nową funkcję

Zrzut ekranu lub krótki film o nowej funkcji robi więcej niż akapit. Podlinkuj artykuł pomocy, który ją wyjaśnia.

Publikuj zgodnie z harmonogramem, który ludzie mogą znaleźć

Trzymaj każde wydanie na jednej stronie changeloga, najnowsze na górze, aby klienci i Twój zespół wsparcia zawsze wiedzieli, gdzie szukać.

Częste błędy w informacjach o wydaniach

• Wklejanie logu commitów w niezmienionej formie, z numerami zgłoszeń i żargonem.
• Ukrywanie zmiany powodującej błędy w środku listy.
• Wymienianie każdej wewnętrznej zmiany w notatkach dla klientów.
• Obiecywanie dat lub funkcji, których nie ma w wydaniu.

Generator zawiera tylko zmiany z Twojej listy i nie doda dat, których nie podałeś, ale sprawdź każdą pozycję przed publikacją.