agentleFS
pdparchitectpdparchitect/noodle/.agents/skills/no-code-docs/SKILL.md

no-code-docs

Skill259 starsChanged 35 days agoApache-2.0View on GitHub

Code is documented only in the source. Use whenever writing or editing a README.md, anything under docs/, or any other Markdown documentation, and whenever a change tempts you to explain how something works outside the code.

The file

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    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:

    When a change alters what someone does or sees, update the README in those terms.

    line 19
  2. Distinctive:

    Before saving a README or doc, read every sentence as someone who has never seen the code.

    line 27

≈ “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

No code docs

Documentation outside the source code is for people using the apps, not for people reading the code. Code is documented in its own comments and nowhere else.

A README says what the app is, what it does for the person using it, and how to get and use it, in plain language. It must not contain:

  • type, function, property, file or module names, or source paths;
  • formats, codecs, protocols, sandbox rules, entitlements, internal limits or anything else about how the code does its job;
  • architecture, design reasoning or implementation notes.

When a change alters what someone does or sees, update the README in those terms. When it only changes how the code works, do not touch the README; write the explanation as a comment beside the code.

Guidance the apps print or hand to agents lives in source files, such as the Applet guidance or the messenger documentation. That is source, not documentation, and follows its own rules.

Before saving a README or doc, read every sentence as someone who has never seen the code. Delete any sentence they would not need or understand.

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.