doc-integrity

Audit KDoc coverage, pattern-code alignment, API freshness, and document structure.

1|Updated Mar 9, 2026
One-click install
npx skills add https://github.com/oscardlfr/AndroidCommonDoc --skill doc-integrity
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-integrity
Source: https://github.com/oscardlfr/AndroidCommonDoc/tree/main/skills/doc-integrity
Command: npx skills add https://github.com/oscardlfr/AndroidCommonDoc --skill doc-integrity

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

The doc-integrity skill helps maintain the accuracy and completeness of your documentation by auditing KDoc coverage, pattern-code alignment, freshness of API documentation, and overall document structure.

Core Features & Use Cases

  • KDoc Coverage Audit: Measures KDoc coverage and identifies gaps.
  • Pattern-Code Alignment: Ensures documentation patterns are correctly implemented in code.
  • API Freshness Check: Validates the freshness of the docs/api/ directory.
  • Doc Structure Audit: Validates document structure for correctness.
  • Automated Reporting: Provides a comprehensive report of the audit results.

Quick Start

Perform a full documentation integrity audit with /doc-integrity.

Frequently Asked Questions about doc-integrity

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit KDoc coverage and find documentation gaps in my Kotlin project?

To audit KDoc coverage, run a full documentation integrity audit using the `/doc-integrity` command. It measures KDoc coverage across multiple project roots and modules, identifies missing documentation gaps, and generates a comprehensive report of the audit results.

What is API documentation freshness validation and how does it work?

API documentation freshness validation checks the `docs/api/` directory to ensure your API documentation is current. The doc-integrity audit validates this freshness, confirming that your documented patterns align with the actual codebase implementation.

Can I check if my code follows documented patterns across multiple project modules?

Yes, you can check pattern-code alignment across multiple project roots and modules. The audit ensures your documentation patterns are correctly implemented in code and validates the overall document structure for correctness across the entire project.

How do I generate missing API docs and KDoc comments after an audit?

After auditing documentation integrity, you can generate missing API docs and KDoc comments directly. The audit utilizes generation tools to create documentation where needed, resolving the coverage gaps identified in the report.

Does this documentation audit tool require any specific dependencies or environment setup?

No specific dependencies are required to run the documentation audit. The doc-integrity skill operates independently using internal scripts to audit KDoc coverage, validate document structure, and check API documentation freshness without external tools.

What is the best way to ensure complete documentation integrity for a Kotlin codebase?

The best way to ensure documentation integrity is performing a full audit that checks KDoc coverage, pattern-code alignment, API freshness, and document structure. This comprehensive approach identifies gaps and validates correctness across all project modules.