项目文档管理规范
- 格式:docx
- 大小:118.03 KB
- 文档页数:8
项目文档管理规范
2015年x月x日
目录
1. 编写目的 (3)
2. 适用范围 (3)
3. 文档规范 (3)
3.1 基本情况 (3)
3.2 文档命名规则 (3)
3.3 文档封面要求 (4)
3.4 修订记录要求 (4)
3.5 页眉/页脚的要求 (5)
3.6 正文格式要求 (5)
3.7 新建文档要求 (6)
3.8 文档变更要求 (6)
3.9 其他要求 (6)
4. 文档目录结构 (6)
5. 文档管理 (7)
6. 文档模板 (7)
1.编写目的
为保证项目实施过程中项目文档的规范性和有效性,积累项目经验,形成项目知识文档,为项目的有效推进和建设打下基础,特制定此文档管理规范。
2.适用范围
本规定适用于项目组成员在项目中所提交的文档。
3.文档规范
3.1基本情况
文档规范包括:文档命名原则、封面的要求、修订记录要求、页眉/页脚的要求、正文格式要求、需求类文档格式、模板等几个方面,下面从个别方面详细介绍,并适当举例。
3.2文档命名规则
XXXX_ZZZV99_YYYYYY.FFF格式
3.2.1XXXX -- 文档类型:直接填写中文,参考类型如下:
3.2.2ZZZV99 -- 项目+版本号:大写V后跟数字,建议是小数点形式。例
如:妈妈100V4.0,商家中心V3.2等
3.2.3YYYYYY -- 主题:可以是中英文,长度自行控制,尽量保持短小,
精简。例如:免费试用、商品分类优化等,让人感觉清晰易懂。
3.2.4FFF -- 文件扩展名:按Windows标准。例如: .doc .ppt .xls
下面以产品需求文档命名为例子:
需求:产品需求_妈妈100V3.2_免费试用.doc
细则:产品需求_妈妈100V3.2_会员成长值体系细则.xls
原型:产品需求_妈妈100V3.2_免费试用原型.rp
3.3文档封面要求
文档封面的基本要素是文档名称和文档编写日期,也可注明适配的系统等等,其具体格式如下:
3.4修订记录要求
修订记录主要体现文档的修改情况,目的是对文档编写过程进行追溯。基本要素包括修订人、修订时间和变更内容说明、修订版本。文档后续的变更,建议使用红色加下划线字体。具体格式如下:
3.5页眉/页脚的要求
对于一般的文档,页眉要求如下(建议套用模板的):
页眉的左上方是“妈妈100”图标,中间是文档名称,对于较长的文件名称一般只写文件类别名称,譬如XXX项目软件需求说明书,一般写为“软件需求说明书”。右上角显示“内部资料”。
3.6正文格式要求
对于正文要求为:标题采用四号宋体加粗的格式,可采用多级标题,而正文都是采用小四宋体,1.5倍行距。下图是文档正文的格式:
3.7新建文档要求
尽可能通过模板新建文档,从其他格式转换的文档也必须遵守格式要求;
按命名规则设置文档名,文档在提交前不放入正式文档的目录,可先放在个人文档目录下。
3.8文档变更要求
3.8.1变更文档时务必更改文档修订记录的内容。
3.8.2正文的修改部分要求用下划线,字体用红色标识。
3.8.3修改文档时请使用“修订”功能,以便更好的了解修改的内容,以
及查阅最终版本。
3.8.4文档变更后,通过必要的途径通知项目相关人,例如通过邮件通知
或者公告通知的方式,避免新的文档产生后还有大量的使用者使用旧
的文档。
3.8.5保留所有原有版本备查。
3.9其他要求
3.9.1文档目录采用自动生成方式,一般不超过三级。
3.9.2正文中引用的文件或表单,需要单独编制,并在附件中列出。
3.9.3在模板中用于说明的文字,要求用蓝色标识,使用时删除。
3.9.4英文缩写及专用名词必须以全“大写”字母表示,如MKT。
3.9.5粘贴图片应采用“.JPG”、“.GIF”等经过压缩的图片格式,不能使
用“.BMP”等未经压缩的图片格式。
3.9.6注意控制文档的页数和大小,原则上不超过100页和不大于10M,若
文档的页数和大小超过限制,应采用附件形式对文档分拆成册。4.文档目录结构
为了能够在纷繁复杂的文档中找到需要的文档,需要在进行文档管理时建立
一套完整的文档目录体系,对各类文档进行分类管理。项目文档的目录结构建议如下:
子目录暂不做细分,如果一个目录内文档比较多,可新建目录来存放。以产品需求为例,如果“免费试用”模块有多个需求文档,可以新建“免费试用”
目录,把相关文档都存放在此目录内,便于查找,也避免因存放路径过多,遗漏了个别文档。
5.文档管理
5.1全部项目文档均由专门的项目文档管理人员按本规范要求进行监督和管
理。
5.2文档管理人员需对项目文档、目录定期进行备份。
5.3个人文档供项目成员进行文档交流所用,由个人自行备份,也可上传到
项目或者团队的分享目录中。
6.文档模板
面对各类纷繁复杂的文档,如果各式各样,每个人一个风格,不论从美观性和可读性上,都会有影响,所以在文档管理过程中需要建立一套文档的模板。
在建立文档模板时,需要对一些格式进行要求,需要将一些基本的要素固化到文档模板中,确保文档需要的内容能够在文档中体现,例如文档的页眉页脚、文档变更历史、文档的目录方式、文档的字体等。建议项目团队各自建立起常用的文档模板,以规范日后文档的编写。