alicloud-platform-docs-api-review
阿里云产品文档与API文档审查技能,用于对指定产品的端到端文档和API质量进行全面审查。
npx skills add cinience/alicloud-skills --skill alicloud-platform-docs-api-reviewBefore / After 效果对比
1 组在评估阿里云产品文档和API质量时,需要人工查阅产品页面、API文档,并手动比对功能描述、参数定义和示例代码,过程耗时且评估结果受主观因素影响。
通过此技能,可以自动化地对阿里云产品文档和API进行端到端质量评估。技能能够解析OpenAPI元数据、抓取产品帮助文档,并生成结构化的审查报告,提供客观的文档覆盖率、API一致性等指标,显著提高了评估效率和准确性。
description SKILL.md
alicloud-platform-docs-api-review
Alibaba Cloud Product Docs + API Docs Reviewer Use this skill when the user gives a product name and asks for an end-to-end documentation/API quality review. What this skill does Resolve product from latest OpenAPI metadata. Fetch latest API docs for default version. Discover product/help-doc links from official product page. Produce a structured review report with: score evidence prioritized suggestions (P0/P1/P2) Workflow Run the bundled script: python skills/platform/docs/alicloud-platform-docs-api-review/scripts/review_product_docs_and_api.py --product "" Example: python skills/platform/docs/alicloud-platform-docs-api-review/scripts/review_product_docs_and_api.py --product "ECS" Output policy All generated artifacts must be written under: output/alicloud-platform-docs-api-review/ For each run, the script creates: review_evidence.json review_report.md Reporting guidance When answering the user: State resolved product + version first. Summarize the score and the top 3 issues. List P0/P1/P2 recommendations with concrete actions. Provide source links used in the report. Validation 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 Pass criteria: command exits 0 and output/alicloud-platform-docs-api-review/validate.txt is generated. Output And Evidence Save artifacts, command outputs, and API response summaries under output/alicloud-platform-docs-api-review/. Include key parameters (region/resource id/time range) in evidence files for reproducibility. Prerequisites Configure least-privilege Alibaba Cloud credentials before execution. Prefer environment variables: ALICLOUD_ACCESS_KEY_ID, ALICLOUD_ACCESS_KEY_SECRET, optional ALICLOUD_REGION_ID. If region is unclear, ask the user before running mutating operations. References Review rubric: references/review-rubric.md Weekly Installs197Repositorycinience/alicloud-skillsGitHub Stars355First SeenFeb 26, 2026Security AuditsGen Agent Trust HubPassSocketPassSnykPassInstalled ongemini-cli195github-copilot195codex195kimi-cli195amp195cursor195
forum用户评价 (0)
发表评价
暂无评价,来写第一条吧
统计数据
用户评分
为此 Skill 评分