文件编写导则
文件修改控制
目录
1. 目的
1. 适用范围
2. 术语和缩略语
3.1 程序
3.2 程序文件
3.3 技术文档
4. 编制规范
4.1质量体系文件的结构
4.2文件的版面
4.3文件的封面
4.4文件的目录
4.5文件的正文
4.6表格文件
4.7文件编写注意事项
5. 引用文件
附录一:“质量体系文件封面格式”
附录二:“质量体系文件正文格式”
附录三:“技术文档封面格式”
附录四:“技术文档正文格式”
1.目的
为使公司所用的各种文件的编写规范、统一、提高工作效率特制定本导则。
2.适用范围
适用于质量体系文件和技术性文档的编写。
3.术语和缩略语
3.1 程序(procedure):本公司质量体系文件中所说的程序,是指为保证产品质量,
在进行软件开发或质量活动时所必须遵守的一系列步骤。不能和软件开发过程产
生的计算机程序(program)相混淆。
3.2 程序文件:以书面形式规定的在软件开发或质量活动中所必须遵守的步骤,即本
公司质量体系文件结构中的第二层文件。
3.3 技术文档:指在软件开发过程中所需的各种文档,它是执行质量体系文件产生的
结果。例如,需求分析报告、详细设计报告等。
4.编制规范
4.1 质量体系文件的结构
本公司质量体系文件可分为四层,其结构如下图:
质量
手册
程序文件
支持性文件
4.2 文件的版面
所有质量体系文件用纸规格均为A4,页面的上、下边距为20毫米,左边距为25
毫米,右边距为15毫米;页眉边距为15毫米,页脚边距为17.5毫米。正文行
距为1.5倍行距。
4.3 文件的封面
4.3.1 质量体系文件的封面
1)封面是质量体系文件的第一组成部分,文件封面包括公司注册图标、文件名
称、公司名称和控制栏;
2)控制栏包含项目有:受控编号、保密级别、文件编号、修改状态、版次、总
页数、正文页数、附录页数、生效日期、拟制人、审核人、批准人;
3)修改状态的表示方法:修改状态表示为“版次号+修改标识”,修改标识用一
位大写字母表示,取值从“A~Z”。文件每修改一次,对应一个修改状态,
文件升级版本时,修改状态清空;
4)公司图标在页眉下边靠右对齐;
5)文件名称居中,距页眉约12个单倍小四行距,字体为楷体小初;
6)控制栏居中,距文件名称约16个单倍小四行距,字体为楷体小四号;
7)公司名称居中,距控制栏约3个单倍小四行距,字体为楷体四号。紧靠在公
司名称的下面是外加括号的版权声明,字体为黑体小三;
8)程序文件的封面格式具体参见附录一。
4.3.2 技术文档的封面
1)技术文档的封面没有页眉,其顶部除公司注册标志外,还包括密级、文件编
号、分册名称和修改状态。字体为幼圆小三,1.5倍行距;
2)封面的中间部分包括项目名称、文档名称及开发部门名称;
3)封面的底部包括公司名称和页脚。页脚内容和质量体系文件相同;
4)技术文档的封面格式具体参见附录三。
4.4 文件的目录
目录是质量体系文件的第二部分,在目录里列出该文件正文部分各项条款的标
题,但不超过两级。在目录页内“目录”二字为黑体二号。
4.5 文件的正文
4.5.1 质量手册及程序文件的正文要求
质量手册及程序文件的正文部分包括页眉、页脚和正文内容。
1)页眉由横线上文件名称、版次、修改状态标识和页码组成,页眉字体为楷体
小四;页脚是在一条横线下面加上公司名称,字体为楷体五号。
2)质量体系文件的正文内容的字体为宋体小四号,各条目标题的字体为黑体小
四号。正文后面附的表格内字体一般为幼圆五号。
3)质量体系中程序文件的正文内容
程序文件正文部分的内容必须包括如下几项
a)目的
编写本程序文件的主要目的,也可指出本文件控制的活动应达到的目的。
b)适用范围
该程序中的活动所涉及的工作领域或部门、岗位、人员,也可简单地列出
该程序不适用的领域。
c)职责
该程序规定的活动所涉及的责任部门或人员的职责。
d)术语和缩略语
术语──仅在本程序中用到的关键词和术语在该条款下列出,并给出其定
义。
缩略语──应列出在本程序中用到的所有缩略语,并给出其全称。此外在
缩略语首次出现处也要给出其全称。
e)工作程序
该项条款向执行者提供执行工作任务时的具体做法。程序中规定的各步骤
按活动的逻辑顺序来编写。在可能或需要时可用流程图辅助说明。但流程
图不能取代程序的正文内容。
f)引用文件
列出该程序文件在编写或执行中参考的其他程序、管理文件及支持性文件
等。
g)质量记录
列出执行本程序所产生的记录,这些记录可以看作是执行程序的结果,并
在附录给出这些记录的格式。
以上所规定的各项条款,对某个文件来说,如果有哪一项不适用或该文件对应这
一项没有内容,必须在文件中加以说明(可在该条款下标明“无”或“不适用”)。
4.5.2 支持性文件的正文要求
支持性文件正文的页眉和页脚的要求与程序文件相同。支持性文件的正文标题包
括以下几部分:目的、适用范围、职责(可选)、术语、规范要求(或作业指导
等)、引用文件、质量记录和或附录。其它要求与程序文件相同。
4.5.3 技术文档的正文要求
a)技术文档的页眉包括文档名称和页码。页脚由一横线下加上公司名称组成,公
司名称字体为楷体五号。
b)技术文档的正文内容要求参见相应的编写规范,其格式参见附录四。
4.6 表格文件
文件的附录一般为各种表格,表格内的字体一般为幼圆五号,表格的格式要求由
相应的文件具体规定。
4.7 文件编写注意事项
4.7.1 程序中使用的语句要简单扼要,含义明确,不使用可能引起误解的语言。尽量使
纸面上的文字描述能够得到验证,如职责划分、对时间的要求等。
4.7.2 编写应做到“该说的要说到,说到的一定要做到”。不要将不切实际的作法写入,
一定要注意文件的可操作性。
4.7.3 对已有管理制度规定中实用的办法可直接引用,必须写明引用的文件名,编号及
引用条款。
5.引用文件
(无)
附录一:“质量体系文件封面格式”
附录二:“质量体系文件正文格式”
附录三:“技术文档封面格式”
附录四:“技术文档正文格式”
附录一:质量体系文件封面格式
文件名称
附录二:质量体系文件的正文格式
文件名称 Ver2.0 P-9/9
正文内容
附录三:技术文档封面格式
密级:
文档编号:SE97012SD01
第 版
分册名称:
第1册/共2
册
项目名称
(项目编号)
系统设计报告
(部门名称)
*******
附录四:技术文档的正文格式
文档名称 1/5
正文内容