alicloud-platform-docs-api-review

📁 cinience/alicloud-skills 📅 3 days ago
54
总安装量
54
周安装量
#7271
全站排名
安装命令
npx skills add https://github.com/cinience/alicloud-skills --skill alicloud-platform-docs-api-review

Agent 安装分布

github-copilot 53
codex 53
kimi-cli 53
gemini-cli 53
cursor 53
amp 53

Skill 文档

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

  1. Resolve product from latest OpenAPI metadata.
  2. Fetch latest API docs for default version.
  3. Discover product/help-doc links from official product page.
  4. 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:

  1. State resolved product + version first.
  2. Summarize the score and the top 3 issues.
  3. List P0/P1/P2 recommendations with concrete actions.
  4. Provide source links used in the report.

References

  • Review rubric: references/review-rubric.md