diataxis-documentation

Create Diátaxis documentation with tutorials, how-tos, references, and explanations for AI agents.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/ai212983/gh-csi --skill diataxis-documentation-ai212983
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: diataxis-documentation
Source: https://github.com/ai212983/gh-csi/tree/main/.agents/skills/diataxis-documentation
Command: npx skills add https://github.com/ai212983/gh-csi --skill diataxis-documentation-ai212983

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the difficulty of authoring documentation that is both human-readable and directly actionable by AI agents by enforcing concise, structured, and token-efficient Diátaxis-aligned content so agents can find and act on the right information without context bloat or ambiguity.

Core Features & Use Cases

  • Agent-First Constraints: Guidelines for token efficiency, structural predictability, and explicit constraints to reduce misinterpretation by agents.
  • Diátaxis Mapping: Clear patterns for splitting content into Tutorials, How-to Guides, Reference, and Explanation to match agent goals (procedural, semantic, conceptual).
  • Verification & Golden Path: Emphasizes single runnable "golden path" examples, explicit verification steps, and deterministic reference entries for reliable automation.
  • Use Cases: Onboard an agent to a new codebase, refactor READMEs into agent-ready sections, and produce deterministic reference docs for tooling and APIs.

Quick Start

Refactor the project's README into Diátaxis sections by adding a short runnable tutorial, a how-to recipe with explicit verification steps, a concise reference of facts, and a brief explanation optimized for AI agents.

Frequently Asked Questions about diataxis-documentation

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

FAQPage Schema
How do I structure technical documentation for AI agents?

Refactor a README into agent-optimized documentation by separating content into runnable tutorials with explicit verification steps, concise reference pages, and brief explanations to reduce context bloat for AI agents.

What is the best way to write how-to guides for AI agent workflows?

The best way to write how-to guides for AI agent workflows is to enforce explicit structural predictability, single runnable golden path examples, and deterministic reference entries so agents can execute tasks without ambiguity.

Can I use Diátaxis to refactor existing tutorials for developer-facing tooling?

Yes, you can use Diátaxis to refactor existing tutorials for developer-facing tooling by converting authorial intent into concise, machine-actionable instructions with explicit verification steps and token efficiency.

Why does my AI agent misinterpret unstructured technical writing?

AI agents misinterpret unstructured technical writing due to context bloat and ambiguous instructions; enforcing Diátaxis separations and agent-first constraints reduces misinterpretation and improves discoverability.

When do I need to separate reference pages from explanation content for AI agents?

You need to separate reference pages from explanation content for AI agents when providing deterministic facts versus conceptual understanding, ensuring agents retrieve actionable data without parsing unnecessary semantic context.