Skip to content
A translucent document panel seen in isometric view, thin amber lines tracing from its text down to a folder, a terminal window, a file tree and a verified badge.

README Guidelines

READMEs grounded in the codebase, not in wishful thinking.

An agent skill for writing READMEs whose claims trace back to something real: manifests, help output, tests, CI workflows. It comes with playbooks for ten different kinds of project.

Generated READMEs will confidently document a flag that doesn't exist. Every claim should be checkable against the repo it describes.

What's in it

  • Canonical section order per the standard-readme spec
  • Playbooks for ten project types including CLI, library, API and SDK
  • Source tracing from manifests, tests, CI workflows and LICENSE
  • GitHub and package registry rendering quirks

Next project

Activity Tracker