Nota wydania – jak powinna wyglądać?

Nota wydania – jak powinna wyglądać?
Opis noty wydania (ang. release notes) znajdziemy w materiałach ITCQF dla techwriterów. Ponieważ role te odpowiadają za poprawną konstrukcję tego dokumentu, warto zwrócić uwagę na ich perspektywę.

O tym, jak ważna jest nota wydania dla testerów oprogramowania, pisaliśmy tutaj: 
https://testerzy.pl/baza-wiedzy/nota-wydania-release-notes i https://testerzy.pl/baza-wiedzy/artykuly/tester-programiscie-programista-testerowi
 
Czas spojrzeć na nią oczami samych właścicieli lub twórców struktury dokumentu. 
 
Ten rodzaj dokumentacji zawiera przegląd zmian w danej wersji oprogramowania. Nie wyjaśnia on funkcji tak szczegółowo, jak inne rodzaje dokumentacji.

Cel

Celem dokumentu release notes jest przekazanie informacji o zmianach wprowadzonych w określonej wersji produktu użytkownikom końcowym. Zmiany te mogą obejmować dodanie i usunięcie funkcji, a także poprawki błędów i znane problemy. Jeśli to konieczne, informacje o wydaniu w dokumencie mogą również przeprowadzić użytkowników przez wszelkie kroki wymagane do zastosowania poszczególnych poprawek.

Grupa odbiorców

Informacje o wydaniu (nota wydania) są przeznaczone dla użytkowników końcowych, którzy planują aktualizację do określonej wersji oprogramowania. Taka dokumentacja może być również używana wewnętrznie przed wydaniem produktu i ma na celu ułatwienie procesu planowania i tworzenia innej dokumentacji. Informacje o wydaniu mogą także pomóc w opracowaniu testów na podstawie podanych zmian w produkcie.

Struktura

Struktura noty wydania jest zazwyczaj projektowana indywidualnie w każdej organizacji w zależności od wymagań i rodzaju informacji, które mają być przekazywane. Najpopularniejsza struktura składa się z krótkiego wprowadzenia, po którym następuje wypunktowana lista zmian i/lub znanych problemów, wraz z opisem ich wpływu na produkt, jaki każda zmiana wywiera.

Publikowanie

Ponieważ informacje o wydaniu są zazwyczaj dość krótkie (do kilku stron), mogą być osadzone w oprogramowaniu, którego dotyczą (na przykład jako wyskakujące okienko lub część sekcji "O programie") albo opublikowane w formie krótkiego artykułu w postaci elektronicznej, dostarczanego wraz z oprogramowaniem.

Najpopularniejsze formaty publikowania informacji o wydaniu to TXT, PDF i HTML. Rzadko udostępnia się informacje o wydaniu w formie drukowanej.
 
O innych dokumentach możesz poczytać w sylabusie ITCQF Technical Communication Professional, Foundation Level (EN).

510
Źródła:
http://edu.ittraining.pl/material/Sylabus-ITCQF-Technical-Communication-Professional-Foundation-Level

To powinno Cię zainteresować