最近接手公司的一個需要項目，我最主要的工作便是編寫整理項目文檔。以前除了上大學(xué)交論文的時候?qū)戇^什么概要設(shè)計、詳細設(shè)計，工作以來還沒寫過這些東西。
請教項目經(jīng)理、上網(wǎng)查資料發(fā)現(xiàn)這些文檔還真沒有統(tǒng)一的格式，千奇百怪，這就愁壞了我這樣的新手，雖說有GB T-8567-2006標(biāo)準(zhǔn)，但是這也不是模板，故在自己不斷總結(jié)摸索中，總結(jié)出了一些文檔格式，希望對大家有所幫助。

---

先來說說一個項目的文檔都包括什么：

• 需求規(guī)格說明書

  需求規(guī)格說明書是對所開發(fā)軟件的功能、性能、用戶界面及運行環(huán)境等作出詳細的說明。它是用戶與開發(fā)人員雙方對軟件需求取得共同理解基礎(chǔ)上達成的協(xié)議，也是實施開發(fā)工作的基礎(chǔ)。
  有的為了更嚴(yán)謹(jǐn)還會有需求調(diào)研報告等文檔，咱們這里討論主要也是必須的文檔。

• 項目開發(fā)計劃

  項目開發(fā)計劃為軟件項目實施方案制定出具體計劃，應(yīng)該包括各部分工作的負責(zé)人員、開發(fā)的進度、開發(fā)經(jīng)費的預(yù)算、所需的硬件及軟件資源等。項目開發(fā)計劃應(yīng)提供給管理部門，并作為開發(fā)階段評審的參考。

• 建設(shè)方案

  該文檔根據(jù)需求分析說明書，對系統(tǒng)建設(shè)整理出總體流程及系統(tǒng)總體編碼規(guī)范等，為設(shè)計人員、編程人員及測試人員工作的基礎(chǔ)。

• 概要設(shè)計說明書

  該說明書是概要設(shè)計階段的工作成果，它應(yīng)說明功能分配、模塊劃分、程序的總體結(jié)構(gòu)、輸入輸出以及接口設(shè)計、運行設(shè)計、數(shù)據(jù)結(jié)構(gòu)設(shè)計和出錯處理設(shè)計等，為詳細設(shè)計奠定基礎(chǔ)。

• 詳細設(shè)計說明書

  編制目的是說明一個軟件系統(tǒng)各個層次中的每一個程序 （每個模塊或子程序）的設(shè)計考慮，著重描述每一模塊是怎樣實現(xiàn)的，包括實現(xiàn)算法、邏輯流程等。

• 測試計劃

  為做好組裝測試和確認測試，需為如何組織測試制定實施計劃。計劃應(yīng)包括測試的內(nèi)容、進度、條件、人員、測試用例的選取原則、測試結(jié)果允許的偏差范圍等。

• 測試用例

  項目測試用例設(shè)計，是為項目編制的測試輸入、執(zhí)行條件以及預(yù)期結(jié)果，以便測試某個程序路徑或核實是否滿足需求。

• 測試報告

  測試工作完成以后，應(yīng)提交測試計劃執(zhí)行情況的說明。對測試結(jié)果加以分析，并提出測試的結(jié)論意見。

• 用戶操作手冊

  該手冊詳細描述軟件的功能、性能和用戶界面，使用戶了解如何使用該軟件。

• 系統(tǒng)安裝部署手冊

  顧名思義，就是項目軟件及軟件環(huán)境、數(shù)據(jù)庫等相關(guān)軟件的安裝及部署手冊，詳細描述安裝步驟。

• 培訓(xùn)方案

  培訓(xùn)方案是從組織的戰(zhàn)略出發(fā)，在全面、客觀的培訓(xùn)需求分析基礎(chǔ)上做出的對培訓(xùn)內(nèi)容、培訓(xùn)時間、培訓(xùn)地點、培訓(xùn)者、培訓(xùn)對象、培訓(xùn)方式和培訓(xùn)費用等的預(yù)先系統(tǒng)設(shè)定。

---

說完了文檔包括哪些，下面來說說文檔書寫模板。

需求規(guī)格說明書

1引言
1.1編寫目的
1.2適用范圍
1.3術(shù)語和縮寫
1.4參考資料
2項目概述
2.1項目背景
2.2建設(shè)目標(biāo)
2.3項目遵循的標(biāo)準(zhǔn)或規(guī)范
2.4用戶特征
3系統(tǒng)功能需求
3.1系統(tǒng)總體功能
3.2組織結(jié)構(gòu)圖
3.3系統(tǒng)角色
3.4主要功能流程圖
3.5系統(tǒng)功能詳情
4外部接口需求
4.1用戶接口
4.2硬件接口
4.3軟件接口
4.4通信接口
5系統(tǒng)數(shù)據(jù)需求
5.1數(shù)據(jù)內(nèi)容
5.2數(shù)據(jù)的邏輯描述
5.2.1靜態(tài)數(shù)據(jù)
5.2.2動態(tài)輸入數(shù)據(jù)
5.2.3動態(tài)輸出數(shù)據(jù)
5.2.4內(nèi)部生成數(shù)據(jù)
5.2.5數(shù)據(jù)約定
5.3數(shù)據(jù)的采集
5.3.1要求和范圍
5.3.2輸入的承擔(dān)者
5.3.3預(yù)處理
5.3.4影響
6系統(tǒng)非功能需求
6.1用戶界面需求
6.2軟件環(huán)境需求
6.3硬件環(huán)境需求
6.4網(wǎng)絡(luò)需求
6.5安全設(shè)施需求
6.6產(chǎn)品質(zhì)量需求
6.7故障處理需求

---

項目開發(fā)計劃

1引言
1.1編寫目的
1.2項目背景
1.3術(shù)語與縮略語
1.4參考資料
1.5標(biāo)準(zhǔn)、條件和約定
2項目概述
2.1工作內(nèi)容
2.2主要參加人員
2.3產(chǎn)品及成果
2.3.1程序
2.3.2文件
2.3.3服務(wù)
2.3.4非移交產(chǎn)品
2.4驗收標(biāo)準(zhǔn)
2.4.1代碼的驗收
2.4.2文檔驗收
2.4.3服務(wù)驗收
2.5完成項目最遲期限
3實施總計劃
3.1開發(fā)過程
3.1.1需求分析
3.1.2系統(tǒng)設(shè)計
3.1.3編碼及測試階段
3.1.4文檔、產(chǎn)品部署
3.1.5項目總結(jié)
3.2工作任務(wù)分解
3.3接口人員
3.4進度
3.5關(guān)鍵問題
4支持條件
4.1計算機系統(tǒng)支持
4.2需要用戶承擔(dān)的工作
4.3需由外單位提供的條件
5專題計劃要點
5.1培訓(xùn)計劃
5.2測試計劃
5.3質(zhì)量保證計劃
5.4安全保密計劃
5.5合同計劃

注：其中內(nèi)容可根據(jù)具體情況酌情刪減。
為避免篇幅過長，其他文件模板將在下一篇說明。

總結(jié)

以上是生活随笔為你收集整理的项目验收文档模板（一）的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。