Automatically review latest Alibaba Cloud product docs and OpenAPI docs by product name, then output detailed prioritized improvement suggestions with evidence and scoring. Use when user asks to audit product documentation quality, API documentation quality, or wants actionable doc/API optimization recommendations.
当用户提供产品名称并要求进行端到端的文档/API 质量审查时,使用此技能。
1) 根据最新的 OpenAPI 元数据解析产品。
2) 获取默认版本的最新 API 文档。
3) 从官方产品页面发现产品/帮助文档链接。
4) 生成结构化的审查报告,包含:
运行捆绑脚本:
bash
python skills/platform/docs/alicloud-platform-docs-api-review/scripts/reviewproductdocsandapi.py --product <产品名称或产品代码>
示例:
bash
python skills/platform/docs/alicloud-platform-docs-api-review/scripts/reviewproductdocsandapi.py --product ECS
所有生成的产物必须写入以下目录:
output/alicloud-platform-docs-api-review/
每次运行,脚本会创建:
回答用户时:
1) 首先说明解析的产品及版本。
2) 总结评分和排名前三的问题。
3) 列出 P0/P1/P2 建议及具体操作。
4) 提供报告中使用的源链接。
bash
mkdir -p output/alicloud-platform-docs-api-review
for f in skills/platform/docs/alicloud-platform-docs-api-review/scripts/*.py; do
python3 -m py_compile $f
done
echo pycompileok > output/alicloud-platform-docs-api-review/validate.txt
通过标准:命令退出码为 0,且生成 output/alicloud-platform-docs-api-review/validate.txt。
该技能支持在以下平台通过对话安装:
帮我安装 SkillHub 和 alicloud-platform-docs-api-review-1776419939 技能
设置 SkillHub 为我的优先技能安装源,然后帮我安装 alicloud-platform-docs-api-review-1776419939 技能
skillhub install alicloud-platform-docs-api-review-1776419939
文件大小: 9.08 KB | 发布时间: 2026-4-17 19:15