Informacje o wydaniu

Informacje o wydaniu to dokumenty, które są dystrybuowane z oprogramowaniem lub produktami sprzętowymi, czasami gdy produkt jest nadal w fazie rozwoju lub testowania (np. wersja beta ). W przypadku produktów, które były już używane przez klientów, informacja o wersji jest dostarczana klientowi po wydaniu aktualizacji. Innym skrótem dla informacji o wydaniu jest zmian lub dzienniki wydań , zmiany oprogramowania lub aktualizacje historii wersji lub plik README . Jednak w niektórych przypadkach informacje o wersji i changelog są publikowane oddzielnie. Ten podział ma na celu przejrzystość i odróżnienie najważniejszych funkcji od błędów, próśb o zmiany ( CR ) lub ulepszeń po drugiej stronie.

Zamiar

Informacje o wydaniu to dokumenty udostępniane użytkownikom końcowym, klientom i klientom organizacji. Definicje terminów „Użytkownicy końcowi”, „Klienci” i „Klienci” mają bardzo względny charakter i mogą mieć różne interpretacje w zależności od konkretnego kontekstu. Na przykład grupę ds. zapewniania jakości w organizacji zajmującej się rozwojem oprogramowania można interpretować jako klienta wewnętrznego.

Treść

Informacje o wydaniu szczegółowo opisują poprawki, zmiany lub ulepszenia ( funkcjonalne lub niefunkcjonalne ) wprowadzone do usługi lub produktu zapewnianego przez firmę.

Mogą być również dostarczane jako artefakt towarzyszący produktom testowania systemu i testowania integracji systemu oraz innym zarządzanym środowiskom, zwłaszcza w odniesieniu do organizacji informatycznej .

Informacje o wersji mogą również zawierać wyniki testów i informacje o procedurze testowej . Tego rodzaju informacje dają czytelnikom informacji o wydaniu większą pewność co do dokonanej poprawki/zmiany; informacja ta umożliwia również wdrażającemu zmianę przeprowadzenie podstawowych testów akceptacyjnych .

Różnią się one od umowy licencyjnej użytkownika końcowego , ponieważ nie zawierają (nie powinny) żadnych warunków prawnych dotyczących oprogramowania lub usługi. Należy skupić się na samej wersji oprogramowania, a nie na przykład na warunkach prawnych.

Informacje o wersji można również interpretować jako opis instalacji lub kompilacji oprogramowania, a nie podkreślanie nowych funkcji lub naprawionych błędów. Innym terminem często używanym w tym kontekście są Wymagania systemowe , oznaczające wymagany sprzęt i oprogramowanie do instalacji lub budowania oprogramowania.

Formatuj styl

Nie ma standardowego formatu informacji o wydaniu, który jest stosowany w różnych organizacjach. Organizacje zwykle przyjmują własne style formatowania w oparciu o wymagania i rodzaj informacji, które mają być rozpowszechniane. Treść informacji o wydaniu również różni się w zależności od typu wydania. W przypadku produktów, które są na etapie testowania i które zostały niedawno wydane, treść jest zwykle bardziej opisowa niż informacje o wydaniu dotyczące poprawek błędów i ulepszeń funkcji, które są zwykle krótkie.

Informacje o wersji mogą zawierać następujące sekcje:

  • Nagłówek — nazwa dokumentu (tj. uwagi do wydania), nazwa produktu, numer wydania, data wydania, data notatki, wersja notatki itp.
  • Przegląd - Krótki przegląd produktu i zmian, w przypadku braku innej formalnej dokumentacji.
  • Cel — krótkie omówienie celu informacji o wersji z listą nowości w tej wersji, w tym poprawek błędów i nowych funkcji.
  • Podsumowanie problemu — krótki opis błędu lub ulepszenia w wydaniu.
  • Kroki do odtworzenia — kroki, które wykonano, gdy napotkano błąd.
  • Rozwiązanie — krótki opis modyfikacji/ulepszenia wprowadzonego w celu naprawienia błędu.
  • Wpływ na użytkownika końcowego — jakie różne działania są potrzebne użytkownikom końcowym aplikacji. Powinno to obejmować, czy te zmiany mają wpływ na inne funkcje.
  • Wpływ wsparcia - Zmiany wymagane w codziennym procesie administrowania oprogramowaniem.
  • Uwagi — uwagi dotyczące instalacji oprogramowania lub sprzętu , aktualizacji i dokumentacji produktu (w tym aktualizacji dokumentacji)
  • Zastrzeżenia — wiadomości dotyczące firmy i standardowych produktów. np; freeware , przeciwdziałanie piractwu , powielanie itp. Zobacz także wyłączenie odpowiedzialności .
  • Kontakt — informacje kontaktowe pomocy technicznej.

