SuperAPI AI 工具集

cdk-documentation-review

写作与研究

查看项目

更新于 10-15 19:58

技能介绍

用途:审查 PR 新增或修改的文档是否与代码及 CDK 设计指南一致。CDK 文档具有代码地位:必须真实(如 @default 须与代码实际默认值相符)、完整(指南要求处必须存在),示例必须能编译。

主要能力:按清单核查文档面,包括示例编译、@default 准确性、公共 API 文档完整性、迁移说明。对每个规则同时检查“存在但错误”和“应有无缺”。对 @default,读取同一 diff 中构造函数或 ?? 处理,与标签比对,矛盾为最高价值缺陷。按危害分级(BLOCKING/RECOMMENDED/OPTIONAL),同一位置多个缺陷归入最严重类型并合并描述。

使用方式:先盘点 diff 触及的文档面(新增/重命名的导出公共类、方法、属性;新增可选属性及其 @default;暴露 CloudFormation 属性的只读属性;@deprecated 与破坏性变更;新增或修改的 ```ts 代码块与 *.ts-fixture)。再阅读 documentation-rules.md 作为清单,并查阅 aws/aws-cdk 主分支权威文档核实事实,不凭记忆。然后按家族逐项核查,最后按危害评级并停止。输出使用 cdk-review-principles 定义的结构化字段,message 为完整评论,含观察、影响、具体修复与指南引用。

适用场景:审查 AWS CDK 仓库 PR 中的文档改动。

限制:只审查本 PR 新增或修改的文档,不标记既有未文档化 API 或未触及的过时示例;不评判代码正确性、测试覆盖、设计或破坏性变更决策;不标记措辞、拼写、注释密度等风格问题;不标记代码正确性、测试问题。缺失事实暂未提供。