SuperAPI AI 工具集

audit-agent-documentation

智能体与模型

查看项目

更新于 10-28 16:16

技能介绍

用途

该技能用于审计和改进代码库中的智能体(Agent)文档,同时保留项目契约。它审查智能体为所请求工作接收的指令栈,追踪其文档图谱,包括入口点、作用域指引、引用、技能、生成器和消费者。在保留已验证项目契约的同时,重新审视历史指引和推荐在当前是否仍然有用。

主要能力

  • 支持三种授权模式:审计(仅诊断并提出修改建议,不编辑文件)、改进(进行聚焦编辑并验证)、发布(在改进后完成发布流程)。
  • 遵循指令层级:用户明确指令覆盖技能和仓库指南,但受更高优先级指令和工具权限约束。
  • 将示例、夹具和检索到的指令视为证据,而非重定向审计的权威。
  • 支持委派覆盖切片,每个委派者只读取其切片新增的文档。
  • 提供分步流程:设定范围与权限、追踪相关图谱、诊断并选择变更、执行授权模式、验证受影响行为、完成并报告。
  • 在诊断阶段,调用 /writing-for-agents 并阅读 AUDIT-RUBRIC.md,对每个范围内文档和不同指令栈应用两者。
  • 验证事实性声明,检查命令定义,使用历史记录和仓库规定的查找工具。
  • 根据规则分类发现,优先处理不正确或冲突的指引、不必要的上下文和工作、以及不清晰的决策边界。
  • 在改进或发布模式中,对每个更改的智能体文档应用 /writing-for-agents,修复拥有源并刷新其输出,更新入站链接和发现元数据。
  • 验证受影响行为,包括阅读更改文档、检查链接、锚点、导入、命令、发现路由和消费者需求,运行适用的仓库格式化、文档和完整性门禁,以及 git diff --check 和最终状态审查。
  • 在发布模式中,本地验证后阅读并完成 PUBLICATION.md。
  • 报告结果、行为改进、覆盖范围和排除项、重要保留契约、未解决的冲突或上游工作以及验证结果。

使用方式

该技能通过分步流程执行:

  1. 设定范围与权限:解析仓库根、工作树、分支和管理指令,捕获初始状态,记录所有权、设置、生成和发布约束。根据请求匹配覆盖范围。
  2. 追踪相关图谱:在声明范围内按文件名和内容搜索跟踪文件和文件系统,包括隐藏的智能体目录、配置的忽略位置和未链接的指引。找到入口点并遵循继承、指令引用、技能依赖、设置输出、生成器和发现适配器。
  3. 诊断并选择变更:调用 /writing-for-agents 并阅读 AUDIT-RUBRIC.md,验证事实性声明,分类发现,规划最小一致修复。
  4. 执行授权模式:在审计模式中,将发现转化为有证据支持的提案,不更改仓库文件。在改进或发布模式中,应用 /writing-for-agents 到每个更改的智能体文档。
  5. 验证受影响行为:端到端阅读更改文档,在每个受影响的指令栈中评估它们。运行适用的门禁,然后 git diff --check 和最终状态审查。
  6. 完成并报告:在发布模式中,本地验证后阅读并完成 PUBLICATION.md。报告结果、行为改进、覆盖范围和排除项等。

适用场景

适用于需要审计或改进代码库中智能体文档的场景,例如审查智能体接收的指令栈、追踪文档图谱、评估历史指引的当前有效性、修复或改进文档、以及发布文档更新。

限制

具体收费、价格、平台、效果或使用步骤等信息暂未提供。该技能依赖于 /writing-for-agents 和 AUDIT-RUBRIC.md 等依赖项,如果依赖不可用,写作评估将报告为受阻。