agentleFS
shangyiyshangyiy/life-kit/skills/writing/readable/SKILL.md

readable

Skill10 starsChanged 6 days agoMITView on GitHub

Default prose style for user-facing text: one simple idea, then elaboration, then an example when it helps. Use for every writeup, explanation, README, or reply the reader will see, and when the user runs /readable.

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

4 rules. About 0 are common, 4 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    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
  1. Distinctive:

    Write so a reader with no time can follow on the first pass.

    line 11
  2. Distinctive:

    Use short, common words. Give each word one meaning.

    line 19
  3. Distinctive:

    Use a hard word only after this writeup already defined it.

    line 21
  4. Distinctive:

    Keep the author's argument when the source already has one.

    line 23

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Write so a reader with no time can follow on the first pass.

For each point:

  1. Idea — one sentence as subject + verb + object. A reader with no time can infer the elaboration from this sentence alone. Rewrite the idea until they can.
  2. Elaboration — a few sentences that explain the idea in plain words.
  3. Example — add one concrete case when it makes the idea easier to see.

Use short, common words. Give each word one meaning.

Use a hard word only after this writeup already defined it. After that, reuse is fine.

Keep the author's argument when the source already has one. Change only the words and the shape of each point.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.