乐于分享
好东西不私藏

每日一背——项目文档管理

每日一背——项目文档管理

一、管理基础

1、文档分为三类:开发文档、产品文档、管理文档。

1)开发文档描述开发过程本身,基本的开发文档是:可行性研究报告和项目任务书、需求规格说明、功能规格说明、设计规格说明(包括程序和数据规格说明、开发计划、软件集成和测试计划、质量保证计划、安全和测试信息)。

2)产品文档描述开发过程的产物,基本的产品文档包括:培训手册、参考手册和用户指南、软件支持手册、产品手册和信息广告。

3)管理文档记录项目管理的信息,例如:开发过程的每个阶段的进度和进度变更的记录、软件变更情况的记录、开发团队的职责定义、项目计划、项目阶段报告、配置管理计划

2、文档的质量通常可以分为4级:

1)最低限度文档(1级文档),适合开发工作量低于一个人月的开发者自用程序。该文档应包含程序清单、开发记录、测试数据和程序简介。

2)内部文档(2级文档),可用于没有与其他用户共享资源的专用程序。除1级文档提供的信息外,2级文档还包括程序清单内足够的注释以帮助用户安装和使用程序。

3)工作文档(3级文档),适合于由同一单位内若干人联合开发的程序,或可被其他单位使用的程序。

4)正式文档(4级文档),适合那些要正式发行普遍使用的软件产品。关键性程序或具有重复管理应用性质(如工资计算)的程序需要4级文档。4级文档遵守GB/T2006-8567的有关规定。

二、规则和方法

1、文档书写规范

无论是哪种类型的文档都应该遵循统一的书写规范。例如,在程序的开始要用统一的格式包含程序名称、程序功能、调用和被调用的程序、程序设计人等。

2、图表编号规则

图表的编号一般采用分类结构。

3、文档目录编写标准

4、文档管理制度

文档的管理制度需根据组织实体的具体情况而定,主要包括建立文档的相关规范、文档借阅记录的登记制度、文档使用权限控制规则等。