docs-audit

Audit project documentation for Diataxis coverage and readiness gaps.

Updated Apr 15, 2026

Search Tags:#documentation #audit #readme #quality #staleness #diataxis #api-docs

Ready to run

npx skills add https://github.com/AAbdulghany/fms --skill docs-audit-aabdulghany

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs-audit
Source: https://github.com/AAbdulghany/fms/tree/main/.claude/skills/docs-audit
Command: npx skills add https://github.com/AAbdulghany/fms --skill docs-audit-aabdulghany

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit a project's documentation to ensure coverage across Tutorials, How-to guides, Reference docs, and Explanations.

Core Features & Use Cases

Diataxis completeness checks for Tutorials, How-tos, Reference, and Explanation sections
Readiness evaluation of README, API docs, deployment guides, changelog, and staleness
Guided workflow for stepwise improvements with actionable findings
Use Case: Apply to a repo to produce a structured audit showing gaps and priority fixes

Quick Start

Run the docs-audit skill against a project to generate a Diataxis completeness report and recommended fixes

Frequently Asked Questions about docs-audit

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

FAQPage Schema

How do I audit my project documentation for completeness and staleness?▼

To audit project documentation for completeness and staleness, run a Diataxis-driven evaluation that checks coverage across Tutorials, How-to guides, Reference docs, and Explanations. It flags gaps in README files, API docs, and deployment guides, producing structured findings and a readiness verdict.

What is the Diataxis framework for evaluating API docs and README quality?▼

The Diataxis framework evaluates documentation by categorizing content into Tutorials, How-to guides, Reference docs, and Explanations. Auditing API docs and README quality against this framework identifies missing documentation types and flags staleness to drive targeted improvements.

Can I check if my repository has missing deployment guides or changelogs?▼

Yes, you can check if your repository has missing deployment guides or changelogs by running a documentation audit. It evaluates README quality, API references, and deployment guides, flagging gaps and staleness to produce a structured readiness verdict with actionable findings.

What's the best way to identify documentation gaps across tutorials and how-to guides?▼

The best way to identify documentation gaps across tutorials and how-to guides is applying a Diataxis completeness check. This framework-based evaluation assesses coverage across Tutorials, How-tos, Reference, and Explanation sections, generating a structured audit report that prioritizes stepwise improvements.

Does a Diataxis-based documentation audit work for code repositories without API references?▼

A Diataxis-based documentation audit can work for code repositories without API references by focusing on README quality, changelogs, and deployment guides. It evaluates completeness across Tutorials, How-to guides, and Explanations, although API reference checks will flag gaps if they are absent.

Why does my documentation audit flag staleness in my reference docs?▼

Your documentation audit flags staleness in reference docs because it evaluates the readiness and currency of API references, README files, changelogs, and deployment guides. This Diataxis-driven check identifies outdated content to help prioritize stepwise improvements and maintain healthy documentation.