docs-check-zh-cn

Installation
SKILL.md

Documentation Check

Run OpenHarmony API documentation quality checks with emphasis on template compliance, documentation consistency, error code coverage, and implementation alignment. Focus the output on issues only. Do not repeat content that already complies.

Input Collection

Infer paths from the user context, current working directory, and repository layout whenever possible. Ask the user only if the needed files still cannot be located.

Collect or infer the following inputs:

  • public API doc path, optional, usually under /docs
  • system API doc path, optional, usually under /docs
  • error code doc path, optional, usually under /docs
  • API definition path, usually under /interface
  • repository root path, only if interface implementations cannot be found from the current workspace

By default, resolve /docs first from the workspace root, then /interface.

If the user provides a path starting with /docs/... or /interface/..., interpret it as a repository-root path first, not as a path relative to the current module directory.

Related skills

More from openharmonyinsight/openharmony-skills

Installs
23
GitHub Stars
21
First Seen
Mar 11, 2026