Write effective product release notes (+real examples & templates)

Każdy, kto zajmuje się tworzeniem notatek o wydaniu produktu uważa je za żmudne, nudne i czasochłonne. Często można zobaczyć ludzi, którzy dosłownie od nich uciekają. Ale pamiętaj, że publikowanie informacji o wydaniu produktu i aktualizowanie changelogu jest ważne dla rozwoju Twojego biznesu. W tym artykule przyjrzymy się również szablonom notatek o wydaniu.

Poza prowadzeniem serwisu changelog, zajmujemy się również notkami o wydaniu bardzo często. Ciągle informujemy naszych użytkowników o ostatnich zmianach i ulepszeniach, które wprowadziliśmy w naszym produkcie. Dlatego też opracowaliśmy techniki, jak uczynić cały proces bardziej znośnym i efektywnym.

Co to są Release Notes?

Release notes to dokument w formie wypunktowanej, który jest dołączany do wydania oprogramowania, aby poinformować użytkowników o tym, co się zmieniło. Chociaż nie ma żadnego uniwersalnego formatu, typowe noty wydania zawierają informacje o poprawkach błędów, nowych funkcjach, a czasami znanych problemach. Informacja o wydaniu może być nudnym technicznym dokumentem, którego nikt nie lubi czytać i pisać. Ale naszą misją, jako menedżera produktu, jest uczynienie tych notatek bardziej atrakcyjnymi, interesującymi i pouczającymi.

Jaki jest z nimi problem?

Trzy główne problemy związane z notami wydania to
– zarządzanie,
– zerwana komunikacja,
– i kanał dystrybucji.

Największym problemem, z jakim się spotykamy, jest brak komunikacji wewnątrz zespołu. Nawet w małych firmach zespół techniczny ma trudności z wyjaśnieniem, co zostało zmienione. Często zdarza się, że coś naprawiają, a kilka tygodni później zapominają, co zostało zrobione w tym miesiącu.
Cóż, błędem jest również pozostawianie zadań związanych z notatkami do wydania zespołowi programistów. Mają oni tendencję do pisania bardzo technicznych notatek dla ludzi z doktoratem z informatyki.
Czytelników nie obchodzi, jak coś zostało naprawione; obchodzi ich tylko efekt końcowy. Jak mogą skorzystać z aktualizacji?

Wskazówki dotyczące pisania notek o wydaniu (z szablonami)

Odkładając na bok temat humoru w notkach o wydaniu na później, większość informacji w notkach o wydaniu może zostać ujęta w zrozumiałą formę. Tak więc, następnym razem, kiedy deweloper wyśle Ci notatki o naprawionym błędzie lub nowej funkcjonalności, oboje zaoszczędzicie czas.
Więc, zamiast otrzymywać komentarz od dewelopera, który nie ma sensu. Będziesz miał głębsze zrozumienie, co się zmieniło i jak lepiej przekazać to użytkownikom końcowym.
Więc, dochodzimy do mojej osobistej listy wskazówek i trików, których używam, aby tworzyć świetne release notes! Zainspiruj się i napisz swój własny szablon notatki o wydaniu produktu! Szablony notatek o wydaniu produktu oprogramowania to świetny sposób na zaoszczędzenie czasu.

1. They > We

Nie zaczynaj od „We’ve done this”. Użytkowników nie obchodzi, co Ty zrobiłeś, obchodzi ich tylko to, co oni otrzymają dzięki temu, co Ty zrobiłeś.

Możesz teraz .
Nowo wydany jest dostępny do Twojego użytku. Teraz, będziesz mógł

2. skupić się na użytkowniku

Częściej używaj „TY”. Jest to sztuczka copywriterska, która błyskawicznie zmienia sposób postrzegania informacji tekstowej. Będą oni podświadomie bardziej skłonni do przeczytania tekstu, gdy zobaczą „ty”.

Wspaniała wiadomość dla ciebie! pozwala ci zbierać informacje zwrotne od użytkowników.
Mamy przyjemność ogłosić, co pomoże ci uniknąć utraty danych.
Zaoszczędź swój czas dzięki

3. Postępuj zgodnie z prostymi szablonami notatek o wydaniu

