項目文檔管理規範-記得收藏

前言：聽曲一首

1. 引言

1.1 文檔目的

為加強檔案的管理，確定檔案管理的規範化、合理化，避免資訊機密的洩露，便于各種檔案合理有效地儲存與利用，便于對文檔的查閱和文檔版本的控制，起到對技術文檔編寫者的指導性原則，特制定本規範。

1.2 适用範圍

适用對于軟體開發的各種技術資料、代碼，各種項目管理過程全過程産生的文檔。

2. 技術文檔管理規範

2.1 配置管理庫目錄結構

目前使用SVN（Git）配置管理工具進行對項目文檔、代碼的版本管理，項目開發過程中所有項目文檔和代碼必須全部存放到SVN（Git）配置庫中。SVN（Git）配置庫分為開發域、管理域、基線域和産品域。開發域對項目開發過程中的文檔、代碼的版本管理；管理域是項目管理過程中産生的文檔版本管理；基線域是項目在各階段形成基線後文檔、代碼的管理；産品域是存放已經釋出并傳遞客戶後的産品及相關文檔。

配置庫目錄結構參見：《配置庫目錄結構》檔案包。

2.2 文檔命名規範

2.2.1 檔案在配置庫中的命名規範

項目中的檔案包括兩大類：技術文檔、管理文檔；該兩類文檔以及過程域相關文檔都納入配置庫中管理。

技術文檔：屬于産品組成部分的工作成果，如項目計劃書、需求相關文檔、設計相關文檔、源代碼、測試用例等。

管理文檔：項目管理和機構支撐過程域中産生的文檔。這些文檔雖然不是産品的組成部分，但是值得儲存。比如：項目周例會、項目周報、項目日志、使用者需求跟蹤矩陣、風險識别等。

2.2.1.1 過程域檔案命名規範

過程域檔案是指過程定義文檔、各種規程及相關模闆等，文檔儲存在SVN配置管理庫中。

過程檔案命名為“XXX過程”，“XXX”為過程域全稱。如：技術解決方案過程域的過程檔案為“技術解決方案過程”。

規程文檔以實際的内容為辨別，如：XXX規範、XXX規程、XXX指南等。

模闆文檔的名稱與實際在項目運用過程中用到的名稱保持一緻，統一為已定義的模闆文檔名。

2.2.1.2 技術檔案命名規範

技術檔案是指項目開發過程中産生的技術文檔，文檔儲存在SVN（Git）配置管理庫中的檔案命名規範格式為：“YYYZZZ”。其中：

“YYY”為技術文檔名稱。

“ZZZ”為自定義項。一般為文檔版本号；也可為版本号+日期。其格式如下圖：

2.2.1.2技術檔案命名規範

示例：

XXX項目的“使用者需求說明書”文檔，在SVN（Git）配置庫中的辨別為：“使用者需求說明書V1.0”。

2.2.1.3 管理檔案命名規範

管理檔案是指項目管理過程中産生的文檔，文檔儲存在VSS配置管理庫中的檔案命名規範格式為：“YYY_ZZZ”。其中：

“YY…Y”為管理檔案名稱。

“ZZZ”為自定義項，如果沒有，則該項可以預設。

示例：

示例1：“個人周報_小王”表明：此文檔為小王的個人周報。

2.3 文檔辨別規範

文檔辨別規範指文檔的唯一辨別，對于文檔均有一個文檔辨別。

2.3.1 過程域文檔辨別

對于過程域的文檔标使用中文全稱命名。

2.3.2 項目文檔辨別

項目文檔均存放在項目指定的檔案夾下，檔案夾名稱命名為項目中文名稱。

對于項目中的文檔辨別格式為：“YYY_ZZZ”。其中：

“YYY”為技術文檔名稱。

“ZZZ”為自定義項。一般為文檔版本号；

示例：

XXXX項目的“使用者需求說明書”文檔中文檔辨別為：” 使用者需求說明書V1.0”。

2.3.3 配置項辨別

為了管理配置項，在配置管理過程中，配置員需對每個配置項進行辨別；

XXX-YYYY-ZZZZ_XXXX

XXX:公司簡稱

YYYY:年份

ZZZZ:文檔編号

XXXX:文檔名稱拼音首字母

2.4 版本辨別

項目檔案一般包括技術檔案和管理檔案兩種，其中技術檔案如：軟體需求規格說明書、概要設計、詳細設計和代碼等。管理文檔包括項目計劃書、系統測試計劃書等，下面對這些文檔的版本辨別應遵循以下規範：

版本的基準格式為：Vx.y：

1、新起草的檔案版本定為V0.1版。

2、逐漸完善的檔案但還沒有通過評審的，版本更新為V0.1~0.9版。

3、通過正式評審的檔案版本更新為V1.0版，可對外釋出。

4、經過一級、二級變更的檔案，可更新為V1.y版，“y”可根據次數依次遞增。

3. 文檔安全管理

項目在研發過程中，是以的技術資料（包括：技術文檔、管理文檔、代碼）都儲存在部門内部的配置管理庫SVN中；配置庫根據人員的崗位進行權限配置設定。

配置管理庫SVN的權限管理：

角色	操作文檔項	操作權限
部門經理	SVN配置庫中的所有權限	所有權限
項目經理	所負責項目的文檔所有權限	所有權限
需求分析員	使用者需求說明書、軟體需求說明書、界面原型、需求跟蹤矩陣等。	文檔的增、删、改、查的操作，其它文檔可檢視
開發主管	軟體概要設計、資料庫設計、詳細設計、代碼等	文檔的增、删、改、查的操作。（其它文檔可檢視）
程式員	詳細設計、代碼等	文檔或負責的子產品增、删、改、查的操作。（其它文檔可檢視）
配置管理者	所負責項目的文檔所有權限	所有權限
美工	界面原型。	界面原型的增、删、改、查的操作。需求文檔查閱功能
測試工程師	系統測試用例、系統測試報告	系統測試用例、系統測試報告的增、删、改、查的操作。需求文檔查閱功能

4. 知識産權

為確定公司的知識産權得以良好的保護，避免因知識産權流失或洩漏造成公司的重大損失，制定本辦法，本辦法适用于研發部門，并遵循公司的保密政策。

4.1 知識産權的範圍：

技術秘密和商業秘密：指公司研制開發的與知識産權相關的各種技術文檔、技術資料、代碼、電腦CD光牒、榮譽實物、證件等不同形式的展現或隐含知識産權的曆史記錄或實物。還包括儲存有知識産權資訊的計算機硬碟、軟碟、移動式儲存設備和錄音帶、錄像帶等磁媒體載體。

4.2 知識産權的内容：

軟體技術資料（是指正式啟動的項目在其生命周期内産生的、經稽核通過後的所有文檔），源程式、資料庫、技術方案、軟體産品、技術發展規劃等。

員工在職期間編制出來的與工作相關的各類技術知識檔案

4.3 知識産權的秘密等級

知識産權的秘密等級一般分三個級别：絕密級，機密級，秘密級。

下表是知識産權保密等級

密級	範圍	備注
絕密	系統驗收（或釋出）後的源代碼、通過稽核的技術文檔（包括：需求文檔、設計文檔、測試報告、驗收報告等）	儲存在公司的“企業文檔（或知識）管理系統”中
機密	各種技術規劃、編碼規範、設計規範、以及正在研發的相關技術文檔技術方案	儲存在部門的SVN配置管理庫中
秘密	項目管理過程中的各種資料：項目周報、項目日志、項目品質記錄、評審記錄、項目檔案、使用者手冊、項目	儲存在部門的SVN配置管理庫中