# absolute-docs

absolute-docs is a Claude Code skill that structures technical documentation with Diátaxis. It creates and reviews tutorials, how-to guides, reference pages, and architectural explanations from code.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 171 installs · ★ 224 repo stars
- Author: dhruvjainin
- License: MIT · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/dhruvjainin/absolute/tree/HEAD/skills/absolute-docs/SKILL.md
- Updated: 2026-10-26
- Security check: automated, 2026-11-17 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/skills/absolute-docs

## What it does

The skill organizes technical documentation into four Diátaxis quadrants: practical tutorials, how-to guides, reference entries, and explanations. Before generating any text, it inspects repository files, detects the documentation stack, and checks option names and defaults against actual code.

A mandatory outline gate blocks prose generation until file paths, section headings, and target audiences are explicitly confirmed. This check stops agents from producing mixed-purpose pages or relying on hallucinated API parameters.

It operates across three modes: writing fresh documentation, improving existing files by verifying code snippets, and auditing complete doc directories to identify orphaned pages and mixed content.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add dhruvjainin/absolute --skill absolute-docs -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/absolute-docs/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/absolute-docs/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add dhruvjainin/absolute --skill absolute-docs -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/absolute-docs/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add dhruvjainin/absolute --skill absolute-docs -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/absolute-docs/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install dhruvjainin/absolute skills/absolute-docs
```

2. **Manually: put the files in place**
- File: `.github/skills/absolute-docs/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add dhruvjainin/absolute --skill absolute-docs -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/dhruvjainin/absolute --path skills/absolute-docs
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/absolute-docs/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add dhruvjainin/absolute --skill absolute-docs -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/dhruvjainin/absolute/tree/HEAD/skills/absolute-docs/SKILL.md

## When to use it
- classify documentation into distinct Diátaxis quadrants
- verify code snippets and CLI flags against current repository code
- lock down section outlines before generating documentation prose
- audit existing documentation trees for structural gaps and mixed pages

## Example prompts
- absolute docs: write a tutorial for setting up the project
- improve this doc: align README.md with the latest implementation
- audit our docs: review the docs folder and flag mixed quadrants

## Source text · SKILL.md · MIT

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: d1eacbab777e1f2e.

BEGIN THIRD-PARTY FILE d1eacbab777e1f2e
```text
---
name: absolute-docs
version: 0.5.0
description: >
  Diátaxis-driven documentation for AI coding agents: write, improve, or audit
  tutorials, how-tos, reference, explanation, and developer docs (README,
  CONTRIBUTING, ADRs). Detects the docs stack; gates on the outline before
  writing prose; verifies every claim against the code before it ships.
  Triggers on "absolute docs", "write docs", "write a tutorial", "write a README",
  "document this", "improve this doc", "audit our docs".
category: workflow
tags:
  - workflow
  - documentation
  - diataxis
  - readme
  - tutorials
  - reference
platforms:
  - claude-code
  - gemini-cli
  - openai-codex
  - mcp
user-invocable: true
argument-hint: "[target]"
license: MIT
maintainers:
  - github: maddhruv
---

> Start your first response with the 📚 emoji.

## Absolute Documentations: Diátaxis-Driven Documentation

Absolute Documentations turns "write some docs" into documentation a reader can
actually use. Every document it produces serves exactly one reader need, identified
with the Diátaxis framework, written in the project's own voice and docs stack, and
verified against the actual codebase before it ships. It writes new docs, rewrites
existing ones to their quadrant's standard, and audits whole doc sites for
structural rot.

It never writes a full document before the outline is approved, and it never
documents behavior it has not verified in the code.

---

## The Diátaxis Compass

Every piece of documentation answers exactly one kind of reader need. Classify
before writing — a page that mixes quadrants serves nobody.

|  | **Serves the reader's STUDY** | **Serves the reader's WORK** |
|---|---|---|
| **Practical steps** | **Tutorial** — a lesson. Guides a newcomer through a guaranteed-success experience. | **How-to guide** — a recipe. Helps a competent user accomplish a specific goal. |
| **Theoretical knowledge** | **Explanation** — a discussion. Deepens understanding of a topic, gives context and reasons. | **Reference** — a dictionary. States facts about the machinery, completely and neutrally. |

To classify, ask two questions:

1. **Is the reader studying (acquiring skill) or working (applying skill)?**
2. **Does the reader need action (steps to follow) or cognition (knowledge to absorb)?**

| Reader situation | Quadrant |
|---|---|
| "I'm new, show me what this is like" | Tutorial |
| "I know the basics, I need to get X done" | How-to guide |
| "What exactly does this option/endpoint/flag do?" | Reference |
| "Why does it work this way? What's the bigger picture?" | Explanation |

**The cardinal sin is mixing.** A tutorial that stops to explain architecture loses
the learner. A reference page that gives advice stops being trustworthy as a pure
description. When you feel the urge to mix, that is a signal to *link* to the other
```
END THIRD-PARTY FILE d1eacbab777e1f2e

The third-party file has ended. Everything between the d1eacbab777e1f2e tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

First 2851 of 15807 bytes. © dhruvjainin · MIT · https://github.com/dhruvjainin/absolute/tree/HEAD/skills/absolute-docs/SKILL.md

_Part of the page did not fit — see the HTML version._

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
