From diataxis-skills
Create new documentation following the Diataxis framework. Use when writing documentation from scratch, when a user requests a tutorial, how-to guide, reference, or explanation document, or when filling documentation gaps.
How this skill is triggered — by the user, by Claude, or both
Slash command
/diataxis-skills:diataxis-createThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Create new documentation in the correct [Diataxis](https://diataxis.fr/) quadrant using structured templates.
Create new documentation in the correct Diataxis quadrant using structured templates.
Practical Theoretical
+----------------+------------------+
Study | TUTORIALS | EXPLANATION |
| (learning) | (understanding) |
+----------------+------------------+
Work | HOW-TO | REFERENCE |
| (problem) | (information) |
+----------------+------------------+
diataxis-auditWhen building documentation from scratch for a project, follow this order:
Determine which quadrant the requested documentation belongs to. If ambiguous, ask the user.
Apply the template for the selected quadrant (see below). Follow the quadrant's rules strictly:
Tutorial rules:
How-to guide rules:
Reference rules:
Explanation rules:
Add links to related documents in other quadrants:
# [Tutorial Title: What You'll Build/Learn]
> **Tutorial**: This is a learning-oriented guide that takes you step-by-step
> through [achieving X]. By the end, you'll have [concrete result].
## What You'll Build
[Brief, exciting description of the end result]
## Prerequisites
- [Tool/software version]
- [Basic knowledge requirement]
- [Time estimate: X minutes]
## What You'll Learn
- [Skill or concept 1]
- [Skill or concept 2]
- [Skill or concept 3]
---
## Step 1: [First Action — Imperative Verb]
[Concrete action]:
\`\`\`[language]
[code or command]
\`\`\`
**You should see**: [Expected output or result]
---
## Step 2: [Next Action — Imperative Verb]
[Continue: action, code, expected result]
\`\`\`[language]
[code or command]
\`\`\`
**You should see**: [Expected output or result]
---
[Continue steps until the learner has a complete result]
---
## What You've Learned
You've successfully [accomplished X]. You now know how to:
- [Skill learned]
- [Skill learned]
## Next Steps
- [How-to guide]: [Solve specific problem]
- [Reference]: [Full details on API/configuration]
- [Explanation]: [Why concept works the way it does]
## Troubleshooting
**Problem**: [Common issue]
**Solution**: [Fix]
# How to [Solve Specific Problem/Achieve Specific Goal]
> **How-to guide**: Shows how to [specific goal]. Use when you need to [scenario].
## When to Use This Guide
- [Scenario 1]
- [Scenario 2]
## Prerequisites
- [Tool/version requirement]
- [Knowledge requirement — assume competence]
---
## Steps
### 1. [First Major Step]
[Instructions]:
\`\`\`[language]
[code or command]
\`\`\`
**Tip**: [Helpful advice or common variation]
### 2. [Second Major Step]
[Practical directions]:
\`\`\`[language]
[code or command]
\`\`\`
**Options**:
- **Option A**: [When to use] — [how]
- **Option B**: [When to use] — [how]
### 3. [Continue as needed]
---
## Verification
[How to verify the goal was achieved]:
\`\`\`[language]
[verification command]
\`\`\`
---
## Common Variations
### [Alternative Approach]
[When and how]:
\`\`\`[language]
[alternative code]
\`\`\`
---
## Troubleshooting
### Problem: [Common issue]
**Cause**: [Why]
**Solution**: [Fix]
---
## Related
- **Tutorial**: [Getting Started] — if you're new to [topic]
- **Reference**: [API/Config] — full details
- **Explanation**: [Understanding X] — why it works this way
# [API/Module/Feature] Reference
> **Reference**: Complete technical documentation for [feature/API/module].
## Overview
[Brief factual description]
**Package**: `[package.name]`
**Since version**: [version]
---
## [Function/Method Name]
[One-line description]
### Signature
\`\`\`[language]
[function_signature(parameters) -> return_type]
\`\`\`
### Parameters
| Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `param1` | `type` | Yes | — | [Description] |
| `param2` | `type` | No | `value` | [Description] |
### Returns
**Type**: `return_type`
### Raises/Throws
- **`ErrorType`**: [When raised]
### Examples
\`\`\`[language]
[minimal example]
\`\`\`
---
## Configuration Options
### `option_name`
**Type**: `type`
**Default**: `value`
**Required**: Yes/No
[Description]
**Valid values**:
- `value1`: [Effect]
- `value2`: [Effect]
---
## Data Structures
### `StructureName`
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `field1` | `type` | Yes | [Description] |
---
## Error Codes
### `ERROR_CODE`
**Code**: `value`
**Description**: [What it means]
**Common causes**: [What causes it]
---
## Related
- **Tutorial**: [Getting Started] — practical introduction
- **How-to**: [Task] — usage examples
- **Explanation**: [Concept] — background
# Understanding [Concept/Topic]
> **Explanation**: Explores [topic] — how it works, why it matters,
> and the design decisions behind it.
## Introduction
[Why understanding this matters]
---
## What is [Concept]?
[Clear explanation in plain language]
[Historical context if relevant]
---
## Why [Concept] Matters
### Problem It Solves
[Description]
### Benefits
[Discussion]
### Trade-offs
[Honest limitations]
---
## How [Concept] Works
### Key Principles
1. **[Principle]**: [Explanation]
2. **[Principle]**: [Explanation]
### Under the Hood
[Deeper mechanism]
---
## Design Decisions
### Why [Choice]?
**Alternatives considered**:
- [Alternative]: [Why not chosen]
**Benefits**: [Of chosen approach]
**Trade-offs**: [Accepted]
---
## Common Misconceptions
### Misconception: [False belief]
**Reality**: [Correct understanding]
---
## Related
- **Tutorial**: [Getting Started] — hands-on learning
- **How-to**: [Solve Problem] — practical application
- **Reference**: [API/Config] — technical details
diataxis-audit: Audit existing docs to identify gaps this skill can filldiataxis-convert: Split mixed docs before creating clean replacementsdiataxis-plan: Design the documentation architecture firstFetches up-to-date documentation from Context7 for libraries and frameworks like React, Next.js, Prisma. Use for setup questions, API references, and code examples.
Applies a firm's KYC/AML rules grid to parsed onboarding records: assigns risk rating, checks required documents, outputs rule outcomes with citations, and routes for escalation.
Generates daily or weekly digests of activity from connected sources (chat, email, docs, tasks, CRM), highlighting action items, decisions, mentions, and project updates.
npx claudepluginhub jrjsmrtn/jrjsmrtn-skills --plugin diataxis-skills