軟體文件編寫那些事

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

每乙個文件在目錄和引言之間，都要有乙個變更記錄表

，當然，變更記錄表的形式不固定，可以自己設計，但是主要的幾項不能丟掉，如

修改記錄，變更時間，修改人，驗收人

等。

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

1、可行性研究報告

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

專案開發計畫由專案組長編寫，預期讀者是開發小組，專案經理，boss以及客戶。開發小組看專案開發計畫，可以通過甘特圖看到專案具體開發安排，專案經理和boss通過開發計畫，可以大概得評估專案的價值，和專案開發安排是否合理，客戶通過專案開發計畫，可以確認專案是否符合自己的要求，以及是否需要更改。簡單的理解，專案開發計畫主要就是甘特圖（我理解為「具體描述這個專案的所有工作安排即什麼時間，什麼地點，所有小組人員在做什麼」）。

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

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

軟體需求說明書主要用於開發人員和客戶溝通，形成紙質檔案，在系統驗收時提供憑證。需求說明書中主要的部分是對輸入和預期輸出的描寫，也就是ipo圖。通過預期的輸入、處理、輸出的這個圖，描述出系統需要實現的絕大多數功能。

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

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

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

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

舉個注釋的例子：

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

6、資料庫設計說明書

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

7、測試計畫

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

8、測試分析報告

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

9、使用者手冊

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

軟體設計文件編寫概述

瀑布式 快速原型法以及迭代式 自從1968年提出 軟體工程 概念以來，軟體開發領域對於借鑑傳統工程的原則 方法，以提高質量 降低成本的探索就從未停止過。而在這個過程中，提出了許多不同的軟體開發模型，典型的有 瀑布式，快速原型法以及迭代式開發。是由w.w.royce在1970年最初提出的軟體開發模型，...

教學軟體使用文件編寫指南

教學軟體使用文件是為了幫助使用者理解該教育軟體的目標 作用 意義和使用方法而必備的文件資料，應隨程式一起發至使用者。文件的編寫可分為功能簡介和使用說明書兩部分。其內容按以下要求編寫 一 功能簡介 1.軟體名稱及其版本號 2.開發者 3.載體 載體形式 磁碟 磁帶 光碟及其規格等 載體卷數。4.教育目...

那些人，那些事

很久沒有整理一下自己的思緒，聽著熟悉的歌，那歌聲會讓我想起那些人，那些事.乙個標點，乙個符號，乙個個早已在歲月深處冰封的眼神，一段沒有伴侶的歸途。一直以來我都認為我的人生就是這樣，平平淡淡，安安靜靜，波瀾不驚地在歲月的 眼角劃過，不留絲毫痕跡。現在看來，原來我寫的東西在很大程度上是是在滿足自己的某種...