write-docs
Skill112 starsChanged 3 days agoNo licenceView on GitHub
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.
We split this skill into the rules it gives an agent
3 rules. 0 are common, 3 are distinctive, and 0 are very specific to this project.
0
Common
Most of the 35 edited versions we read keep these.
3
Distinctive
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
No licence file, so all rights are reserved — read it at the source. We count its rules but don't quote them. Read them on GitHub.
“Common” is measured: kept by at least 6 in 10 of the 35 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.
Trending
Steady: 0 new projects took it in the last 4 weeks, none the 4 weeks before.thin data
Other versions40 projects use a version of this.
Word for word · 4
- dzhng/jevgrep★ 3.1k100% same
- dzhng/skills★ 1.4k100% same
- dzhng/duet-agent★ 55100% same
- Buddhilive/buddhi-cli★ 1100% same
Edited · 0
None found.
Wrote their own version · 36
- 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
- classroomio/classroomio★ 1.7ksame name
26 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 repository33 other files it gives its agents.
- AGENTS.mdAGENTS.md
- audit-agentsSkill
- audit-decisionsSkill
- audit-performanceSkill
- audit-testsSkill
- auto-researchSkill
- claudeSkill
- close-specSkill
- code-reviewSkill
- codexSkill
- compare-screenshotsSkill
- design-with-imagesSkill
- eli5Skill
- eval-skillsSkill
- explore-unknownsSkill
- handoff-specSkill
- implement-specSkill
- implement-spec-with-codexSkill
- implement-spec-with-goalSkill
- launch-videoSkill
- marketing-pagesSkill
- preview-shotsSkill
- ratchet-filesSkill
- refactor-cleanSkill
- releaseSkill
- rendererSkill
- retroSkill
- reviewSkill
- screenshot-critiqueSkill
- write-skillsSkill
- write-specSkill
- write-testsSkill
- yapSkill
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.