Stats
Actions
Tags
From diataxis
Use when the user asks to review, audit, improve, classify, or reorganise existing documentation — for a single page or a whole docs set. Evaluates docs against Diátaxis principles: type fit, boundary discipline, user fit, structure, and quality. Returns concrete prioritised fixes and, where needed, recommends splitting overloaded pages. Triggers on phrases like "review my docs", "audit the documentation", "what's wrong with this guide", "improve this README", "tell me what's wrong".
How this skill is triggered — by the user, by Claude, or both
Slash command
/diataxis:docs-reviewerThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Review one document or a whole docs set using Diátaxis.
Review one document or a whole docs set using Diátaxis.
The job is not to say whether the writing is "good" in the abstract. The job is to determine whether each page has the right purpose, stays within its boundaries, serves the right user need, and forms part of a usable documentation system.
Use this skill when the user asks for:
Assess each page on these axes:
Type fit
Boundary discipline
User fit
Structure
Functional quality
Deep quality
System quality
Flag examples like:
For each document, return:
For a docs set, also return:
Be direct and specific. Prefer:
Avoid vague advice like:
Before returning, verify:
npx claudepluginhub jayteealao/agent-skills --plugin diataxisReviews documentation from a novice user's perspective, rating clarity, completeness, actionability, and structure. Outputs prioritized issues and concrete suggested fixes.
Analyzes markdown docs using Diataxis principles: classifies sections as tutorial/how-to/reference/explanation, identifies type-specific issues, and interactively refines.
Audits the pedagogical UX of documentation outlines—beginnner progression, signposting, and reading flow—using a reference prompt.