返回顶部
a

aliyun-platform-docs-review阿里云文档审核

Use when reviewing 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.

作者: admin | 来源: ClawHub
源自
ClawHub
版本
V 1.0.0
安全检测
已通过
108
下载量
免费
免费
0
收藏
概述
安装方式
版本历史

aliyun-platform-docs-review

技能名称: aliyun-platform-docs-review
详细描述:

阿里云产品文档 + API 文档审查工具

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

该技能的功能

1) 根据最新的 OpenAPI 元数据解析产品。
2) 获取默认版本的最新 API 文档。
3) 从官方产品页面发现产品/帮助文档链接。
4) 生成结构化的审查报告,包含:

  • - 评分
  • 证据
  • 优先级建议(P0/P1/P2)

工作流程

运行捆绑脚本:

bash
python skills/platform/docs/aliyun-platform-docs-review/scripts/reviewproductdocsandapi.py --product <产品名称或产品代码>

示例:

bash
python skills/platform/docs/aliyun-platform-docs-review/scripts/reviewproductdocsandapi.py --product ECS

输出策略

所有生成的产物必须写入以下目录:

output/aliyun-platform-docs-review/

每次运行时,脚本会创建:

  • - reviewevidence.json
  • reviewreport.md

报告指南

回答用户时:

1) 首先说明解析出的产品及版本。
2) 总结评分和排名前三的问题。
3) 列出 P0/P1/P2 级别的建议,并附上具体操作。
4) 提供报告中使用的源链接。

验证

bash
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 pycompileok > output/aliyun-platform-docs-review/validate.txt

通过标准:命令退出码为 0,且生成了 output/aliyun-platform-docs-review/validate.txt 文件。

输出与证据

  • - 将产物、命令输出和 API 响应摘要保存到 output/aliyun-platform-docs-review/ 目录下。
  • 在证据文件中包含关键参数(区域/资源 ID/时间范围),以确保可复现性。

前提条件

  • - 执行前配置最小权限的阿里云凭证。
  • 优先使用环境变量:ALICLOUDACCESSKEYID、ALICLOUDACCESSKEYSECRET,可选 ALICLOUDREGIONID。
  • 如果区域不明确,在执行变更操作前先询问用户。

参考资料

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

标签

skill ai

通过对话安装

该技能支持在以下平台通过对话安装:

OpenClaw WorkBuddy QClaw Kimi Claude

方式一:安装 SkillHub 和技能

帮我安装 SkillHub 和 aliyun-platform-docs-review-1775876535 技能

方式二:设置 SkillHub 为优先技能安装源

设置 SkillHub 为我的优先技能安装源,然后帮我安装 aliyun-platform-docs-review-1775876535 技能

通过命令行安装

skillhub install aliyun-platform-docs-review-1775876535

下载

⬇ 下载 aliyun-platform-docs-review v1.0.0(免费)

文件大小: 8.99 KB | 发布时间: 2026-4-12 08:56

v1.0.0 最新 2026-4-12 08:56
Initial release of aliyun-platform-docs-review skill.

- Enables end-to-end review of Alibaba Cloud product and OpenAPI documentation by product name.
- Generates a structured quality report with scores, evidence, and prioritized improvement suggestions (P0/P1/P2).
- Supports output of review artifacts and evidence to a dedicated directory for transparency and reproducibility.
- Includes clear workflow, reporting guidance, and validation steps for users.

Archiver·手机版·闲社网·闲社论坛·羊毛社区· 多链控股集团有限公司 · 苏ICP备2025199260号-1

Powered by Discuz! X5.0   © 2024-2025 闲社网·线报更新论坛·羊毛分享社区·http://xianshe.com

p2p_official_large
返回顶部