5.2 操作步骤写法
本节规范了技术文档中操作步骤的组织方式和撰写要求。
R-095
必须
操作步骤使用有序列表
描述需要按顺序执行的操作步骤时，必须使用有序列表（编号列表）。无序列表仅用于顺序无关的枚举项。有序列表让读者清楚地了解操作顺序和总步骤数。
R-096
推荐
每个步骤以动词开头
操作步骤中的每一步应以动词开头，直接描述用户需要执行的操作。这种写法使指令更加直接和明确，避免冗余的前置说明。
正确
配置数据库连接： 1. 打开配置文件 config.yaml。 2. 找到 database 部分。 3. 输入数据库服务器地址。 4. 设置端口号为 5432。 5. 保存文件并重启服务。
错误
配置数据库连接的方法是首先打开配置文件 config.yaml，然后你需要在里面找到 database 部分，接下来把数据库服务器地址输入进去，端口号需要改成 5432，最后别忘了保存文件和重启服务。
正确示例使用有序列表、每步以动词开头，结构清晰。错误示例使用连续散文叙述，步骤边界模糊，读者难以按步操作。
R-097
推荐
单个过程不超过 10 步
单个操作过程的步骤数量应控制在 10 步以内。如果步骤超过 10 步，应将其拆分为多个子过程，或按逻辑分组并增加分组标题。过多的步骤容易让读者失去位置感，增加操作出错的风险。
技巧
如需补充说明，可在步骤下方缩进添加备注信息。例如，在某一步骤后缩进说明该步骤的预期结果、可能出现的提示框或需要注意的前置条件。缩进的补充说明不占用步骤编号。