38d67f3c2f
✨ New Features: • Collections system for organizing domain-specific customizations • Plan collection with 6 specialized prompts for feature development • Automated README generation for collections • Badge generation with proper collection path support 📝 Plan Collection Content: • Epic planning (PRD and architecture) • Feature planning (PRD and implementation) • GitHub issue automation • Build implementation guide • Comprehensive development workflow 🔧 Script Enhancements: • Collections discovery and processing • Individual collection README generation • Main README collections section • Badge URL generation with collection paths • Proper navigation links to README.md files 📁 Structure: collections/ ├── plan/ (6 prompts) └── test/ (demo content) The collections feature enables organized, domain-specific GitHub Copilot customizations with automated documentation and proper VS Code integration.
114 lines
3.4 KiB
Markdown
114 lines
3.4 KiB
Markdown
---
|
|
mode: 'agent'
|
|
description: 'Prompt for creating the high-level technical architecture for an Epic, based on a Product Requirements Document.'
|
|
---
|
|
|
|
# Epic Architecture Specification Prompt
|
|
|
|
## Goal
|
|
|
|
Act as a Senior Software Architect. Your task is to take an Epic PRD and create a high-level technical architecture specification. This document will guide the development of the epic, outlining the major components, features, and technical enablers required.
|
|
|
|
## Context Considerations
|
|
|
|
- The Epic PRD from the Product Manager.
|
|
- **Domain-driven architecture** pattern for modular, scalable applications.
|
|
- **Self-hosted and SaaS deployment** requirements.
|
|
- **Docker containerization** for all services.
|
|
- **TypeScript/Next.js** stack with App Router.
|
|
- **Turborepo monorepo** patterns.
|
|
- **tRPC** for type-safe APIs.
|
|
- **Stack Auth** for authentication.
|
|
|
|
**Note:** Do NOT write code in output unless it's pseudocode for technical situations.
|
|
|
|
## Output Format
|
|
|
|
The output should be a complete Epic Architecture Specification in Markdown format, saved to `/docs/ways-of-work/plan/{epic-name}/arch.md`.
|
|
|
|
### Specification Structure
|
|
|
|
#### 1. Epic Architecture Overview
|
|
|
|
- A brief summary of the technical approach for the epic.
|
|
|
|
#### 2. System Architecture Diagram
|
|
|
|
Create a comprehensive Mermaid diagram detailing the full system architecture for the epic:
|
|
|
|
```mermaid
|
|
graph TB
|
|
subgraph "User Layer"
|
|
U[Users] --> WEB[Web Browser]
|
|
U --> MOB[Mobile App]
|
|
end
|
|
|
|
subgraph "Application Layer"
|
|
WEB --> LB[Load Balancer]
|
|
MOB --> LB
|
|
LB --> APP1[App Instance 1]
|
|
LB --> APP2[App Instance 2]
|
|
|
|
APP1 --> AUTH[Stack Auth]
|
|
APP2 --> AUTH
|
|
end
|
|
|
|
subgraph "Service Layer"
|
|
APP1 --> API[tRPC API]
|
|
APP2 --> API
|
|
API --> BG[Background Services]
|
|
BG --> WORK[n8n Workflows]
|
|
end
|
|
|
|
subgraph "Data Layer"
|
|
API --> DB[(PostgreSQL)]
|
|
API --> VECTOR[(Qdrant Vector DB)]
|
|
BG --> CACHE[(Redis Cache)]
|
|
WORK --> EXT[External APIs]
|
|
end
|
|
|
|
subgraph "Infrastructure Layer"
|
|
DB --> DOCKER[Docker Containers]
|
|
VECTOR --> DOCKER
|
|
CACHE --> DOCKER
|
|
APP1 --> DOCKER
|
|
APP2 --> DOCKER
|
|
end
|
|
|
|
style U fill:#e1f5fe
|
|
style WEB fill:#f3e5f5
|
|
style MOB fill:#f3e5f5
|
|
style APP1 fill:#e8f5e8
|
|
style APP2 fill:#e8f5e8
|
|
style DB fill:#fff3e0
|
|
style VECTOR fill:#fff3e0
|
|
```
|
|
|
|
**Architecture Flow Description:**
|
|
|
|
- **Color Coding**: User interactions (blue), Applications (purple), Services (green), Data (orange)
|
|
- **Service Boundaries**: Clear separation between application zones and data persistence
|
|
- **Data Flow**: Request routing from users through load balancer to application instances
|
|
- **Integration Points**: Authentication, background processing, and external service connections
|
|
|
|
#### 3. High-Level Features & Technical Enablers
|
|
|
|
- A list of the high-level features to be built.
|
|
- A list of technical enablers (e.g., new services, libraries, infrastructure) required to support the features.
|
|
|
|
#### 4. Technology Stack
|
|
|
|
- A list of the key technologies, frameworks, and libraries to be used.
|
|
|
|
#### 5. Technical Value
|
|
|
|
- Estimate the technical value (e.g., High, Medium, Low) with a brief justification.
|
|
|
|
#### 6. T-Shirt Size Estimate
|
|
|
|
- Provide a high-level t-shirt size estimate for the epic (e.g., S, M, L, XL).
|
|
|
|
## Context Template
|
|
|
|
- **Epic PRD:** [The content of the Epic PRD markdown file]
|