Diátaxis Reference Writer FAQs

Question 1

Does this skill write step-by-step tutorials?

Accepted Answer

No, this skill is specifically designed to avoid tutorial prose. It creates neutral, factual descriptions of machinery intended for lookup during development rather than onboarding or teaching.

Question 2

Can I include examples in the documentation?

Accepted Answer

Yes, but the skill follows a strict policy where examples must be short and illustrative of syntax rather than turning into a walkthrough or essay.

Question 3

What is the Diátaxis framework?

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. This skill focuses exclusively on the Reference quadrant.

Question 4

Why use this skill instead of standard Claude responses?

Accepted Answer

This skill enforces a rigid, predictable structure and a neutral tone, preventing the AI from adding unnecessary opinion or narrative that can clutter professional-grade technical references.

Question 5

What specific document types can I create?

Accepted Answer

You can use this skill for API docs, CLI command references, configuration keys, parameter tables, schema documentation, error code lists, and version compatibility matrices.

Diátaxis Reference Writer

主要功能

使用场景

Diátaxis Reference Writer

主要功能

使用场景