用途:当用户给出产品名称或产品代码并希望进行端到端的文档与 API 质量审查时使用此技能,可针对阿里云产品的帮助文档和 OpenAPI 文档生成结构化评审结果。
主要能力:从最新 OpenAPI 元数据解析产品及其默认版本;抓取该默认版本的最新 API 文档;从官方产品页面发现产品/帮助文档链接;生成包含评分、证据和 P0/P1/P2 优先级改进建议的结构化评审报告。
使用方式:运行随附脚本,例如 python skills/platform/docs/alicloud-platform-docs-api-review/scripts/review_product_docs_and_api.py --product "ECS" 其中 --product 可传产品名称或产品代码。回答用户时应先说明解析出的产品与版本,再概括评分和前三项问题,列出 P0/P1/P2 建议及具体行动,并附上报告使用的来源链接。
输出与校验:所有生成产物须写入 output/alicloud-platform-docs-api-review/,每次运行生成 review_evidence.json 和 review_report.md。可用 mkdir -p output/alicloud-platform-docs-api-review 与 python3 -m py_compile 逐一编译 scripts 目录下 .py 文件完成校验,命令退出码为 0 且生成 validate.txt 即视为通过。证据文件应包含区域、资源 ID、时间范围等关键参数以便复现。
前提与限制:执行前需配置最小权限的阿里云凭证,优先使用环境变量 ALICLOUD_ACCESS_KEY_ID、ALICLOUD_ACCESS_KEY_SECRET,可选 ALICLOUD_REGION_ID;若区域不明确,应在执行变更类操作前询问用户。评审标准参考 references/review-rubric.md。具体收费、价格、平台支持范围及效果等资料暂未提供。