文件编写导则

《文件编写导则》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、文件编写导则文件编号：NW602101生效日期：2000.3.20受控编号：密级：秘密版次：Ver2.1修改状态：总页数11正文7附录4编制：马云生审核：孟莉批准：孟莉沈阳东大阿尔派软件股份有限公司(版权所有,翻版必究)文件编写导则Ver2.1P-2/7文件修改控制修改记录编号修改状态修改页码及条款修改人审核人批准人修改日期沈阳东大阿尔派软件股份有限公司文件编写导则Ver2.1P-4/7沈阳东大阿尔派软件股份有限公司文件编写导则Ver2.1P-4/7目录1.目的1.适用范围2.术语和缩略语3.1程序3.2程序文件3.3技术文档4.编制规范4.1质量

2、体系文件的结构4.2文件的版面4.3文件的封面4.4文件的目录4.5文件的正文4.6表格文件4.7文件编写注意事项5.引用文件附录一：“质量体系文件封面格式”附录二：“质量体系文件正文格式”附录三：“技术文档封面格式”附录四：“技术文档正文格式”沈阳东大阿尔派软件股份有限公司文件编写导则Ver2.1P-4/71.目的为使公司所用的各种文件的编写规范、统一、提高工作效率特制定本导则。2.适用范围适用于质量体系文件和技术性文档的编写。3.术语和缩略语3.1程序（procedure）：本公司质量体系文件中所说的程序，是指为保证产品质量，在进行软件开发或质

3、量活动时所必须遵守的一系列步骤。不能和软件开发过程产生的计算机程序（program）相混淆。3.2程序文件：以书面形式规定的在软件开发或质量活动中所必须遵守的步骤，即本公司质量体系文件结构中的第二层文件。3.3技术文档：指在软件开发过程中所需的各种文档，它是执行质量体系文件产生的结果。例如，需求分析报告、详细设计报告等。4.编制规范4.1质量体系文件的结构本公司质量体系文件可分为四层，其结构如下图：质量手册程序文件支持性文件4.2文件的版面所有质量体系文件用纸规格均为A4，页面的上、下边距为20毫米，左边距为25沈阳东大阿尔派软件股份有限公司文件编

4、写导则Ver2.1P-5/7毫米，右边距为15毫米；页眉边距为15毫米，页脚边距为17.5沈阳东大阿尔派软件股份有限公司文件编写导则Ver2.1P-5/7毫米。正文行距为1.5倍行距。4.3文件的封面4.3.1质量体系文件的封面1)封面是质量体系文件的第一组成部分，文件封面包括公司注册图标、文件名称、公司名称和控制栏；2)控制栏包含项目有：受控编号、保密级别、文件编号、修改状态、版次、总页数、正文页数、附录页数、生效日期、拟制人、审核人、批准人；3)修改状态的表示方法：修改状态表示为“版次号+修改标识”，修改标识用一位大写字母表示，取值从“A~Z”

5、。文件每修改一次，对应一个修改状态，文件升级版本时，修改状态清空；4)公司图标在页眉下边靠右对齐；5)文件名称居中，距页眉约12个单倍小四行距，字体为楷体小初；6)控制栏居中，距文件名称约16个单倍小四行距，字体为楷体小四号；7)公司名称居中，距控制栏约3个单倍小四行距，字体为楷体四号。紧靠在公司名称的下面是外加括号的版权声明，字体为黑体小三；8)程序文件的封面格式具体参见附录一。4.3.2技术文档的封面1)技术文档的封面没有页眉，其顶部除公司注册标志外，还包括密级、文件编号、分册名称和修改状态。字体为幼圆小三，1.5倍行距；2)封面的中间部分包括

6、项目名称、文档名称及开发部门名称；3)封面的底部包括公司名称和页脚。页脚内容和质量体系文件相同；4)技术文档的封面格式具体参见附录三。4.4文件的目录目录是质量体系文件的第二部分，在目录里列出该文件正文部分各项条款的标题，但不超过两级。在目录页内“目录”二字为黑体二号。4.5文件的正文4.5.1质量手册及程序文件的正文要求质量手册及程序文件的正文部分包括页眉、页脚和正文内容。沈阳东大阿尔派软件股份有限公司文件编写导则Ver2.1P-7/71)页眉由横线上文件名称、版次、修改状态标识和页码组成，页眉字体为楷体小四；页脚是在一条横线下面加上公司名称，字

7、体为楷体五号。沈阳东大阿尔派软件股份有限公司文件编写导则Ver2.1P-7/71)质量体系文件的正文内容的字体为宋体小四号，各条目标题的字体为黑体小四号。正文后面附的表格内字体一般为幼圆五号。2)质量体系中程序文件的正文内容程序文件正文部分的内容必须包括如下几项a)目的编写本程序文件的主要目的，也可指出本文件控制的活动应达到的目的。b)适用范围该程序中的活动所涉及的工作领域或部门、岗位、人员，也可简单地列出该程序不适用的领域。c)职责该程序规定的活动所涉及的责任部门或人员的职责。d)术语和缩略语术语──仅在本程序中用到的关键词和术语在该条款下列出，

8、并给出其定义。缩略语──应列出在本程序中用到的所有缩略语，并给出其全称。此外在缩略语首次出现处也要给出其全称。e)工作程序