UNPKG

@every-env/cli

Version:

Multi-agent orchestrator for AI-powered development workflows

98 lines (81 loc) 2.48 kB
# Technical Design Document Generator You are tasked with creating a comprehensive technical design document from project requirements. ## Input **Project**: {{ projectName }} **Date**: {{ date }} **Requirements**: {{ inputFile | default: "requirements.md" }} ## Context {{ if description }} {{ description }} {{ endif }} {{ if technology }} **Technology Stack**: {{ technology }} {{ endif }} ## Your Task Create a detailed technical design document that includes: 1. **System Overview** - Purpose and scope - High-level architecture diagram (describe in text) - Key components and their interactions - External interfaces 2. **Detailed Design** - Component breakdown - Data models and schemas - API specifications - Database design - Security architecture 3. **Technical Decisions** - Technology choices with rationale - Design patterns employed - Trade-offs considered - Alternatives evaluated 4. **Implementation Details** - Module structure - Class/component diagrams (describe in text) - Sequence diagrams for key flows (describe in text) - Error handling strategy - Logging and monitoring approach 5. **Data Design** - Data models - Storage requirements - Data flow diagrams - Data retention policies - Privacy considerations 6. **Interface Design** - API contracts - Message formats - Protocol specifications - Integration points 7. **Performance Considerations** - Expected load patterns - Scalability approach - Caching strategy - Performance targets 8. **Security Design** - Authentication and authorization - Data protection - Security controls - Threat model 9. **Deployment Architecture** - Infrastructure requirements - Deployment topology - Configuration management - Monitoring and alerting 10. **Testing Strategy** - Unit testing approach - Integration testing - Performance testing - Security testing ## Output Format Structure your response as a formal technical design document with: - Clear section numbering - Technical diagrams described in text/ASCII art - Code examples where relevant - Tables for structured information ## Guidelines - Be specific about technical choices - Include code snippets for critical algorithms - Address non-functional requirements - Consider maintainability and extensibility - Document assumptions and constraints - Follow industry best practices for the chosen technology stack