Guide Whitebook

操作手册格式

前置条件—步骤—验证—排错,适合工具与流程类知识

引导型引导笔记note-tutorial66/100
结构清晰24/25可执行11/25覆盖面9/25冗余控制22/25本地启发式评分:8 个小节、9 条列表、含表格、约 168 字。AI 评判不可用,启用降级评分。

操作手册格式

一句话定位:让别人(和未来的自己)照着做就能复现结果。

1. 适用场景

  • 工具配置、环境搭建、部署流程、故障处理
  • 不适用:概念解释、观点论述

2. 硬性规则

  1. 必须写明前置条件(系统、版本、权限、依赖)。
  2. 步骤必须可执行:每条命令给完整可复制的形式。
  3. 每一步之后给「怎么验证这步成功了」。
  4. 必须有一节常见错误,写清报错原文与解法。

3. 输出结构

# {任务名}

> 目标:{做完之后能得到什么}

## 前置条件
## 步骤
1. {动作} → 验证:{判定方式}
## 常见错误
| 报错 | 原因 | 解法 |
## 回滚方式

4. 质量判定

  • 合格:零上下文的人照着做能跑通
  • 不合格:缺验证步骤、命令不完整