文件编写导则

1、文件编写导那么文件编号： NW602101 生效日期：受控编号：密级：秘密版次：修改状态：总页数11正文7附录4 马云生 孟莉 孟莉沈阳东大阿尔派软件股份(版权所有,翻版必究)文件修改控制修改记录编号修改状态修改页码及条款修改人审核人批准人修改日期目录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. 引用文件附录一：“质量体系文件封面格式附录二：“质量体系文件正文格式附录三：“技术文档封面格式附录四：“

2、技术文档正文格式1. 目的为使公司所用的各种文件的编写标准、统一、提高工作效率特制定本导那么。2. 适用范围适用于质量体系文件和技术性文档的编写。3. 术语和缩略语3.1程序procedure：本公司质量体系文件中所说的程序，是指为保证产品质量，在进行软件开发或质量活动时所必须遵守的一系列步骤。不能和软件开发过程产生的计算机程序program相混淆。3.2程序文件：以书面形式规定的在软件开发或质量活动中所必须遵守的步骤，即本公司质量体系文件结构中的第二层文件。3.3技术文档：指在软件开发过程中所需的各种文档，它是执行质量体系文件产生的结果。例如，需求分析报告、详细设计报告等。4. 编制标准4.

3、1 质量体系文件的结构 本公司质量体系文件可分为四层，其结构如以下图： 质量 手册程序文件支持性文件4.2 文件的版面所有质量体系文件用纸规格均为A4，页面的上、下边距为20毫米，左边距为25毫米，右边距为15毫米；页眉边距为15毫米，页脚边距为毫米。正文行距为倍行距。4.3文件的封面4.3.1质量体系文件的封面1) 封面是质量体系文件的第一组成局部，文件封面包括公司注册图标、文件名称、公司名称和控制栏；2) 控制栏包含工程有：受控编号、保密级别、文件编号、修改状态、版次、总页数、正文页数、附录页数、生效日期、拟制人、审核人、批准人；3) 修改状态的表示方法：修改状态表示为“版次号+修改标识，

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

5、包括工程名称、文档名称及开发部门名称；3) 封面的底部包括公司名称和页脚。页脚内容和质量体系文件相同；4) 技术文档的封面格式具体参见附录三。4.4文件的目录目录是质量体系文件的第二局部，在目录里列出该文件正文局部各项条款的标题，但不超过两级。在目录页内“目录二字为黑体二号。4.5文件的正文4.5.1质量手册及程序文件的正文要求质量手册及程序文件的正文局部包括页眉、页脚和正文内容。1) 页眉由横线上文件名称、版次、修改状态标识和页码组成，页眉字体为楷体小四；页脚是在一条横线下面加上公司名称，字体为楷体五号。2) 质量体系文件的正文内容的字体为宋体小四号，各条目标题的字体为黑体小四号。正文后面附

6、的表格内字体一般为幼圆五号。3) 质量体系中程序文件的正文内容程序文件正文局部的内容必须包括如下几项a) 目的编写本程序文件的主要目的，也可指出本文件控制的活动应到达的目的。b) 适用范围该程序中的活动所涉及的工作领域或部门、岗位、人员，也可简单地列出该程序不适用的领域。c) 职责该程序规定的活动所涉及的责任部门或人员的职责。d) 术语和缩略语术语仅在本程序中用到的关键词和术语在该条款以下出，并给出其定义。缩略语应列出在本程序中用到的所有缩略语，并给出其全称。此外在缩略语首次出现处也要给出其全称。e) 工作程序该项条款向执行者提供执行工作任务时的具体做法。程序中规定的各步骤按活动的逻辑顺序来编

7、写。在可能或需要时可用流程图辅助说明。但流程图不能取代程序的正文内容。f) 引用文件列出该程序文件在编写或执行中参考的其他程序、管理文件及支持性文件等。g) 质量记录列出执行本程序所产生的记录，这些记录可以看作是执行程序的结果，并在附录给出这些记录的格式。以上所规定的各项条款，对某个文件来说，如果有哪一项不适用或该文件对应这一项没有内容，必须在文件中加以说明可在该条款下标明“无或“不适用。4.5.2 支持性文件的正文要求支持性文件正文的页眉和页脚的要求与程序文件相同。支持性文件的正文标题包括以下几局部：目的、适用范围、职责可选、术语、标准要求或作业指导等、引用文件、质量记录和或附录。其它要求与

8、程序文件相同。4.5.3 技术文档的正文要求a) 技术文档的页眉包括文档名称和页码。页脚由一横线下加上公司名称组成，公司名称字体为楷体五号。b) 技术文档的正文内容要求参见相应的编写标准，其格式参见附录四。4.6表格文件文件的附录一般为各种表格，表格内的字体一般为幼圆五号，表格的格式要求由相应的文件具体规定。4.7文件编写考前须知4.7.1程序中使用的语句要简单扼要，含义明确，不使用可能引起误解的语言。尽量使纸面上的文字描述能够得到验证，如职责划分、对时间的要求等。4.7.2编写应做到“该说的要说到，说到的一定要做到。不要将不切实际的作法写入，一定要注意文件的可操作性。4.7.3对已有管理制度

9、规定中实用的方法可直接引用，必须写明引用的文件名，编号及引用条款。5. 引用文件(无)附录一：“质量体系文件封面格式附录二：“质量体系文件正文格式附录三：“技术文档封面格式附录四：“技术文档正文格式附录一：质量体系文件封面格式文件名称文件编号： 生效日期：受控编号：密级：秘密版次：修改状态：总页数正文附录 沈阳东大阿尔派软件股份(版权所有,翻版必究)附录二：质量体系文件的正文格式文件名称 V P-9/9版次、页码页眉为楷体小四号字正文内容页脚为楷体五号字附录三：技术文档封面格式黑体二号字密级：机密文档编号：SE97012SD01第 版分册名称：第1册/共2册8行小四号字、单倍行距黑体小初号字黑体一号字空1行小四号字，单倍行距 工程名称工程编号楷体小初号字