Doc Coverage

Documentation Coverage

Detect missing documentation across code and project files with coverage metrics.

Triggers

• check documentation coverage
• find missing docs
• validate API documentation
• check XML doc comments
• run doc coverage scan

Quick Start

# Check all files in current directory
python3 scripts/check_docs.py --target .

# Check only changed files (CI mode)
python3 scripts/check_docs.py --git-staged

# Check specific files
python3 scripts/check_docs.py src/models/user.cs src/services/auth.py

# JSON output for automation
python3 scripts/check_docs.py --target . --format json --output coverage.json

# Set minimum threshold
python3 scripts/check_docs.py --target . --min-coverage 80

Evidence

Created based on analysis of moq.analyzers closed PR reviewer patterns:

• 8.9% of human reviewer feedback (10 of 112 comments) addressed documentation gaps
• Common patterns: Missing XML doc comments, CHANGELOG not updated, undocumented public APIs
• Examples: "Missing XML doc comments", "Update CHANGELOG.md", "Public API needs documentation"

Source: .agents/analysis/moq-analyzers-reviewer-patterns-2026-02-08.md

Documentation Types Checked

C# XML Documentation

Python Docstrings

JavaScript/TypeScript JSDoc

CHANGELOG Coverage

When to Use

Use this skill when:

• Preparing code for PR submission (catch documentation gaps before review)
• Setting up CI gates for documentation quality
• Auditing existing codebase documentation coverage
• Enforcing documentation standards on public APIs

Use doc-sync instead when:

• Syncing CLAUDE.md navigation files
• Updating architecture documentation in README files
• Not checking code-level documentation

Output Formats

Text (default)

Documentation Coverage Report
=============================

Overall Coverage: 73.2% (below 80% threshold)

Gaps Found: 12

src/services/auth.cs:45:AuthenticateUser
  - Missing: <summary> on public method
  - Missing: <param name="credentials">

src/models/user.py:12:User
  - Missing: class docstring

CHANGELOG.md
  - Missing: entry for breaking change in v2.1.0

JSON

{
  "coverage_percent": 73.2,
  "threshold": 80,
  "passed": false,
  "total_symbols": 156,
  "documented_symbols": 114,
  "gaps": [
    {
      "file": "src/services/auth.cs",
      "line": 45,
      "symbol": "AuthenticateUser",
      "type": "method",
      "missing": ["summary", "param:credentials"]
    }
  ]
}

Markdown

Produces a markdown report suitable for PR comments or documentation.

Configuration

Create .doccoveragerc.json in project root:

{
  "min_coverage_percent": 80,
  "check_public_only": true,
  "check_changelog": true,
  "exclude_patterns": [
    "**/tests/**",
    "**/test_*.py",
    "**/*.Tests.cs",
    "**/dist/**",
    "**/node_modules/**"
  ],
  "languages": {
    "csharp": {
      "require_summary": true,
      "require_param": true,
      "require_returns": true,
      "require_exception": false
    },
    "python": {
      "style": "google",
      "require_module_docstring": true,
      "require_args_section": false
    },
    "javascript": {
      "require_jsdoc": true,
      "require_param": true,
      "require_returns": true
    }
  }
}

Exit Codes

Integration

Pre-commit Hook

# .pre-commit-config.yaml
repos:
  - repo: local
    hooks:
      - id: doc-coverage
        name: Documentation Coverage
        entry: python3 .claude/skills/doc-coverage/scripts/check_docs.py --git-staged --min-coverage 80
        language: system
        pass_filenames: false

GitHub Actions

# .github/workflows/docs.yml
name: Documentation Coverage
on: [pull_request]

jobs:
  doc-coverage:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Check documentation coverage
        run: |
          python3 .claude/skills/doc-coverage/scripts/check_docs.py \
            --target . \
            --min-coverage 80 \
            --format json \
            --output coverage.json
      - name: Upload coverage report
        uses: actions/upload-artifact@v4
        with:
          name: doc-coverage
          path: coverage.json

Anti-Patterns

Verification

After running:

• Coverage percentage reported
• All gaps have file:line:symbol location
• Exit code matches coverage status
• Configuration file respected (if present)

Scripts

Extension Points

1. New languages: Add parser in check_docs.py for additional languages
2. Custom checks: Add project-specific documentation requirements
3. Report formats: Add SARIF or other CI-friendly formats
4. Threshold by type: Different thresholds for classes vs methods

Related Skills

Converted and distributed by TomeVault — claim your Tome and manage your conversions.