Diátaxis Docs Reviewer FAQs

Question 1

What is the Diátaxis framework used by this skill?

Accepted Answer

Diátaxis is a systematic approach to technical documentation that categorizes content into four distinct types: tutorials, how-to guides, technical reference, and explanation, ensuring each serves a specific user need.

Question 2

Does it provide general writing advice or specific technical fixes?

Accepted Answer

It avoids vague advice like 'make it nicer' and instead provides concrete fixes such as moving parameter tables into reference sections or shrinking quickstarts to a single happy path.

Question 3

How does the skill handle 'overloaded' documentation pages?

Accepted Answer

The skill identifies boundary violations where different types of content are mixed inappropriately and provides specific recommendations on how to split the page into more focused, manageable documents.

Question 4

Can this skill review an entire documentation folder at once?

Accepted Answer

Yes, it is designed to audit both single pages and entire documentation sets to identify missing document types, duplicates, and proposed improvements to information architecture.

Question 5

What kind of feedback does the documentation audit provide?

Accepted Answer

You receive a detailed report including current vs. ideal document types, audience analysis, identified boundary violations, a severity scale for issues, and specific, direct rewrite strategies.

Diátaxis Docs Reviewer

주요 기능

사용 사례

Diátaxis Docs Reviewer

주요 기능

사용 사례