ワンクリックで
doc-nav
通过文档理解 NcatBot 项目:查阅功能说明、API 签名、架构设计、预期行为。文档优先,按优先级分层查阅。Use when: 理解功能、查 API、架构理解、预期行为、怎么用、设计决策、模块职责、文档在哪。
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
メニュー
通过文档理解 NcatBot 项目:查阅功能说明、API 签名、架构设计、预期行为。文档优先,按优先级分层查阅。Use when: 理解功能、查 API、架构理解、预期行为、怎么用、设计决策、模块职责、文档在哪。
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
SOC 職業分類に基づく
定位 NcatBot 代码实现:锁定模块目录、找到关键类/函数、追踪调用链。当文档不够时才读代码,用搜索而非遍历。Use when: 找代码实现、哪个文件、哪个类、追踪调用链、定位 bug 行号、代码在哪、模块目录、源码定位。
维护 NcatBot 项目文档、示例、Skills 知识资产。编写/编辑文档、修复文档问题、文档结构规范审查。Use when: 写文档、改文档、新增文档、修复断链、修复索引、修复代码块标注、文档规范、文档模板、文档结构设计、docs maintenance。
整体/局部防腐检查:Docs 内部链接断裂、README 索引不同步、guide↔reference 内容不一致、examples 导入过时、Code↔Docs API 对齐。逐文件检查,最大化并发 subagent。Use when: docs 防腐、docs 链接、docs 断链、断链检查、docs 审计、docs audit、code docs 对齐、reference 过时、guide reference 不同步、examples 检查、定期检查。
开发与维护 NcatBot 框架本体。调试 bug、开发新功能、维护 Skill、代码审查、重构。Use when: 框架调试、debug、fix bug、feat、新功能、Skill 维护、代码贡献、模块修改、代码审查、重构。
使用 NcatBot 框架开发 QQ 机器人或跨平台 Bot。当用户需要快速体验、创建插件、注册事件处理、发送消息、调用 Bot API、使用 Mixin/Hook、使用 CLI 工具、编写插件测试、或调试运行问题时触发此技能。Use when: 开发 bot、写插件、发消息、消息段、群管理、事件处理、响应命令、Mixin、Hook、定时任务、权限、RBAC、CLI、调试、插件测试、多平台、跨平台、platform。
将 NcatBot 4.4/4.5 版本插件迁移到 5.0。包括导入路径、注册方式、Config/Data API、事件类型、消息构造的全面映射。Use when: 迁移插件、升级插件、4 转 5、老版本、旧版本、migration、upgrade、plugin migration、版本升级。
| name | doc-nav |
| description | 通过文档理解 NcatBot 项目:查阅功能说明、API 签名、架构设计、预期行为。文档优先,按优先级分层查阅。Use when: 理解功能、查 API、架构理解、预期行为、怎么用、设计决策、模块职责、文档在哪。 |
根据用户描述的问题或需求,快速定位到正确的文档,理解模块职责、预期行为和接口设计。
核心原则:先读文档再读代码。通过文档理解"应该怎样",而非遍历源码。
1. 分类问题(确定涉及的模块区域)
→ 2. 定位文档(按优先级查阅)
→ 3. 输出(文档路径 + 阅读建议)
根据用户描述的症状或需求,判断涉及的模块区域。
完整症状速查表:references/symptom-doc-table.md
docs/guide/11. 架构与概念/1. 架构总览.md 的分层架构图按以下优先级查阅,每个目录先读 README.md:
| 优先级 | 文档类型 | 路径 | 获取的信息 |
|---|---|---|---|
| 1 | 使用指南 | docs/guide/<模块>/ | 预期行为、使用方式、常见模式 |
| 2 | API 参考 | docs/reference/<模块>/ | 类签名、方法参数、返回值 |
| 3 | 模块内部实现 | docs/contributing/3. 模块内部实现/ | 内部结构、调用链、设计约束 |
| 4 | 设计决策 | docs/contributing/2. 设计决策/ | 为何如此设计、已知权衡 |
| 需要了解什么 | 去哪里找 |
|---|---|
| 某功能怎么用 | docs/guide/ → 对应子目录 |
| 某类/方法的签名 | docs/reference/ → 对应子目录 |
| 某模块内部如何实现 | docs/contributing/3. 模块内部实现/ |
| 某设计为何如此 | docs/contributing/2. 设计决策/ |
| 整体架构 | docs/guide/11. 架构与概念/1. 架构总览.md |
关键词快速跳转索引:references/keyword-doc-index.md
向用户提供: