mcpField
A
aliyun-platform-docs-review

aliyun-platform-docs-review

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

关于 aliyun-platform-docs-review

aliyun-platform-docs-review 用于审查指定 Alibaba Cloud 产品的产品文档和 API 文档。它解析产品及版本、收集文档证据，并生成带评分和优先级建议的报告。

主要功能

  1. 01解析产品及默认版本
  2. 02获取最新 API 文档
  3. 03查找官方产品页和帮助文档链接
  4. 04评估文档质量并评分
  5. 05按优先级整理建议

适用场景

  1. 01审查指定产品的文档
  2. 02确定产品和 API 文档的改进优先级

安装

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

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

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

包含的文件

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

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

详细介绍

Alibaba Cloud 产品文档 + API 文档审查

当用户提供产品名称并要求进行端到端的文档/API 质量审查时，使用此技能。

此技能的功能

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

工作流

运行随附脚本：

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

示例：

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

输出策略

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

output/aliyun-platform-docs-review/

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

  • review_evidence.json
  • review_report.md

报告指南

回答用户时：

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

验证

mkdir -p output/aliyun-platform-docs-review
for f in skills/platform/docs/aliyun-platform-docs-review/scripts/*.py; do
  python3 -m py_compile "$f"
done
echo "py_compile_ok" > output/aliyun-platform-docs-review/validate.txt

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

输出与依据

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

前提条件

  • 执行前配置权限最小化的 Alibaba Cloud 凭据。
  • 优先使用环境变量：ALIBABACLOUD_ACCESS_KEY_ID、ALIBABACLOUD_ACCESS_KEY_SECRET，以及可选的 ALIBABACLOUD_REGION_ID。
  • 如果地域不明确，请在运行会修改数据的操作前询问用户。

参考资料

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

评论

支持 Markdown