Simple English
moeru-ai/airi
Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.
Write and edit project docs (README/markdown) as a glossary of principles, not a mirror of the code.
Install Write Docs
$ npx skills add dzhng/skills --skill write-docs -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install dzhng/skills write-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/dzhng/skills.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/engineering/write-docs .claude/skills/write-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 "write-docs" agent skill from https://github.com/dzhng/skills/tree/main/skills/engineering/write-docs into .claude/skills/write-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-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/dzhng/skills/tree/main/skills/engineering/write-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 dzhng/skills --skill write-docs -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install dzhng/skills write-docs --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/dzhng/skills.git skills-src && mkdir -p .agents/skills && cp -r skills-src/skills/engineering/write-docs .agents/skills/write-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 "write-docs" agent skill from https://github.com/dzhng/skills/tree/main/skills/engineering/write-docs into .agents/skills/write-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-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 dzhng/skills --skill write-docs -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install dzhng/skills write-docs --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/dzhng/skills.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/skills/engineering/write-docs .cursor/skills/write-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 "write-docs" agent skill from https://github.com/dzhng/skills/tree/main/skills/engineering/write-docs into .cursor/skills/write-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-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/dzhng/skills.git --path skills/engineering/write-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 dzhng/skills --skill write-docs -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install dzhng/skills write-docs --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/dzhng/skills.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/skills/engineering/write-docs .gemini/skills/write-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 "write-docs" agent skill from https://github.com/dzhng/skills/tree/main/skills/engineering/write-docs into .gemini/skills/write-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-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 dzhng/skills write-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 dzhng/skills --skill write-docs -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/dzhng/skills.git skills-src && mkdir -p .github/skills && cp -r skills-src/skills/engineering/write-docs .github/skills/write-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 "write-docs" agent skill from https://github.com/dzhng/skills/tree/main/skills/engineering/write-docs into .github/skills/write-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-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 dzhng/skills --skill write-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 dzhng/skills write-docs --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/dzhng/skills.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/skills/engineering/write-docs .opencode/skills/write-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 "write-docs" agent skill from https://github.com/dzhng/skills/tree/main/skills/engineering/write-docs into .opencode/skills/write-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-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
write-docs- GitHub stars
- 1k
- Token cost
- ~930 tokens
- SKILL.md length
- 570 words
- Files
- 1
- Skills in repo
- 27
- Repo updated
- First seen
- Licence
- MIT
At a glance
Write and edit project docs (README/markdown) as a glossary of principles, not a mirror of the code.
- Revising a README
- SKILL.md covers Keep vs shed, Point, don't transcribe, One home per fact and Link the tree, downward, plus 1 more section
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
- A doc enumerates exact scenes
What it does
Write Docs is an agent skill from dzhng/skills. Write and edit project docs (README/markdown) as a glossary of principles, not a mirror of the code. Use when creating or revising a README; when a doc enumerates exact scenes, scenarios, helpers, class ids, file lists, or command/flag matrices the code already holds; when trimming narrative or changelog out of a doc; or when deduplicating overlapping docs and wiring a root doc to its sub-docs.
Its SKILL.md is about 930 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 Development, covering Changelog and release notes and Technical documentation. The repository describes itself as: Reusable AI agent skills for software factories: explore ideas, write specs, implement, review, and run autonomous research. Works with Claude Code, Codex, and other… The licence is MIT.
When your agent uses it
- Revising a README
- A doc enumerates exact scenes
- Command/flag matrices the code already holds
- Trimming narrative
Example prompts
- “/write-docs”
What it can do on your machine
Read from SKILL.md and the folder at commit d513228. 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
Write Docs loads about 930 tokens when it runs. Until then it costs about 102 tokens; SKILL.md has 570 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 dzhng/skills at commit d513228, republished under its MIT licence (© dzhng). 570 words, ~930 tokens.
Download SKILL.mdSave it as
.claude/skills/write-docs/SKILL.md (or your agent's skills folder).- name
- write-docs
- description
- Write and edit project docs (README/markdown) as a glossary of principles, not a mirror of the code. Use when creating or revising a README; when a doc enumerates exact scenes, scenarios, helpers, class ids, file lists, or command/flag matrices the code already holds; when trimming narrative or changelog out of a doc; or when deduplicating overlapping docs and wiring a root doc to its sub-docs.
Write Docs
A doc is a glossary: it names the moving parts, says why each exists, and carries the principles a reader can't derive by grepping. The code is the source of truth for what exists right now — the doc must never race it. Before writing any line, ask the one question that governs this skill: could the reader get this faster and more reliably by reading the code? If yes, point them at the code instead of copying it in.
Keep vs shed
Keep — a reader cannot grep their way to these:
- The WHY: why a thing exists, the principle behind a split, the taxonomy file names don't reveal.
- Non-obvious discoveries: platform quirks, "if you remove this, X breaks because Y", a contract two files silently share.
- Pointers to where things live, and what KIND of thing lives there plus the rule for what belongs.
Shed — the code or its git history already holds these, so a copy only rots:
- Exact rosters: scene names, scenario tables, helper lists, class ids, file lists, command/flag matrices.
- Narrative and changelog: "we renamed X", "the old Y was removed as a dup", what was tried and abandoned.
- Exact counts, tick values, current constants, line numbers — anything that just restates the code.
Point, don't transcribe
Where you're tempted to list specifics, name the folder or the single file that owns them and send the reader there — prefer a folder over a file, a source-of-truth registry over a transcribed copy. Describe a helper module by the kind of helper it holds and the rule for what belongs in it, not its current roster. One concrete touchstone is fine to ground a principle; a full inventory is the smell. "The matchups live in the table that defines them; the ids key off the class registry" stays true after the next edit — reproducing either does not.
One home per fact
Every fact has exactly one canonical home; every other doc links to it. Repetition across docs is a maintenance bug — copies drift and the reader can't tell which is current. A root/global doc gets a short section plus pointers to the sub-docs. When two docs explain the same thing, pick the hub and cut the other to a pointer.
Show full SKILL.md (198 more words)Show less
Link the tree, downward
Docs form a tree reachable from one root/hub doc: the hub links to each sub-doc, and a sub-doc links on to any module-level doc beneath it. Navigation flows down — a reader starts at the root and follows links in, so the whole tree is reachable from there. A doc links back up to its parent, or across to a sibling, only to reuse a fact that already lives there — an app doc pointing at the hub's deployment section instead of restating it, a boundary doc naming the sibling it defers to. That is the one-home rule doing its job. What you do not add is a rote "part of X" back-link that carries no information: it's noise, and the tree is already navigable from the root without it.
Edit pass
When trimming an existing doc, delete on sight: enumerations of code-discoverable items, changelog and narrative, and any sentence that restates the code. Then read what survives as a stranger with no conversation history — every remaining line should be a principle, a why, or a pointer. If a line would be just as true and just as useful as a link, make it the link.
© dzhng, 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/engineering/write-docs of dzhng/skills.
Open the folder on GitHubat commit d513228
Used in 1 other repository
We found 1 copy of this SKILL.md (exact, near-identical or edited) in other folders. This page covers the copy in dzhng/skills, which our catalogue first saw on October 7, 2026.
Compare with similar skills
Write 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 |
|---|---|---|---|---|---|---|
| Write Docs this skilldzhng/skills | 1k | — | ~930 | Automated safety check: Pass | MIT | |
| Simple Englishmoeru-ai/airi | 50k | 2 repos | ~4.6k | Automated safety check: Pass | MIT | |
| Ccb GitHubSeemSeam/claude_codex_bridge | 3.6k | — | ~4.9k | Automated safety check: Pass | Custom licence | |
| Golang Documentationunxed/f4 | 241 | 3 repos | ~3.5k | Automated safety check: Pass | MIT | |
| Simple Englishropensci/ckanr | 104 | 3 repos | ~2k | Automated safety check: Pass | MIT | |
| Opik Documentation Patternscomet-ml/opik | 22k | — | ~1.3k | Automated safety check: Pass | Apache-2.0 |
Similar skills
Ccb GitHub
SeemSeam/claude_codex_bridge
Maintain this CCB project's GitHub-facing release and npm publication surface.
Golang Documentation
unxed/f4
Comprehensive documentation guide for Golang projects, covering godoc comments, README, CONTRIBUTING, CHANGELOG, Go Playground, Example tests, API docs, and llms.txt.
Simple English
ropensci/ckanr
Write or rewrite text in plain, layman-readable English in the spirit of ASD-STE100 Simplified Technical English: short sentences, active voice, simple tenses, one word one meaning, condition before…
Opik Documentation Patterns
comet-ml/opik
Rules for writing PR descriptions, changelog entries and feature documentation in the Opik repository, including the exact headings that CI requires.
Release
jrswab/axe
Prepare code for release (version bumps, changelog, README updates) and create an annotated tag to trigger the GoReleaser workflow.
More from dzhng/skills
All 27 skills in this repoCompare Screenshots
dzhng/skills
Compare screenshots against the intended design, distinguishing approved references from historical baselines.
Claude
dzhng/skills
Use Claude Code as an independent claude -p subagent when the user explicitly asks for Claude, wants a second-agent opinion from Claude, or asks to delegate a well-scoped task to Claude.
Refactor Clean
dzhng/skills
Refactor cleanly instead of layering sediment. An agent skill from dzhng/skills.
Write Skills
dzhng/skills
Create or revise agent skills. An agent skill from dzhng/skills.
Codex
dzhng/skills
Use the local Codex CLI as an independent second agent. An agent skill from dzhng/skills.
Implement Spec With Codex
dzhng/skills
Run [implement-spec](../implement-spec/SKILL.md) with Codex doing the implementation passes while you orchestrate, integrate, and review.
Related
Categories
Questions about Write Docs
What does Write Docs do?
Write and edit project docs (README/markdown) as a glossary of principles, not a mirror of the code. Write Docs is an agent skill from dzhng/skills. Write and edit project docs (README/markdown) as a glossary of principles, not a mirror of the code.
When should I use Write Docs?
Write Docs fits situations like: revising a README; A doc enumerates exact scenes; command/flag matrices the code already holds; trimming narrative.
How do I install Write Docs in Claude Code?
Run `npx skills add dzhng/skills --skill write-docs -a claude-code`. Or copy the skill folder (skills/engineering/write-docs in dzhng/skills) into .claude/skills/write-docs in your project. Claude Code loads it when a task matches its description.
How do I install Write Docs in Codex?
Run `npx skills add dzhng/skills --skill write-docs -a codex`. Or copy the skill folder (skills/engineering/write-docs in dzhng/skills) into .agents/skills/write-docs in your project. Codex loads it when a task matches its description.
Can I use Write 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 dzhng/skills --skill write-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/write-docs, .gemini/skills/write-docs, .github/skills/write-docs and .opencode/skills/write-docs in your project.
What does Write Docs need to run?
SKILL.md names no scripts, command-line tools or credentials: Write Docs is instructions for the agent only.
Does Write 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 Write 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 Write Docs use?
Write 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 Write Docs use?
About 930 tokens (SKILL.md is roughly 3.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 Write Docs?
Skills that share tags, products or a category with Write Docs: Simple English (moeru-ai/airi, 50k stars), Ccb GitHub (SeemSeam/claude_codex_bridge, 3.6k stars), Golang Documentation (unxed/f4, 241 stars) and Simple English (ropensci/ckanr, 104 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Write Docs?
dzhng (a GitHub user) maintains it in dzhng/skills, which has 1,016 GitHub stars. The repository holds 27 skills in this directory. The repository was last updated on October 5, 2026.
Source: dzhng/skills on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.