SuperAPI AI 工具集

provider-fix-documentation

写作与研究

查看项目

更新于 10-15 19:55

技能介绍

用途:修复 Terraform Provider(阿里云)资源与数据源文档中的问题,包括属性取值错误、描述过时、信息缺失、示例与代码不一致、术语不统一、缺少弃用说明等。需求可来自用户描述、Aone 工作项链接、GitLab Code Review 链接或用户反馈的文档错误;若提供链接,先用 link-info-extractor 技能提取需求详情。

主要能力:识别常见文档问题;定位文档文件(website/docs/r/<product><resource>.html.markdown 与 website/docs/d/...)及对应 Go 代码文件(alicloud/resource_alicloud<product><resource>.go、alicloud/data_source_alicloud<product>_<resource>.go);对照 schema 的 ValidateFunc 与转换函数核验取值;按既有格式修正文档,补充弃用说明与 available-since 版本信息。

使用方式:按步骤执行——识别问题、定位文件、对照代码核验、修正文档、验证一致性(如 grep -r "attribute_name" website/docs/)、提交变更(git status && git diff、make commit、git push origin fix/<brief_description>,提交信息格式 docs(<resource_name>): fix <attribute_name> documentation),最后必须运行 make ci-check-quick 并确保退出码为 0,失败则修正后 git commit --amend 并重跑。

适用场景:阿里云 Terraform Provider 文档维护与评审修复。

限制:仅用于文档修复,不改代码;若代码有误应使用 provider-add-attribute 技能。文档应展示 Terraform 侧取值而非 API 内部取值,schema 为最终依据。其余细节暂未提供。