[ PROMPT_NODE_22176 ]
AI Maestro 文档搜索
[ SKILL_DOCUMENTATION ]
# AI Maestro 文档搜索
搜索代码库自动生成的文档,涵盖函数签名、类定义、API 文档和代码注释。在编写代码前验证正确的模式。属于 [AI Maestro](https://github.com/23blocks-OS/ai-maestro) 套件的一部分。
## 前置条件
需要本地运行 [AI Maestro](https://github.com/23blocks-OS/ai-maestro) 并已完成文档索引。
```bash
# 安装文档工具
git clone https://github.com/23blocks-OS/ai-maestro-plugins.git
cd ai-maestro-plugins && ./install-doc-tools.sh
```
## 核心行为
在实施任何代码更改之前,先搜索文档:
```
接收指令 -> 搜索文档 -> 开始实施
```
## 命令
### 搜索
| 命令 | 描述 |
|---------|-------------|
| `docs-search.sh ` | 语义文档搜索 |
| `docs-search.sh --keyword ` | 精确关键词匹配 |
| `docs-find-by-type.sh ` | 按类型查找(函数、类、模块) |
| `docs-get.sh ` | 获取完整文档内容 |
### 索引
| 命令 | 描述 |
|---------|-------------|
| `docs-index.sh [path]` | 对项目进行完整索引 |
| `docs-index-delta.sh [path]` | 增量索引(仅限新增/修改的文件) |
| `docs-list.sh` | 列出所有已索引的文档 |
| `docs-stats.sh` | 索引统计信息 |
## 文档类型
| 类型 | 来源 |
|------|---------|
| `function` | JSDoc, RDoc, docstrings |
| `class` | 类级注释 |
| `module` | 模块/命名空间注释 |
| `interface` | TypeScript 接口 |
| `component` | React/Vue 组件注释 |
| `readme` | README 文件 |
| `guide` | docs/ 文件夹内容 |
## 使用示例
```bash
# 语义搜索
docs-search.sh "身份验证流程"
# 对特定标识符进行关键词搜索
docs-search.sh --keyword "UserController"
# 查找所有类文档
docs-find-by-type.sh class
# 获取完整文档详情
docs-get.sh doc-abc123
# 对代码库进行索引(首次)
docs-index.sh /path/to/project
# 更改后更新索引
docs-index-delta.sh
```
## 全面的 AI Maestro 体验
此技能是 [AI Maestro](https://github.com/23blocks-OS/ai-maestro) 平台的一部分,该平台提供 **6 项技能** 用于 AI 智能体编排:消息传递、内存、文档、图谱、规划和智能体管理。