產品發布文檔清單

產品發版時需要哪些文檔，用來做什么用？

   我們的新產品要發版了，產品的發版除了軟件功能本身之外，我們還是需要有一系列配套的文檔去支撐我們的售前、交付、服務、項目開發，畢竟只有前期的文檔准備到位了之后，我們的下游團隊才能做到具體項目上才會能說“心中有數”！

   目前項目開發、 實施&服務團隊初步梳理了一下文檔的內容，發現這這個清單還是很長，這么長的一個清單，如何讓我們的產品能夠快速迭代，如何做到敏捷呢？這對於我們目前的產品團隊也是一個非常犯難的事情。

   在這個問題上，建議進一步思考：按照不同的產品生命周期做管理。如果對於孵化期產品可以不要求這些文檔，因為這個時候產品還不成熟，且也沒有太多的業務積累可以提供這些文檔，唯一的方法就是產品團隊直接進入到項目中和實施團隊共同面對客戶需求進行完善，這個時候還算是在產品的“實驗室”中，還需要產品團隊主刀做完善的，因此可以不需要講究這些，要的就是產品做快速迭代與完善；如果是成長期的產品，應該一些關鍵文檔是需要提供給到區域、項目開發了，因為這個時候產品團隊參與的項目主要是業務方案的部分，實際業務交付、項目開發都已經給到其它團隊了，只要有任務的移交就一定要有文檔的輸出，這個應該是大原則！

序號	交付件名稱	是否必需品	交付件說明	交付件主要用途	如果不提供該交付件對項目的影響
1	產品設計文檔	是	1.     功能設計文檔	1.     需求評估時，查看相關功能設計	1.     需求容易出現遺漏，特別是一些變化較大產品
			2.     數據庫設計文檔（枚舉類型的需要每個值所代表的意義）	2.     數據庫取數或者BUG查證時，便於進行數據核對	2.     開發效率低，需要不停的咨詢他人
2	報表設計器，新工作流操作手冊等	是	1.     基本的配置和操作指引	1.     報表快速開發	遇到問題，只能靠自己摸索和尋求他人，效率極低
				2.     工作流站點的快速配置，遇到問題時可以查找
3	業務解決方案	是	1、 功能的由來。（比如計划系統的會議管理模塊，是基於什么原因增加的）	1、 學習新系統時，快速掌握客戶實際業務	1、 不清楚功能加了有什么用。
			2、 業務流程圖		2、 如果項目上需要對功能進行調整，不清楚在業務上有何影響。
			3、 CP點說明
			4、 管理價值
4	功能規格設計書	是	1、 必須是按新功能進行描述，不能像之前那樣增量描述。	1、 評估新版本需求時，能通過該文檔查詢現有功能的具體情況，減少直接的代碼閱讀工作。（對於標准版的，可以不用看代碼，直接以該文檔為准）	1、 只能通過代碼去理解現有系統是什么樣的，效率低。
			2、 描述清楚數據流向	2、 學習新系統
			3、 描述清楚業務邏輯
			4、 描述清楚系統流程圖
5	數據結構	是	1、 表關系。	1、 學習新系統時，梳理數據關系。	1、 只能通過代碼去理解現有系統是什么樣的，效率低。
			2、 數據字典。	2、 評估需求時，梳理數據關系。
			3、 存儲過程。
			4、 視圖
6	Bug修復清單	是	1、 新版本修復Bug清單	1、 快速解決舊版本已知Bug	1、 針對已知的Bug如果沒有統一的、經過驗證的解決方案，各項目團隊修復時可能會產生因修復方案錯誤或不完整導致次生Bug
			2、 每個Bug針對各版本老產品代碼級修復方案	2、 項目團隊根據清單對舊產品Bug進行主動修復	2、 不知道老版本還有多少Bug，沒有清單支撐主動修復
7	可供客戶直接更新的補丁包	是	針對大版本的補丁包發布時，需要產品團隊制作一個可供客戶直接更新的補丁包，而不是丟一堆文件放到服務器上(306 SP1)	1、 對於未做過開發的新客戶，可以直接使用補丁包升級，不需要項目再做一次升級包	1、 每個項目團隊都要自己做一個更新包，重復勞動
					2、 產品提供的補丁包目錄存在大量的空文件夾和多余文件，刪除有風險，不刪除更新包過大
8	移動產品及相關文檔	是	1、 微助手等移動產品隨ERP一起發布，放到各版本下面	1、 方便找到ERP對應版本的移動產品，便於項目團隊學習和客戶上線開發	1、 現在微助手與標准產品分開發布，不清楚哪個版本對應
			2、 移動操作手冊、環境部署等相關的資料。		2、 新版本產品客戶已經在用了，與之對應的移動產品未發布導致客戶用不了
			3、 采用的框架及技術及相關資料		3、 缺少渠道，對於公司新的產物不了解。

 

 

序號	交付件名稱	是否 必需品	交付件說明 （具體內容建議定時間派代表與產品人員一同協商）	交付件主要用途	如果不提供該交付件對一線的影響
1	發布及升級公告	是		了解最新版本信息，及更新內容	無法獲取升級與舊版的差異
2	產品功能清單	是		合同附件附帶	合同附件與交付產品不一致。
3	產品更新說明	是	與上一版本的差異點，主要更新點，業務上及軟件上都要	了解最新版本的更新信息	無法獲取升級與舊版的差異
4	產品理念PPT	是	售前介紹PPT，介紹產品的亮點功能	1、新功能的業務背景了解； 2、產品實施環節給客戶做產品理念宣講用到；	1、無法推廣新產品，一線不理解新產品理念； 2、無法了解產品亮點以及產品功能業務背景；
5	測試報告	否	包含性能測試報告	1、客戶要求； 2、售前用得到，客戶IT高層會有要求；	1、如客戶無要求無影響，可考慮不與產品一起交付，但需要時能夠及時提供； 2、無法消除客戶對於產品平穩運行的擔憂；
6		否	功能測試報告
7		否	系統安全資質認證
8		否	壓力測試報告
9	產品操作手冊	是	要包含新版本功能說明	新功能操作說明	無法了解新功能操作，需要各自摸索
10	問題集	否	包含各子系統	1、碰到問題查詢解決辦法； 2、快速定位問題，提升問題處理效率；	1、非必選，遇到問題需要找人咨詢，處理問題流程會增長； 2、無影響，目前一線也會自己積累問題集；
11	實施交付運維服務配套文檔	是	交付指引	1、新人培訓，系統功能交付標准參考； 2、指導新產品實施交付；	一線交付難度大，尤其對於不理解的新產品，交付難度非常大，模式可參考采招258發布時的交付指引。
12		建議有	產品培訓PPT&錄像	1、標准操作，可提供客戶； 2、給一線作為參考，形成客戶自己的培訓資料；	如沒有，客戶要求則要顧問自行錄制。
13		是	測試用例場景	客戶要求，系統上線完成功能驗證，需要安排場景的測試用例。	建議提供，客戶要求還是比較普遍。如無會造成客戶對新產品不信任。
14		是	數據結構	制作報表查詢	降低報表制作效率，尤其是涉及新功能報表
15	Demo數據庫	是	演示數據庫	售前演示、系統功能學習	只有空庫，需要花費很大精力做演示數據，效率低，演示效果無法保障
16		是	核心業務模板（例如主項計划模板、成本控制科目模板等）	售前演示、系統功能學習	只有空庫，需要花費很大精力做演示數據，效率低，演示效果無法保障