project-docs
Installation
SKILL.md
Project Docs
Author the orientation set that takes someone from "just cloned this" to "shipping a change":
| Doc | Answers | Audience |
|---|---|---|
README.md |
What is this, why, how do I run it? | Anyone landing on the repo |
docs/GLOSSARY.md |
What does this word mean here? | Anyone reading code or specs |
docs/development-guide/ |
How do I actually do a task end-to-end? | A developer picking up work |
docs/onboarding/ |
How do I get set up and find my way around? | A brand-new contributor |
Produce whichever the user asks for; default to all four. They share one source (the codebase + existing docs) and one rule: describe reality, then cross-link; never duplicate. Where a fact already lives in another doc (standards, task breakdown, deployment plan, ADRs), link to it rather than restating it; restated facts drift and rot.
1. Read first
Before writing, build an accurate picture: