agentleFS
anorthanorth/agent-skills/skills/markdown-for-humans/SKILL.md

markdown-for-humans

Skill1 starsChanged 5 days agoMITView on GitHub

Conventions for authoring markdown so humans can read it easily, in the source and in diffs. Use when writing or editing markdown files, such as READMEs, docs, designs, ADRs, and skills.

The file

We split this skill into the rules it gives an agent

1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    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:

    Don't wrap at a fixed column: one edit would the rest of the paragraph, and every reflowed line shows in the diff.

    line 20

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 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

Markdown for humans

Markdown files are read by humans too, often as diffs. Format them for human readability.

Line breaks

Break lines at sentence boundaries, or at clause and phrase boundaries, to keep lines below ~120 chars (rough target). An edit to a sentence then touches one line, and displays cleanly in a diff view. This file is an example.

Don't wrap at a fixed column: one edit would the rest of the paragraph, and every reflowed line shows in the diff. For the same reason, leave lines you aren't otherwise changing as they are.

This applies to files. GitHub issues, PR descriptions, and comments render each line break, so write their paragraphs on one line.

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.