编写文档规范

1 范围 本 标准 excel标准偏差excel标准偏差函数exl标准差函数国标检验抽样标准表免费下载红头文件格式标准下载 规定了技术文件编写的规则。 本标准适用于我所设计的计算机产品,其他产品可参照执行。 2 总则 2.1 要求 2.1.1 技术文件由封面和正文(包括附录)组成,当文件内容较多时(正文超过15页),应增加目次。 2.1.2 技术文件的文字应准确、简明、通俗易懂、逻辑严谨。 2.1.3 技术文件中的图样、表格、数值、公式和其他技术内容应准确无误。2.1.4 技术文件的内容编排、层次划分及编写细则应符合本标准第4章的规定。 2.1.5 技术文件应用计算机编排打印。 2.2 统一性 2.2.1 同一技术文件中的术语、符号和代号应统一,且应符合相应的国家标准、行业标准的规定。在缺少相应标准时,则应在该文件中给出定义或说明。2.2.2 对于已定义的概念应避免使用同义词,每个选用的术语尽可能只有唯一的含义。 3 条文的编排 3.1 层次划分及编号 3.1.1 通则 技术文件应按其内容,分成若干层次进行叙述,一般可分为:篇、章、条、段、列项和附录。除篇外,其他各层次的编号均采用阿拉伯数字,不同层次之间加圆点,圆点加在数字的右下角。 3.1.2 篇 技术文件章数较多时,可以组合若干章为一篇。篇的编号用阿拉伯数字, 例如“第1篇”、“第2篇”等。 3.1.3 章 章是技术文件内容划分的基本单元。技术文件中应使用阿拉伯数字从1开始对章编号,一直连续到附录之前。每一章均应有标题。标题应置于编号之后,并与其后的条文分行。 3.1.4条 章以下的层次统称为条。应使用阿拉伯数字对条编号,其编号只在所属章、条的范围内连续。例如1、1.1、1.1.1等。同一层次中有两个层次以上(含两个)的条时才设条。例如,5.1的条文中,如果没有5.1.2就不应设5.1.1。第一层次的条应有标题。标题应置于编号之后,并与其后的条文分行。其他层次的条可有标题,也可没有标题,但同一层次的条,有无标题应统一。 3.1.5段 段是章或条的细分。段不编号。 3.1.6列项 列项可用以下形式引出:一个句子(见示例1);一个句子的前半部分,该句子由分行列举的各项来完成(见示例2);如果需要对某个列项进一步细分,则应使用破折号(见示例3)。列项的编号用小写英文字母a、b、c,……顺序表示,小写英文字母的右下 角加圆点。 示例1: 下列各类仪器不需要开关: a. 在正常操作条件下,功耗不超过10W的仪器; b. 在任何故障条件下使用2min,测得功耗不超过50W的仪器; c. 用于连续运转的仪器。 示例2: 仪器中的振动可能产生于: a. 转动部件的不平衡; b. 机座的轻微变形; c. 滚动轴承; d. 气动负载。 示例3: 可按下列两种方式对一项标准的技术要素分类: a. 由要素的规范性或资料性的性质以及它们在标准中的位置来划分,可分为:——资料性概述要素; ——规范性一般和技术要素; ——资料性补充要素。 b. 由要素的必备的或可选状态来划分,可分为: ——必备要素; ——可选要素。 3.1.7 附录 每个附录应有一个编号。附录编号由“附录”和随后表明顺序的大写英文字母组成,字母从“A”开始,例如“附录A”。如果只有一个附录应仍标为“附录A”。附录必须设标题。标题应置于编号下方,并与其后的条文分行。附录中章、条、图、表和数学公式的编号应重新从1开始,编号前应加上附录编号中表明顺序的字母,例如:附录A中的章条编号用“A1”、“A1.1”、“A1.1.1”等表示;图用“图A1”、“图A2”等表示;表用“表A1”、“表A2”等表示;公式用“(A1)”、“(A2)”等表示。 3.2 条文的排列格式 3.2.1 篇 设篇时,每篇应有标题,写在编号之后,中间空一个汉字的位置,编号和标题置于条文之上居中位置。篇的编号和标题占两行。 3.2.2 章、条、段 章、条的编号顶格排,编号与标题或文字之间空一个汉字的间隙。段的文字空两个汉字起排,回行时顶格排。 3.2.3 列项 字母编号空两个汉字起排,在编号的圆点与文字之间空一个汉字的间隙,回行时顶格排。 3.2.4 引用文件 在“引用文件”章中所列出的文件均空两个汉字起排,回行时顶格排,每个文件之后不加标点符号,所列文件的编号与名称之间空一个汉字的间隙。 3.2.5 注 每条注另起一行空两个汉字起排,回行时与注的内容的文字位置对齐。 3.2.6 公式 技术文件中的公式应另起一行居中排,较长的公式尽可能在等号处回行,或者在“+”、“-”等符号处回行。公式的编号右端对齐,公式与编号之间用“……”连接。公式下面的“式中”空两个汉字起排,单独占一行。公式中所要解释的符号按先左后右,先上后下的顺序分行空两个汉字起排,再用破折号与释文连接,回行时与上一行释文对齐。上下行破折号对齐。对于整个文件多次使用的符号及注释,允许在正文首页前单独列出。 3.2.7 附录 附录应另起一页编写,页次与正文连续。附录的编号和标题每项各占一行,置于附录条文之上居中位置。每个附录在正文中均应明确提及。技术文件条文的排列格式参见附录A。 4 编写细则 4.1 目次 当文件内容较长,页数超过15页时,应编写目次。目次的内容包括篇、章、条和附录的编号,相应的标题及所在的页码。标题与页码之间用“……”连接。目次应另编页码,不与正文页码连续。 4.2 引用文件 4.2.1 通则 引用完整的文件可以注日期,也可不注日期,但引用文件中特定的章、条、图和表时,均应注明日期,同时还应写明这些条文、图和表的编号。无代号的引用文件应列出该文件的出处、作者及出版日期。 4.2.2 用法 技术文件中被引用的文件在第一次出现时,应将被引用文件的代号和名称写出,再次引用时只写代号不必再写名称。引用无代号的文件时,必须写出文件名称。对于注日期的引用文件应给出年号以及名称。随后如果有修改单或修订版,则引用这些文件的技术文件可根据需要进行更改,以便引用这些被引用文件的修改单或修订版的内容。对于不注日期的引用文件,不给出年号。 4.3 图 4.3.1 用法 如果用图提供信息更有利于文件的理解,则宜用图。每幅图在条文中均应明 确提及。图一般应排在有关条文的附近,文件中图所占的篇幅较大,集中在一起更好时,可列在文件条文之后。 只允许对图进行一个层次的细分。例如,图1可分成a)、b)、c)等。 4.3.2 编号 每幅图均有编号。图的编号由“图”和从1开始的阿拉伯数字组成,例如“图1”、 “图2”等。图的编号应一直连续到附录之前,并与章、条和表的编号无关。只有一幅图时,仍应标为“图1”。 4.3.3 图题 图题即图的名称。每幅图应有图题(包括下一层次的图),图题应在编号之后并与编号之间有一个汉字的间隙。图的编号和图题应置于图下方居中位置。 4.3.4 图的接排 如果某个图需要转页接排,应在接排的图下方中间写明“续图×”,其中图题可省略,但在一份文件中图的接排格式保持一致。接排的流程图应清楚表明与上页图的联接关系。 4.4 表 4.4.1 用法 如果用表提供信息更有利于文件理解,则宜使用表。每个表在条文中均应明确提及。表一般应排在有关条文的附近,文件中表所占的篇幅较大,集中在一起更好时,可列在文件条文之后。 不允许表中有表,也不允许将表再分为次级表。 4.4.2 编号 每个表均有编号。表的编号由“表”和从1开始的阿拉伯数字组成,例如“表1”、 “表2”等。表的编号应一直连续到附录之前,并与章、条和图的编号无关。只有一幅表时,仍应标为“表1”。 4.4.3 表题 表题即表的名称。每个表应有表题,表题应在编号之后并与编号之间有一个汉字的间隙。表的编号和表题应置于表上方居中位置。