1、 文檔管理規(guī)范 v1.0密級：秘密2012-6-12第 1 頁 共 9 頁文檔管理規(guī)范文檔管理規(guī)范版本版本 1.0修訂記錄初稿日期2012-6-15修正日期審核日期批準日期深圳恒飛盈通科技有限公司版權所有 侵權必究 文檔管理規(guī)范 v1.0密級：秘密2012-6-12第 2 頁 共 9 頁目錄目錄1.簡介簡介.31.1目的.31.2范圍.31.3讀者.32.文檔類別文檔類別.33.文檔清單文檔清單.34.文檔標識文檔標識.64.1帶版本文檔.64.1.1標識號（id）.64.1.2版本號.74.2無版本文檔.74.2.1項目文檔.74.2.2員工周報.85.文檔格式文檔格式.96.文檔修訂文檔修

2、訂.9 文檔管理規(guī)范 v1.0密級：秘密2012-6-12第 3 頁 共 9 頁文檔管理文檔管理1. 簡介簡介1.1 目的目的編制本文檔的目的在于為所有的項目文檔的命名、編碼以及版本號的確定建立一套統(tǒng)一的規(guī)則和方法，以唯一地確定項目的每一產出物。1.2 范圍范圍本文檔僅描述項目級文檔的管理規(guī)則，不包括公司級文檔。1.3 讀者讀者所有軟件工程人員應該閱讀本文檔，并遵從本文檔的規(guī)則識別項目中產生的文檔，并對其進行標識以及按照規(guī)范的格式撰寫文檔。2. 文檔類別文檔類別類別說明代碼管理類各種有關項目策劃、度量、跟蹤、調整的文檔mng需求類各種與業(yè)務和需求相關的文檔、模型req設計類各種設計文檔、模型等

3、dsn實施類與軟件開發(fā)和集成相關的文檔imp測試類測試相關文檔、數據等tst發(fā)布類發(fā)布聲明以及各種用戶文檔rel參考資料類各種參考資料ref3. 文檔清單文檔清單序號文檔中文名稱文檔英文名稱文檔代碼模板評審級別 文檔管理規(guī)范 v1.0密級：秘密2012-6-12第 4 頁 共 9 頁管理類（mng）1立項申請project establish requestper/組織級2項目任務書statement of worksow/組織級3軟件開發(fā)計劃software development plansdp/組織級4軟件開發(fā)日程表software development schedulesds/組織級

4、5軟件維護計劃software maintainance plansmp/組織級6任務單task formtask/7項目跟蹤報告project tracking reportptr/8項目總結報告project summary reportpsr/組織級需求類（req）1可行性分析報告feasibility analysis reportfar/組織級2業(yè)務分析規(guī)格說明書business analysis specificationbas/組織級3前景與范圍vision and scopevns/組織級4軟件需求規(guī)格說明書software requirment specificationsr

5、s/組織級設計類（dsn）1總體設計說明書general design specificationgds/項目級2數據庫設計說明書database design specificationdbds/項目級3用戶界面設計說明書user interface design specificationuids/項目級4接口設計說明書interface design specificationids/項目級 文檔管理規(guī)范 v1.0密級：秘密2012-6-12第 5 頁 共 9 頁5詳細設計說明書detailed design specificationdds/項目級實施類（imp）1軟件配置清單soft

6、ware configuration listscl/項目級2軟件開發(fā)文件software development filesdf/項目級3系統(tǒng)部署文檔system deployment documentsdd/項目級測試類（tst）1單元測試用例unit test caseutc/2單元測試數據unit test datautd/3單元測試腳本unit test scriptuts/4單元測試報告unit test reportutr/項目級5集成測試用例integration test caseitc/6集成測試數據integration test dataitd/7集成測試腳本integ

7、ration test scriptits/8集成測試報告integration test reportitr/項目級9系統(tǒng)測試用例system test casestc/10系統(tǒng)測試數據system test datastd/11系統(tǒng)測試腳本system test scriptsts/12系統(tǒng)測試報告system test reportstr/組織級發(fā)布類（rel）1產品技術白皮書product technical whitepaperptw/組織級2系統(tǒng)安裝手冊system installation manualsim/組織級3用戶操作手冊user operation manualuom/

8、組織級4產品維護手冊product maintainance manualpmm/組織級 文檔管理規(guī)范 v1.0密級：秘密2012-6-12第 6 頁 共 9 頁5產品培訓資料product training materialsptm/組織級6產品發(fā)布聲明product release noteprn/組織級其它1評審報告review reportrr/2員工周報weekly reportwr/對于以上文檔清單中未列出的文檔，可參考以下編碼規(guī)則以確定其代碼：參考編碼規(guī)則中文名稱英文名稱代碼中文名稱英文名稱代碼計劃planpln樣例samplesmpl模型modelmdl文檔documentdo

