软件品质管理系列九文档管理规范.docx
- 文档编号:11757866
- 上传时间:2023-03-31
- 格式:DOCX
- 页数:18
- 大小:68.73KB
软件品质管理系列九文档管理规范.docx
《软件品质管理系列九文档管理规范.docx》由会员分享,可在线阅读,更多相关《软件品质管理系列九文档管理规范.docx(18页珍藏版)》请在冰豆网上搜索。
软件品质管理系列九文档管理规范
文档管理规范
变更历史
编号
年月日
变更号码
页数
编制
审查
确认
审议及确认
1
2004.03.10
新建
A4:
18页
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
页数包含封面、变更历史、变更书、目录
Sheet编号
1/1
目录
1目的4
2文档管理概要4
2.1规定4
3文档的构成4
3.1文档的种类4
3.2文档的结构4
3.3文档的编写规范7
3.3.1编写工具7
3.3.2用纸7
3.3.3文章的写法7
4文档的管理9
4.1文档的编制、审查和确认9
4.2文档的识别及登录管理9
4.3文档的发行10
4.4文档的变更10
4.5文档的收领10
4.6文档的保管10
5相关记录11
附录1.文档类别12
附录2.封面13
附录3.变更历史14
附录4.变更书15
附录5.文档管理台帐格式16
附录6.文档传送票格式17
附录7.文档发送对象管理台帐格式例18
1目的
明确文档的规格、制作规定及管理方法。
2文档管理概要
2.1规定
Ø文档编写者负责按相应的文档编写基准、及本文中的文档编写规范编制文档。
当编写者不唯一时,须推选其代表作为文档负责人。
Ø文档负责人负责确认文档,并对文档表述方式的统一性和内容的连贯性负责。
Ø文档须经过审查、确认后方能发行,已发行的文档必须明确标注编制、审查、确认者的姓名方才有效。
Ø文书负责登记和维护《文档管理台帐》,并统一管理文档的发行、改版、收领、保管等相关事宜。
3文档的构成
3.1文档的种类
文档管理的对象大致可分为四类:
(1)产品的规格说明文档或对产品品质有影响的说明书,包括:
Ø要件定义书
Ø功能说明书
Ø详细设计书
Ø相关的编写基准等
(2)与项目计划相关的文档,包括:
Ø开发计划书
Ø检查计划书
Ø监察计划书
Ø测试计划书等
(3)从项目外接收的与项目产品及其品质相关的文档
(4)各项目认为有必要管理的其他文档
3.2文档的结构
文档的结构如图3.2-1所示。
表3.2-1中表示文档各部分的页数和规格。
表3.2-1文档各部分的页数及规格一览
编号
名称
页数
1
封面
1页
2
变更历史
数页,视变更情况而定
(通常归纳为一页)
3
变更书
1~数十页,视变更情况而定。
通常1个变更号码对应一页
(新编制的文档没有变更书)
4
目录
数页
5
正文
按文档的编写需要分页
文档各部分的组成要素及其说明如下:
(1)封面
作为各文档的特定要素,包含以下项目:
1文件编号
记录该文档的唯一编码,编码规则参见公司的《质量体系文件及项目文件标识规定》。
2版本号
记录该文档的发布版本号。
3密级和受控状态
密级:
记录该文档的保密级别,通常分为绝密、机密和公开三类,由各项目决定;
受控状态:
一律为受控。
4系统名称
记录系统名称或项目名称。
5文档名称
记录该文档的名称。
(2)变更历史
以管理文档的发行/变更历史为目的,包含以下项目:
1年月日
记录该文档创建及发生变更的日期,记录格式为「YYYY.MM.DD」。
(在本规范中如无特别说明,一律采用上述的日期记录格式)
2变更号码
新创建时,填写「新建」。
从第一次变更开始(记为「#1」),依此类推,记录变更次数。
3纸型-总页数
记录该文档的纸型和总页数,记录格式为:
「纸型:
总页数」,如A4:
16页。
4编制
记录该文档的作者或修改人的姓名,以及创建或修改日期。
5审查
记录该文档的审查人的姓名和审查日期。
6确认
记录该文档的确认人的姓名和确认日期。
7审议及确认
如果该文档需要经过相关组或部门的审议确认,则此处记录审议确认人的姓名和审议确认日期。
如需多人审议确认,则此处记录负责人或代表的姓名。
8Sheet编号
当表格跨页时,记录表格当前页的序号和表格的总页数,记录格式为「表格当前页的序号/表格总页数」。
例如某表格共三页,则表格第1页的Sheet编号为:
1/3
(3)变更书
在文档发生变更时,明确记录变更内容,包含以下项目:
1变更号码
记录文档的变更次数,使其下的变更内容与文档的变更历史相对应,记述方式与变更历史的变更号码项相同。
2变更内容
记录该文档的变更内容和变更位置,明确变更前后的变化。
3变更页
记录与变更内容对应的变更页号。
4变更类别
记录变更内容所属的变更类别。
变更类别如下所示。
编号
变更类别
说明
1
追加
增加新的页
2
变更
变更现存页的内容
3
删除
删除现存页的内容
5变更人
记录变更执行人的姓名。
(4)目录
根据该文档的正文形成目录。
(5)正文
正文的构成因文档不同而有所差异,其记述方式可参照对应的编写基准。
3.3文档的编写规范
3.3.1编写工具
如无特殊需要,一般使用Microsoft公司的Office系列产品(Word/Excel/PowerPoint)、Visio、及CA公司的ERWin(或同类产品)编写文档。
3.3.2用纸
文档原则上使用A4纵纸,用其他纸型编写的页在文档提交前要合并为A4。
但是,图和表若用A4横纸合适的话,也可以接受。
3.3.3文章的写法
(1)字体
正文字体原则上使用宋体、五号字,正文行距1.5倍。
(2)目录
目录中最多包含3层项目号。
「目录」二字使用宋体、小四、加粗,目录体使用宋体、五号字。
(3)页号
页号从文档的封面开始为第一页,用连续的号码标注。
记录格式为:
第x页共x页,封面页不显示页号。
其他页号在页脚的右下角记述。
(4)页面设置
页边距:
上/下:
2.5cm左/右:
2.8cm
装订线:
0.3cm装订线位置:
左
(5)页眉/页脚
页眉、页脚参照本文的页眉和页脚的格式。
字体为宋体、小五号字。
(6)项目号
文档的项目号可归纳为下述7个,原则上,不应有比①更细的分法。
1
1.1
1.1.1
1.1.1.1←.号最多4个。
可能的话,应尽量控制为3个。
(1)
(a)
①
其中:
标题1—宋体四号字、加粗
标题2—宋体小四号字、加粗
标题3—宋体五号字、加粗
标题4—宋体五号字、加粗
标题行距1.5倍,段前、段后各0.5行。
(7)图·表的标注方法
(a)表在其上加号码及标题,图在其下加号码及标题。
(b)图号码、表号码的标注方式为:
项目号+「-」+图·表在此项目下的顺序号(图·表分开排序)。
例如:
(c)同一表跨多个页时,在各个页上标注表号码+「-」+顺序号码、及表的标题。
例如:
第一页表5.2-2(1/3)
第三页表5.2-2(3/3)
(d)图·表的标题格式为:
「图」或「表」+图或表的号码+空格+图或表的标题。
例如:
4文档的管理
4.1文档的编制、审查和确认
文档在发行前必须明确标注编制、审查、确认者的姓名。
当文档的编写者不唯一时,应确定一代表作为文档负责人,并在「编制」栏中填写其姓名。
当文档的审查、确认者不唯一时,可以顺序填写其姓名,也可以只填写代表的姓名,由各项目自行确定。
审查文档的目的是:
确认文档的技术性或实质性是否恰当、正确、符合要求,因此审查者一般拥有比编写者更高的资格,通常为比编写者更高一级的负责人。
确认文档的目的是:
保证文档经过了切实有效地审查,并获得了组织上的认可。
文档的确认人及其有权的确认范围可参照下表:
编号
确认人
确认范围
1
项目组长或项目经理
项目组内使用的文档及对外报送的文档
2
总PM或部门负责人
部门内部使用的文档
3
部门负责人
向部门外报送的文档
实际的文档确认人也可以是比上表中的确认人更高级别的人员或由上表中的确认人授予权限的人,但权限的授予应事先在项目的开发计划书中明确。
对外交纳的产品文档及电子介质上的文档,在不能将编制、审查、确认人记入本体的情况下,应另外编制一份只有封面和变更历史的文档,填写文档的编制、审查、确认及变更信息,并用《文档管理台帐》统一管理。
4.2文档的识别及登录管理
在发行文档前,为了便于识别和管理,必须对文档进行统一编码,文档的编码规则可参见公司的《质量体系文件及项目文件标识规定》或由项目组自行制定。
文书负责将已发行的文档记入《文档管理台帐》,统一管理文档的版本、变更、发行等信息。
文档类别可参照附录1.填写。
4.3文档的发行
发行文档时,应针对文档发送对象编制《文档传送票》,和文档一并发送给对方,得到对方的确认回答后视为发行成功。
发行成功的文档,应记入《文档发送对象管理台帐》,明确发送的文档、文档发送对象、发送日期及对方确认日期等信息,便于日后查询和管理。
4.4文档的变更
当已发行的文档发生变更时,需要发行应对的变更文档。
具体的方法如下:
(1)在修改文档的同时,须记录文档的变更历史、并编制本次变更的变更书,明确记录文档的变更内容;
(2)变更文档的编制、审查、确认标准参照4.1;
(3)变更后的文档须再次整体发行,并在《文档传送票》中注明对旧版本文档的处理方式(原则上旧版本文档应在对方确认接受变更文档后废止)。
4.5文档的收领
项目组从外部接收文档的管理办法为:
(1)当发送方在《文档传送票》中注明了文档的使用方式时,应首先遵从发送方的指示。
(2)文书检查收到的文档和《文档传送票》上记载的版本、内容是否一致,检查无误后向发送人返送确认信息。
(3)项目经理或项目组长确定接收的文档是否适合在项目内使用,并决定文档的使用者。
(4)文书将经过确认的文档登记到《文档管理台帐》,并将文档分发给使用者。
4.6文档的保管
文书应同公司或有关部门就文档的保管办法达成协议,明确文档的保管场所、保管期限、交付方式和废止办法。
此外,文书应在年初按照公司现行的文档体系编制《文档管理台帐》,并在本年度内定期管理台帐,确认文档的保管状态。
同时保管文档的新、旧版本时,应在旧版本的封面上用红色明确标注「旧版本」字样。
5相关记录
输入
输出
相关基准
示例
《文档管理台帐》
《文档传送票》
《文档发送对象管理台帐》
附录1.文档类别
文档类别详见下表。
文档类别表
编号
文档类别
说明
1
顾客
业务式样书(包含顾客编写的要件定义书和要件确认书)
2
BS
基本设计书、提案书
3
RS
要件定义书
4
开发
开发计划书、其他计划书
5
基准
基准书
6
管理
管理资料
7
指导
指导标准
8
AS
机能式样书
9
DS
详细设计书
10
IS
接口式样书
11
OM
操作手册
12
定义
定义书
13
DM
设计要点
14
现行
现行系统资料
15
其他
其他
附录2.封面
文件编号:
版本号:
密级:
受控状态:
受控
系统名称
文档名称
XXXX规范
分册名称
北京XXX科技发展有限公司
附录3.变更历史
变更历史
编号
年月日
变更号码
纸型-总页数
编制
审查
确认
审议及确认
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
页数包含封面、变更历史、变更书、目录
Sheet编号
/
附录4.变更书
变更书
变更号码
序号
变更内容
变更页
变更类别
变更人
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Sheet编号
/
附录5.文档管理台帐格式
附录6.文档传送票格式
附录7.文档发送对象管理台帐格式例
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件 品质 管理 系列 文档 规范