用户学习手册编写规范总结.docxVIP

用户手册编写规范 文件编号： 生效日期：1999.6.1 受控编号： NW506103 密级：秘密 版次：第 2 版 修改状态： 总页数12 正文12 附录0 编制：余克清 审核：袁淮 批准：孟莉 沈阳东大阿尔派软件股份有限公司 （版权所有，翻版必究） 2 用户手册编写规范 Ver2.0 P-3/12 文件修改控制 修改 修改记录编号 修改页码及条款 修改人 审核人 批准人 修改日期状态 沈阳东大阿尔派软件股份有限公司 文件发放控制 应发放部门 应发放份数 应发放部门 应发放份数 管理者代表 1 项目管理事业部 1 主管开发副总经理 1 软件工程事业部 1 总工程师 1 软件产品事业部 1 国际合作事业部 1 4 用户手册编写规范 Ver2.0 P-5/12 目录 用户手册格式的统一规定 1.1 章、节标题 1.2 版面设置 用户手册的内容 2.1 用户手册的目标 2.2 用户手册的内容 2.3 用户手册的风格 沈阳东大阿尔派软件股份有限公司 用 手册格式的 一 定 1.1 章、 一般情况下，用 手册用章、 来划分其内容。如果有的系 很大，其用 手册所包含 的内容繁多，那么 根据其内容把用 手册划分 几个分册。每一分册根据本 定独立 行章、 号。 1.1.1 章 每章的 号用阿拉伯数字表示，采用“第 1章”、“第 2章”、??的形式表示章的 号， 章的 号后面空一个半角的格，然后是 一章的 。 1）每一章必 另起一 开始打印； 2）章的 号和 采用左 的格式放在行的左 ； 3）章的 号和 采用黑体小三号字； 4）章的 号和 与其篇眉之 空一行，和其正文之 空三行。 1.1.2 的 号格式 “§ x.y”。其中， x 章的号 ， y 的号 ，用阿拉伯数字表示。 的 号后面空一个半角的格，然后是 一 的 。 1）每一 必 另起一 开始打印； 2） 的 号和 采用左 的格式放在行的左 ； 3） 的 号和 采用黑体四号字； 4） 的 号和 与其篇眉、正文之 均空一行。 1.1.3 小 小 的 号格式 “§ x.y.z”。其中， x 章的号 ， y 的号 ， z 小 号 ，用阿 拉伯数字表示。小 的 号后面空一个半角的格，然后是 一小 的 。 1）不必 小 另起一 开始打印； 2）小 的 号和 从左 开始 格 写； 3）小 的 号和 采用黑体小四号字； 4）小 的 号和 与其前后的正文之 均空一行。 【注意】 1）一般情况下，章的下面可以划分 和小 ，但要具体情况具体分析。如果没有划分 小 的必要， 可以划分到 止；而且，如果有必要， 可以在小 下面划分更小的 ，我 且称之 小小 。 6 用户手册编写规范 Ver2.0 P-7/12 2）对于小小节的各种规定与小节一致。 1.1.4 其它编号 1）页编号：用户手册中的正文按章进行编号，其格式为“章—页”。如，第 2章的第 3页， 编号为“ 2-3”。各种页编号的形式请参考本手册所采用的格式。 2）图、表编号：用户手册中的图、表均按章分别进行编号，其格式分别为“图 x-y ”、 “表 x-y”。如，第 2章的第 3幅图的编号是“图 2-3”；第 2章的第 3张表格的编号是“表 2-3”。在图、表编号的编号后面空一个半角的格，然后是这一图表的名称。另外，还规 定： 表的编号与名称放在表的顶部 表的编号与名称和表在左边对齐，而整个表则对中放置 表的编号与名称和前面的正文之间空一行，和表之间无空行 表和其后面的正文之间空一行 图的编号与名称放图的底部 图的编号与名称和图均对中放置 图的编号与名称和前面的图、后面的正文之间均空一行 图和其前面的正文之间空一行 图、表的编号与名称均采用黑体五号字打印 3）编号序列：在本章的 1.1.3中的编号序列为无名编号序列，在本小节中，带编号的序列 为有名编号序列。在节、小节、小小节里面均可以含有编号序列。在一般情况下，节中 编号序列所含的内容比小节所含的内容少，在什么情况下用小节、小小节，在什么情况 下用编号序列，由用户手册的编制人员自己确定。 编号序列在缩进两个汉字位置之后开始书写，对于有名编号序列的编号和名称要选择黑 体五号打印方式，其后面的内容均采用五号宋体汉字。 在带编号的序列里还容许二级编号序列，其格式规定如下： 编号的格式是“ n).”，其中 n为阿拉伯数字 其它规定和一级序列编号一致 【注意】 1）用户手册的正文均采用宋体五号汉字。 沈阳东大阿尔派软件股份有限公司 2）编写手册时，对于界面中的按钮名称，应把按钮名称用尖括号“〈 〉”括起来，按 钮名称用黑体五号字书写。对于下拉菜单选项的名称，应用引号“ ”引起来，选项名 称用黑体五号字书写。 1.2 版面设置 1.2.1