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的权限管理：

4. 知识产权

为确保公司的知识产权得以良好的保护，避免因知识产权流失或泄漏造成公司的重大损失，制定本办法，本办法适用于研发部门，并遵循公司的保密政策。

4.1 知识产权的范围：

技术秘密和商业秘密：指公司研制开发的与知识产权相关的各种技术文档、技术资料、代码、电脑光盘、荣誉实物、证件等不同形式的体现或隐含知识产权的历史记录或实物。还包括保存有知识产权信息的计算机硬盘、软盘、移动式存储设备和录音带、录像带等磁介质载体。

4.2 知识产权的内容：

软件技术资料（是指正式启动的项目在其生命周期内产生的、经审核通过后的所有文档），源程序、数据库、技术方案、软件产品、技术发展规划等。

员工在职期间编制出来的与工作相关的各类技术知识文件

4.3 知识产权的秘密等级

知识产权的秘密等级一般分三个级别：绝密级，机密级，秘密级。

下表是知识产权保密等级