2008-11-24 36 views
14

什麼是發佈說明以及誰閱讀它們?應該/可以通過爲當前版本發佈錯誤修復來實現自動化,還是需要進行人工編輯? 那麼,與軟件發行說明有關的最佳實踐鏈接(推理背後)?版本說明,用於什麼?

回答

6

發行註記到你的測試機構重要(如果有的話),讓他們知道什麼是在發佈更改,並且需要測試。

+0

我將其標記爲答案,因爲在實踐中我不認爲其他用戶作爲整體閱讀說明。其他用戶傾向於閱讀幫助,或工具提示和其他應用程序的位置。不過,質量檢查員對測試的詳細發佈說明表示讚賞,至少在我的組織中他們確實會閱讀它們。謝謝。 – 2009-01-14 17:50:42

6

這實際上取決於您的應用程序的構建目標和組織目標。但是,我傾向於認爲發行說明必須是特定發行版中包含的重要關鍵附加功能,增強功能或修補程序的簡要列表。

有時候,一個簡單的轉儲錯誤跟蹤系統信息就足夠了,有時候,我發現他們需要改進。

關鍵是,通常發佈說明被認爲是「嘿看看我們做了什麼」類型的變更列表。

16

錯誤修正和增加的功能。用戶將閱讀它們以確定是否應該去安裝增量升級的麻煩,或者等到下一個版本發佈,因爲這個版本沒有添加他們需要的任何功能,或者修復了他們使用的功能中的任何錯誤。

我會說他們至少需要一個人來通讀他們,並確保每個音符都很有用。這取決於您的錯誤修復的評論有多好。

5

我們的發佈記錄是人類創建的,而不是機器創建的。封面三大主題。

  1. 中有什麼版本包括 (文件列表)

  2. 如何安裝它

  3. 從上一版本 (是什麼改變了,特別是如果改變不是 的手冊)。

項目1和2在版本和版本之間並沒有很大的差別,但他們需要審查。項目3需要最多的工作。

+0

有趣的是對這個吉姆。我通常會將項目1和項目2包含在其他文檔中,而不是發行說明文件中。... – 2008-11-24 21:58:39

1

如果您的客戶除了正常程序以外還需要採取特殊措施進行升級,版本說明和自述文件可能非常重要。警告用戶/用戶可能會因安裝更新的補丁程序而自動發生任何數據庫升級。我看到它的方式,發行說明和自述文件應該寫給系統管理員的讀者。因此,請包括他們想知道的事情類型:重要更改的摘要,如何安裝,已知錯誤,您的軟件可能會做的任何事情,以便讓某人拉出他人的頭髮等。

4

我習慣性地閱讀發行說明。我傾向於需要全面的功能更改列表(或者似乎合理),以便更好地使用新產品。

我希望看到何時解決某些重要的錯誤或關鍵安全問題。

5

版本註釋在生產環境中也非常重要。

他們幫助回答古老的問題:

赫克目前運行到生產什麼?

或者更精煉的問題:這個bug在這個版本中是否確實得到修復?

1

發佈說明取決於您的組織。

我可以爲我的組織說話。我們使用PDF格式的發佈說明,每次發佈clickonce或後端版本。我們向辦公室經理髮送說明。這是業務高層管理員(不僅是IT)使用的文檔。這份文件是讓他們知道發生了什麼的一種方式。現在正在生產的新功能,已修復的錯誤以及他們可能想要向其用戶解釋的其他內容都發生了變化。

這是可以3〜4頁之間,說明已在此版本簡短的話已完成任務的文件。

0

當然,這是高度依賴於應用程序/服務/諸如此類的類型,
但我發現閱讀我最喜歡的開發工具的發佈說明等。
常常使我偶然發現不錯,有趣甚至殺手鐗,我很可能會錯過,如果我did'nt至少瀏覽筆記.....好了,也許不是殺手,但你明白我的意思;-)

由於大多數電腦電力用戶(現什麼樣的表情是...)
我從來不在乎多少與普通文檔,所以這給了我
那麼一點額外的東西someth荷蘭國際集團除了點擊,懸停和faq'ing ...

0

發行說明測試人員和用戶知道什麼是新的/改變。此外,發佈說明可用作爲您爲其構建的客戶端軟件的新「版本」計費時的支持文檔。 v1.31似乎更容易關聯和鑽取。

而不是手動編譯兩個列表,如果你可以使用你的發行說明,爲你做它的偉大。