9、c數據datadata工具tooltool腳本scriptscrp報告reportrpt問題issueiss參考資料referenceref4. 文檔標識文檔標識4.1 帶版本文檔帶版本文檔帶版本文檔指的是有版本修訂、演進過程的文檔，項目中絕大部分管理文檔和技術文檔（第三節(jié)的文檔清單中以黑色字體標識）都是帶版本的。4.1.1 標識號（標識號（id）文檔的標識號用于命名文檔，同時寫入文檔的配置管理頁與頁眉中。帶版本文檔的標識號形式為：項目/產品英文簡稱-系統(tǒng)/子系統(tǒng)/組件代碼-文檔類別-文檔代碼其中：項目/產品英文簡稱：項目/產品立項時確定的英文名稱縮寫，如 obs_1.0系統(tǒng)/子系統(tǒng)/組件代碼

10、：系統(tǒng)/子系統(tǒng)/組件代碼用于標識文檔的級別或其所屬的子系統(tǒng)/組件。對于系統(tǒng)級文檔，該代碼為 sys；對于子系統(tǒng)/組件級文檔，該代碼為子系統(tǒng)/組件代碼。子系統(tǒng)/組件由項目經理在總體設計完成之前確定，并寫入總體設計規(guī)格說明書 文檔管理規(guī)范 v1.0密級：秘密2012-6-12第 7 頁 共 9 頁文檔類別：本文檔第二節(jié)確定的文檔類別文檔代碼：本文檔第三節(jié)確定的文檔代碼，如果同類文檔有多個，可以在本節(jié)加上兩位數的編碼。樣例：obs_1.0-sys-mng-sds為 obs 系統(tǒng) 1.0 版的軟件開發(fā)日程表obs_1.0-sys-dsn-mod為系統(tǒng)設計模型obs_1.0-jsp-dsn-dds為 j

11、sp 組件的詳細設計規(guī)格說明書obs_1.0-jsp-tst-utr為 jsp 組件的單元測試報告obs_1.0-sys-tst-itd01為集成測試的第一組測試數據4.1.2 版本號版本號版本號形式為 x.y，其中 y 表示文檔修訂的次數，x 表示文檔發(fā)布的次數。文檔初始版本號為 0.1，以后每產生一次修訂，y+1第一次發(fā)布的正式版版本號為 1.0，以后每產生一次修訂，y+1重新評審和發(fā)布，x+14.2 無版本文檔無版本文檔無版本文檔指的是由項目當前狀態(tài)評估而產生的各種文檔，如評審報告、scm 報告、sqa 報告等各種報告以及任務單、變更請求表等表單。在第三節(jié)的文檔清單中以灰色字體標識。4.

12、2.1 項目文檔項目文檔項目中無版本文檔的標識號形式為：項目/產品英文簡稱-系統(tǒng)/子系統(tǒng)/組件代碼-文檔類別-文檔代碼-日期/編碼其中：項目/產品英文簡稱：項目/產品立項時確定的英文名稱縮寫，如 obs_1.0系統(tǒng)/子系統(tǒng)/組件代碼：系統(tǒng)/子系統(tǒng)/組件代碼用于標識文檔的級別或其所屬的子系統(tǒng)/組件。對于系統(tǒng)級文檔，該代碼為 sys；對于子系統(tǒng)/組件級文檔，該代碼為子系統(tǒng)/組件代碼。子系統(tǒng)/組件由項目經理在總體設計完成之前確定，并寫入總體設計規(guī)格說明書 文檔管理規(guī)范 v1.0密級：秘密2012-6-12第 8 頁 共 9 頁文檔類別：本文檔第二節(jié)確定的文檔類別文檔代碼：本文檔第三節(jié)確定的文檔代碼（

13、若有本文檔中未識別出來的文檔，請及時通知您的 sqa 工程師以獲得幫助）日期/編碼：對于各種報告規(guī)定為報告的日期，形式為 yyyymmdd；對于各種表單則為 3 位數的流水號樣例：obs_1.0-sys-req-rr-20011121為 2001 年 11 月 21 日需求評審的報告obs_1.0-jsp-dsn-rr-20011121為 2001 年 11 月 21 日 jsp 組件詳細設計評審的報告obs_1.0-sys-scm-cr-001為項目的第一個變更請求4.2.2 員工周報員工周報員工周報命名方式為：wr-name（-日期）其中：name：公司統(tǒng)一的 email 帳號日期：項目規(guī)定的報告日期，形式為 yyyymmdd樣例：wr-lijuan-200111215. 文檔格式文檔格式文檔的格式包括：文檔封面頁眉和頁腳目錄（正文 10 頁以上的文檔必須有目錄）標題與字體格式配置管理頁（所有帶版本的文檔必須有配置管理頁） 文檔管理規(guī)范 v1.0密級：秘密2012-6-12第