write-docs
Skill1 starsChanged 15 days agoMITView on GitHub
Write or update documentation that matches this repository — README, API docs, or runbooks — from the code that exists. Use when the user asks for docs, README, API reference, or a runbook. Do not start a multi-page design document. Do not invent features the code does not have.
- Reads credentials
43 other projects use a version of this, 1 of them edited.
Adopted by
Most recently taken up by
- alchemy-run/alchemy-effecttheir own version, first seen Nov 9, 2026
- alchemy-run/alchemytheir own version, first seen Nov 8, 2026
- adhamhaithameid/write-skillstheir own version, first seen Nov 8, 2026
- dzhng/jevgreptheir own version, first seen Nov 7, 2026
- oberon-systems/enggraphtheir own version, first seen Nov 6, 2026
- dzhng/skillstheir own version, first seen Nov 4, 2026
Used with
Projects with it also use close-spec, design-with-images and 10 more.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
dzhngSkillclose-spec
When a spec under specs/<feature>/ is done shipping (a write-spec build, or any planned task that produced a spec), archive it to specs/done/ and rewrite it from a build-plan into a durable rationale — the why, the principles, the invariants — pointing back to the real code for the how. Use when implementation has landed and the plan no longer matches what shipped, or the user says a feature/spec is finished. Pairs with [write-spec](../write-spec/SKILL.md) (the plan this closes) and [review](../review/SKILL.md) (run before closing).
Also in 5 projects that use this
- dzhngSkill
design-with-images
Explore UI and visual design with image generation, then iterate the real implementation against the user-selected concept. Use when brainstorming visual directions, offering mockup variants, or implementing an approved generated design; do not stop at the mockups or the first code approximation.
Also in 5 projects that use this
transitive-bullshitSkillcompare-screenshots
Compare screenshots against the intended design, distinguishing approved references from historical baselines. Use for iterative implementation matching, before/after visual review, objective image telemetry, or checking a lone capture for flat, empty, or badly framed content.
Also in 5 projects that use this
LucasMatuszewskiSkillaudit-agents
Audit and maintain agent configuration files (.claude/agents, AGENTS.md, CLAUDE.md, agent-memory). Checks for duplicates, outdated info, naming conflicts, wrong technical facts, and files over 200 lines. Fixes all issues and commits.
Also in 5 projects that use this
wolverin0Skillaudit-decisions
Standardize remediation decisions, baseline-policy entries, and legal-review banners for accepted, deferred, or policy-blocked audit findings.
Also in 4 projects that use this
rhnfzlSkillexplore-unknowns
Walk the user through mapping the unknowns of a task before, during, and after they build it, and hand them a four-quadrant map (settled ground, open decisions, taste, and landmines) they keep. Reach for this eagerly whenever a request is ambiguous or underspecified, the codebase or domain is unfamiliar, the user will "know it when they see it", a reference implementation must be understood before porting, a build-queue or architecture-changing task is about to start, a mid-build deviation needs capturing, or a finished change needs buy-in or verified understanding before merge. Trigger even when the skill is not named: "do a blindspot pass", "find my unknown unknowns", "interview me about this change", "brainstorm the approach for a task I am about to build", "help me scope this", "what am I missing here", "plan this before I build", "I know nothing about X in this codebase". When a territory profile is present it reads memory and the graph first and feeds the map into the build pipeline; without one it degrades to a plain general map. Not for trivial or mechanical tasks with clear acceptance criteria, single-fact lookups, pure debugging of a known symptom, or pure code review, those have their own tools. Do not use it to run the build itself; the map is the deliverable and implementation remains a separate task, whether it has not started or is already underway.
Also in 5 projects that use this
- +6 more from dzhng
Other versions43 projects use a version of this.
Word for word · 0
None found.
Edited · 1
- rpraharaj/ai-sdlc★ 031% same
Wrote their own version · 42
- tldraw/tldraw★ 51ksame name
- tabler/tabler★ 42ksame name
- videojs/video.js★ 40ksame name
- PrefectHQ/prefect★ 24ksame name
- comet-ml/opik★ 23ksame name
- coder/coder★ 17ksame name
- browseros-ai/BrowserOS★ 14ksame name
- Agenta-AI/agenta★ 4.9ksame name
- liveblocks/liveblocks★ 4.8ksame name
- dzhng/jevgrep★ 3.2ksame name
32 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository34 other files it gives its agents.
- AGENTS.mdAGENTS.md
- templates/AGENTS.mdAGENTS.md
- commitSkill
- cut-releaseSkill
- data-changeSkill
- debugSkill
- engineering-barSkill
- explain-codeSkill
- explore-codebaseSkill
- fix-ciSkill
- handoffSkill
- implement-changeSkill
- incident-triageSkill
- lean-reviewSkill
- open-prSkill
- performanceSkill
- production-passSkill
- ready-to-mergeSkill
- record-decisionSkill
- refactor-safelySkill
- resolve-conflictsSkill
- revert-changeSkill
- review-changeSkill
- security-passSkill
- shape-workSkill
- ship-notesSkill
- start-projectSkill
- upgrade-depsSkill
- verify-uiSkill
- write-architectureSkill
- write-designSkill
- write-dev-tasksSkill
- write-prdSkill
- write-testsSkill
The file
We split this skill into the rules it gives an agent
8 rules. 0 are common, 6 are distinctive, and 2 are very specific to this project.
0
Common
Most of the 42 edited versions we read keep these.
6
Distinctive
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 12
Document what the code does.
- Distinctive: line 14
Read AGENTS.md if present.
- Distinctive: line 30
If kind is Decision, Notes, Product, Architecture, Design, or Tasks, stop after naming the other skill.
- Distinctive: line 34
Follow heading level, tone, and link style of the nearest existing doc.
- Distinctive: line 35
Do not switch the repo to a new doc system.
- Distinctive: line 36
If no doc exists, write the smallest file that answers the ask in this repo's markdown style.
- Very specific: line 43
No secrets, tokens, or real .env values.
- Distinctive: line 53
Do not commit unless asked.
“Common” is measured: kept by at least 6 in 10 of the 42 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Write docs
Document what the code does. Do not invent APIs, flags, or metrics. This is not an ADR (record-decision) and not a changelog (ship-notes).
Read AGENTS.md if present. Read the code and existing docs you will touch.
Kind
| Ask | Kind | Home |
| README, getting started, how to run | Product readme | Root README.md or the one this repo already uses |
| Endpoint/type/flag reference | API docs | Existing docs/, OpenAPI comments, or doc site this repo has |
| Operate / recover / deploy steps | Runbook | Existing docs/runbooks/ or ops folder; else reply only unless they asked for a file |
| Why we chose X | Decision | Stop — record-decision |
| What shipped | Notes | Stop — ship-notes |
| PRD / what we should build | Product | Stop — write-prd |
| System architecture | Architecture | Stop — write-architecture |
| Technical design / tech spec | Design | Stop — write-design |
| Tickets / task breakdown | Tasks | Stop — write-dev-tasks |
If kind is Decision, Notes, Product, Architecture, Design, or Tasks, stop after naming the other skill.
Match this repo
- Follow heading level, tone, and link style of the nearest existing doc.
- Do not switch the repo to a new doc system.
- If no doc exists, write the smallest file that answers the ask in this repo's markdown style.
Write from evidence
- Commands come from
AGENTS.mdor a file you opened. Never inventnpm test. - Public behavior comes from handlers, types, and tests — not from memory.
- Mark unknowns as unknowns. Do not fill them with typical advice.
- No secrets, tokens, or real
.envvalues. Point at variable names.
Load engineering-bar (paths in that skill) if you must edit code comments or generated doc stubs that this change made wrong. Prefer editing docs only.
Done
- Kind and path (or the text in the reply)
- What you documented
- What you left out (and which skill owns it)
Do not commit unless asked.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.