cognitive-doc-design
Skill2 starsChanged 20 days agoMITView on GitHub
Write docs that reduce cognitive load. Trigger: writing READMEs, guides, RFCs, or architecture 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 4 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.
- Common
- Distinctive
- Very specific
- Distinctive: line 13
Lead with the conclusion: Put the answer first, details after.
- Distinctive: line 15
Prefer a concrete example over abstract prose.
- Distinctive: line 17
Use tables for comparisons.
“Common” is measured: kept by at least 6 in 10 of the 4 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
Goal
A reader should get what they need with the least effort. Optimize for scanning and for the reader's question, not for completeness.
How
- Lead with the conclusion. Put the answer first, details after.
- One idea per section; use headings the reader can scan to find their question.
- Prefer a concrete example over abstract prose. Show the command, the output, the file.
- Use tables for comparisons; lists for steps; short paragraphs for the rest.
- Cut hedging and filler. If a sentence doesn't help the reader act, remove it.
- Name things consistently with the code (
internal/sdd,copilot-instructions.md).
Structure for a guide
What it is → why it matters → how to use it (steps) → gotchas. Mirror the parity doc and the SDD skills in this repo.
Other versions4 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 4
- Gentleman-Programming/gentle-ai★ 8.2ksame name
- JuankCadavid/akili-specs★ 9same name
- svg153/skills★ 1same name
- AndyTechnologies/my-own-skills★ 0same 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.
In this repository9 other files it gives its agents.
- AGENTS.mdAGENTS.md
- llms.txtllms.txt
- branch-prSkill
- capiko-devSkill
- chained-prSkill
- comment-writerSkill
- go-testingSkill
- issue-creationSkill
- work-unit-commitsSkill
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.