docs-improve

Audit and improve docs/ directory documentation using the Diataxis framework.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit and improve project documentation in the docs/ directory using the Diataxis framework to ensure clarity, structure, and consistency across the software project.

Core Features & Use Cases

  • Diataxis-aligned documentation auditing and improvement across tutorials, how-to guides, reference, and explanations.
  • Consistency checks for structure, tone, audience targeting, and cross-referencing with related documents.
  • Actionable recommendations and a documentation health score to guide ongoing documentation maintenance.

Quick Start

Audit the docs/ directory and propose improvements according to the Diataxis framework.

Frequently Asked Questions about docs-improve

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

FAQPage Schema
How do I audit project documentation quality using the Diataxis framework?

To audit project documentation quality using the Diataxis framework, scan your docs/ directory to evaluate tutorials, how-to guides, references, and explanations for structural consistency, clear audience targeting, and valid cross-references, generating a documentation health score and actionable recommendations.

What is the Diataxis framework for documentation?

The Diataxis framework is a systematic approach to documentation that categorizes content into four modes: tutorials, how-to guides, reference, and explanations. This Skill uses it to inventory, audit, and align your docs/ directory structure, ensuring each document serves its specific user intent and audience.

How do I check cross-references and consistency across core docs like README.md and AGENTS.md?

Checking cross-references and consistency across core docs like README.md and AGENTS.md involves scanning these files to verify structured sections, last updated markers, and valid internal links. The audit ensures no placeholders remain and audience targeting is clear across the project documentation.

Can I use this to enforce documentation standards for existing docs?

Yes, you can use this to enforce documentation standards for existing docs. It audits the docs/ directory to enforce structured sections, last updated markers, and clear audience targeting, while providing a health score and actionable recommendations to guide ongoing maintenance and eliminate placeholders.

What is the best way to improve documentation structure and eliminate placeholders?

The best way to improve documentation structure and eliminate placeholders is to run a Diataxis-driven audit on your docs/ directory. This process enforces structured sections, verifies cross-references across core files, and outputs actionable recommendations to resolve inconsistencies and remove all placeholder content.