KD

keithpatton/diataxis-agent-skill

开发工具

本页由 AI 翻译,技术细节请以原文为准。 查看原文

22 stars 质量 57 趋势 10CC-BY-SA-4.0

Diataxis 特工技能

概览

该技能将文档视为一个受治理的系统:Diátaxis 提供分类法,该技能执行意图,AI 仅在明确范围内运行。 该智能体技能使人工智能智能体能够利用 Diátaxis 框架进行分类、验证、生成和审计文档。在教程、操作指南、参考资料和解释中强制执行象限纯粹性。 - 将文档编入四个Diátaxis象限之一 - 为缺口、不平衡和违规设置文档集- 严格遵循象限的新文档 - 将混合模式文档转为纯象限文档 该技能强制执行单象限纯度:一份文件只承担一个目的。当象限纯度无法维持时,拒绝并解释是有效的结果。

概述(AI 翻译)

该技能将文档视为受控系统:Diátaxis 提供分类法,该技能执行意图,AI 仅在明确范围内工作。

该智能体技能使人工智能智能体能够利用 Diátaxis 框架进行分类、验证、生成和审计文档。在教程、操作指南、参考资料和解释中强制执行象限纯粹性。

这项技能的作用

  • 将文档分类为四个Diátaxis象限之一
  • 审计关于缺口、不平衡和违规的文档集
  • 生成严格遵守象限的新文档
  • **将混合模式文档重组为纯象限文档

该技能强制执行单象限纯度:一份文件只承担一个目的。当象限纯度无法维持时,拒绝并解释是有效的结果。

四个象限

象限 目的 用户上下文
教程以学习为导向的课程 学习(习得)
操作指南目标导向的指导 工作(应用)
参考文献 面向信息的描述 工作(应用)

本页由 AI 翻译,技术细节请以原文为准。

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

在 GitHub 查看完整 README

推荐工具

换一个关键词,或者移除筛选条件。

安装

npx skillfish add keithpatton/diataxis-agent-skill
新手?先看 mcpskill.org 教程 →