SuperAPI AI 工具集

docs-planner

写作与研究

查看项目

更新于 10-16 09:39

技能介绍

用途

docs-planner 用于识别文档站点中的缺口,并产出一份按优先级排序的文档待办清单(backlog)。它适合在以下场景使用:规划一次文档改进冲刺、在社区信号显示反复出现使用摩擦之后、或当新的 SDK 功能上线需要评估文档覆盖时。

主要能力

该技能围绕四个步骤展开:

第一步:清点现有文档。 读取 site/src/config/navigation.yml 获取完整导航树(这是 Astro 站点的权威导航来源,由 site/astro.config.mjs 通过 site/src/sidebar.ts 加载),并用 glob 匹配 site/src/content/docs/**/*.{md,mdx} 获取所有内容文件。随后按内容类型(教程、操作指南、参考、解释、混合)和覆盖领域(快速开始、工具、智能体、多智能体、部署等)对每个文件进行分类。

第二步:识别缺口。 将清点结果与以下维度对比:SDK 功能面(所有主要功能是否都有文档页面,没有文档页面的功能即为缺口);Diátaxis 完整性(每个功能领域是否四类文档齐全,例如只有参考没有教程即为缺口);社区信号(若 GitHub CLI 可用,拉取 strands-agents/harness-sdk 中标记为 "documentation" 的开放 issue,将问题映射到现有文档的不清晰/难查找,或缺失文档的内容缺口);竞品对比(若提供,则对比 LangChain、CrewAI、Anthropic、OpenAI 对等功能的文档情况)。

第三步:优先级排序。 按开发者影响和工作量对每个缺口评分:P0(立即做)高影响,任意工作量,如快速开始、入门、核心概念;P1(尽快做)中等影响、低工作量,如常见任务缺失的操作指南;P2(计划做)中等影响、高工作量,如新教程、架构解释;P3(待办)低影响,如小众场景、边缘情况文档。

第四步:产出待办清单。 以 Markdown 格式输出,包含:标题(Docs Backlog: [Scope])、生成日期、清点页面数、识别缺口数;按 P0 至 P3 分组的任务列表,每项包含任务、内容类型、目标页面、原因;覆盖矩阵表格(功能领域 × 教程/操作指南/参考/解释,用 Y/~ /N 标记);以及信号驱动洞察(将社区信号主题映射到具体文档缺口)。

使用方式

该技能接受以下输入:范围(要评估的区域,默认全部文档)、信号(可选,GitHub issue、社区问题、支持线程)、竞品上下文(可选,竞品有而自身没有的文档)。它可仅凭本地清点独立工作,不要求外部信号管道。

适用场景

适用于文档改进冲刺规划、新功能上线后的文档覆盖评估、社区反馈驱动的文档优化,以及需要系统化梳理文档缺口的团队。

限制

该技能不撰写文档(撰写文档应使用 docs-writer);不要求外部信号管道(可仅凭本地清点工作);不会自动在外部工具中创建任务。