Noty wydania

Czym zajmują się technical writerzy? Tworzą m.in. release notes. A czym zajmują się release notes? I czym właściwie są?

Release notes, przetłumaczone kiedyś na polski jako "noty wydania", to dokumenty opisujące oprogramowanie, a dokładniej zmiany w konkretnej wersji oprogramowania. Czekacie na definicję z Wikipedii? Proszę bardzo: http://en.wikipedia.org/wiki/Release_notes 😊. Przez zmiany rozumiemy tutaj wszelkie nowe funkcjonalności (ang. features), zmiany w funkcjonalnościach już obecnych, poprawione błędy (fixed bugs) oraz... niepoprawione błędy (known issues).

Release notes są dostarczane razem z oprogramowaniem, np. z nową wersją aplikacji, pakietem poprawek (service pack), pojedynczą naprawą (hotfix) czy nawet jedną z wielu nowo zbudowanych wersji dostarczanych przez programistów (build). Mogą również zawierać informacje na temat tego, w jaki sposób nowa wersja czy poprawka ma być zainstalowana i skonfigurowana.

Jak widzicie, jest to dość zaawansowana technicznie wiedza, stąd w wielu firmach tworzeniem release notes zajmują się po prostu programiści. Przykład (ugly) 😉. Czasem jednak pozwolą nam "coś z tym zrobić". Przykładowy efekt (simply beautiful) 😉.

Adresatami not wydania są odbiorcy oprogramowania, szczególnie Ci, którzy planują aktualizację do nowszej wersji albo instalację pakietu z poprawkami. Ale release notes mają również odbiorców wewnętrznych - testerów, dział zarządzania produktem, wsparcie klienta albo marketing.

Najczęściej spotykana postać release notes to aktualnie po prostu HTML, ale spotyka się również .txt, .pdf, .doc, .rtf...Tutaj znajdziecie typowy przykład old-school'owych release notes.

Tego typu dokumentację zazwyczaj dostarczamy w pakiecie z oprogramowaniem, dostępną na płytce CD/DVD, albo z poziomu samej aplikacji (np. jako wyskakujące okienko albo opcję w menu).

Na koniec cytat z not wydania do jednej z gier, jeden z powodów dla których ta praca nigdy nam się nie znudzi:

"The value of five ducks is now one pig..."