Skip to content

案例 03|项目式写文档:先搭目录再填内容(SOP)

目标

写教程/方案时,不从第一段开始写,而是先把“目录骨架”搭好,再逐篇填充,避免写到一半跑偏。


你对小艺说(输入模板)

我要写一个 OpenClaw 使用教程,先把目录搭起来:基础/高级/案例三层。每个条目先写一句话说明。


小艺会怎么做(步骤)

  1. 先建立信息架构(nav/sidebar/README)
  2. 为每篇文章生成统一模板(目标/步骤/验收/常见坑)
  3. 你确认目录 OK 后,再逐篇补细节

验收清单

  • [ ] 目录一眼能导航
  • [ ] 每篇结构一致(模板化)
  • [ ] npm run docs:build 通过

常见坑

  • 目录看着全,但缺学习路径:解决:在首页/快速开始增加“推荐学习路径”
  • 写着写着变成百科:解决:每篇必须带“验收”与“最小示例”