Toolverse
Wszystkie skille

write-changelog

autor: jamiebrynes7

Twórz wpisy do changelogu skupione na korzyściach użytkownika, nie na szczegółach technicznych

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Kategoria
Frontend

O skillu

Umiejętność pisania i aktualizowania wpisów changelogu z perspektywy użytkownika. Narzędzie prowadzi Cię przez wytyczne, które zapewniają, że każdy wpis skupia się na tym, co użytkownik zyskuje, a nie na implementacji technicznej. Obsługuje wszystkie standardowe kategorie: nowe funkcje, poprawki błędów, zmiany, ulepszenia wewnętrzne, tłumaczenia i zmiany powodujące niezgodność. Idealne dla zespołów, które chcą utrzymać changelog czytelny i skupiony na doświadczeniu użytkownika.

Jak używać

  1. Zainstaluj umiejętność write-changelog w swoim środowisku Claude lub Copilot, wskazując repozytorium jamiebrynes7/obsidian-todoist-plugin.

  2. Przygotuj informacje o zmianach, które chcesz dodać do changelogu — opisz je z perspektywy użytkownika, na przykład "Użytkownik może teraz synchronizować zadania automatycznie przy starcie aplikacji" zamiast "Dodano useEffect do triggerowania sync na mount".

  3. Uruchom umiejętność i podaj opis zmian. Narzędzie automatycznie sformatuje wpis zgodnie z wytycznymi, wybierając odpowiednią kategorię (Funkcje, Poprawki błędów, Zmiany, Wewnętrzne, Tłumaczenia lub Zmiany powodujące niezgodność).

  4. Umiejętność doda nowy wpis do sekcji "Unreleased" na górze pliku changelog (docs/docs/changelog.md), tworząc nagłówek kategorii, jeśli jeszcze nie istnieje.

  5. Przejrzyj wygenerowany wpis i upewnij się, że jest zwięzły (zwykle jedna linia), skupiony na korzyści użytkownika i nie zawiera szczegółów technicznych takich jak nazwy zmiennych, klasy CSS czy architektura wewnętrzna.

  6. Zatwierdź zmiany w changelogu. Wpisy będą przeniesione do sekcji wersjonowanej podczas procesu wydania.

Podobne skille