KjerrPrzykłady changelogów,
które warto skopiować.
Dobre przykłady changelogów mają trzy cechy wspólne: tytuł, który mówi, co się zmieniło, zdanie o tym, co użytkownik może teraz zrobić, i uczciwą informację, co dalej. Poniżej cztery wpisy, po jednym na każdy rodzaj zmiany, a potem changelog a release notes i lista kontrolna.
Cztery przykłady changelogów, według kategorii
Każdy przykład napisaliśmy dla fikcyjnego produktu, w czterech kategoriach, których używa sekcja Aktualności w Kjerr. Kopiuj kształt, nie słowa.
Nowa funkcja
Logowanie dwuskładnikowe już jest
Możesz teraz chronić swoje konto drugim krokiem przy logowaniu. Otwórz Ustawienia, potem Bezpieczeństwo, zeskanuj kod QR dowolną aplikacją uwierzytelniającą i zapisz kody zapasowe. Właściciel przestrzeni roboczej może wymagać tego od każdego członka zespołu. To była jedna z najczęściej zgłaszanych próśb na naszej tablicy.
Dlaczego działa: Zaczyna od tego, co użytkownik może teraz zrobić, mówi, gdzie to znaleźć, i docenia prośbę.
Ulepszenie
Raporty ładują się nawet trzy razy szybciej
Przebudowaliśmy sposób liczenia raportów. Miesięczne podsumowanie, które na dużych kontach otwierało się sześć sekund, teraz otwiera się w niecałe dwie, a zakresy dat dłuższe niż rok przestały się zawieszać. Same liczby się nie zmieniły.
Dlaczego działa: Podaje liczbę, którą czytelnik poczuje, i uspokaja, że dane są te same.
Poprawka
Naprawione: eksport CSV gubił ostatni wiersz
W eksportach większych niż 10 000 wierszy brakowało ostatniego wiersza. Błąd jest naprawiony, a eksporty wykonane od dziś są kompletne. Jeśli w pierwszej połowie sierpnia eksportowałeś duży raport, wykonaj go ponownie.
Dlaczego działa: Mówi, co było nie tak, kogo to dotyczyło i co trzeba zrobić. Bez eufemizmów.
Ogłoszenie
Nad czym pracujemy tej jesieni
Krótkie spojrzenie na najbliższe miesiące, oparte na Waszych głosach. Powiadomienia na Slacku są już w realizacji. Następny będzie tryb ciemny; to pomysł z największą liczbą głosów na tablicy i projektowanie już ruszyło. Napiszemy tutaj, gdy każda z tych rzeczy zostanie wdrożona.
Dlaczego działa: Ustawia oczekiwania bez dat, których nie da się dotrzymać, i odsyła do głosów.
Anatomia wpisu w changelogu, który działa
- Tytuł: zmiana, a nie numer wersji. „Raporty ładują się nawet trzy razy szybciej” mówi czytelnikowi, czy go to dotyczy. „v4.12.1” nie mówi.
- Kategoria. Nowa funkcja, ulepszenie, poprawka albo ogłoszenie. Pozwala przeglądać i filtrować.
- Co możesz teraz zrobić. Jedno lub dwa zdania z perspektywy użytkownika.
- Gdzie to znaleźć. Ścieżka w menu albo link.
- Co dalej. Często nic. Gdy poprawka wymaga ponownego eksportu albo zmiany ustawienia, napisz to wprost.
- Doceń prośbę. Jeśli użytkownicy o to prosili, podlinkuj prośbę. To najtańszy dowód, że feedback jest czytany.
Changelog a release notes
Changelog to bieżący rejestr wszystkich istotnych zmian; release notes to opis jednego wydania. Changelog to lista do przejrzenia: krótkie wpisy, od najnowszych, jeden na zmianę. Release notes to dokument do przeczytania: grupują zmiany z danej wersji, większe objaśniają zrzutami ekranu i zawierają kroki aktualizacji lub migracji.
Małym zespołom zwykle wystarcza sam changelog, z dłuższym wpisem, gdy wydanie na to zasługuje. Produkty z wersjonowanymi instalacjami albo z API często publikują także release notes i linkują do nich z każdego wpisu w changelogu.
Lista kontrolna przed publikacją
Przeczytaj wpis jak użytkownik, który nigdy nie widział Twojej roadmapy.
- Czy tytuł jest zrozumiały bez treści?
- Czy pierwsze zdanie jest o użytkowniku, a nie o zespole?
- Czy jest liczba, ścieżka albo zrzut ekranu tam, gdzie by pomogły?
- Jeśli coś się zepsuło, czy wiadomo, kogo to dotyczyło i co robić?
- Czy prośby, na które wpis odpowiada, są podlinkowane?
- Czy dowiedzą się o nim ci, którzy prosili, a nie tylko ci, którzy akurat zajrzą?
Jak opublikować takie wpisy w Kjerr
Sekcja Aktualności w Kjerr to changelog z czterema powyższymi kategoriami. Wpisy obsługują nagłówki, listy, linki i obrazy, wskazują pomysły, na które odpowiadają, i przy publikacji mogą wysłać e-mail do subskrybentów.
- Kategorie, wyszukiwanie po treści i dacie, reakcje emoji i komentarze.
- Subskrypcja e-mail z potwierdzeniem adresu.
- Powiązane pomysły widać pod wpisem; status Shipped wysyła e-mail do głosujących.
- Widżet na Twojej własnej stronie pokazuje te same ogłoszenia w panelu bocznym, z liczbą nieprzeczytanych wpisów na przycisku.
Pytania i proste odpowiedzi.
Co to jest changelog?
Changelog to datowana lista zmian w produkcie, ułożona od najnowszych i pisana dla ludzi, którzy z niego korzystają. Każdy wpis mówi, co się zmieniło, kogo to dotyczy i co, jeśli cokolwiek, trzeba zrobić.
Czym różni się changelog od release notes?
Changelog to bieżący rejestr wszystkich istotnych zmian; release notes to opis jednego wydania. Wpis w changelogu to kilka zdań. Release notes mogą zająć stronę, ze zrzutami ekranu i krokami aktualizacji. Wiele produktów publikuje jedno i drugie w tym samym miejscu.
Co powinien zawierać wpis w changelogu?
Tytuł, który mówi, co się zmieniło, kategorię, jedno lub dwa zdania o tym, co użytkownik może teraz zrobić, informację, gdzie to znaleźć, i ewentualne wymagane działanie. Jeśli zmiana odpowiada na prośbę, napisz to i podlinkuj ją.
Jak często aktualizować changelog?
Zawsze wtedy, gdy wdrażasz coś, co użytkownicy mogą zauważyć. Krótki wpis co tydzień lub dwa buduje więcej zaufania niż długi raz na kwartał.
Gdzie powinien znajdować się changelog?
Na publicznej stronie z własnym adresem, żeby dało się go linkować, przeszukiwać i indeksować, oraz w e-mailu dla subskrybentów. Kjerr umieszcza go na tej samej tablicy co prośby o funkcje.
Powiązane strony
Daj użytkownikom odpowiedź.
W okresie wczesnego dostępu Kjerr jest darmowy: wszystkie funkcje, bez karty kredytowej. Płatne plany, gdy się pojawią, będą liczone za przestrzeń roboczą, nigdy za stanowisko administratora.