轉載地址：http://blog.csdn.net/lu930124/article/details/18792169

對於文件的編寫，你瞭解多少呢？下面描述了一些我不知道的問題，看看你知道嗎？

在文件的編寫時，你的文件標題是“****系統設計文件嗎”？還是隻是把文件的名稱寫上，沒有放系統的名稱。

（二）每一個文件中，都會出現一些問題，就我的問題，分析如下：

1、可行性研究報告

可行性研究報告由專案組長編寫，給專案經理和boss看，所以預期讀者是專案經理和boss

。可行性研究報告，顧名思義，它是想分析一下，這個專案是否可行，話句話說，就是老闆和專案經理看到這份報告後，確定這個專案要不要做！所以，這個專案的精髓就在於分析要開發的系統的經濟可行性，技術可行性，社會因素可行性。編寫目的自然是全方位分析這個系統，在現在的條件下，是否能夠開發，開發時間，開發的預計資金。對於這個文件，你有沒有丟掉三個重要的可行性分析呢？

2、專案開發計劃

專案開發計劃由專案組長編寫，預期讀者是開發小組，專案經理，boss以及客戶。開發小組看專案開發計劃，可以通過甘特圖看到專案具體開發安排，專案經理和boss通過開發計劃，可以大概得評估專案的價值，和專案開發安排是否合理，客戶通過專案開發計劃，可以確認專案是否符合自己的要求，以及是否需要更改。簡單的理解，專案開發計劃主要就是

甘特圖（我理解為“具體描述這個專案的所有工作安排即什麼時間，什麼地點，所有小組人員在做什麼”）。

專案開發計劃中要寫明非移交產品，如：可行性分析報告、專案開發計劃書、軟體需求說明書、概要設計書、詳細設計說明書、測試計劃、測試分析報告、開發進度月報、專案開發總結報告以及原始碼等。

3、軟體需求說明書

軟體需求說明書預期讀者為開發人員和使用者。通過需求說明書，客戶描述出自己對系統的要求，和預期系統的功能，系統開發人員通過需求說明書瞭解系統的大概模型和系統要實現的功能。

軟體需求說明書主要用於開發人員和客戶溝通，形成紙質檔案，在系統驗收時提供憑證。需求說明書中主要的部分是對輸入和預期輸出的描寫，也就是

IPO圖。通過預期的輸入、處理、輸出的這個圖，描述出系統需要實現的絕大多數功能。

4、概要設計說明書

預期讀者為開發人員、專案經理、驗收維護人員、客戶。概要設計說明書交給各個被調研單位稽核，並經領導層討論通過後，軟體開發小組成員將以這本說明書為框架開發新的系統。在概要設計說明書中，可以用系統原型（可以設計系統原型，也可以把舊系統直接作為系統原型）直觀的介紹系統功能，資料庫（資料庫中的表名、觸發器、命名規範等），模組以及功能塊等。在後期，可以把類圖、包圖放到概要設計說明書中。概要設計可以參考需求說明書和資料庫設計說明書來寫。對於概要設計中的資料庫設計，可以簡寫。

概要設計中應該寫明系統期望實現什麼、系統的出錯處理、補救措施和簡單的維護計劃。

5、詳細設計說明書

詳細設計說明書預期讀者為開發人員、專案經理、驗收維護人員。

主要定義類、方法、引數註釋（頭註釋、單行註釋、多行註釋、模組註釋等。要以實際設計說明）、命名規範、詳細類圖等

舉個註釋的例子：

在詳細設計中，所有的約定都要做好，例如編碼規則，這樣，開發小組的各個成員才能按照規定，分別編寫自己的部分，在最後把所有的工作合到一起的時候，才能在一定程度上保證系統可以使用。

6、資料庫設計說明書

資料庫設計主要是給系統開發人員看的。在資料庫設計中，主要從物理設計，邏輯設計和結構設計三個方面來描述資料。使用ER圖來描述資料庫設計。對於資料庫中的表，儘量用手寫表，不要截圖，寫明資料庫中表的命名規範和資料庫中的約定。寫明資料庫儲存過程，若出現圖類的總結，在圖的下面要詳細的描述圖中出現的資料。

7、測試計劃

測試計劃的預期讀者為測試人員和客戶，為做好整合測試和驗收測試，需為如何組織測試製定實施計劃，計劃應包括測試內容、進度、條件、人員、測試用例的選取原則、測試結果允許的偏差範圍等。測試計劃中要包含測試用例

8、測試分析報告

測試分析報告主要是給軟體開發者看的，測試分析報告是在測試分析的基礎上，對測試結果以及測試資料等加以記錄和分析總結。它也是測試過程中的一個重要環節，同時，它也是對軟體效能的一個總的分析和認可及對不足之處的說明。

9、使用者手冊

使用者手冊主要是給使用者看的，使用者是在不瞭解這個系統的內部結構，不知道系統的功能的前提下，使用的使用者手冊。使用者手冊主要告訴使用者該如何操作這個系統，可以截圖說明系統如何使用。截圖上一定要有相應的操作說明的文字，方便使用者理解。

對於文件編寫，這些都是我的一些個人想法，如果出現錯誤，歡迎評論指出，感激不盡！