alicloud-platform-docs-api-review
Automatically review 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.
Install via CLI (Recommended)
clawhub install openclaw/skills/skills/cinience/alicloud-platform-docs-api-reviewWhat This Skill Does
The alicloud-platform-docs-api-review skill serves as an automated auditor for Alibaba Cloud documentation and OpenAPI schemas. It provides developers and technical writers with a structured, data-driven analysis of product documentation quality. By leveraging the latest OpenAPI metadata and official product documentation links, the skill performs a comprehensive evaluation. It generates a standardized report that includes a quality score, specific evidence gathered during the audit, and actionable improvement recommendations categorized by priority levels (P0, P1, and P2). This ensures that documentation gaps, broken API definitions, or missing parameters are identified and addressed systematically.
Installation
To install this skill, run the following command in your terminal within the OpenClaw environment:
clawhub install openclaw/skills/skills/cinience/alicloud-platform-docs-api-review
Before running the skill, ensure your Alibaba Cloud environment variables are properly configured for the CLI, specifically ALICLOUD_ACCESS_KEY_ID and ALICLOUD_ACCESS_KEY_SECRET. The skill adheres to the principle of least privilege, requiring only read-only access to query OpenAPI metadata and fetch public documentation files.
Use Cases
This skill is ideal for technical writers aiming to improve product adoption, API developers verifying the accuracy of their Swagger/OpenAPI documentation, and DevOps engineers preparing for platform integrations. It is particularly useful during documentation sprints, pre-release audits for new product features, or when migrating legacy documentation to updated standards.
Example Prompts
- "Perform an audit of the ECS documentation. Tell me what is missing and identify any critical errors in the OpenAPI spec."
- "I need a quality report for the Object Storage Service (OSS) API docs. Please prioritize suggestions based on clarity and technical accuracy."
- "Evaluate the current documentation for the Auto Scaling product. Give me a P0-P2 list of recommended improvements based on the latest Alibaba Cloud standards."
Tips & Limitations
To get the best results, always ensure you provide the exact product name or code as defined in the Alibaba Cloud product list. The skill relies on public-facing documentation and metadata; therefore, it cannot access non-public, internal-only documentation or private API schemas. Always review the review_report.md in the output directory after execution for full context. If the tool fails to resolve a product, verify the spelling against the official Alibaba Cloud product index.
Metadata
Not sure this is the right skill?
Describe what you want to build — we'll match you to the best skill from 16,000+ options.
Find the right skillPaste this into your clawhub.json to enable this plugin.
{
"plugins": {
"official-cinience-alicloud-platform-docs-api-review": {
"enabled": true,
"auto_update": true
}
}
}Tags(AI)
Flags: file-write, file-read, external-api, code-execution
Related Skills
volcengine-compute-ecs
Manage Volcengine ECS instances and related resources. Use when users need instance inventory, lifecycle operations, troubleshooting, or automation templates for ECS.
alicloud-ai-search-opensearch
Use OpenSearch vector search edition via the Python SDK (ha3engine) to push documents and run HA/SQL searches. Ideal for RAG and vector retrieval pipelines in Claude Code/Codex.
alicloud-storage-oss-ossutil
Alibaba Cloud OSS CLI (ossutil 2.0) skill. Install, configure, and operate OSS from the command line based on the official ossutil overview.
alicloud-platform-openapi-product-api-discovery
Discover and reconcile Alibaba Cloud product catalogs from Ticket System, Support & Service, and BSS OpenAPI; fetch OpenAPI product/version/API metadata; and summarize API coverage to plan new skills. Use when you need a complete product list, product-to-API mapping, or coverage/gap reports for skill generation.
alicloud-ai-image-qwen-image
Generate images with Model Studio DashScope SDK using Qwen Image generation models (qwen-image, qwen-image-plus, qwen-image-max and snapshots). Use when implementing or documenting image.generate requests/responses, mapping prompt/negative_prompt/size/seed/reference_image, or integrating image generation into the video-agent pipeline.