docs-check-zh-cn

What problem does it solve?

Prevent OpenHarmony API documentation from drifting away from required templates or the actual API definitions by automatically finding template violations, missing fields (like system interface/error-code sections), and link/consistency issues.

Core Features & Use Cases

• Template compliance & field coverage: Verifies that public/system API docs, error-code docs, and interface documentation include required labeled fields (e.g., system interface, permissions, model constraints) and match expected structures.
• Script-assisted consistency checking: Runs automated checks first via the bundled Python script to catch high-confidence mismatches between d.ts tags and Markdown documentation fields.
• Error-code doc auditing: Ensures error-code documents include required blocks and that the error-code coverage is consistent with declared @throws codes in d.ts.
• Implementation alignment & manual follow-up: Helps identify documentation gaps that automation can’t reliably validate, then produces an issues-only Markdown report with locations and suggested fixes.

Quick Start

Run this skill to check API doc consistency for the repository’s docs and interface definitions, focusing on issues only.