Document a project for developers and agents
Create concise repository context, shared language, and operating instructions that remain useful across sessions.
Use when
Contributors and coding agents repeatedly rediscover the same terminology, decisions, and commands.
Outcome
A repository that explains its purpose, domain, architecture, commands, and constraints without oversized prompt context.
The sequence
4 deliberate steps
- 01Open prompt
Create the contributor entry point
Write a README around the real user and verified first-use path.
- 02Open prompt
Capture domain language
Define the small vocabulary needed to discuss the system precisely.
- 03Open prompt
Explain the execution model
Walk one representative behavior through the modules and operational boundaries.
- 04Open prompt
Record durable decisions
Add concise ADRs only for choices future contributors would otherwise relitigate.