命令手册写作模板V.-存储临时通用.docVIP

命令手册写作模板－V1.02版本 Prepared by 拟制 杜民 00933 Date 日期 2005-6-13 Reviewed by 评审人 RD Info Date 日期 yyyy-mm-dd Approved by 批准 梁铁华 Date 日期 yyyy-mm-dd Authorized by 签发 梁铁华 Date 日期 yyyy-mm-dd Revision Record 修订记录 Date 日期 Revision Version 修订版本 CR ID / Defect ID CR号 Sec No. 修改章节 Change Description 修改描述 Author 作者 2005-06-13 1.00 对模板进行修改，形成基线化的1.00版本 杜民 2005-12-22 1.01 增加了产品系列的说明 2007-12-20 1.02 增加了【缺省级别】 朱萍 目 录 第1章 XX配置命令 （标题1样式，快捷键ctrl＋F1） 1-1 1.1 XX配置命令（标题2样式，快捷键F2） 1-1 1.1.1 Xxx（标题3样式，快捷键F3） 1-1 XX配置命令（标题1样式，快捷键ctrl＋F1） XX配置命令（标题2样式，快捷键F2） Xxx（标题3样式，快捷键F3） 如果是系列产品手册，即一个手册包含多款产品，此命令仅系列中的个别产品支持或不支持，则在命令标题下方增加如下说明： ( 说明： 在XX系列设备中，XX1、XX2……、XXn产品支持XXX配置命令，其他产品型号不支持。（适用个别产品支持的情况） 或 在XX系列设备中，除XX1、XX2……、XXn产品不支持此命令外，其他产品型号均支持。（适用个别产品不支持的情况） 【命令】 写作要求： 命令形式可以表达产品的命令涵盖的所有情况,使用下面的约定来进行手册命令行形式的写作 常见参数：interface-type interface-number,ip-address 只有一个必选参数时不用加大括号 多条命令请按字母顺序依次介绍。 格 式 意 义 粗体 命令行关键字（命令中保持不变、必须照输的部分）采用加粗字体表示。 斜体 命令行参数（命令中必须由实际值进行替代的部分）采用斜体表示。 [ ] 表示用“[ ]”括起来的部分在命令配置时是可选的。 { x | y | ... } 表示从两个或多个选项中选取一个。 [ x | y | ... ] 表示从两个或多个选项中选取一个或者不选。 { x | y | ... } * 表示从两个或多个选项中选取多个，最少选取一个，最多选取所有选项。 [ x | y | ... ] * 表示从两个或多个选项中选取多个或者不选。 如果系列产品手册中，此命令的参数个别产品支持情况不一致，则建议采用如下方式： XX1、XX2……、XXn设备使用下列命令： xxx undo xxx XXn1……、XXnn设备使用下列命令： xxx undo xxx 【视图】 这里写出命令实际的执行视图 【缺省级别】 这里写出命令实际的缺省级别： 0：访问级 1：级 3：管理级 【参数】 写作要求： 对参数的解释要准确，明白，不能只进行字面上的翻译 对于在不同的命令章节中重复出现的参数，每次都应该进行相同的重复说明，不采用“参见前文”的写法 参数解释中要说明缺省值 参数解释中要进行取值范围介绍 参数的罗列顺序请严格按照设备中给出的先后顺序罗列 【描述】 写作要求： 开始的句子采用固定的句式 下面说明命令的缺省情况 接着说明命令的注意事项：采用item list样式 说明与所介绍的命令相关的其他命令,并使用超链链接。 display命令使用表格形式说明显示信息中的字段、取值情况。 XX命令用来XXX。undo XX命令用来xxx。 缺省情况下，XXXX。 相关配置可参考命令XXXX。此处链接为示意，手册写作时请链接到正确的位置。 【举例】 写作要求： 从用户视图写起； display命令的举例必须附上显示信息，必要时还需要填写显示信息表 # XXXX。 Quidway XXX XX 命令显示信息描述（Table Description样式，快捷键F8） 字段 描述 手册名称 目 录 i 手册名称 第1章 XX配置命令 1-3 建议列出，如实际无内容，也可省略。 如果没有，可省略。 如果没有，可省略。 如有注意事项，可增加与此同级别的[注意]。