What documentation types are supported?

It provides specialized audit criteria for project READMEs, API documentation, and Architecture Decision Records (ADRs).

Can this skill find undocumented code automatically?

Yes, it includes specific detection patterns that compare public classes and methods in the source code against existing markdown documentation.

Does it integrate with CI/CD workflows?

The skill provides guidance and tool recommendations, such as markdownlint and link-check, for integrating documentation validation into CI/CD pipelines.

How does the skill calculate documentation scores?

It uses a weighted formula evaluating Completeness (25%), Accuracy (25%), Clarity (20%), Consistency (15%), Navigation (10%), and Freshness (5%).

Documentation Quality Auditor

Name: Documentation Quality Auditor
Author: dykyi-roman

bydykyi-roman

•

Content Management

Audits and improves technical documentation through standardized quality metrics, checklists, and automated detection patterns.

The Documentation Quality Auditor skill provides Claude with a comprehensive framework for assessing the quality of technical documentation. It features a weighted scoring system across dimensions like completeness, accuracy, and clarity, along with specialized checklists for READMEs, API docs, and architecture records. By using built-in detection patterns, the skill helps identify undocumented code, broken links, and outdated examples, allowing teams to generate professional audit reports and maintain high documentation standards throughout the development lifecycle.

Key Features

01Automated grep patterns to detect undocumented public classes and methods

02Weighted quality scoring system for objective documentation assessment

03Detailed audit checklists for READMEs, APIs, and System Architecture

04Structured audit report templates with severity-based issue tracking

0545 GitHub stars

06Quality improvement guides featuring quick wins and automation strategies

Use Cases

01Standardizing documentation reviews across a development team

02Identifying undocumented public APIs in large PHP codebases

03Performing a pre-release documentation audit for software projects

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add dykyi-roman/awesome-claude-code documentation-qa-knowledge

For use in Claude.ai and ChatGPT

Download Skill