Stwórz te szablony i poproś deweloperów, aby pisali notatki tylko w tym formacie. W ten sposób unikniecie nieporozumień i będziecie dokładnie wiedzieć co zostało zmienione, jak to działa i jakie cele stara się osiągnąć. Te 4 szablony same w sobie pokrywają 90% wszystkich notatek o wydaniu.

• Poprzednio X jest teraz Y
• Możesz teraz zrobić X zamiast Y
• X nie robi już X, Y kiedy Z, Q, W
• X nie robi już Y. Oznacza to, że nie musisz już robić Z

4. Unikaj zbyt formalnego

Oczywiście, zależy to od brandingu Twojej firmy. Jednak formalne pismo jest zazwyczaj długie i nie od razu do rzeczy. Utrudnia to więc czytelnikom skanowanie tekstu. Staraj się używać spójnego języka i unikaj zbyt formalnego w swoich szablonach dokumentów release notes.

5. Rozwiń, a następnie uprość

Dobra notatka o wydaniu jest krótka i zwięzła. Jednakże, aby się tam dostać, należy rozwinąć tekst, upewnić się, że odzwierciedla on wszystko, o co chodzi w nowej funkcji, poprawce błędu. Ponadto, duża część pisania release notes to branie dużej ilości informacji i ściskanie ich w krótkich akapitach. Upewnij się, że każda informacja o wydaniu nie jest wyrwana z kontekstu.

Przyjrzyjrzyjmy się najlepszym przykładom informacji o wydaniu. 3 firmy ze świetnymi stronami Release Notes i jak możesz się od nich uczyć?

👉Related article: Everything you need to know about key metrics in SaaS

Release notes examples

Salesforce Release Notes Examples

Salesforce to platforma CRM z wieloma produktami pod ich parasolem. Więc utrzymanie klientów na bieżąco o nowych funkcjach i zmianach w produkcie jest piekło dla pisarzy technicznych, menedżerów produktu i deweloperów.
Zakładam, że firma przygotowuje release notes kwartalnie i nazywa się „Salesforce Summer ’19 Release Notes”, który jest bardzo kompleksowy release notes strona z jego kategorii i podkategorii.
Salesforce release notes jest mieszanką regularnych informacji o wydaniu, jak również mapy produktu. Jest to szczegółowe wyjaśnienie, jak każda funkcja będzie działać, a konkretnie do których użytkowników będą one dostępne.

Oczywistą korzyścią z takich kompleksowych stron release notes jest podjęcie pracy z ramion działów wsparcia. Na przykład, jeśli otrzymają oni pytanie od klienta związane z konkretnym tematem. Z łatwością mogą przekierować je na stronę, na której użytkownicy znajdą odpowiedź.

Kluczowe wskazówki pro do wyciągnięcia:

1. Jak korzystać z sekcji Release Notes

2. Szczegółowe, wizualnie zrozumiałe tabele z mapą drogową produktu

3. Sekcja filtrów

4. Uogólnione wyjaśnienie, uogólnione wyjaśnienie, a następnie szczegółowy opis działania nowej funkcji.

Salesforce stosuje również szablony release notes.

Krok 1: Wyjaśnienie, na czym polega nowa funkcja.
Nie musisz już przełączać się na Salesforce Classic, aby zarządzać przypisaniami terytoriów na stronie Konto. Możesz teraz edytować listę powiązanych terytoriów przypisanych w Lightning Experience. Wcześniej lista powiązana była tylko do odczytu w Lightning Experience.

Nie musisz już wykonywać . Teraz można wykonać . Poprzednio można było wykonać tylko .

Krok 2: Wyjaśnij, jak włączyć lub uzyskać dostęp do funkcji
Gdzie: Ta zmiana dotyczy Lightning Experience w edycjach Performance i Developer oraz edycjach Enterprise i Unlimited z chmurą Sales Cloud.

Krok 3: Wyjaśnij, jak korzystać z funkcji
Jak: Jeśli układ strony Konto zawiera listę powiązaną Przypisane terytoria, nie jest wymagana żadna konfiguracja. Kliknij Assign Territories i przypisz, aby zarządzać przypisaniami.

Sketch Release Notes Examples

