Individual skill
write-docs
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.
skills/engineering/write-docs/SKILL.md
Source commit 0867285d3f2612104afa6bb774779943854d4c15
What was checked
- Matches the observed repository HEAD
- Yes
- Scanner rules are current
- Yes
- Repository scan complete
- No
- Skill scan complete
- No
- Observed behavior
- Network or broad shell
- Last checked
- Nov 9, 2026
These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.
Install this skill
Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.
An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.
Repository context
- Repository stars (not skill ratings)
- 1,470
- Repository last updated
- Nov 8, 2026
- License
- MIT
Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.
- agent-skills Repository topic
- ai-agents Repository topic
- autonomous-agents Repository topic
- autoresearch Repository topic
- claude-code Repository topic
- code-review Repository topic
- codex Repository topic
- developer-tools Repository topic
- software-engineering Repository topic
- spec-driven-development Repository topic
- docs Derived category
Files and excerpt
File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.
Read excerpt
# 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