alicloud-platform-docs-api-review

核心用法

该 Skill 通过命令行脚本实现阿里云产品文档与 API 文档的端到端质量审查。用户只需提供产品名称（如 "ECS"），脚本即可自动完成以下流程：从阿里云 OpenAPI 元数据服务解析产品信息，获取默认版本的 API 文档，从产品列表页提取帮助文档链接，最终生成包含评分、证据和改进建议的结构化报告。

显著优点

1. 零依赖轻量化：仅使用 Python 标准库（urllib、json、re、pathlib 等），无第三方包依赖，部署简单且供应链攻击面极小。
2. 官方数据源：所有数据均来自阿里云官方域名（api.aliyun.com、www.aliyun.com、help.aliyun.com），确保信息权威性和时效性。
3. 结构化输出：生成 JSON 格式的评审证据和 Markdown 格式的可读报告，支持 P0/P1/P2 优先级分级，便于团队排期处理。
4. 透明可审计：代码功能单一、逻辑清晰，约 536 行 Python 代码易于人工审查，无黑箱操作。

潜在缺点与局限性

1. HTML 解析鲁棒性不足：当前使用正则表达式提取 HTML 内容，若阿里云官网改版可能导致解析失败，建议后续迁移至 BeautifulSoup 等专用库。
2. 无缓存机制：每次运行均重新请求 OpenAPI 元数据，频繁调用时效率较低且增加网络开销。
3. 网络依赖性强：必须能访问阿里云官方域名，内网或受限环境无法使用。
4. 评审维度有限：主要关注文档结构和 API 规范，不涉及内容准确性、多语言完整性等深度质量维度。

适合的目标群体

• 阿里云技术文档团队：需要批量审计多产品文档质量，建立统一的评审基线。
• 开发者体验（DX）工程师：负责优化 API 开发者体验，需要数据驱动的改进建议。
• 产品经理与运营：评估产品文档成熟度，对比竞品文档质量差距。
• 开源社区贡献者：希望为阿里云产品文档提交改进 PR，需要具体的证据支撑。

使用风险

• 网络超时风险：阿里云 API 偶发响应延迟，脚本已设置 15-30 秒超时，极端情况下可能返回不完整数据。
• 输出目录权限：需确保 output/alicloud-platform-docs-api-review// 目录可写，否则报告生成失败。
• 产品名称匹配：模糊输入（如"云服务器"而非"ECS"）可能导致解析失败，建议使用标准产品代码。