Informacja o wydaniu jest zwykle zwięzłym podsumowaniem ostatnich zmian, ulepszeń i poprawek błędów w określonej wersji oprogramowania. Nie zastępuje instrukcji obsługi . Informacje o wersji są często pisane w czasie teraźniejszym i zawierają jasne, poprawne i kompletne informacje.

Propozycja otwartej specyfikacji istnieje i nosi nazwę Specyfikacja schematu uwag do wydania.

Wybitne przykłady (głównie oprogramowanie)

Poniższa lista zawiera wybór głównych programów z różnych branż, takich jak gry, systemy operacyjne, motoryzacja, projektowanie CAD itp.

Zobacz też

Dalsza lektura

  1. ^ „Koncepcje dziennika zmian (standardy kodowania GNU)” . www.gnu.org . Źródło 2021-04-05 .
  2. ^ Scott, James (24.04.2020). „Sztuka pisania świetnych informacji o wydaniu” . średni . Źródło 2021-04-05 .
  3. ^ „Wydania (standardy kodowania GNU)” . www.gnu.org . Źródło 2021-04-05 .
  4. ^ „Historia wersji — angielski — Baza wiedzy” . kb.i-doit.com . Źródło 2021-10-10 .
  5. ^ "56508 - Zynq-7000 SoC, 14,6 FSBL - Czy istnieje lista zmian?" . Wyszukiwanie słów kluczowych wsparcia Xilinx . {{ cite web }} : CS1 maint: stan adresu URL ( link )
  6. Bibliografia   _ Besner, Claude (2016-05-01). „Projekty z klientami wewnętrznymi a zewnętrznymi: empiryczne badanie różnic w praktyce” . Międzynarodowy Dziennik Zarządzania Projektami . 34 (4): 675–687. doi : 10.1016/j.ijproman.2016.02.010 . ISSN 0263-7863 .
  7. ^ „Dzienniki zmian (standardy kodowania GNU)” . www.gnu.org . Źródło 2021-04-05 .
  8. Bibliografia    _ Li, J.; Liang, P.; Daneva, M.; Sinderen, M. (wrzesień 2019). „Oczy programistów na zmiany w aplikacjach: badanie eksploracyjne dotyczące dzienników zmian aplikacji” . 2019 IEEE 27. Międzynarodowa Konferencja Inżynierii Wymagań Warsztaty (REW) : 207–212. doi : 10.1109/REW.2019.00042 . ISBN 978-1-7281-5165-6 . S2CID 209460408 .
  9. ^   Bourne, Kelly C. (2014-01-01), Bourne, Kelly C. (red.), „Rozdział 10 - Aktualizacje i poprawki” , Podręcznik administratora aplikacji , Boston: Morgan Kaufmann, s. 150–165, doi : 10.1016/b978-0-12-398545-3.00010-8 , ISBN 978-0-12-398545-3 , pobrane 2021-03-25
  10. ^ Release-notes/release-notes-spec , Release Notes, 2021-03-25 , pobrane 2021-03-25
  11. ^ „Jądro Linuksa w wersji 5.x — Dokumentacja jądra Linuksa” . www.kernel.org . Źródło 2021-03-25 .
  12. ^ Release-notes/release-notes-spec , Release Notes, 2021-03-25 , pobrane 2021-03-25
  13. ^ „Wydania · GitLab.org / GitLab” . GitLab . Źródło 2021-02-13 .
  14. Bibliografia   _ Bavota, G.; Penta, doktor medycyny; Oliveto, R.; Marcus, A.; Canfora, G. (luty 2017). „ARENA: podejście do automatycznego generowania informacji o wersji” . Transakcje IEEE dotyczące inżynierii oprogramowania . 43 (2): 106–127. doi : 10.1109/TSE.2016.2591536 . ISSN 1939-3520 .
  15. ^ Newton, Casey (10.02.2016). „Piłem piwo i pisałem informacje o wydaniu z zespołem średnich informacji o wydaniu” . Krawędź . Źródło 2021-04-05 .

Linki zewnętrzne

Pobrano z „ https://en.wikipedia.org/w/index.php?title=Release_notes&oldid=1138547733 ”