documentation__writing

Classify and restructure technical documentation using the Diátaxis framework.

1|1|Updated Mar 16, 2026
One-click install
npx skills add https://github.com/erikhazzard/vasir --skill documentation-writing-erikhazzard
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation__writing
Source: https://github.com/erikhazzard/vasir/tree/main/.agents/skills/documentation__writing
Command: npx skills add https://github.com/erikhazzard/vasir --skill documentation-writing-erikhazzard

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Diátaxis-driven writing skill automates classification, auditing, and restructuring of technical documentation to ensure consistent page types and clear information architecture.

Core Features & Use Cases

  • Identify the dominant Diátaxis type for each page (tutorial, how-to, reference, explanation) and nominate a primary page role.
  • Audit existing docs to expose mixed-type pages, gaps, and navigation opportunities.
  • Plan and execute restructures that maintain a one-type-per-page rule while improving discoverability and maintainability.

Quick Start

Provide your documentation set and let the skill produce a Diátaxis-aligned plan and a set of rewritten pages.

Frequently Asked Questions about documentation__writing

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

FAQPage Schema
What is the Diátaxis framework for technical documentation?

Diátaxis is a documentation strategy that classifies content into tutorials, how-to guides, references, and explanations. It enforces a single dominant type per page to improve navigation and resolve mixed-type documentation issues.

How do I audit existing technical documentation for information architecture gaps?

Audit documentation by classifying each page into a dominant Diátaxis type to expose mixed-type content, structural gaps, and navigation opportunities. This enforces a one-type-per-page rule to remediate information architecture issues.

How do I restructure API docs and quickstarts to follow a one-type-per-page rule?

Restructure API docs and quickstarts by classifying their dominant Diátaxis role and splitting mixed content. Automating this ensures one page type per document, yielding clearer quickstarts, references, and troubleshooting guides.

Can I use this approach to plan navigation for tutorials and how-to guides?

Yes, applying the Diátaxis framework assists navigation and information architecture planning. By nominating a primary page role for tutorials and how-tos, you can organize navigation that strictly separates learning-oriented and task-oriented content.

What are the limitations of enforcing a single Diátaxis type per page?

Enforcing one Diátaxis type per page prevents mixing explanations with references. While it improves clarity and maintainability, this constraint requires splitting complex pages, which may fragment troubleshooting content or interconnected API explanations.

When do I need to separate technical communication into different content types?

Separate technical communication into distinct content types when pages mix tutorials, how-tos, and reference data. Applying Diátaxis resolves this by nominating a single dominant type per page, ensuring documentation serves specific user intents clearly.