agent-docs

Installation
SKILL.md

Init Project Docs

Check the project root for README.md, AGENTS.md, and CLAUDE.md. Create whichever are missing. NEVER modify or overwrite one that exists, even partially; if all three exist, say so and stop.

First: survey the project

Before writing anything, build real understanding. Read the file tree, package manifests and lockfiles, scripts/tasks, CI config, recent git log, and any requirements, spec, or PRD documents (a spec-only repo is a valid and sufficient source; a good PRD answers most README questions and seeds the AGENTS.md core vocabulary and never-compromise list). Skim the main entry points if code exists. Check the project root, and only the root, for a CONTEXT.md or equivalent glossary: if one is there, it owns the project's vocabulary and AGENTS.md should point at it rather than restate it. Ignore glossaries in subdirectories; those belong to a package, not the project. Everything you write must be derived from this specific project. Generic boilerplate ("write clean code", "follow best practices") is worse than nothing: delete any sentence that would be true of every repo on earth.

If the survey finds no substantive source material (no code, no requirements/spec/PRD, no meaningful history), STOP. Tell the user there is nothing to derive documentation from yet and that the skill should be run again once the project has a spec or code. Do not create any files in this case; docs invented from nothing are boilerplate by definition.

README.md (if missing)

Audience: humans, and agents deciding whether to use this project. NOT instructions for working on it.

  • What this is and why it exists, in the first two sentences
  • Status if relevant (personal tool, experiment, production)
  • Quickstart: install, configure, run, in copy-pasteable commands verified against the actual scripts/manifest
  • Basic usage
  • Pointers to deeper docs if they exist
Installs
2
Repository
birdsigh/skills
GitHub Stars
3
First Seen
Aug 14, 2026
agent-docs — birdsigh/skills