实际软件开发项目工作中会涉及到大量的项目文档，譬如需求文档、设计文档、数据库/接口说明、测试报告等等。很多时候文档的水平也反映了公司的整体水平，尤其是需要交给客户的用户手册、部署手册等文档，万一出现错别字或者排版不美观，会给公司形象打折扣。
但目前公司人员水平参差不齐，做的文档也是各式各样，归根结底还是由于公司本身没有相应的文档管理规范，也没有对员工进行相应培训。作为产品经理，是无法忍受目前这种混乱的文档管理的，因此根据公司实际情况，并参考借鉴了其他公司的规范，制作了本公司的文档管理规范。

目录

1 编写目的****1

2 任务概要****1

2.1 工作内容 1

2.2 工作要求 1

2.3 工作程序 1

3 文档管理规范****2

3.1 总则 2

3.2 内容 2

3.2.1 需求/设计方案 2

3.2.2 软件开发过程文档 2

3.2.3 会议/培训/部署文件 2

3.2.4 参考文档 3

3.3 文档命名规范 3

3.4 文档内容撰写建议 3

3.5 Word文档撰写规范建议 3

3.6 存档规范 4

3.7 目录建设与管理 4

3.8 文档的提交、保存及修改 4

3.8.1 文档提交 4

3.8.2 文档修改 4

4 SVN管理服务器****5

4.1 文档存放目录 5

4.2 文档权限 5

1 编写目的

1）制订统一的文档管理办法及格式，对项目过程中产生的项目有关资料提供规范，便于在今后项目开展过程中对各项资料的查找和相互交流，以利项目开发及进展；

2）制订项目开发过程中的评审和查阅规范，明确相应的管理人员责任。

2 任务概要

2.1 工作内容

项目发展的过程中，随着项目逐步展开，会产生大量的设计方案文件、设计说明书、源代码、会议记录及培训资料等内容，对这些内容进行分类整理归档；同时根据项目需要，对有关文档在项目文档服务器上发布。

2.2 工作要求

项目部目前使用SVN管理项目文档，建立相应文档目录，根据要求适时添加文档并与相关人员（各专业组负责人）合作及时将文件归档，注意对项目信息的及时更新，以帮助各组人员获得最新信息。

2.3 工作程序

1. 对于项目常规文档：

1. 综合组对文档（纸质和电子版）收集及文档分类；

2. 各专业组负责人负责对项目每个阶段过程中产生的文档资料进行汇总，由负责人审核后将相关文档上传到SVN服务器相关目录（建立统一的项目文档目录，例如命名为“项目文档”）下；

3. 项目进行每个阶段产生的各项文档资料包括：调研资料、需求说明、设计方案文件/图、设计说明书、用户手册、部署手册、会议培训资料、汇报材料、报告文件、数据文档、文献等文档资料。

2. 对于项目存档文档：

1. 综合组对项目常规文档目录下的文档进行审核；

2. 对阶段性重要的文件进行归档，文档管理员将其处理成PDF格式，加入文档编号后上传到SVN服务器相关目录下。

3 文档管理规范

3.1 总则

1. 项目正式启动前，由项目负责人确定本项目名称、必须具备的文档及相对应文档负责人；

2. 所有重要文档集中管理，维护档案的安全与完整；

3. 所有存档文件根据需要归档；

4. 各项目专业组人员在工作中形成的具有参考价值的文件、材料由个人或该项目组负责人整理后报文档管理人员存档；

5. 所有人员均有承担按时提交文档的义务和职责；

6. 由专人负责项目文档管理工作，通常为项目负责人，如有专职项目管理，则由项目管理人员担任。

3.2 内容

3.2.1 需求设计方案

需求说明书、功能说明书、合同（技术部分）等。

3.2.2 软件开发过程文档

软件概要设计、详细设计书、源代码（包括注释）及源代码说明等。

3.2.3 会议/培训/部署文件

包括会议记录、演示PPT、阶段报告、培训材料、部署手册、使用说明、产品介绍、实施部署记录等文档；

3.2.4 参考文档

数据标准、数据格式说明、相关业务规范等。

3.3 文档命名规范

示例：合肥XX-项目文档管理计划-V1.0（20200728）.doc

1. 命名规则为：项目名称-类型-文件-版本号（日期）.后缀名；

2. 类型文档类型名称，可使用文档类型编号（根据文档内容此部分可以省略）；

3. 文件名为该文件的具体内容总称，文件名字数不限；

4. 版本号用于追踪相同文件的修改记录，通常为两位。使用字符“V”表示版本，一位数字表示修改次数。数字从“1”开始以自然数顺序排列，用于记录文档变化。最终确定稿用字符“F”替代数字；

5. 日期为记录文件的编写日期，用8位日历日期表示，如：2020年7月28日，在文件名中表示为20200728。

3.4 文档内容撰写建议

1. 明确需求，理清整体思路/框架；

2. 切勿从其他文档或网络上直接拷贝，不同文章站的角度不同，需充分理解其他参考文章的内容，再根据实际情况做出调整；

3. 理解每类文档的编写目的与最终读者，提供的模板仅供参考，并非标准，撰写时需要根据实际情况对模板进行适当裁剪，避免文档冗余。

3.5 Word文档撰写规范建议

1. 使用《置顶文档撰写参考模板.docx》进行编写；

2. 标题必须使用自动编号，禁止手动编号；

3. 使用Word“引用”-“插入题注”功能给表格、图片加题注，方便内容部分引用；

4. 擅于使用“交叉引用”功能；

5. 正确使用标点符号，切勿出现中英文标点符号混用情况；

6. 正确使用英文缩写，且在文档内保持统一，譬如WebGIS、Java；

7. 可以使用“编辑标记”，避免出现不必要的不可见标记，影响后续人员编辑；

8. 合理使用“分页符”、“分节符”，保证内容连贯；

9. 文档完成时，及时更新目录。

3.6 存档规范

1. 基线：活动完成或项目结束后两周内归档；

2. 完整性：是否成套、缺页和涂改；

3. 准确性：所收集的材料是否同它反映的对象相一致，同一项目的文件材料在内容上是否一致；

4. 文件材料属性的鉴别：是否为同一类；

5. 所有文档定期整理一次（1个月或2个月，根据实际情况），由公司网络设备负责人定期备份。

3.7 目录建设与管理

1. 所建目录要求符合明确方便的原则；

2. 查阅者能够迅速的查阅所要文档，了解文档简单的相关信息；

3. 文档用SVN服务器进行存储和管理；

3.8 文档的提交、保存及修改

3.8.1 文档提交

1. 文档的提交时间根据具体规定执行，在规定时限内提交；

2. 项目文档由文档作者提交，一般为Office形式（要求使用Office2007以上版本）。

3.8.2 文档修改

1. 项目进展过程中，随着对项目进一步的深入，将会产成一些需要修正的文档，对文档的修改需经过项目负责人的确认；

2. 文档修改则文档目录和编号也同时进行修正；

3. 文档修改后需在相关目录中标注修改，并记录到文档修改日志。

4 SVN管理服务器

4.1 文档存放目录

文档目录可由项目负责人根据项目实际情况进行划分，不做严格要求，尽量让用户能快速找到所需文档，同时避免层级过多，查找困难。

4.2 文档权限

项目部所有成员均可使用公共权限对文档服务器中的文件进行查阅，并且所有成员均有承担按时提交文档的义务和职责。