AI Maestro 文档搜索

来自 AI Maestro 的文档搜索 Skill，在实施任何代码更改前主动搜索自动生成的文档。该 Skill 强制执行"文档优先"的开发方法，确保在编写代码前充分理解现有的 API、函数签名和代码模式。

核心理念

这不是可选的。这是默认行为。

该 Skill 将文档搜索作为强制性的第一步，而不是可选的辅助步骤。在接收到任何开发任务时，必须首先搜索相关文档，理解现有代码结构，然后再开始实施。

搜索内容

当用户给出任何指令或任务时，必须首先搜索文档以查找：

函数签名：查找函数的参数类型、返回类型、可选参数等。理解函数的输入输出契约，避免传递错误的参数类型或期望错误的返回值。

类文档：查找类的方法、属性、继承关系等。理解类的设计意图和使用方式，正确使用现有的类结构。

API 文档：查找 API 端点的规范、请求格式、响应格式等。理解 API 的使用方式和限制，避免错误的 API 调用。

代码注释：查找代码中的注释，理解作者的意图和设计决策。了解代码的历史背景和特殊处理逻辑。

禁止行为

在检查文档前开始实施：绝不在未查阅文档的情况下开始编写代码。即使任务看起来简单，也必须先搜索文档。

假设你知道函数签名：不要依赖记忆或猜测函数的签名。始终通过文档确认准确的参数和返回类型。

跳过"简单任务"的文档搜索：即使是看似简单的任务，也可能涉及不熟悉的 API 或函数。不要因为任务简单就跳过文档搜索。

等待用户要求：不要等待用户明确要求查阅文档。文档搜索应该是自动的、主动的行为。

必须执行

收到任务时立即搜索文档：在分析任务需求后，第一步就是搜索相关文档。在理解现有代码结构后再制定实施计划。

搜索用户提到的术语：用户提到的任何类名、函数名、API 名称都应该被搜索。确保完全理解用户所指的内容。

调用不熟悉的函数前检查文档：在调用任何不完全熟悉的函数前，必须查阅其文档。确认函数的正确用法和潜在的副作用。

创建新组件前查找模式：在创建新的类、函数或组件前，搜索现有的类似实现。遵循项目中已有的设计模式和编码规范。

应用场景

代码实施前的准备：在开始编写代码前，全面了解相关的 API 和函数。避免因不了解现有代码而重复造轮子或使用错误的 API。

代码审查：在审查代码时，查阅相关文档确认代码的正确性。验证函数调用是否符合文档规范。

重构工作：在重构代码前，理解现有代码的设计��图。确保重构不会破坏原有的功能和契约。

新成员入职：帮助新团队成员养成查阅文档的习惯。通过强制文档搜索，加速对代码库的理解。

应用价值

该 Skill 通过强制执行"文档优先"的方法，显著降低了代码错误率。在编写代码前充分理解现有 API 和设计模式，避免了因误解或猜测导致的 bug。

对于大型代码库，文档搜索是理解复杂系统的关键。该 Skill 确保开发者不会因为懒惰或自信而跳过这一关键步骤。通过养成主动查阅文档的习惯，提升代码质量和开发效率。

作为 AI Maestro 主动开发工作流的一部分，该 Skill 与其他 Skills 协同工作，构建系统化的开发流程。

相关：Agent Messaging Skill、Agent Ops Incident Notifier，分类见 skills。