文档规划器
识别文档站点中的空白,并生成排好优先级的待办事项列表。
输入
- 范围:待评估的区域 — 全部文档、特定部分或功能领域。默认:全部。
- 信号(可选):GitHub Issues、社区问题、支持主题。
- 竞争环境(可选):竞争对手记录了但我们没有记录的内容。
流程
步骤 1:盘点当前文档
读取 site/src/config/navigation.yml 获取完整导航树 — 这是 Astro 站点的权威导航来源,由 site/astro.config.mjs 通过 site/src/sidebar.ts 加载。使用 Glob 模式 site/src/content/docs/**/*.{md,mdx} 获取所有内容文件。按内容类型(教程、操作指南、参考、解释、混合)和覆盖领域(快速入门、工具、智能体、多智能体、部署等)对每个文件进行分类。
步骤 2:识别空白
将盘点结果与以下内容进行比较:
- SDK 表面功能:是否所有主要功能都有文档?没有文档页面的功能即为空白。
- Diataxis 完整性:对于每个功能领域,是否所有四种类型的文档都存在?如果一个功能只有参考文档而没有教程,那就是空白。
- 社区信号:如果 GitHub CLI 可用,则从 strands-agents/harness-sdk 仓库中拉取标记为“documentation”的开放 Issue。将问题映射到现有文档(不清楚/难找)或缺失的文档(内容空白)。
- 竞争对比(如果提供):LangChain、CrewAI、Anthropic 和 OpenAI 关于同等功能记录了哪些内容,而我们没有?
步骤 3:优先级排序
根据开发者影响和努力程度为每个空白打分:
- P0(立即执行):高影响,任何努力。快速入门、入门指南、核心概念。
- P1(尽快做):中影响,低努力。常见任务的缺失操作指南。
- P2(计划做):中影响,高努力。新教程、架构解释。
- P3(待办列表):低影响。小众场景、边缘案例文档。
步骤 4:生成待办事项列表
以 Markdown 格式输出:
## 文档待办事项:[范围]
**生成时间:** [日期]
**已盘点页面数:** [数量]
**识别的空白数:** [数量]
### P0:立即执行
- [ ] [任务] — [内容类型] — [目标页面] — [原因]
### P1:尽快做
- [ ] [任务] — [内容类型] — [目标页面] — [原因]
### P2:计划做
- [ ] [任务] — [内容类型] — [目标页面] — [原因]
### P3:待办列表
- [ ] [任务] — [内容类型] — [目标页面] — [原因]
### 覆盖矩阵
| 功能领域 | 教程 | 操作指南 | 参考 | 解释 |
|---|---|---|---|---|
| 智能体基础 | Y | ~ | Y | N |
| 自定义工具 | Y | Y | Y | N |
| 多智能体 | ~ | N | Y | ~ |
### 信号驱动的洞察
- [从社区信号中提取的主题,映射到具体的文档空白]
此技能不做的事
- 不编写文档(请使用 docs-writer 技能)
- 不依赖外部信号管道(仅凭本地盘点即可工作)
- 不会在外部工具中自动创建任务