docs-improve

Audit project documentation and generate a 100-point health score.

1|Updated Aug 16, 2025
One-click install
npx skills add https://github.com/ReefBytes/Manifest --skill docs-improve
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-improve
Source: https://github.com/ReefBytes/Manifest/tree/main/configs/claude/skills/docs-improve
Command: npx skills add https://github.com/ReefBytes/Manifest --skill docs-improve

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit and improve project documentation using Diataxis and documentation quality best practices across the docs set.

Core Features & Use Cases

  • Diataxis-based organization: Classifies docs into Tutorials, How-to Guides, Reference, and Explanation.
  • Health scoring & recommendations: Generates a 100-point score with actionable improvements.
  • Cross-document consistency: Enforces standardized formatting, linking, and last-updated markers.
  • Audit workflow: Inventory core docs (README.md, AGENTS.md, docs/README.md) and propose missing items.

Quick Start

Execute an initial audit by scanning the docs/ directory and generate a health score with targeted improvements.

Frequently Asked Questions about docs-improve

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

FAQPage Schema
How do I audit and improve project documentation quality?▼

To audit and improve project documentation quality, scan your docs directory to inventory files like README.md and AGENTS.md, classify them using the Diataxis framework, and generate a 100-point health score with actionable improvement recommendations.

What is the Diataxis framework for software documentation?▼

The Diataxis framework is a documentation structure that classifies content into Tutorials, How-to Guides, Reference, and Explanation. It organizes software project docs to ensure they serve distinct user needs and learning styles effectively.

How do I calculate a documentation health score for my repository?▼

Calculate a documentation health score by inventorying core configuration docs and README files, assessing cross-references, formatting consistency, and last-updated markers, then generating a 100-point score with targeted improvements.

What's the best way to enforce last-updated markers and cross-references in docs?▼

The best way to enforce last-updated markers and cross-references is running an audit workflow that scans documentation sets, checks cross-document consistency, and proposes missing items to maintain standardized formatting across the project.

Can I audit AGENTS.md and configuration docs using Diataxis?▼

Yes, you can audit AGENTS.md and configuration docs by applying the Diataxis framework guidance. The audit handles inventory, quality assessment, and improvement recommendations for comprehensive software project documentation.