write-docs
Skill12 starsChanged 30 days agoMITView on GitHub
Document a debuff change everywhere it shows up (JSDoc, package READMEs, agent skills, debuff.jp in English and Japanese, changesets), keeping the docs for old behaviour. Use for any change to public API, CLI, MCP tools or behaviour, and when renaming or deprecating anything.
45 other projects use a version of this.
Adopted by
Most recently taken up by
- iammrduncan/skillstheir own version, first seen Nov 16, 2026
- dzhng/skillstheir own version, first seen Nov 15, 2026
- develeep/dev-gongbangtheir own version, first seen Nov 15, 2026
- karlo-ks/Infradecktheir own version, first seen Nov 15, 2026
- dzhng/jevgreptheir own version, first seen Nov 11, 2026
- alchemy-run/alchemy-effecttheir own version, first seen Nov 9, 2026
Used with
Projects with it also use close-spec, design-with-images and 9 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
dzhngSkilldesign-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
- +5 more from dzhng
Other versions45 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 45
- 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
35 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 repository2 other files it gives its agents.
- AGENTS.mdAGENTS.md
- add-packageSkill
The file
We split this skill into the rules it gives an agent
1 rule. 0 are common, 1 is distinctive, and 0 are very specific to this project.
0
Common
Most of the 43 edited versions we read keep these.
1
Distinctive
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 12
Search for the old name or behaviour before editing:
“Common” is measured: kept by at least 6 in 10 of the 43 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
Writing docs for a debuff change
A change isn't done until its docs are. Docs ship to debuff.jp before the release goes to GitHub and npm.
1. List every place that mentions the thing
Search for the old name or behaviour before editing:
git grep -n "<name>" -- '*.md' '*.ts' ':!**/CHANGELOG.md'Then the same in D:/docs-live (the debuff.jp source), which covers docs/, ja/docs/, spryte/, keiko/, myaku/, plonk/ and blog/.
The places that usually need an edit:
| Where | What |
packages/*/src | JSDoc on the changed export. TypeDoc builds the API pages from it. |
packages/*/README.md, tooling/*/README.md | Examples and option lists. |
plugins/debuff/skills/*/SKILL.md and plugins/openai/debuff/skills/* | What agents are told. Keep both copies in step. |
D:/docs-live/docs/*.md | The guide pages. |
D:/docs-live/ja/... | The Japanese copy of every English page you touch. |
.changeset/*.md | One changeset per user-facing change (npx changeset). |
2. Keep the old docs (hard rule)
People on older versions still read the docs. Never delete docs for something deprecated, renamed or changed in behaviour. Keep them and add the version:
- Renamed: "Deprecated in 0.21: use
squish." Keep the old section below the new one. - Changed behaviour: "Before 0.21,
xreturnedy." Then the new behaviour. - Removed: keep the section, headed "Removed in 0.21", with what to use instead.
This applies to JSDoc (@deprecated Since 0.21: use squish), READMEs, skills and both languages on debuff.jp. If a diff deletes a doc section, check that it was moved or marked, not lost.
Find the version from the next release the changeset will produce (the fixed @debuffjp/* version plus the bump).
3. Write it
- English site copy: follow the
write-postskill inD:/docs-live.npm run lint:enchecks names, British spelling, em dashes and stock AI phrases. - Japanese: follow the
translate-jaskill there.npm run check:jalists missing or stale pages. - Apply the
unslopskill to READMEs, changesets and commit messages. - "debuff" is lowercase in prose.
- Code examples import from the package that owns the API.
4. Check it
In this repo:
npm run checkIn D:/docs-live:
npm run build
npm run check:ja
npm run lint:ennpm run deploy there runs the checks again and publishes debuff.jp. Deploying is the maintainer's call: say the docs are ready, then deploy only if 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.

