SuperAPI AI 工具集

reviewing-documentation

写作与研究

查看项目

更新于 10-16 00:30

技能介绍

用途:审计、改进并维护代码仓库中的文档质量。查找文档时通过搜索定位文件,不依赖硬编码路径。涉及 ARCHITECTURE-FLOW.md 更新时,先加载 .github/skills/understanding-architecture/SKILL.md,其中包含校验命令与事实来源映射。

主要能力与质量门:SKILL.md 命名需小写、连字符、最长 64 字符,frontmatter 必含 name(与目录名一致)和 description(说明做什么与何时使用,最长 1024 字符),正文需含目标陈述、实用代码示例、常见错误与相关技能交叉引用。.agent.md 必含 name、description、argument-hint、tools、model,并校验 handoffs 引用有效 agent 名。copilot-instructions.md 每次请求都会加载,需精简,包含架构速查、开发命令、agents 表与 skills 表。

检查清单:ARCHITECTURE-FLOW.md 的 Mermaid 图无语法错误、状态机与 appState.ts 类型一致、SSE 事件与 Program.cs 的 Write*Event 方法一致、动作与 AppAction 类型联合一致;README 的快速开始可用、命令表准确、子 README 链接可解析;技能与 agent 的 YAML frontmatter 有效、示例 SDK 版本与 *.csproj / package.json 一致、交叉引用有效;跨文档需架构表一致、端口号一致(5173、8080)、SDK 版本与实际依赖一致。

用法与输出:对每份文档标注路径与状态(良好/需改进/损坏),用编号列出问题与修复建议,并单列交叉引用问题(失效链接、版本不匹配)。内容规则:只描述当前行为,不写历史或变更理由;不写死版本号,指向源文件;不写 issue/PR 追踪链接;不重复同一事实,改用交叉引用;互斥路径明确说明,不使用含糊的 fallback 或 automatic 表述;避免过期注释。应包含非显而易见的约束、互斥选项、错误签名(如 AADSTS65001)、文件到概念映射与 SDK 版本引用。风格上代码块须带语言标识,内部链接用相对路径、外部用绝对路径。限制:不修改代码,只改文档;不得编造代码库中不存在的功能。