Beads Documentation Style Guide
gastownhall/beads
Sets the house style for the beads user docs: the canonical concept model, required terminology, prose and diagram conventions, and checks before docs work is done.
Author and restructure technical documentation with the Diátaxis framework — tutorials, how-to guides, reference, and explanation.
$ npx skills add shepherdjerred/monorepo --skill diataxis -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install shepherdjerred/monorepo diataxis --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/shepherdjerred/monorepo.git skills-src && mkdir -p .claude/skills && cp -r skills-src/packages/dotfiles/dot_agents/skills/diataxis .claude/skills/diataxis && 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" agent skill from https://github.com/shepherdjerred/monorepo/tree/main/packages/dotfiles/dot_agents/skills/diataxis into .claude/skills/diataxis/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "diataxis", 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/shepherdjerred/monorepo/tree/main/packages/dotfiles/dot_agents/skills/diataxisType 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 shepherdjerred/monorepo --skill diataxis -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install shepherdjerred/monorepo diataxis --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/shepherdjerred/monorepo.git skills-src && mkdir -p .agents/skills && cp -r skills-src/packages/dotfiles/dot_agents/skills/diataxis .agents/skills/diataxis && 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" agent skill from https://github.com/shepherdjerred/monorepo/tree/main/packages/dotfiles/dot_agents/skills/diataxis into .agents/skills/diataxis/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "diataxis", 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 shepherdjerred/monorepo --skill diataxis -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install shepherdjerred/monorepo diataxis --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/shepherdjerred/monorepo.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/packages/dotfiles/dot_agents/skills/diataxis .cursor/skills/diataxis && 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" agent skill from https://github.com/shepherdjerred/monorepo/tree/main/packages/dotfiles/dot_agents/skills/diataxis into .cursor/skills/diataxis/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "diataxis", 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/shepherdjerred/monorepo.git --path packages/dotfiles/dot_agents/skills/diataxis--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 shepherdjerred/monorepo --skill diataxis -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install shepherdjerred/monorepo diataxis --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/shepherdjerred/monorepo.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/packages/dotfiles/dot_agents/skills/diataxis .gemini/skills/diataxis && 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" agent skill from https://github.com/shepherdjerred/monorepo/tree/main/packages/dotfiles/dot_agents/skills/diataxis into .gemini/skills/diataxis/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "diataxis", 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 shepherdjerred/monorepo diataxisInstalls 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 shepherdjerred/monorepo --skill diataxis -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/shepherdjerred/monorepo.git skills-src && mkdir -p .github/skills && cp -r skills-src/packages/dotfiles/dot_agents/skills/diataxis .github/skills/diataxis && 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" agent skill from https://github.com/shepherdjerred/monorepo/tree/main/packages/dotfiles/dot_agents/skills/diataxis into .github/skills/diataxis/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "diataxis", 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 shepherdjerred/monorepo --skill diataxis -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install shepherdjerred/monorepo diataxis --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/shepherdjerred/monorepo.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/packages/dotfiles/dot_agents/skills/diataxis .opencode/skills/diataxis && 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" agent skill from https://github.com/shepherdjerred/monorepo/tree/main/packages/dotfiles/dot_agents/skills/diataxis into .opencode/skills/diataxis/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "diataxis", 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.
diataxisAuthor and restructure technical documentation with the Diátaxis framework — tutorials, how-to guides, reference, and explanation.
Diataxis is an agent skill from shepherdjerred/monorepo. Author and restructure technical documentation with the Diátaxis framework — tutorials, how-to guides, reference, and explanation. Use when writing or reorganising docs, when a page mixes instruction with description or discussion, when deciding where a piece of content belongs, when a doc "reads badly" without an obvious cause, or when the user mentions Diátaxis, docs structure, or a documentation rewrite.
Its SKILL.md is about 2.6k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Writing & Content, covering Technical writing and Technical documentation. The repository describes itself as: Monorepo for all of my projects. The licence is GPL-3.0.
2 steps, taken from the first numbered list in SKILL.md.
Read from SKILL.md and the folder at commit 46ddf2f. It shows what the files ask for, not the result of running them.
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.
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.
Links to these hosts (documentation or services it may open):
diataxis.frFrom URLs in SKILL.md, links to its own repository left out.
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Diataxis loads about 2.6k tokens when it runs. Until then it costs about 105 tokens; SKILL.md has 1,379 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.
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.
The full file from shepherdjerred/monorepo at commit 46ddf2f, republished under its GPL-3.0 licence (© shepherdjerred). 1,379 words, ~2,600 tokens.
.claude/skills/diataxis/SKILL.md (or your agent's skills folder).Diátaxis says there are exactly four kinds of technical documentation, because there are exactly two axes of any craft. Each kind serves one user need and must not be mixed with the others on one page.
Most bad documentation is not badly written. It is two or three kinds of documentation on one page, each getting in the other's way.
When you don't know what a page is, what it should be, or why it feels wrong, ask two questions:
| Informs | Serves | It is a |
|---|---|---|
| action | acquisition | tutorial |
| action | application | how-to guide |
| cognition | application | reference |
| cognition | acquisition | explanation |
Apply it to a whole page, a section, or a single sentence. The most useful move in a rewrite is running the compass over one paragraph at a time and relocating whatever answers a different question than its neighbours.
| Action | Cognition | |
|---|---|---|
| Acquisition (at study) | Tutorial | Explanation |
| Application (at work) | How-to guide | Reference |
A learning experience. The reader does something meaningful under your guidance and gains confidence. Success is what they can now do, not what they produced.
Directions that get a competent reader from a real problem to a result.
Facts the reader consults while working. Austere, neutral, authoritative.
Understanding, from a wider angle. The only kind you would read away from the keyboard.
Tutorial vs how-to is the most common and most damaging conflation. Both are practical, both are step-by-step, so they look alike. The difference is the reader: at study or at work.
| Tutorial | How-to guide |
|---|---|
| builds basic competence | assumes competence |
| a managed path, one line, no choices | forks and branches; the real world |
| a contrived, safe, repeatable setting | whatever reality throws at it |
| eliminates the unexpected | prepares for the unexpected |
| responsibility lies with the teacher | responsibility lies with the user |
| concrete and particular | general, adaptable |
It is not the difference between basic and advanced. A how-to can be elementary; a tutorial can be highly advanced.
Reference vs explanation is easier but slips. Rules of thumb: if it is boring and unmemorable it is reference; lists and tables are reference; if you can imagine reading it in the bath it is explanation. The real test is the same one — would the reader reach for this while working, or while reflecting?
These are what make documentation read well, independent of structure.
Universal
How to …, … reference, Why … / About ….Diátaxis is a guide, not a plan. Do not design the perfect structure up front, and never create empty section shells — structure is what emerges from improving pages, not what you impose before writing them.
The loop:
Two techniques worth using:
How to diagnose …). "Should I use this?"
is explanation. Avoid FAQ pages — an FAQ is where content goes when nobody
will decide where it belongs.The house format for a Diátaxis site in this ecosystem:
src/content/docs/
├── index.md # splash: hero + one section per reader need
├── tutorials/
├── how-to/
├── reference/
└── explanation/ # labelled "Concepts" in the sidebartroubleshoot-notifications.md, not notifications.md).{ autogenerate: { directory: "…" } }, with order from
each page's sidebar.order frontmatter. Autogeneration means a new page is
never orphaned.docsSchema(). The directory is the page's kind; do not add a
frontmatter field that restates it..md by default; .mdx only where a page renders generated content.Page shapes that work:
## N. Step sections, "What you did",
then "From here" links.shepherdjerred/monorepo, load monorepo-docs for where documentation
belongs, and follow packages/docs/wiki/AGENTS.md for the wiki's rules.© shepherdjerred, GPL-3.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Just SKILL.md in packages/dotfiles/dot_agents/skills/diataxis of shepherdjerred/monorepo.
Open the folder on GitHubat commit 46ddf2f
Diataxis 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 this skillshepherdjerred/monorepo | 112 | — | ~2.6k | Automated safety check: Pass | GPL-3.0 | |
| Beads Documentation Style Guidegastownhall/beads | 28k | — | ~3.2k | Automated safety check: Pass | MIT | |
| Technical Writing Standardcursor/plugins | 10k | 10 repos | ~2.4k | Automated safety check: Pass | None | |
| Heym Documentation Articlesheymrun/heym | 1.4k | — | ~780 | Automated safety check: Pass | Custom licence | |
| Developer Docs Technical Writervercel-labs/github-tools | 131 | — | ~3.9k | Automated safety check: Pass | MIT | |
| Aholo Viewer Docsmanycoretech/aholo-viewer | 1.1k | — | ~341 | Automated safety check: Pass | MIT |
gastownhall/beads
Sets the house style for the beads user docs: the canonical concept model, required terminology, prose and diagram conventions, and checks before docs work is done.
cursor/plugins
Applies four layers of technical-writing rules to docs, RFCs, readmes, PR descriptions and commit messages so a tired engineer follows them on the first read.
heymrun/heym
Creates and updates documentation articles for the Heym platform: category choice, manifest entry, markdown file and cross-links from existing pages.
vercel-labs/github-tools
Writes, reviews and edits developer documentation for SDKs, libraries and frameworks, from getting-started guides and API references to migration guides.
manycoretech/aholo-viewer
Guides writing and maintaining Aholo Viewer documentation: README, AGENTS.md, architecture notes, bilingual manual pages and AI collaboration guides.
WebMCP-org/npm-packages
Write technical documentation following the Diataxis framework by Daniele Procida.
shepherdjerred/monorepo
Bun runtime APIs and current operational patterns for files, processes, modules, networking, databases, tests, and deployment.
shepherdjerred/monorepo
Current Bun test runner guidance for discovery, isolation, parallelism, sharding, changed tests, mocks, timers, snapshots, coverage, DOM Testing Library, and integration teardown.
shepherdjerred/monorepo
Current Bun workspace guidance for isolated and hoisted linkers, catalogs, filters, scripts, dependency classes, lockfiles, lifecycle trust, caches, publishing, TypeScript package exports, and…
shepherdjerred/monorepo
This skill should be used when the user asks to "deep research", "research this topic", "investigate thoroughly", "do a deep dive on", "comprehensive research on", "find everything about", "survey…
shepherdjerred/monorepo
This skill should be used when the user asks to "create a Figma design", "design in Figma", "make a Figma mockup", "create an app icon", "design UI", "render JSX to Figma", "export from Figma"…
shepherdjerred/monorepo
Current Fish shell scripting, functions, abbreviations, completions, variables, events, configuration, plugins, testing, and safety guidance.
Categories
Author and restructure technical documentation with the Diátaxis framework — tutorials, how-to guides, reference, and explanation. Diataxis is an agent skill from shepherdjerred/monorepo. Author and restructure technical documentation with the Diátaxis framework — tutorials, how-to guides, reference, and explanation.
Diataxis fits situations like: reorganising docs; A page mixes instruction with description; deciding where a piece of content belongs; A doc reads badly without an obvious cause.
Run `npx skills add shepherdjerred/monorepo --skill diataxis -a claude-code`. Or copy the skill folder (packages/dotfiles/dot_agents/skills/diataxis in shepherdjerred/monorepo) into .claude/skills/diataxis in your project. Claude Code loads it when a task matches its description.
Run `npx skills add shepherdjerred/monorepo --skill diataxis -a codex`. Or copy the skill folder (packages/dotfiles/dot_agents/skills/diataxis in shepherdjerred/monorepo) into .agents/skills/diataxis in your project. Codex loads it when a task matches its description.
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add shepherdjerred/monorepo --skill diataxis -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, .gemini/skills/diataxis, .github/skills/diataxis and .opencode/skills/diataxis in your project.
SKILL.md names no scripts, command-line tools or credentials: Diataxis is instructions for the agent only.
SKILL.md names 1 domain. As links in the text: diataxis.fr. This is read from the text; nothing was executed.
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.
Diataxis is published under the GPL-3.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
About 2.6k tokens (SKILL.md is roughly 10k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
Skills that share tags, products or a category with Diataxis: Beads Documentation Style Guide (gastownhall/beads, 28k stars), Technical Writing Standard (cursor/plugins, 10k stars), Heym Documentation Articles (heymrun/heym, 1.4k stars) and Developer Docs Technical Writer (vercel-labs/github-tools, 131 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
shepherdjerred (a GitHub user) maintains it in shepherdjerred/monorepo, which has 112 GitHub stars. The repository holds 63 skills in this directory. The repository was last updated on October 7, 2026.
Source: shepherdjerred/monorepo on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.