write-guide
Skill0 starsChanged 3 months agoMITView on GitHub
Use when: drafting one planned tutorial from guides/plan.json into docs/guides with measured facts and executable verification annotations.
6 other projects use a version of this.
Adopted by
Most recently taken up by
- caiopizzol/tres-pinostheir own version, first seen Nov 15, 2026
- karlo-ks/Infradecktheir own version, first seen Nov 15, 2026
- runpod/runpod-plugins-officialtheir own version, first seen Oct 15, 2026
- readium/swift-toolkittheir own version, first seen Oct 8, 2026
- vercel/next.jstheir own version, first seen May 14, 2026
- sethsontech-max/claudeSkillstheir own version, first seen Apr 3, 2026
Other versions6 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 6
- vercel/next.js★ 144ksame name
- readium/swift-toolkit★ 574same name
- karlo-ks/Infradeck★ 85same name
- runpod/runpod-plugins-official★ 50same name
- caiopizzol/tres-pinos★ 7same name
- sethsontech-max/claudeSkills★ 1same name
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.
The file
Show its rules and text
We split this skill into the rules it gives an agent
18 rules. 0 are common, 13 are distinctive, and 5 are very specific to this project.
0
Common
Most of the 6 edited versions we read keep these.
13
Distinctive
This author's own choices. Worth a look.
5
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 9
Write exactly one guide identified by the guide ID in the request.
- Very specific: line 13
Read only the selected entry in guides/plan.json plus its prerequisite entries.
- Very specific: line 15
Read docs/contributing/writing-guides.md and docs/contributing/tutorial-template.md.
- Very specific: line 16
Read docs/facts.json, every file in primary_code, and every file in tests from the selected entry.
- Distinctive: line 17
Read prerequisite guide pages only when needed to avoid reteaching their concepts.
- Distinctive: line 19
Stop without editing if the guide is not planned, is keyed, or its declared output already exists.
- Distinctive: line 30
Never modify application code, tests, harness code, workflow files, dependencies, lockfiles, existing guides, or any other curriculum entry.
- Distinctive: line 34
Follow the Google developer documentation style rules in the repository writing guide.
- Very specific: line 36
Use the selected entry's descriptive output path.
- Distinctive: line 37
Use four spaces for every paragraph, annotation, and code block that continues a numbered item.
- Distinctive: line 38
Run every deterministic command before showing its output.
- Distinctive: line 40
Use only offline commands.
- Distinctive: line 42
Do not add a fact merely because it is interesting.
- Distinctive: line 44
Add the guide to MkDocs in curriculum order.
- Very specific: line 45
Keep a Next steps section.
- Distinctive: line 46
Keep destructive build-from-empty steps manual.
- Distinctive: line 50
Run these checks after writing:
- Distinctive: line 62
Do not commit, push, open a pull request, or alter the generated branch.
“Common” is measured: kept by at least 6 in 10 of the 6 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 one planned guide
Write exactly one guide identified by the guide ID in the request. The repository's independent checks, not your judgment, decide whether the draft is valid.
Read before writing
- Read only the selected entry in
guides/plan.jsonplus its prerequisite entries. - Confirm the selected entry has
status: "planned"andtier: "offline". - Read
docs/contributing/writing-guides.mdanddocs/contributing/tutorial-template.md. - Read
docs/facts.json, every file inprimary_code, and every file intestsfrom the selected entry. - Read prerequisite guide pages only when needed to avoid reteaching their concepts.
Stop without editing if the guide is not planned, is keyed, or its declared output already exists.
Allowed changes
Change only:
- The selected entry's declared
outputfile. mkdocs.yml, adding one navigation entry for that output.- The selected entry's
status, fromplannedtodraft. docs/facts.jsononly by runninguv run python -m harness.measure_facts --root . --write docs/facts.json; never edit measured values manually.
Never modify application code, tests, harness code, workflow files, dependencies, lockfiles, existing guides, or any other curriculum entry.
Authoring rules
- Follow the Google developer documentation style rules in the repository writing guide.
- Teach only the concepts declared in the selected entry; the default budget is three.
- Use the selected entry's descriptive output path. Never create a numbered
guide-N.mdfilename. - Use four spaces for every paragraph, annotation, and code block that continues a numbered item.
- Run every deterministic command before showing its output. Never invent output, versions, rankings, metrics, scores, errors, or API behavior.
- Wrap every shell block with
verify cmdorverify manual. A manual annotation requires a specific reason. - Use only offline commands. Do not access Anthropic, Voyage, or any other paid API.
- Wrap every displayed scalar from
docs/facts.jsonin afactannotation and declare it in the selected plan entry. - Do not add a fact merely because it is interesting. Add only facts necessary to the lesson.
- Link every declared prerequisite in
Before you beginusing its curriculum output path. - Add the guide to MkDocs in curriculum order. MkDocs previous/next navigation is the authoritative forward path.
- Keep a
Next stepssection. Link only guides that already exist; mention planned guides without creating dead links. - Keep destructive build-from-empty steps manual. Never clear or overwrite source files in the checked-out repository.
Verification sequence
Run these checks after writing:
uv run python -m harness.verify_facts --root .
uv run python -m harness.verify_guide_flow --root .
uv run python -m harness.verify_guides "docs/guides/*.md"
uv run pytest -q
uv run ruff check .The executable guide gate may reject a new command because it is not allowlisted. Do not weaken, bypass, or edit the allowlist. Leave the draft for a human to add a narrowly reviewed command rule.
Do not commit, push, open a pull request, or alter the generated branch. The workflow owns Git operations and changed-file enforcement.
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.

