KD

keithpatton/diataxis-agent-skill

Developer tools

Эта страница переведена автоматически. Технические детали смотрите в оригинале. Открыть оригинал

22 stars Качество 57 Тренд 10CC-BY-SA-4.0

Diataxis Agent Skill

Обзор

This skill treats documentation as a governed system: Diátaxis provides the taxonomy, this skill enforces intent, and AI operates only within explicit bounds. An agent skill that enables AI agents to classify, validate, generate, and audit documentation using the Diátaxis framework. Enforces quadrant purity across tutorials, how-to guides, reference, and explanation. - documentation into one of four Diátaxis quadrants - documentation sets for gaps, imbalances, and violations - new documentation with strict quadrant adherence - mixed-mode documents into pure quadrant documents The skill enforces single-quadrant purity: one document serves one purpose. When quadrant purity cannot be maintained, refusal with explanation is a valid outcome.

README

Показан фрагмент оригинального README. Открыть оригинал.

Diátaxis Agent Skill

This skill treats documentation as a governed system: Diátaxis provides the taxonomy, this skill enforces intent, and AI operates only within explicit bounds.

An agent skill that enables AI agents to classify, validate, generate, and audit documentation using the Diátaxis framework. Enforces quadrant purity across tutorials, how-to guides, reference, and explanation.

What This Skill Does

  • Classify documentation into one of four Diátaxis quadrants
  • Audit documentation sets for gaps, imbalances, and violations
  • Generate new documentation with strict quadrant adherence
  • Restructure mixed-mode documents into pure quadrant documents

The skill enforces single-quadrant purity: one document serves one purpose. When quadrant purity cannot be maintained, refusal with explanation is a valid outcome.

The Four Quadrants

Quadrant Purpose User Context
Tutorial Learning-oriented lesson Study (acquisition)
How-to Goal-oriented directions Work (application)
Reference Information-oriented description Work (application)
Explanation Understanding-oriented discussion Study (acquisition)

Installation

Option 1: Copy to Your Skills Directory

Clone this repository and copy the diataxis/ folder to your agent’s skills directory:

Cursor

# Project-level
cp -r diataxis/ .cursor/skills/diataxis/

# User-level (global)
cp -r diataxis/ ~/.cursor/skills/diataxis/

Claude Code

# Project-level
cp -r diataxis/ .claude/skills/diataxis/

# User-level (global)
cp -r diataxis/ ~/.claude/skills/diataxis/

Codex

# Project-level
cp -r diataxis/ .codex/skills/diataxis/

# User-level (global)
cp -r diataxis/ ~/.codex/skills/diataxis/

Option 2: Install via skills.sh

npx skills add keithpatton/diataxis-agent-skill

Usage

Once installed, the skill activates when you:

  • Ask to create, review, or audit documentation
  • Mention Diátaxis, documentation structure, or doc quality
  • Request help with tutorials, how-to guides, reference docs, or explanations

Example Prompts

Classification:

“Classify this documentation and tell me which Diátaxis quadrant it belongs to.”

Audit:

“Audit the docs/ folder for Diátaxis compliance and report any violations.”

Generation:

“Write a how-to guide for configuring SSL certificates.”

Restructure:

“This README mixes tutorial and reference content. Split it into separate documents.”

Skill Structure

diataxis/
├── SKILL.md                    # Main skill file (the "constitution")
└── references/
    ├── quadrants.md            # Detailed quadrant characteristics
    ├── compass.md              # Classification decision tree
    └── anti-patterns.md        # Violation detection and fixes

Key Behaviors

Classification Output

Открыть полный README на GitHub

Рекомендуемые инструменты

Попробуйте другой запрос или уберите фильтр.

Установка

npx skillfish add keithpatton/diataxis-agent-skill
Новичок в MCP? Начните с руководства на mcpskill.org →