project_context_template.md•3.56 kB
# Project Context File for LLM Assistants
This file provides essential context about the project for LLM assistants. Update this file as your project evolves to ensure all LLM assistants have a consistent understanding of the project.
## Project Overview
**Project Name**: [Project Name]
**Description**: [Brief description of the project's purpose and goals]
**Target Users**: [Who will use this software]
**Current Version**: [Version number]
**Development Stage**: [e.g., Planning, Alpha, Beta, Production]
## Technical Stack
**Languages**: [Programming languages used]
**Frameworks/Libraries**: [Key frameworks and libraries]
**Database**: [Database technologies]
**Infrastructure**: [Hosting, cloud services, etc.]
**Tools**: [Build tools, linters, etc.]
## Architecture Overview
**Pattern**: [e.g., Microservices, Monolith, Serverless]
**Key Components**:
- [Component 1]: [Description]
- [Component 2]: [Description]
- [Component 3]: [Description]
**Data Flow**:
[Brief description of how data flows through the system]
**API Structure**:
[Overview of API design pattern and key endpoints]
## Code Conventions
**Naming Conventions**:
- Variables: [Convention]
- Functions: [Convention]
- Classes: [Convention]
- Files: [Convention]
**Formatting**:
- Indentation: [Tabs/Spaces]
- Line Length: [Max characters]
- Comments: [Style guidelines]
**Documentation**:
- [Where and how code should be documented]
## Development Workflow
**Branching Strategy**:
[Description of git workflow]
**Testing Requirements**:
[Testing expectations and standards]
**Code Review Process**:
[How code reviews are conducted]
**Deployment Process**:
[How code is deployed]
## Project Structure
```
project/
├── [directory]/ # [Description]
│ ├── [subdirectory]/ # [Description]
│ └── [file] # [Description]
├── [directory]/ # [Description]
└── [file] # [Description]
```
## Domain-Specific Terminology
| Term | Definition |
|------|------------|
| [Term 1] | [Definition] |
| [Term 2] | [Definition] |
| [Term 3] | [Definition] |
## Current Project Status
**Completed Features**:
- [Feature 1]
- [Feature 2]
**In-Progress Features**:
- [Feature 3]: [Current status]
- [Feature 4]: [Current status]
**Planned Features**:
- [Feature 5]
- [Feature 6]
## Known Issues & Technical Debt
- [Issue 1]: [Description]
- [Issue 2]: [Description]
## LLM Collaboration History
**Key Decisions**:
- [Date]: [Decision made and reasoning]
- [Date]: [Decision made and reasoning]
**Challenging Areas**:
- [Area 1]: [Why it was challenging and how it was addressed]
- [Area 2]: [Why it was challenging and how it was addressed]
**Successful Approaches**:
- [Approach 1]: [Where it worked well]
- [Approach 2]: [Where it worked well]
## Resources & References
**Documentation**:
- [Link to relevant documentation]
**Similar Projects**:
- [Project 1]: [Link/Description]
- [Project 2]: [Link/Description]
**Learning Resources**:
- [Resource 1]: [Link/Description]
- [Resource 2]: [Link/Description]
## LLM Assistant Roles
| Role | Responsibility | Notes |
|------|----------------|-------|
| Architect LLM | System design and architecture decisions | [Specific guidance] |
| Developer LLM | Implementation of features | [Specific guidance] |
| Tester LLM | Test design and verification | [Specific guidance] |
| DevOps LLM | Deployment and infrastructure | [Specific guidance] |
| Documentation LLM | User and technical documentation | [Specific guidance] |
---
Last Updated: [Date]