Jeśli Twój produkt nie jest tak skomplikowany i nie jest platformą z dużym parasolem narzędzi podrzędnych, sprawdź firmę Sketch.
Układ jest interesujący. Po prawej stronie masz szczegółowy opis wszystkich nowych funkcji i poprawek, a po lewej stronie opisy głównych, dużych funkcji. I CTA.

Uaktualnienia Smart Distribute

Możesz teraz używać Smart Distribute do kontrolowania odstępów w siatkach. Możesz łatwo dostosować pionowe odstępy między rzędami warstw, a także poziome odstępy między każdą warstwą w rzędzie. Wprowadziliśmy również nowy przycisk „Porządkuj” do inspektora. Umożliwia on szybkie wyrównanie zaznaczenia wielu warstw w schludną siatkę, co jeszcze bardziej ułatwia tworzenie i zarządzanie złożonymi układami.

Ponownie widzimy prosty szablon:
Teraz możesz zrobić . Możesz łatwo zrobić . Wprowadziliśmy również nową funkcję .

Ulepszenia:
Dodaliśmy do menu Edycja nowe polecenie Zaznacz wszystko w szyku, abyś mógł szybko chwycić wszystkie warstwy na wybranym szyku. Dodaliśmy również podmenu dla różnych poleceń Zaznacz wszystko.

• Dodaliśmy polecenie Zaznacz wszystko, dzięki czemu można teraz wykonywać .
• Zlikwidowaliśmy błąd, który mógł wystąpić podczas próby przeciągania do zaznaczenia za pomocą narzędzia Różdżka.
• Zlikwidowaliśmy błąd, w którym nie była wyświetlana prawidłowa waga czcionki dla czcionek o tej samej nazwie.

– Naprawiono błąd w listach stron i warstw, w którym zaznaczenia nie były prawidłowo podświetlane po podłączeniu do zewnętrznego wyświetlacza.

Powracając do informacji o wydaniu zorientowanym na użytkownika, musimy zrozumieć, że piszemy nasze informacje o wydaniu dla naszej grupy docelowej. Salesforce pisze swoje wydania dla osób bez wykształcenia technicznego, dla działów sprzedaży i marketerów, przedsiębiorców, założycieli itp.

Sketch jest używany przez grafików i artystów. Tak więc zarówno Salesforce jak i Sketch używają ogólnego tonu, bardzo przyjaznego dla użytkownika, zorientowanego na prawdziwych ludzi.

Getpostman Release Notes Examples

Jeśli Twój produkt jest techniczny, a Twoi użytkownicy to programiści, to zasadą jest odwrotność. Krótsze, bardziej techniczne, nie atrakcyjne wizualnie są lepsze.

Na przykład, Getpostman jest technicznym produktem dla programistów.

Release Notes można szybko przeskanować, aby mieć ogólne pojęcie o tym, co jest nowe. I to w bardzo uproszczonym formacie.

Numer aktualizacji, data, i informacja w jednym zdaniu o każdej aktualizacji bez szczegółów co to oznacza dla użytkownika, jak tego używać lub jak się do tego dostać.

Im prościej tym lepiej. Oni zrozumieją.

Humor w Release Notes

Mówiliśmy już o przykładach in-app release notes, które są przezabawne i zabawne do czytania. Jednak ten ton głosu nie jest odpowiedni dla większości firm technologicznych. A one potrzebują przewodnika stylu dla Release Notes. Co więcej, nie każdy produkt software’owy ma wersję mobilną, a większość firm publikuje swoje release notes na osobnej stronie, gdzieś pod działem wsparcia lub pomocy. (Firmy strategicznie zakopują swoje release notes, a potem narzekają, dlaczego nikt ich nie czyta.)

Istnieje wiele sprytnych sposobów na ogłaszanie aktualizacji produktów. Na przykład, pisząc świetny e-mail, aby wprowadzić aktualizacje produktu lub utworzyć osobny post na blogu.

👉 Powiązany artykuł: The best and the worst app Release Notes that will inspire you

Like in anything in life, by bringing structure and organization as well as modern technologies we create an easier solution, that is not that boring and unnecessary.

Hopefully our sample software release notes templates
and examples helped you.

.