cli-audit-doc

Assess documentation quality with a 12-dimensional scoring framework.

5|1|Updated Mar 2, 2026
One-click install
npx skills add https://github.com/Destynova2/cli-code-skills --skill cli-audit-doc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: cli-audit-doc
Source: https://github.com/Destynova2/cli-code-skills/tree/main/cli-audit-doc
Command: npx skills add https://github.com/Destynova2/cli-code-skills --skill cli-audit-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill addresses the challenges of maintaining high-quality documentation by providing a comprehensive scoring system and analysis of documentation quality.

Core Features & Use Cases

  • Documentation Quality Score: Provides a quantitative score based on 12 dimensions to assess documentation quality.
  • Audit and Report Generation: Automatically generates a detailed report highlighting strengths and areas for improvement.
  • Language-Specific Analysis: Offers specific guidance and scoring criteria based on the project's primary programming language.

Quick Start

Use the 'cli-audit-doc' skill on a specific directory, e.g., 'cli-audit-doc /path/to/docs/'.

Frequently Asked Questions about cli-audit-doc

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

FAQPage Schema
How do I automate documentation quality analysis for a software project?

Automate documentation quality analysis by running the cli-audit-doc skill against a target directory to evaluate docs using a 12-dimensional scoring framework. It generates a detailed report highlighting strengths and areas for improvement.

What dimensions are evaluated in a documentation quality score?

A documentation quality score evaluates project docs across 12 dimensions, checking them against language-specific standards and best practices. This ensures documentation accuracy and relevance for the specific programming language used.

How do I audit documentation quality from the command line?

Audit documentation quality from the command line by passing a directory path to the skill, such as 'cli-audit-doc /path/to/docs/'. It automatically assesses the files and generates a comprehensive quality report.

Does documentation quality analysis support language-specific standards?

Yes, documentation quality analysis provides specific guidance and scoring criteria based on the software project's primary programming language. This ensures the audit respects language-specific documentation standards and best practices.

What is the best way to report on software documentation strengths and weaknesses?

The best way to report on software documentation strengths and weaknesses is using an automated 12-dimensional scoring framework. It provides a quantitative quality score and generates a detailed audit report highlighting specific areas for improvement.

Do I need external dependencies to run a documentation audit?

No external dependencies are required to run the documentation audit. The skill operates independently using its built-in scripts, references, and assets to assess and report on documentation quality.