mcpField
A
alicloud-platform-docs-api-review

alicloud-platform-docs-api-review

github.com/cinience测试与质量396266 次安装11 周前更新
代码仓库

关于 alicloud-platform-docs-api-review

用于评审指定 Alibaba Cloud 产品的产品文档和 API 文档。它收集最新文档与 API 信息，并生成包含评分、证据和优先级建议的报告。

主要功能

  1. 01从 OpenAPI 元数据解析产品
  2. 02获取最新 API 文档
  3. 03查找官方产品帮助链接
  4. 04生成评分评审报告
  5. 05按优先级整理建议

适用场景

  1. 01评估产品文档质量
  2. 02检查 API 文档覆盖情况
  3. 03制定文档改进优先级

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/cinience/alicloud-skills --skill alicloud-platform-docs-api-review

安装后在 Claude Code 中输入/alicloud-platform-docs-api-review确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

agents/
openai.yaml
references/
review-rubric.md
scripts/
review_product_docs_and_api.py

详细介绍

阿里云产品文档 + API 文档审查员

当用户提供产品名称并要求全面审查文档/API 质量时，使用此技能。

此技能的作用

  1. 根据最新的 OpenAPI 元数据解析产品。
  2. 获取默认版本的最新 API 文档。
  3. 从官方产品页面发现产品/帮助文档链接。
  4. 生成结构化审查报告，包含：
  • 评分
  • 证据
  • 按优先级排序的建议（P0/P1/P2）

工作流

运行随附脚本：

python skills/platform/docs/alicloud-platform-docs-api-review/scripts/review_product_docs_and_api.py --product "<product name or product code>"

示例：

python skills/platform/docs/alicloud-platform-docs-api-review/scripts/review_product_docs_and_api.py --product "ECS"

输出策略

所有生成的产物都必须写入：

output/alicloud-platform-docs-api-review/

每次运行时，脚本都会创建：

  • review_evidence.json
  • review_report.md

报告指南

回答用户时：

  1. 首先说明解析出的产品 + 版本。
  2. 总结评分和最重要的 3 个问题。
  3. 列出 P0/P1/P2 建议，并提供具体操作。
  4. 提供报告中使用的来源链接。

验证

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 "py_compile_ok" > output/alicloud-platform-docs-api-review/validate.txt

通过标准：命令退出码为 0，且生成 output/alicloud-platform-docs-api-review/validate.txt。

输出与证据

  • 将产物、命令输出和 API 响应摘要保存到 output/alicloud-platform-docs-api-review/ 下。
  • 在证据文件中包含关键参数（地域/资源 ID/时间范围），以便复现。

前置条件

  • 执行前配置遵循最小权限原则的阿里云凭证。
  • 优先使用环境变量：ALICLOUD_ACCESS_KEY_ID、ALICLOUD_ACCESS_KEY_SECRET，以及可选的 ALICLOUD_REGION_ID。
  • 如果地域不明确，在执行变更操作前询问用户。

参考资料

  • 审查标准：references/review-rubric.md

评论

支持 Markdown