SuperAPI AI 工具集

doc-maintenance

写作与研究

查看项目

更新于 10-16 06:55

技能介绍

用途

doc-maintenance 是一个文档维护子代理,用于在代码、配置或脚本发生变更时,捕获代码到文档之间的漂移(code→doc drift)。当代码被编辑,或代码变更出现在对话上下文中时,可将任务委派给该子代理处理。

主要能力

该子代理会直接修复文档,无需回报结果。它以 run_in_background: true 的方式在后台运行。

触发条件

在以下文件或目录发生变更时激活:

  • **/*.ts
  • **/*.tsx
  • **/package.json
  • **/esbuild.config.*
  • scripts/**
  • **/.vscodeignore
  • **/.vscode/**
  • **/tsconfig*.json
  • .esbuild-web-extra-settings.json
  • .github/**

作用范围

包含:

  • .claude/skills/
  • .claude/agents/
  • docs/
  • contributing/
  • packages/**/README.md

排除:

  • **/*.plan.md
  • **/plan.md

使用方式

当代码被编辑(或代码变更处于对话上下文中)时,使用 run_in_background: true 将任务委派给 doc-maintenance 代理。子代理会直接修复文档,无需回报。

适用场景

适用于在修改 TypeScript/TSX 源码、包配置、构建配置、脚本、VS Code 相关配置、TypeScript 配置或 GitHub 工作流等文件后,需要同步更新相关文档的场景。

限制

该子代理不处理 **/*.plan.md 和 **/plan.md 文件。关于其具体实现细节、依赖要求、安装方式及收费情况,资料中暂未提供。