Does this skill write step-by-step tutorials?

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.

Can I include examples in the documentation?

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.

What is the Diátaxis framework?

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.

Why use this skill instead of standard Claude responses?

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.

What specific document types can I create?

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

Name: Diátaxis Reference Writer
Author: jayteealao

byjayteealao

0•

学習とドキュメンテーション

Generates structured, neutral, and scannable technical reference documentation for APIs, CLI commands, and configurations.

The Diátaxis Reference Writer skill empowers Claude to create high-quality technical documentation that follows the information-oriented 'Reference' quadrant of the Diátaxis framework. It is designed for active work, providing developers with the facts, types, and constraints they need for quick lookup without the distraction of tutorials or conceptual prose. Whether you are documenting a REST API, a command-line interface, or a complex configuration schema, this skill ensures consistent formatting, precise terminology, and a neutral tone that mirrors professional product machinery.

主な機能

01Factual and neutral tone enforcement for technical accuracy

02Standardized templates for API endpoints, CLI commands, and config keys

03Illustrative code examples focused on syntax rather than tutorials

04Generation of error code lists and version compatibility matrices

05Automatic structuring of parameter tables, types, and constraints

060 GitHub stars

ユースケース

01Building comprehensive API documentation including request/response schemas and authentication

02Generating CLI command references with synopses, arguments, and exit codes

03Documenting configuration files and environment variables with defaults and limits

主な機能

01Factual and neutral tone enforcement for technical accuracy

02Standardized templates for API endpoints, CLI commands, and config keys

03Illustrative code examples focused on syntax rather than tutorials

04Generation of error code lists and version compatibility matrices

05Automatic structuring of parameter tables, types, and constraints

060 GitHub stars

ユースケース

01Building comprehensive API documentation including request/response schemas and authentication

02Generating CLI command references with synopses, arguments, and exit codes

03Documenting configuration files and environment variables with defaults and limits