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.
Diátaxis Documentation Expert. An agent skill from github/awesome-copilot.
Install Documentation Writer
$ npx skills add github/awesome-copilot --skill documentation-writer -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install github/awesome-copilot documentation-writer --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/github/awesome-copilot.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/documentation-writer .claude/skills/documentation-writer && 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 "documentation-writer" agent skill from https://github.com/github/awesome-copilot/tree/main/skills/documentation-writer into .claude/skills/documentation-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-writer", 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/github/awesome-copilot/tree/main/skills/documentation-writerType 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 github/awesome-copilot --skill documentation-writer -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install github/awesome-copilot documentation-writer --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/github/awesome-copilot.git skills-src && mkdir -p .agents/skills && cp -r skills-src/skills/documentation-writer .agents/skills/documentation-writer && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "documentation-writer" agent skill from https://github.com/github/awesome-copilot/tree/main/skills/documentation-writer into .agents/skills/documentation-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-writer", 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 github/awesome-copilot --skill documentation-writer -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install github/awesome-copilot documentation-writer --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/github/awesome-copilot.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/skills/documentation-writer .cursor/skills/documentation-writer && 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 "documentation-writer" agent skill from https://github.com/github/awesome-copilot/tree/main/skills/documentation-writer into .cursor/skills/documentation-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-writer", 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/github/awesome-copilot.git --path skills/documentation-writer--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 github/awesome-copilot --skill documentation-writer -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install github/awesome-copilot documentation-writer --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/github/awesome-copilot.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/skills/documentation-writer .gemini/skills/documentation-writer && 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 "documentation-writer" agent skill from https://github.com/github/awesome-copilot/tree/main/skills/documentation-writer into .gemini/skills/documentation-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-writer", 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 github/awesome-copilot documentation-writerInstalls 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 github/awesome-copilot --skill documentation-writer -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/github/awesome-copilot.git skills-src && mkdir -p .github/skills && cp -r skills-src/skills/documentation-writer .github/skills/documentation-writer && 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 "documentation-writer" agent skill from https://github.com/github/awesome-copilot/tree/main/skills/documentation-writer into .github/skills/documentation-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-writer", 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 github/awesome-copilot --skill documentation-writer -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install github/awesome-copilot documentation-writer --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/github/awesome-copilot.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/skills/documentation-writer .opencode/skills/documentation-writer && 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 "documentation-writer" agent skill from https://github.com/github/awesome-copilot/tree/main/skills/documentation-writer into .opencode/skills/documentation-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "documentation-writer", 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
documentation-writer- GitHub stars
- 40k
- Used in
- 7 other repos
- Token cost
- ~686 tokens
- SKILL.md length
- 330 words
- Files
- 1
- Skills in repo
- 417
- Repo updated
- First seen
- Licence
- MIT
At a glance
Diátaxis Documentation Expert. An agent skill from github/awesome-copilot.
- Works in 4 steps: Clarity: Write in simple, clear, and… → Accuracy: Ensure all information,… → User-Centricity: Always prioritize the… → …
- Tasks that involve Technical writing
- SKILL.md covers GUIDING PRINCIPLES, YOUR TASK: The Four Document…, WORKFLOW and CONTEXTUAL AWARENESS
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Documentation Writer is an agent skill from github/awesome-copilot, published by the product's own GitHub organization. Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.
Its SKILL.md is about 690 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: Community-contributed instructions, agents, skills, and configurations to help you make the most of GitHub Copilot. The licence is MIT.
When your agent uses it
- Tasks that involve Technical writing
- Tasks that involve Technical documentation
Example prompts
- “/documentation-writer”
Workflow steps
4 steps, taken from the first numbered list in SKILL.md.
- Clarity: Write in simple, clear, and unambiguous language.
- Accuracy: Ensure all information, especially code snippets and technical details, is correct and up-to-date.
- User-Centricity: Always prioritize the user's goal. Every document must help a specific user achieve a specific task.
- Consistency: Maintain a consistent tone, terminology, and style across all documentation.
What it can do on your machine
Read from SKILL.md and the folder at commit 727ff2e. 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
Links to these hosts (documentation or services it may open):
diataxis.fr
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
Documentation Writer loads about 686 tokens when it runs. Until then it costs about 60 tokens; SKILL.md has 330 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 github/awesome-copilot at commit 727ff2e, republished under its MIT licence (© github). 330 words, ~686 tokens.
Download SKILL.mdSave it as
.claude/skills/documentation-writer/SKILL.md (or your agent's skills folder).- name
- documentation-writer
- description
- Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.
Diátaxis Documentation Expert
You are an expert technical writer specializing in creating high-quality software documentation. Your work is strictly guided by the principles and structure of the Diátaxis Framework (https://diataxis.fr/).
GUIDING PRINCIPLES
- Clarity: Write in simple, clear, and unambiguous language.
- Accuracy: Ensure all information, especially code snippets and technical details, is correct and up-to-date.
- User-Centricity: Always prioritize the user's goal. Every document must help a specific user achieve a specific task.
- Consistency: Maintain a consistent tone, terminology, and style across all documentation.
YOUR TASK: The Four Document Types
You will create documentation across the four Diátaxis quadrants. You must understand the distinct purpose of each:
- Tutorials: Learning-oriented, practical steps to guide a newcomer to a successful outcome. A lesson.
- How-to Guides: Problem-oriented, steps to solve a specific problem. A recipe.
- Reference: Information-oriented, technical descriptions of machinery. A dictionary.
- Explanation: Understanding-oriented, clarifying a particular topic. A discussion.
WORKFLOW
You will follow this process for every documentation request:
Acknowledge & Clarify: Acknowledge my request and ask clarifying questions to fill any gaps in the information I provide. You MUST determine the following before proceeding:
- Document Type: (Tutorial, How-to, Reference, or Explanation)
- Target Audience: (e.g., novice developers, experienced sysadmins, non-technical users)
- User's Goal: What does the user want to achieve by reading this document?
- Scope: What specific topics should be included and, importantly, excluded?
Propose a Structure: Based on the clarified information, propose a detailed outline (e.g., a table of contents with brief descriptions) for the document. Await my approval before writing the full content.
Generate Content: Once I approve the outline, write the full documentation in well-formatted Markdown. Adhere to all guiding principles.
CONTEXTUAL AWARENESS
- When I provide other markdown files, use them as context to understand the project's existing tone, style, and terminology.
- DO NOT copy content from them unless I explicitly ask you to.
- You may not consult external websites or other sources unless I provide a link and instruct you to do so.
© github, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in skills/documentation-writer of github/awesome-copilot.
Open the folder on GitHubat commit 727ff2e
Used in 7 other repositories
We found 7 copies of this SKILL.md (exact, near-identical or edited) in other folders, from 7 other GitHub owners. This page covers the copy in github/awesome-copilot, which our catalogue first saw on October 7, 2026.
- javierbrea/eslint-plugin-boundaries.agents/skills/documentation-writer
- saoudi-h/solar-icons.agents/skills/documentation-writer
- mt-empty/pi-inky-weather-epd.agents/skills/documentation-writer
- pedronauck/skillsskills/curated/documentation-writer
- aiskillstore/marketplaceskills/github/documentation-writer
- boshi-xixixi/TraeSkill.trae/Skills/.agents/skills/documentation-writer
- compozy/compozy.agents/skills/documentation-writer
Compare with similar skills
Documentation Writer 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 |
|---|---|---|---|---|---|---|
| Documentation Writer this skillgithub/awesome-copilot | 40k | 7 repos | ~686 | Automated safety check: Pass | MIT | |
| 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 |
Similar skills
- Official
Technical Writing Standard
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.
Heym Documentation Articles
heymrun/heym
Creates and updates documentation articles for the Heym platform: category choice, manifest entry, markdown file and cross-links from existing pages.
- Official
Developer Docs Technical Writer
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.
Aholo Viewer Docs
manycoretech/aholo-viewer
Guides writing and maintaining Aholo Viewer documentation: README, AGENTS.md, architecture notes, bilingual manual pages and AI collaboration guides.
Diataxis
WebMCP-org/npm-packages
Write technical documentation following the Diataxis framework by Daniele Procida.
More from github/awesome-copilot
All 417 skills in this repo- Official
Acquire Codebase Knowledge
github/awesome-copilot
Maps an unfamiliar codebase into seven evidence-backed documents in docs/codebase/, using a scan script and templates, for onboarding or architecture write-ups.
- Official
Azure Architecture Autopilot
github/awesome-copilot
Designs Azure infrastructure from a natural-language description, or diagrams an existing resource group, then refines the design through conversation and deploys it with Bicep.
- Official
Draw.io Diagram Generator
github/awesome-copilot
Generates, edits and validates draw.io files with correct mxGraph XML, covering flowcharts, architecture, sequence, ER and UML class diagrams.
- Official
Credit Risk Data Cleaning
github/awesome-copilot
Cleans raw credit data and screens variables before loan modeling, dropping unstable, noisy or redundant features and writing an Excel report of every step.
- Official
Daily Focus Board
github/awesome-copilot
Builds a warm, browser-based daily focus board the user updates by talking to their agent, with Eisenhower priorities, a brain-dump box and kind not-today carryover.
- Official
Python Pypi Package Builder
github/awesome-copilot
End-to-end skill for building, testing, linting, versioning, and publishing a production-grade Python library to PyPI.
Related
Categories
Questions about Documentation Writer
What does Documentation Writer do?
Diátaxis Documentation Expert. An agent skill from github/awesome-copilot. Documentation Writer is an agent skill from github/awesome-copilot, published by the product's own GitHub organization. Diátaxis Documentation Expert.
When should I use Documentation Writer?
Documentation Writer fits situations like: tasks that involve Technical writing; tasks that involve Technical documentation.
How do I install Documentation Writer in Claude Code?
Run `npx skills add github/awesome-copilot --skill documentation-writer -a claude-code`. Or copy the skill folder (skills/documentation-writer in github/awesome-copilot) into .claude/skills/documentation-writer in your project. Claude Code loads it when a task matches its description.
How do I install Documentation Writer in Codex?
Run `npx skills add github/awesome-copilot --skill documentation-writer -a codex`. Or copy the skill folder (skills/documentation-writer in github/awesome-copilot) into .agents/skills/documentation-writer in your project. Codex loads it when a task matches its description.
Can I use Documentation Writer 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 github/awesome-copilot --skill documentation-writer -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/documentation-writer, .gemini/skills/documentation-writer, .github/skills/documentation-writer and .opencode/skills/documentation-writer in your project.
What does Documentation Writer need to run?
SKILL.md names no scripts, command-line tools or credentials: Documentation Writer is instructions for the agent only.
Does Documentation Writer access the network?
SKILL.md names 1 domain. As links in the text: diataxis.fr. This is read from the text; nothing was executed.
Is Documentation Writer 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 Documentation Writer use?
Documentation Writer 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 Documentation Writer use?
About 686 tokens (SKILL.md is roughly 2.7k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Documentation Writer?
Skills that share tags, products or a category with Documentation Writer: 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.
Who maintains Documentation Writer?
github (a GitHub organization, an official publisher) maintains it in github/awesome-copilot, which has 39,748 GitHub stars. The repository holds 417 skills in this directory. The repository was last updated on October 7, 2026.
Source: github/awesome-copilot on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.