mcpField
A
aliyun-platform-docs-review

aliyun-platform-docs-review

github.com/cinienceTesting & quality39656 installsUpdated 11w ago
Repository

About aliyun-platform-docs-review

aliyun-platform-docs-review reviews Alibaba Cloud product and API documentation for a named product. It resolves the product and version, gathers documentation evidence, and produces a scored report with prioritized recommendations.

Key features

  1. 01Resolves product and default version
  2. 02Fetches latest API documentation
  3. 03Finds official product and help-doc links
  4. 04Scores documentation quality
  5. 05Prioritizes recommendations by severity

Use cases

  1. 01Reviewing documentation for a specified product
  2. 02Identifying prioritized product and API doc improvements

Install

Copy the command and run it in a terminal.

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

After installing, type/aliyun-platform-docs-reviewin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

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

Details

From the project README

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/aliyun-platform-docs-review/scripts/review_product_docs_and_api.py --product "<product name or product code>"

Example:

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

Output policy

All generated artifacts must be written under:

output/aliyun-platform-docs-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.

Validation

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

Pass criteria: command exits 0 and output/aliyun-platform-docs-review/validate.txt is generated.

Output And Evidence

  • Save artifacts, command outputs, and API response summaries under output/aliyun-platform-docs-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: ALIBABACLOUD_ACCESS_KEY_ID, ALIBABACLOUD_ACCESS_KEY_SECRET, optional ALIBABACLOUD_REGION_ID.
  • If region is unclear, ask the user before running mutating operations.

References

  • Review rubric: references/review-rubric.md

Comments

Markdown supported