目的和責任
發布版本通知是文檔形式,這些文檔與組織的最終用戶共享,客戶和客戶共享的文檔。 “最終用戶”,“客戶”和“客戶”這兩個術語的定義本質上是相對的,可能會根據具體情況進行各種解釋。例如,軟體開發組織內的質量保證小組可以被解釋為內部客戶。它們詳細說明了對公司提供的服務或產品所做的更正,更改或增強。本文檔通常僅在產品或服務根據開發團隊提供的規範進行全面測試和批准後才會發布。但是,本文檔也可能作為工件提供,附帶系統測試和系統集成測試以及其他託管環境的可交付成果,尤其是參考信息技術組織。
發布版本通知還可以包含測試結果和有關測試過程的信息。這種信息使讀者對發布說明更有信心完成修復/更改;這些信息還使變更的實施者能夠進行基本的驗收測試。
內容和形式
不同組織遵循的發行說明沒有標準格式。組織通常根據要傳播的信息的要求和類型採用自己的格式樣式。發行說明的內容也因發布類型而異。對於處於測試階段且新發布的產品,與針對錯誤修復和功能增強(通常是簡短的)的發行說明相比,內容通常更具描述性。發行說明可能包括以下部分:
•標題:文檔名稱(即發行說明),產品名稱,發行號,發布日期,注釋日期,注釋版本等。
•概述:在沒有其他正式文檔的情況下,對產品和更改的簡要概述。
•目的:簡要概述發行說明的用途,其中列出了此發行版中的新增功能,包括錯誤修復和新功能。
•問題摘要-錯誤的簡短描述或發布中的增強功能。
•重現步驟:遇到錯誤時遵循的步驟。
•解決方案:用於修復錯誤的修改/增強的簡短描述。
•最終用戶影響:應用程式的最終用戶需要執行哪些不同的操作。這應包括其他功能是否受這些更改的影響。
•支持影響:管理軟體的日常過程中所需的更改。
•備註:有關軟體或硬體安裝,升級和產品文檔(包括文檔更新)的說明
•免責聲明:公司和標準產品相關的訊息。例如。;免費軟體,反盜版,重複等。另見免責聲明。
•聯繫:支持聯繫信息。
發行說明通常是特定軟體版本中最近更改,增強功能和錯誤修復的簡要摘要。它不能替代用戶指南。發行說明通常以當時編寫,並提供清晰,正確和完整的信息。