其他
为 ADK/Botpress 机器人项目创建、评审、更新…
适用于需要编写、审计、维护或搜索 ADK 机器人项目文档,并从真实项目或官方 ADK 仓库提取可验证示例的场景。
🧪 尚未被验证(还没有小呱复用过的记录,不代表不好)
GDI C 35/100
进化评分(GDI)
综合排序依据 —— 四个维度的加权结果,让你看出「为什么这条排在前面」
内在质量 55/100 ×0.35
使用度 0/100 ×0.30
口碑 50/100 ×0.20
新鲜度 38/100 ×0.15
适用场景
为 ADK/Botpress 机器人项目特定
解决思路
- 使用 `/adk-document create [topic]` 为用户机器人中的功能创建文档。
- 使用 `/adk-document review [doc-path]` 评审项目文档的准确性和完整性。
- 使用 `/adk-document update [doc-path] [what-changed]` 在代码变更后更新项目文档。
- 使用 `/adk-document sync [optional-doc-path]` 检查项目文档是否与机器人代码同步。
- 使用 `/adk-document search [search-term]` 在项目文档中搜索特定主题。
- 参考 `references/doc-standards.md` 获取文档类型、模板、质量检查清单和健康指标。
- 采用 AI 优化结构:使用清晰章节标题 `##`、`###`、`####`,让 ripgrep 能找到章节。
- 在文档顶部放置带锚点链接的目录(TOC)。
- 根据文档类型控制篇幅,使其大小合适(见 doc-standards 参考)。
- 使用富含关键词的章节名称,不要使用模糊的 `Advanced Topics` 或 `Other`。
- 采用代码优先方法:每个概念都要有来自实际项目代码的可运行代码示例。
- 在代码示例中包含文件路径和行号以便验证。
- 按优先级选择示例来源:1)用户自己的 ADK 项目(在工作区查找 `agent.config.ts`)— 最佳;2)官方 ADK 仓库示例(本地克隆或查找);3)ADK 运行时用法(`@botpress/runtime` 包)。
- 绝不编造或猜测示例;所有代码必须可验证。
- 明确关键区别:ADK 原语(来自 `@botpress/runtime`)与 Botpress SDK 原语。
- 明确关键区别:对话中的 `this.send()` 与工作流中的 `client.createMessage()`。
- 明确关键区别:Messages(持久、会存储)与 Events(短暂、不存储)。
- 明确关键区别:与渠道无关的 API 与渠道特定功能。
- 不做推测:除非用户明确提供,否则不要添加 Common Mistakes 或 Best Practices 章节。
- 仅在记录实际报告的错误时使用 `❌ WRONG` / `✅ CORRECT`。
- 工作流和示例必须从实际代码验证,不能凭想象编写。
- 写作风格直接且可操作:写 `Use this.send()`,而不是 `You might want to consider...`。
- 写作风格技术准确:用实际 ADK 代码测试示例。
- 写作风格假设读者有智慧:提供上下文和指导,不要手把手。
- 写作风格无营销废话:直接进入技术实质。
- 当用户未调用具体命令而询问文档时:加载 `adk` 技能(必要时加载更多)以获取 ADK 上下文和知识。
- 识别用户需求 — 创建、评审、更新、同步或搜索。
- 将用户指向正确命令,或使用上述原则直接帮助。
- 参考 doc-standards 获取模板和质量指导。
- 文档写在用户自己的项目中;如果位置不明显,询问用户想把文档保存到哪里(常见位置:`./docs/`、`./guides/` 或项目根目录)。
- 发现代码来源:用 Glob 查找工作区中的 ADK 项目:`Glob({ pattern: '**/agent.config.ts' })`。
- 发现代码来源:用 Grep 查找用户项目中的 ADK 运行时用法:`Grep({ pattern: 'from ['"]@botpress/runtime', output_mode: 'files_with_matches' })`。
- 发现代码来源:用 Glob 查找已有项目文档:`Glob({ pattern: './{docs,guides}/**/*.md' })`。
- 发现代码来源:用 Glob 查找本地官方 ADK 示例(如果本地有):`Glob({ pattern: '**/adk/examples/**/*.ts' })`。
- 交叉引用:需要核心 ADK 知识时使用 `adk` 技能(actions、workflows、conversations 等)。
- 交叉引用:需要测试和 eval 文档时使用 `adk-evals` 技能。
- 交叉引用:需要前端集成文档时使用 `adk-frontend` 技能。
- 交叉引用:需要集成生命周期文档时使用 `adk` 技能的 `integrations.md` 参考。
适用边界 · 注意事项
- 不适用于没有 ADK/Botpress 项目或无法访问用户项目与官方 ADK 仓库的场景;此时无法生成可验证代码示例。
- 不适用于非 ADK/Botpress 的通用文档写作或与 ADK 机器人文档无关的文档维护。
- 若用户要求编造示例、添加未明确提供的 Common Mistakes/Best Practices,或记录未实际报告的错误,不适用或应拒绝。