2024年3月15日发(作者：)

联机帮助规范

1 文档结构

联机帮助的每一个文档分为两个部分。

1. 文档开头用一段话概括所有的操作或功能。

2. 然后逐一分别介绍每一个操作或功能。

。。。操作有创建、编辑、查看、删除、重命名、更改用户对象的所有者、删除用户拥有的对

象。具体介绍如下。

此处是具体介绍的内容。

…

在文档的第二部分（主要部分），即逐一描述各功能的部分，一定要层次结构清楚，类似树

形结构。

在第二部分，等级编号最多有三级目录，每个等级前面的编号为：

（1）

第一级：●

（2）

第二级：

形如：

（3）

第三级：

范例如附件：中的id为webtools-kem-SearchUser的sgml页面。

2 特殊符号的使用

特殊符号，包括『』、【】、〖〗、中英文引号及中英文圆括号。

2.1 界面元素的引用

界面元素

页面（父页面、弹出对话框或标签页）

按钮和超链接

其它组件

符号

『』

【】

〖〗

示例

如搜索数据库页面，文档中应描述为『搜

索数据库』

页面

如确认按钮，文档中描述为【确认】

按

钮

如数据库名文本框，文档中描述为：〖数

据库名〗

文本框。

如

单选按钮

2.2 引号和括弧

（1）

文字中使用英文引号和中文括弧；

（2）

代码中使用英文引号和英文括弧。

说明：

1.

2.

3.

不要使用中文的引号

。

使用半角的英文引号，不要使用全角的英文引号

。

不要使用sgml语法里的引号（"）

。