RFC Creator
tech-leads-club/agent-skills
Drafts Request for Comments documents that lay out a proposal, the options weighed and the decision needed, so approvers can align before a major change.
Design, classify, write, audit, or restructure technical documentation with the Diátaxis framework.
Install Diataxis Docs
$ npx skills add pmndrs/glyph --skill diataxis-docs -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install pmndrs/glyph diataxis-docs --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/pmndrs/glyph.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/diataxis-docs .claude/skills/diataxis-docs && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "diataxis-docs" agent skill from https://github.com/pmndrs/glyph/tree/main/.agents/skills/diataxis-docs into .claude/skills/diataxis-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "diataxis-docs", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/pmndrs/glyph/tree/main/.agents/skills/diataxis-docsType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add pmndrs/glyph --skill diataxis-docs -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install pmndrs/glyph diataxis-docs --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/pmndrs/glyph.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.agents/skills/diataxis-docs .agents/skills/diataxis-docs && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "diataxis-docs" agent skill from https://github.com/pmndrs/glyph/tree/main/.agents/skills/diataxis-docs into .agents/skills/diataxis-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "diataxis-docs", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add pmndrs/glyph --skill diataxis-docs -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install pmndrs/glyph diataxis-docs --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/pmndrs/glyph.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.agents/skills/diataxis-docs .cursor/skills/diataxis-docs && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "diataxis-docs" agent skill from https://github.com/pmndrs/glyph/tree/main/.agents/skills/diataxis-docs into .cursor/skills/diataxis-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "diataxis-docs", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/pmndrs/glyph.git --path .agents/skills/diataxis-docs--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add pmndrs/glyph --skill diataxis-docs -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install pmndrs/glyph diataxis-docs --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/pmndrs/glyph.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.agents/skills/diataxis-docs .gemini/skills/diataxis-docs && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "diataxis-docs" agent skill from https://github.com/pmndrs/glyph/tree/main/.agents/skills/diataxis-docs into .gemini/skills/diataxis-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "diataxis-docs", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install pmndrs/glyph diataxis-docsInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add pmndrs/glyph --skill diataxis-docs -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/pmndrs/glyph.git skills-src && mkdir -p .github/skills && cp -r skills-src/.agents/skills/diataxis-docs .github/skills/diataxis-docs && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "diataxis-docs" agent skill from https://github.com/pmndrs/glyph/tree/main/.agents/skills/diataxis-docs into .github/skills/diataxis-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "diataxis-docs", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add pmndrs/glyph --skill diataxis-docs -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install pmndrs/glyph diataxis-docs --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/pmndrs/glyph.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.agents/skills/diataxis-docs .opencode/skills/diataxis-docs && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "diataxis-docs" agent skill from https://github.com/pmndrs/glyph/tree/main/.agents/skills/diataxis-docs into .opencode/skills/diataxis-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "diataxis-docs", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
diataxis-docs- GitHub stars
- 392
- Token cost
- ~1.4k tokens
- SKILL.md length
- 690 words
- Files
- 3 (incl. references)
- Skills in repo
- 8
- Repo updated
- First seen
- Licence
- MIT
At a glance
Design, classify, write, audit, or restructure technical documentation with the Diátaxis framework.
- Works in 2 steps: Does the reader need action or… → Are they acquiring skill or applying…
- Reference material
- SKILL.md covers Classify the need, Choose the operation, Write by type and Respect repository context, plus 1 more section
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Diataxis Docs is an agent skill from pmndrs/glyph. Design, classify, write, audit, or restructure technical documentation with the Diátaxis framework. Use for tutorials, how-to guides, reference material, explanations, documentation maps, README routing, documentation audits, or requests to separate mixed-purpose docs. Do not apply it automatically to internal plans, ADRs, research logs, or specifications unless the user wants those artifacts organized as product documentation.
Its SKILL.md is about 1.4k tokens, which your agent loads only when the skill is triggered. The skill folder holds 4 other files, including reference files (for example `agents/openai.yaml` and `references/framework.md`).
It sits in Development, covering Technical writing, Technical documentation and Architecture decision records. The repository describes itself as: ♠️ A typography engine for web graphics. The licence is MIT.
When your agent uses it
- Reference material
- Documentation maps
- Documentation audits
- Requests to separate mixed-purpose docs
Example prompts
- “/diataxis-docs”
Workflow steps
2 steps, taken from the first numbered list in SKILL.md.
- Does the reader need action or understanding?
- Are they acquiring skill or applying existing skill?
What it can do on your machine
Read from SKILL.md and the folder at commit 51a1f34. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md.
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Diataxis Docs loads about 1.4k tokens when it runs, and up to ~2.7k if it reads all its reference files. Until then it costs about 111 tokens; SKILL.md has 690 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from pmndrs/glyph at commit 51a1f34, republished under its MIT licence (© pmndrs). 690 words, ~1,434 tokens.
Download SKILL.mdSave it as
.claude/skills/diataxis-docs/SKILL.md (or your agent's skills folder). This skill also uses 2 other files; get the full folder from GitHub.- name
- diataxis-docs
- description
- Design, classify, write, audit, or restructure technical documentation with the Diátaxis framework. Use for tutorials, how-to guides, reference material, explanations, documentation maps, README routing, documentation audits, or requests to separate mixed-purpose docs. Do not apply it automatically to internal plans, ADRs, research logs, or specifications unless the user wants those artifacts organized as product documentation.
Diátaxis documentation
Use Diátaxis as a decision tool, not a four-folder template. Start from the reader's immediate need, give each page one primary purpose, and link across purposes when the reader is likely to need a different kind of help.
Read references/framework.md before a broad documentation audit, information-architecture change, or ambiguous classification. It records the primary sources, the compass, and the distinctions most often lost in shorter skills.
Classify the need
Ask two questions internally:
- Does the reader need action or understanding?
- Are they acquiring skill or applying existing skill?
Map the answers:
| Reader need | Mode | Documentation type |
|---|---|---|
| Learn by doing | action + acquisition | Tutorial |
| Complete a real task | action + application | How-to guide |
| Look up facts while working | cognition + application | Reference |
| Understand reasons and relationships | cognition + acquisition | Explanation |
Infer the type when the evidence is clear. Ask only when choosing incorrectly would materially change the requested artifact.
Choose the operation
Create or revise one page
- State the intended reader and outcome in working notes.
- Select one primary documentation type.
- Preserve accurate repository-specific facts and examples.
- Write according to the type rules below.
- Move substantial off-purpose material to a better page, or link to an existing page.
- Check navigation so the reader has an obvious next destination.
Audit a documentation set
- Inventory pages and their apparent audience.
- Classify each page by its dominant need; record uncertain or mixed pages.
- Find user journeys and missing destinations, not merely empty quadrants.
- Flag misleading titles, duplicated material, stale facts, dead ends, and mixed-purpose pages.
- Recommend the smallest useful restructure. Do not create empty sections merely to complete a matrix.
- Report evidence and concrete moves, splits, merges, or links.
Restructure mixed documentation
- Preserve the source material and map every substantive section.
- Choose a primary page for each distinct reader need.
- Split only where the mix harms usability; short context or a small example may remain.
- Replace duplication with purposeful cross-links.
- Keep landing pages and READMEs as routing surfaces. They may summarize several types without pretending to be one of them.
- Verify that no claims or operational steps were lost.
Write by type
Tutorial
- Own the learner's success.
- Provide one reliable path with an early visible result.
- Use concrete steps, expected observations, and a coherent learning sequence.
- Minimize branching, alternatives, and extended theory.
- Test commands and examples when the repository permits it.
Show full SKILL.md (285 more words)Show less
How-to guide
- Start from a specific real-world goal.
- Assume a competent practitioner and omit foundational teaching.
- Use ordered actions and conditionals only where the task requires them.
- Include prerequisites and success checks.
- Link to reference facts instead of reproducing exhaustive option lists.
Reference
- Describe the machinery accurately, completely, and consistently.
- Mirror the product or API structure.
- Prefer stable headings, tables, signatures, defaults, constraints, and edge cases.
- Keep instruction and rationale subordinate; link outward for tasks and concepts.
- Generate from authoritative interfaces where possible, then verify the result.
Explanation
- Explain why the subject exists and how its parts relate.
- Discuss constraints, history, alternatives, and tradeoffs.
- Connect the topic to adjacent concepts.
- Avoid turning the page into a numbered procedure or an exhaustive field catalog.
Respect repository context
- Follow existing terminology, style, navigation, and contribution rules.
- Treat plans, decision records, research notes, release notes, and issue backlogs as valid genres outside the four product-documentation types.
- Keep a README focused on orientation, first success, status, and routes to deeper documentation.
- Preserve existing document frontmatter; Diátaxis classification does not authorize removing or rewriting repository metadata conventions.
- Treat
index.mdfiles as navigation surfaces. Do not flag their purposeful links and short descriptions as duplicated human-facing documentation. - Prefer gradual improvement over a repository-wide rewrite without evidence.
- Do not sacrifice accuracy, runnable examples, accessibility, or source attribution for quadrant purity.
Final check
- Identify the primary reader need in one sentence.
- Confirm the title signals that need.
- Confirm the page behaves like its chosen type.
- Split or link only where another need would interrupt the page's flow.
- Verify facts and examples against current sources.
- Make the next step discoverable.
- Confirm existing frontmatter remains intact and navigation indexes were not mistaken for duplicate content.
© pmndrs, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
SKILL.md and 2 other files (references) in .agents/skills/diataxis-docs of pmndrs/glyph.
- SKILL.md
- agents/openai.yaml
- references/framework.md
Open the folder on GitHubat commit 51a1f34
Compare with similar skills
Diataxis Docs next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Diataxis Docs this skillpmndrs/glyph | 392 | — | ~1.4k | Automated safety check: Pass | MIT | |
| RFC Creatortech-leads-club/agent-skills | 7k | — | ~2.9k | Automated safety check: Pass | CC-BY-4.0 | |
| Technical Writingrsmdt/the-startup | 536 | — | ~1.3k | Automated safety check: Pass | MIT | |
| Docsbrickbots/PiFinder | 250 | — | ~6.2k | Automated safety check: Pass | GPL-3.0 | |
| Documentationaiskillstore/marketplace | 430 | 1 repos | ~2.7k | Automated safety check: Pass | None | |
| Technical SpecificationFerroxLabs/wayland | 608 | — | ~4.1k | Automated safety check: Pass | Apache-2.0 |
Similar skills
Technical Writing
rsmdt/the-startup
Create architectural decision records (ADRs), system documentation, API documentation, and operational runbooks.
Docs
brickbots/PiFinder
Author and edit PiFinder's user-facing documentation in the project's house style.
Documentation
aiskillstore/marketplace
Comprehensive documentation specialist covering API documentation, technical writing, design documentation, migration guides, and changelog generation.
Technical Specification
FerroxLabs/wayland
Creates technical specification documents with problem statement, requirements, design proposal, trade-off analysis, and decision rationale.
Technical Writer
RightNow-AI/openfang
Technical writing expert for API docs, READMEs, ADRs, and developer documentation
More from pmndrs/glyph
All 8 skills in this repoCodemod
pmndrs/glyph
Author, archive, apply, and verify TypeScript codemods with ts-morph for APIs that have reached the remote default branch or external users.
Open Knowledge Format
pmndrs/glyph
Create, migrate, inspect, query, validate, or maintain Open Knowledge Format v0.2 bundles made from linked Markdown concepts with YAML provenance.
Tsl
pmndrs/glyph
Implement, migrate, review, debug, or verify Three.js Shading Language (TSL) materials, node graphs, WebGPU compute work, and post-processing.
Maintainability Review
pmndrs/glyph
Audit and improve repository code milestone by milestone for correctness, clarity, local reasoning, DRY design, explicit state modeling, panic resistance, and trustworthy TypeScript boundaries.
Evidence First
pmndrs/glyph
Shape human-facing engineering communication—including chat updates and final answers, reports, reviews, handoffs, debugging or benchmark summaries, PR and issue prose, READMEs, and technical…
Gh Stack
pmndrs/glyph
Manage dependent branches and pull requests with the gh-stack GitHub CLI extension.
Related
Categories
Questions about Diataxis Docs
What does Diataxis Docs do?
Design, classify, write, audit, or restructure technical documentation with the Diátaxis framework. Diataxis Docs is an agent skill from pmndrs/glyph. Design, classify, write, audit, or restructure technical documentation with the Diátaxis framework.
When should I use Diataxis Docs?
Diataxis Docs fits situations like: reference material; documentation maps; documentation audits; requests to separate mixed-purpose docs.
How do I install Diataxis Docs in Claude Code?
Run `npx skills add pmndrs/glyph --skill diataxis-docs -a claude-code`. Or copy the skill folder (.agents/skills/diataxis-docs in pmndrs/glyph) into .claude/skills/diataxis-docs in your project. Claude Code loads it when a task matches its description.
How do I install Diataxis Docs in Codex?
Run `npx skills add pmndrs/glyph --skill diataxis-docs -a codex`. Or copy the skill folder (.agents/skills/diataxis-docs in pmndrs/glyph) into .agents/skills/diataxis-docs in your project. Codex loads it when a task matches its description.
Can I use Diataxis Docs in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add pmndrs/glyph --skill diataxis-docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/diataxis-docs, .gemini/skills/diataxis-docs, .github/skills/diataxis-docs and .opencode/skills/diataxis-docs in your project.
What does Diataxis Docs need to run?
SKILL.md names no scripts, command-line tools or credentials: Diataxis Docs is instructions for the agent only.
Does Diataxis Docs access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Diataxis Docs safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Diataxis Docs use?
Diataxis Docs is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Diataxis Docs use?
About 1.4k tokens (SKILL.md is roughly 5.7k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 1.3k tokens, read only when the agent opens those files.
What are the alternatives to Diataxis Docs?
Skills that share tags, products or a category with Diataxis Docs: RFC Creator (tech-leads-club/agent-skills, 7k stars), Technical Writing (rsmdt/the-startup, 536 stars), Docs (brickbots/PiFinder, 250 stars) and Documentation (aiskillstore/marketplace, 430 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Diataxis Docs?
pmndrs (a GitHub organization) maintains it in pmndrs/glyph, which has 392 GitHub stars. The repository holds 8 skills in this directory. The repository was last updated on October 7, 2026.
Source: pmndrs/glyph on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.