文件编写的标准格式

《文件编写的标准格式》由会员分享，可在线阅读，更多相关《文件编写的标准格式（9页珍藏版）》请在装配图网上搜索。

1、文件编写的标准格式1 标题(3号字体加粗,题号与标题隔1个汉字)。2 标题。3 标题3.1 标题（4号字体加粗，题号与标题隔1个汉字） 正文为5号字体3.1.1 。3.1.2 。3.2 标题X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X X 。a） ；b） ；c） 。） ；） 。 注：先用a、b、c再用1、2数字排序。3.3 标题。注：。4 标题4.1 标题4.1.1 标题(5号加粗，题号与标题隔1个汉字)。4.1.2 标题。 注1：。注2： X X。.2 标题。注：。注：。4.3 标题4.3.

2、1 。4.3.2 。示例：。.4 标题4.4.1 。 ；。4.4.2 。示例1：。示例2：。4.5 标题。 附录A (页面、字体、图、表的要求)A.1 页面要求a) 页面设置为A4纸型，纵向，页边距如下设置，其余采用WORD的默认设置。b) 页眉样式如下图所示，包括公司Logo（居左显示）和文档名称（居中显示）。 c) 页脚样式如下图所示，为“第X页，共X页”模式，居中显示。d) 正文必须有页眉和页脚；目录页需有页眉，但是不需页脚。其余页无页眉和页脚。A.2 第一层标题为3号宋体字加粗，题号与标题隔1个汉字；第二层标题为4号宋体字加粗，题号与标题隔1个汉字；第三层标题为5号宋体字加粗，题号与标

3、题隔1个汉字；正文为5号宋体字。表题和图题为5号宋体字加粗。A.3 若文件篇幅较短小的，标题的字号可灵活处理。即可选4号或5号字。例如：技术要求，技术说明只有一两页纸的。A.4 图的编号样式为“图X-Y”，X表示该图所在的章节号，Y按照该图在本章中的序号，X和Y均为阿拉伯数字。例子：图1-1、图1-2、图2-1、图2-2、。当某图包含多个子图时，每个子图按照“a)、b)、”编号。图号和图题在图的下方居中位置。例子如图1-1所示。a) TFTPD32主界面 b) 设置对话框图1-1A.5 表的标号样式与图编号样式类似，为“表X-Y”。X表示该表所在的章节号，Y按照该表在本章中的序号，X和Y均为阿

4、拉伯数字。例子：表1-1、表1-2、表2-1、表2-2、。表号和表题在表的上方居中位置。表的网格统一为实线，其中外边框线条粗细统一为1.5磅，网格内部线条粗细为0.75磅。例子如表1-1：表1-1 LANS板以太网接口信号定义RJ-45插座名称方向说 明1TX+From VDI发送数据2TX-From VDI发送数据3RX+To VDI接收数据6RX-To VDI接收数据A.6 图和表的位置可有2种,一是文字在图/表的上下方，此时图/表必须居中放置；二是文字在图/表的四周，此时图/表必须居右放置，文字在图/表的左方。图/表的大小不能超出文章所设的左右边界。A.7 表注要放在表内，图注要放在图题

5、以内图幅以下左方。表注和图注的字体为小5号宋体字。A.8 文档中的章节、图和表的编号可以直接使用给定模板中已设定的样式：a) 章节标题的样式为：按层次从上到下为标题1到标题7；b) 表标题的样式为：标题8；c) 图标题的样式为：标题9。A.9 在表明参见图和表时，不能用“参见下图”或“参见下表”表示，应明确表示参见图几。如：参见图1。A.10 目录样式设置见模板。建议用模板中缺省的设置自动生成目录（在模板中已设计好的目录样式，用“插入索引和目录”生成）。附录B(图形符号的附录)使用符号规定a) 文档中的图形界面、鼠标操作、键盘操作的格式约定分别见表1、表2和表3。表1 图形界面格式约定格 式意

6、 义多级目录或菜单用“”隔开。如“文件新建文件夹”多级菜单表示“文件”菜单下的“新建”子菜单下的“文件夹”菜单项。用于标识图片中的功能区。可为矩形、椭圆形等形状，颜色可根据需要设定，通常为蓝色。带尖括号“”表示操作员从终端输入的信息。【】带粗中括号“【】”表示操作页面上的一个参数配置区或功能区 XX | XX 为CLI命令行的表示格式之一，表示命令行中多选一的命令字，多个命令字在大括号“”内用竖线“|”分隔。host（斜体字）为CLI命令行的表示格式之一，斜体字代表命令行中用户指定的参数。例如有如下命令行：tftp host get | put sys | cfg filename其实际用法为

7、：tftp 138.0.0.102 get sys vxworks.bin表2 鼠标操作约定格 式意 义单击快速按下并释放鼠标的一个按钮。双击连续两次快速按下并释放鼠标的一个按钮。拖动按住鼠标的一个按钮不放，移动鼠标。表3 键盘操作约定格 式意 义F“”表示键盘上的某个按键，例如F表示键盘上的F键。Ctrl + C“+”表示同时按下键盘上的多个按键完成一个操作。因此“Ctrl + C”的含义是同时按下键盘上的Ctrl键和C键。b) 文档中使用的各种图形图标约定如表4，“注意”或“说明”的两横线之间内容不得跨页：表4 图标约定图标意 义注意：用于提醒用户在操作中应该注意的事项，这些事项有可能会引

8、起系统出错。说明：用于对操作内容的描述进行必要的补充和说明，或者提示用户一些使用技巧。“注意”或“说明”段落的上方和下方分别要用实线分隔。有多个要点时，使用a)、b)、的编号方法。见以下2个使用图标的例子： 示例1： 注意：a） 参数配置成功后保存配置（主界面的“数据操作”按钮-“保存配置”按钮）并重新启动设备才能生效；b） 当设备IP地址修改后，保存重启设备后，还必须GoView主菜单“设备”-“设备管理”中更新IP地址，控件才能重新与设备连接。 示例2：注意： 移动鼠标到告警名称处可以获得该告警的告警提示。c) 如果文档中由于特殊需求要使用新的符号，必须与文档标准的负责人协商得到批准才能使

9、用，并还要在用户文档的“前言”部分的“本手册约定”或“各类标志”中加入新符号的含义说明。公司商标使用规定 在用户文档的封面、页眉中统一使用如下公司商标：附录C （资料性附录）a） 小数点符号为“.”；b） 文件只使用我国法定的计量单位，如分（min）、小时（h）、天（d）、度（）、等等；c) 不要将单位的符号和名称混在一起使用。例如，写作“千米每小时”或“km/h”，而不写作“每小时km”或“千米/小时”；d） 用拉伯数字表示的数值可与单位符号结合，例如“5m”。避免诸如“五m”和“5米”之类的组合；e） 不要使用非标准化的缩略语表示单位，例如“ses”（代替秒的“s”），“mins”（代替分的“min”）等等；f） 不应使用诸如“ppm”“ppb”之类的缩略语。这些缩略语在不同的语种中含义不同，可能产生淆；g） 两个或更多的物理量不能相加减，除非它们属于相互可比较的同一类量。因此，诸如 230V5%这种表示误差的方法不符合代数的基本规则。可用下述表示方法代替： “230（15%）V”； “230（10.05）V； “230V,具有5%的相对误差”。