段落的组织逻辑

段落是构成文档的基本单位,段落一般由多个句子构成,也包括图、表等内容。一个段落应只有一个主题或一个中心句。将中心句放在段首,对全段内容进行概述。后面的句子作为说明、展开、论据陈述,为中心句服务。

归纳组合与分类

所谓“归纳组合”是对事物的性质类型等进行考察与分析后,所作出的一种归类与归结。而“分类”则是按照归纳的结果,对事物进行有系统的整理与分类。透过归纳与分类,让资料简化,清晰明确。

按逻辑归纳

一篇文章可能包含几十个、上百个的操作步骤,按步骤依次的罗列出来,不利于读者理解和按步骤操作。可以将步骤归纳、拆分成几个子步骤。例如:

安装 InfoBack 程序,分为以下 7 个步骤进行:

1. 硬件准备
2. 软件准备
3. 停止 InfoBack 程序
4. 备份 InfoBack.ini 文件
5. 在 Windows 下运行安装程序
6. 在 Unix 下运行安装程序
7. 确定安装是否成功

对操作步骤进行归纳组合,调整为:

安装 InfoBack 程序,按照以下操作进行安装:

1. 确认是否符合安装条件
    1.1 硬件要求
    1.2 软件要求
2. 停止 InfoBack 程序
3. 备份 InfoBack.ini 文件
4. 运行安装程序
    4.1 Windows 下运行安装程序
    4.2 Unix 下运行安装程序
5. 确定安装是否成功

按内容分类

一篇文章如果说明信息包含在操作步骤中,当读者需要查找一个说明信息时,可能需要浏览整个操作步骤。

将说明信息与操作步骤分开。这样,操作步骤更“面向任务”,读者也能够更快地查阅说明信息。

在下面的例子中,如果读者只是想了解日期的填写,就需要浏览整个操作步骤。

发送在线确认信息
按照以下步骤发送在线确认信息。
1.单击编辑确认按钮,弹出编辑确认窗口。
2.在名称输出框中,输入付款人的姓名。如果付款人名称在系统中未定义过,
   将弹出付款人信息窗口,需要定义付款人姓名、地址和账号。
3.在日期输入框中,输入确认信息发送的时间,注意下面的限制要求:
    - 不要定义周末时间或者假期时间。
    - 不要定义距今天 5 天内的时间。
4.在数量输入框中,输入需要确认的人民币数额,保留至角。例如,25.00。
5.单击“确认”按钮,保存设置。
6.重复步骤 2 至步骤 5,增加其他的确认消息。
7.单击“发送”按钮,发送设置的确认消息。

将说明信息与操作步骤分开,调整为:

发送在线确认信息
按照以下步骤发送在线确认信息。
1. 单击“编辑确认”按钮,弹出编辑确认窗口。
2. 填写名称、日期、数量。
3. 单击“确认”按钮,保存设置。
4. 重复步骤 2 至步骤 3,增加其他的确认消息。
5. 单击“发送”按钮,发送设置的确认消息。

编辑确认窗口
在编辑确认窗口,可以发送在线确认的信息。
名称:用于指定在线确认的付款人。如果设置的付款人名称在系统中未定义过,
      填写 Name 后,将弹出付款人信息窗口,需要定义付款人姓名、地址和账号。
修改:用于修改定义过的付款人信息。
日期:用于指定确认信息发送的时间,注意以下的限制要求:
    - 不要定义周末时间或者假期时间。
    - 不要定义距今天 5 天内的时间。
数量:用于指定需要确认的人民币数额,保留至角。例如, 25.00.

精简语句

去掉与主题无关的修饰信息,精简语句,突出主旨。

呼叫转移(前转)是一种应用比较广泛的新业务。为了方便起见,此业务不但可以在
用户话机上通过拨号登记和撤消,也可以在后台维护系统中通过人机命令直接进行,
后者的优点是可以由局方大批量集中维护。

在技术文档中,不必出现“销售性”的语句,去掉“应用广泛”、“为了方便起见”、“后者的优点是可以由局方大批量集中维护”等语句。精简为:

呼叫转移(前转)是一种新业务。该业务有两种登记/撤销方法:
- 在用户话机上通过拨号登记/撤销;
- 大批量集中维护时,在后台维护系统中,通过人机命令登记/撤销。

标题

标题应该统领文章的主题,明确的标题可以帮助读者快速定位到需要阅读的信息。标题写作的要求:

  • 一级标题下,不能直接出现三级标题。

  • 标题要避免孤立编号(即同级标题只有一个)。

  • 标题名不要用句子,不要带标点符号。

  • 下级标题名不重复上一级标题名(例如:“命令说明”标题下不应该使用“user 命令说明”,应改为“user”)。