doc-readability

Name: doc-readability
Availability: InStock
Author: MegaETH

Audit documentation readability, tone, and structure against AGENTS.md criteria.

4|8|Updated Mar 5, 2025

Search Tags:#linting #documentation #tone #readability #audit #style-guide

Ready to run

npx skills add https://github.com/megaeth-labs/documentation --skill doc-readability

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-readability
Source: https://github.com/megaeth-labs/documentation/tree/main/.claude/skills/doc-readability
Command: npx skills add https://github.com/megaeth-labs/documentation --skill doc-readability

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation quality can vary across teams and layers. This Skill evaluates readability, tone, and structure to ensure audience-appropriate content and consistent documentation standards.

Core Features & Use Cases

Audits a documentation page or layer for readability and tone
Checks formatting, headings, and structure against layer-specific AGENTS.md
Generates actionable guidance to improve publish-ready content

Quick Start

Run a readability audit on a target page or layer to identify tone and structure issues.

Frequently Asked Questions about doc-readability

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

FAQPage Schema

How do I audit documentation readability and tone across a project?▼

To audit documentation readability, apply the doc-readability Skill to a single page, an entire layer, or a glob pattern to generate a structured report on tone and structural consistency. It evaluates formatting against layer-specific rules to ensure publish-ready quality.

What is documentation linting and how does it enforce a style guide?▼

Documentation linting checks frontmatter presence, heading structure, and tone guidance against criteria defined by AGENTS.md. It enforces style guide standards by evaluating content across layers to ensure audience-appropriate consistency and structure.

Can I run a readability audit on a specific directory or glob pattern?▼

Yes, you can target a specific directory or glob pattern, such as docs/integration/*.md, for a readability audit. The Skill evaluates the specified paths and provides a structured report detailing tone and structural issues.

How do I check if my markdown documentation meets audience-appropriate standards?▼

You can check markdown documentation standards by running an audit that evaluates readability, tone, and structure. The Skill checks formatting and headings against layer-specific AGENTS.md criteria to produce actionable guidance for improvement.

What is the best way to ensure consistent documentation tone across multiple pages?▼

The best way to ensure consistent documentation tone is to audit all pages listed in docs/SUMMARY.md at once. This process evaluates readability and tone across the entire documentation set, generating a structured report of inconsistencies.

Do I need an AGENTS.md file to audit documentation readability?▼

Yes, an AGENTS.md file is required to define evaluation criteria like frontmatter presence, heading structure, and tone guidance. The readability audit uses these layer-specific rules to generate its structured report.