A deliberately stack-neutral documentation system for starting a new product with people and AI coding agents. It begins with the problem and evidence, then captures decisions as the project earns them—without preselecting an architecture, language, or cloud provider.
- Use this repository as a GitHub template or copy it into a new project.
- Read the AI working agreement.
- Complete the project brief without filling unknowns with plausible prose.
- Capture significant technical choices as ADRs.
- Keep the roadmap and documentation current as the product changes.
- One question has one canonical answer; link instead of duplicating it.
- Separate evidence, assumptions, and decisions. Give each assumption an owner or validation step.
- Document behavior, contracts, and operating procedures—not a diary of implementation details.
- Keep documents short and navigable. Use tables for comparisons and decision records for trade-offs.
- Update documentation in the same change as the behavior it describes.
The complete system is in Documentation System. Code-boundary guidance is in Code Architecture.
Read the current project status and changelog before planning changes.
| Tool | Entry point | Purpose |
|---|---|---|
| Compatible coding agents | AGENTS.md |
Shared project contract |
| Claude Code | CLAUDE.md |
Claude-specific workflow and safeguards |
| Cursor | .cursor/rules/ |
Scoped, version-controlled project rules |
The documentation is rendered with VitePress on http://localhost:3333.
npm install
npm run docs:devRun npm run docs:build before publishing. Use npm run docs:preview to inspect the production build locally.
| Area | Use it for |
|---|---|
| Orientation | Purpose, ownership, and source-of-truth map |
| Discovery | Problem, users, outcomes, boundaries, and risks |
| Engineering | Architecture, code boundaries, contracts, ADRs, and operations |
| Delivery | Milestones, release conditions, dependencies, and changes |
| Guides | Documentation and agent-rule maintenance |
| Project Status | Current readiness, blockers, risks, and next decision |
| Changelog | User-facing repository history |
| Templates | Repeatable documents without stale project context |
MIT.