DocCoverage is an automated analyzer that scans your codebase to identify missing documentation, incomplete docstrings, and quality gaps across multiple programming languages.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install doccoverage
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install doccoverage using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is DocCoverage?
DocCoverage is a comprehensive documentation auditing tool designed to maintain high-quality codebases. As one of the most practical Openclaw Skills, it evaluates your source code for missing JSDoc, docstrings, and README sections. It supports major languages including JavaScript, TypeScript, Python, Go, Java, and Ruby, ensuring that public functions and exported types are properly explained.
By leveraging regex-based pattern matching against 85+ documentation standards, this skill empowers developers to bridge the gap between code and documentation. Whether you are managing a solo project or a large enterprise repository, DocCoverage provides actionable scores and remediation steps to improve the overall health of your project documentation.
DocCoverage Use Cases
- Identifying undocumented public functions or exported classes in large repositories.
- Auditing README and CHANGELOG files for missing sections or inconsistent versioning.
- Enforcing documentation standards before code is committed to version control using pre-commit hooks.
- Generating detailed documentation coverage reports for team standards audits.
- Detecting redundant comments, TODOs without ticket references, or commented-out code blocks.
How DocCoverage Works
- The skill identifies the target files or directories and auto-detects the programming language based on file extensions.
- It executes over 85 documentation quality patterns to scan for missing docstrings, missing parameters, or incomplete return descriptions.
- A documentation coverage score from 0 to 100 is calculated by deducting points based on the severity of identified issues.
- Detailed findings are reported to the user, including line numbers, check IDs, severity levels, and specific recommendations for improvement.
- For advanced tiers, results can be integrated into git hooks or exported as SARIF files for seamless CI/CD pipeline integration.
DocCoverage Setup
To start using this addition to your Openclaw Skills, follow these installation steps:
# Install the required git hooks manager (optional for free tier)
brew install lefthook
# Configure your license key in your local configuration file
# Path: ~/.openclaw/openclaw.json
# Run a manual scan on your current directory
bash "<SKILL_DIR>/scripts/doccoverage.sh" scan .
DocCoverage Data Schema & Taxonomy
DocCoverage organizes its findings based on a structured scoring system and metadata taxonomy:
| Category | Details |
|---|---|
| Scoring System | 0-100 scale; deductions: Critical (25), High (15), Medium (8), Low (3). |
| File Support | Analyzes .js, .ts, .py, .go, .java, .rb, and Markdown files. |
| Output Formats | Console output, Markdown reports, and SARIF 2.1.0 JSON. |
| Metadata | Includes check ID, file path, line number, and remediation advice. |
DocCoverage Advanced Features
- Git pre-commit hook integration via Lefthook to block commits with undocumented code.
- Organization-specific custom policy enforcement for unique documentation standards.
- Automated CHANGELOG verification against git tags to ensure version history consistency.
- Offline license validation ensuring no source code is ever sent to external servers.
- Multi-language scanning capability that processes polyglot repositories in a single pass.
SKILL.md
Loading
Related Openclaw Skills
FuelWatch SA Tracker
A mobile-first, crowdsourced fuel tracking platform designed to monitor price and availability across South Africa during supply shortages.
Email Approval Workflow
A robust human-in-the-loop protocol for AI agents to draft, review, and send external professional communications.
Model Rate Limit Recovery
A technical framework for diagnosing and recovering from model provider rate limits and 429 errors to maintain agent uptime.
Affiliate Marketing Optimizer
An automated tool designed to maximize affiliate earnings through data-driven product selection, link optimization, and compliance auditing.
Gmail + Gog Setup
Connect your AI agents to Gmail using the Gog CLI to enable automated email reading and mailbox authentication.
Email Web Interface
A streamlined web dashboard for managing AI agent email accounts through Gmail and Gog CLI integrations.
Featured*
