18 lines
850 B
Markdown
18 lines
850 B
Markdown
|
# Project Specs
|
||
|
|
|
||
|
|
This folder contains the "Living Specification" for the project. It serves as the source of truth for all AI sessions.
|
||
|
|
|
||
|
|
## Structure
|
||
|
|
|
||
|
|
* **00_CONTEXT.md**: The high-level overview, goals, domain definition, and glossary. Start here.
|
||
|
|
* **tech/**: Implementation details, including the Tech Stack, Architecture, and Constraints.
|
||
|
|
* **STACK.md**: The technical "Constitution" (Languages, Libraries, Patterns).
|
||
|
|
* **functional/**: Domain logic and behavior descriptions, platform-agnostic.
|
||
|
|
* **01_CORE.md**: Core functional specifications.
|
||
|
|
|
||
|
|
## Usage for LLMs
|
||
|
|
|
||
|
|
1. **Always read 00_CONTEXT.md** and **tech/STACK.md** at the beginning of a session.
|
||
|
|
2. Before writing code, ensure the spec in this folder reflects the desired reality.
|
||
|
|
3. If a Story changes behavior, update the spec *first*, get approval, then write code.
|