如何写任务话题
任务话题的定位与作用
任务话题是 DITA 中用于描述操作步骤的主题类型,专为指导用户完成具体任务而设计。它强调清晰、简洁、可执行,是技术文档中最贴近用户实际操作需求的内容单元。
撰写任务话题的核心原则
每个主题只描述一个任务
- 避免在一个主题中混合多个操作流程(如安装与卸载)。
- 有助于内容的查找、重用与维护。
任务与概念和参考信息分离
- 任务主题应聚焦“怎么做”,不应包含过多背景或数据。
- 背景信息可单独编写为相关主题,以便任务更简洁。
拆分复杂任务为子任务
- 若任务超过 10 步,建议拆分为多个子任务,并通过“父任务”组织。
- 例如:“安装数据库系统”可拆为“准备环境”“配置参数”“启动服务”等子任务。
任务话题的基本结构
一个清晰、好用的任务主题通常包括以下几个部分:
标题
任务标题要让人一眼看出“这是一个操作指南”。 推荐写法: 使用动词或“How to”结构,例如“安装打印机”“如何配置数据库”。
简介
在正文开头写一到两句话,快速说明任务的作用或意义。 例如: “完成这个过程后,系统将支持双用户登录功能。” “本任务适用于已安装数据库服务器的环境。”
背景信息(根据需要决定是否要写)
说明任务的执行条件、适用范围或注意事项。 如有必要,可链接到单独的“背景说明”主题。
前提条件
列出用户执行操作前应具备的准备或条件,使用简洁列表或简单说明。 例如:
- 已具备管理员权限
- 已安装某插件
- 完成了上一步骤
操作步骤
清楚、直接地列出完成任务所需的每一步。 写作建议:
- 每步都用动词开头,如“点击”“输入”“选择”
- 避免复合句,一步做一事
- 如某步有多个选项,可用列表或表格列出
示例:
- 打开控制面板
- 点击“网络设置”
- 启用无线连接
- 输入密码后点击“连接”
步骤结果或提示(根据需要决定是否要写)
说明用户完成步骤后可能看到的界面、变化或反馈。 例如: “系统会自动重启并显示欢迎界面。”
示例或补充说明(根据需要决定是否要写)
提供操作例子、注意事项或常见错误提示,帮助理解操作流程。
后续任务指引(视实际流程决定是否包含)
如果该任务是系列操作中的一部分,建议在最后提示用户“接下来执行 XX”,并提供链接或标题。
命名与风格建议
- 命名统一:所有 Task 主题应使用一致的命名风格,便于用户识别。
- 语言简洁:避免冗长句式与术语,使用清晰、直接的动词。
- 避免假设:不要假设用户已有知识,应从零开始说明每一步。
写作技巧与注意事项
- 将任务话题视为“菜谱”:只提供完成任务所需的最小信息。
- 每一步都应明确、独立,避免逻辑跳跃。
- 使用命令式语言,如“点击保存”而非“保存是通过点击实现的”。