3.3 KiB
3.3 KiB
Documentation Index
Core Project Documentation
| File | Path | Purpose | Status |
|---|---|---|---|
| Project Brief | 00_PROJECT_BRIEF.md |
High-level project overview | Active |
| Vision and Scope | 01_VISION_AND_SCOPE.md |
Product vision and boundaries | Active |
| Business Context | 02_BUSINESS_CONTEXT.md |
Business environment and constraints | Active |
| Problem Statement | 03_PROBLEM_STATEMENT.md |
Core problem being solved | Active |
| Product Goals | 04_PRODUCT_GOALS.md |
Success criteria and objectives | Active |
| User Workflows | 05_USER_WORKFLOWS.md |
User journey and interactions | Active |
| Functional Requirements | 06_FUNCTIONAL_REQUIREMENTS.md |
System functionality specifications | Active |
| Non-Functional Requirements | 07_NON_FUNCTIONAL_REQUIREMENTS.md |
Performance, security, etc. | Active |
| Domain Model | 08_DOMAIN_MODEL.md |
Core entities and relationships | Active |
| States and Lifecycles | 09_STATES_AND_LIFECYCLES.md |
System states and transitions | Active |
| MVP Definition | 10_MVP_DEFINITION.md |
Minimum viable product scope | Active |
| Roadmap | 11_ROADMAP.md |
Development timeline and phases | Active |
| UI/UX Principles | 12_UI_UX_PRINCIPLES.md |
Design guidelines and principles | Active |
| Data Rules | 13_DATA_RULES.md |
Data validation and constraints | Active |
| Automation Opportunities | 14_AUTOMATION_OPPORTUNITIES.md |
Potential automation areas | Active |
| Open Questions | 15_OPEN_QUESTIONS.md |
Unresolved issues and decisions | Active |
| Decisions Log | 16_DECISIONS_LOG.md |
Historical decisions and rationale | Active |
| Progress | 17_PROGRESS.md |
Current project status and achievements | Active |
| Agent Handoff | 18_AGENT_HANDOFF.md |
Session handoff information | Active |
| Tech Stack | 19_TECH_STACK.md |
Technology choices and architecture | Active |
| Project Structure | 20_PROJECT_STRUCTURE.md |
Code organization and layout | Active |
| Engineering Guidelines | 21_ENGINEERING_GUIDELINES.md |
Development standards and practices | Active |
Agent Prompts
| File | Path | Purpose | Status |
|---|---|---|---|
| Master Prompt | prompts/master_prompt.md |
Primary agent instructions | Active |
| Backend Prompt | prompts/prompt_backend.md |
Backend development guidelines | Active |
| Database Prompt | prompts/prompt_database.md |
Database development guidelines | Active |
| Frontend Prompt | prompts/prompt_frontend.md |
Frontend development guidelines | Active |
| Testing Prompt | prompts/prompt_testing.md |
Testing strategy and guidelines | Active |
Required Reading Before Implementation
The following files are mandatory reading before any implementation:
00_PROJECT_BRIEF.md01_VISION_AND_SCOPE.md03_PROBLEM_STATEMENT.md04_PRODUCT_GOALS.md05_USER_WORKFLOWS.md08_DOMAIN_MODEL.md09_STATES_AND_LIFECYCLES.md10_MVP_DEFINITION.md11_ROADMAP.md13_DATA_RULES.md16_DECISIONS_LOG.md17_PROGRESS.md18_AGENT_HANDOFF.md19_TECH_STACK.md20_PROJECT_STRUCTURE.md21_ENGINEERING_GUIDELINES.md
Last updated: 2025-06-17 Total documentation files: 27