ai-spector 0.1.0

package/templates/basic_design/list-screen-template.md

@@ -0,0 +1,242 @@
+# Screen Map: <Project Name>
+
+> This document provides the design system overview, screen map (navigation flow), screen index, and common UI building blocks. For detailed layout and interactions per screen, see the Detail Screen document for each screen.
+
+**Source Requirements:** SRS Section 6.1 (User Interfaces)
+
+---
+
+## 1. Design System Overview
+
+**Color Palette:**
+- Primary: <Color>
+- Secondary: <Color>
+- Accent: <Color>
+- Background: <Color>
+- Text: <Color>
+
+**Typography:**
+- Headings: <Font family, sizes>
+- Body: <Font family, sizes>
+- Buttons: <Font family, sizes>
+
+**Spacing:**
+- Base unit: <8px/4px>
+- Component spacing: <Guidelines>
+
+---
+
+## 2. Screen Map (Navigation Flow)
+
+> This diagram shows the relationships and navigation flow between all screens in the application.
+
+**Mermaid Flowchart:**
+```mermaid
+flowchart TD
+    A[Login] --> B[Dashboard]
+    B --> C[Screen 1]
+    B --> D[Screen 2]
+    B --> E[Screen 3]
+    B --> F[Screen 4]
+    C --> G[Screen 5]
+    D --> G
+    E --> G
+    F --> G
+    G --> B
+```
+
+**Detailed Navigation Map:**
+```
+┌─────────────────────────────────────────────────────────────────┐
+│                    Screen Relationship Map                      │
+└─────────────────────────────────────────────────────────────────┘
+
+Entry Point: Login Screen
+    │
+    ├─→ Dashboard (Main Hub)
+    │   │
+    │   ├─→ Screen 1 (via Navigation Menu)
+    │   │   ├─→ Screen 1A (via Action Button)
+    │   │   └─→ Screen 1B (via Action Button)
+    │   │
+    │   ├─→ Screen 2 (via Navigation Menu)
+    │   │   └─→ Screen 2A (via Modal/Detail View)
+    │   │
+    │   ├─→ Screen 3 (via Navigation Menu)
+    │   │
+    │   └─→ Screen 4 (via Navigation Menu)
+    │       └─→ Screen 4A (via Action Button)
+    │
+    └─→ [Other Entry Points]
+```
+
+**Navigation Patterns:**
+- **Primary Navigation:** <Menu type - Sidebar/Top Nav/Bottom Nav>
+- **Secondary Navigation:** <Breadcrumbs/Back buttons>
+- **Modal/Overlay Screens:** <List screens that appear as modals>
+- **Deep Links:** <Screens accessible via direct URL>
+
+**User Role-Based Navigation:**
+- **<Role 1>:** <List accessible screens>
+- **<Role 2>:** <List accessible screens>
+- **<Role 3>:** <List accessible screens>
+
+---
+
+## 3. Quick Reference: Common UI Elements
+
+> Use these ASCII patterns as building blocks when describing components in detail screens.
+
+**Card Component:**
+```
+┌─────────────────────────────┐
+│ [Icon] Title                 │
+│ ───────────────────────────  │
+│ Content text here            │
+│ [Action Button]              │
+└─────────────────────────────┘
+```
+
+**Button:**
+```
+┌──────────────┐
+│ Button Text  │
+└──────────────┘
+```
+
+**Input Field:**
+```
+┌──────────────────────────────┐
+│ Label                        │
+│ ┌──────────────────────────┐ │
+│ │ Input text here          │ │
+│ └──────────────────────────┘ │
+└──────────────────────────────┘
+```
+
+**Table/List:**
+```
+┌──────┬──────────┬──────────┐
+│ Col1 │ Col2     │ Col3     │
+├──────┼──────────┼──────────┤
+│ Data │ Data     │ Data     │
+│ Data │ Data     │ Data     │
+└──────┴──────────┴──────────┘
+```
+
+**Modal/Dialog:**
+```
+        ┌─────────────────────┐
+        │ [X] Modal Title     │
+        ├─────────────────────┤
+        │                     │
+        │ Modal Content        │
+        │                     │
+        │ [Cancel] [OK]       │
+        └─────────────────────┘
+```
+
+---
+
+## 4. Screen Index
+
+| Screen | Section (Detail Screen) | User Role | Purpose |
+|--------|-------------------------|-----------|---------|
+| <Screen 1> | 5 | <Role> | <Purpose> |
+| <Screen 2> | 6 | <Role> | <Purpose> |
+| <Screen 3> | 7 | <Role> | <Purpose> |
+
+> Each screen has a corresponding section in the Detail Screen document with wireframe, layout, and interactions.
+
+---
+
+## 5. Responsive Design Considerations
+
+**Breakpoints:**
+- Mobile: <Width>
+- Tablet: <Width>
+- Desktop: <Width>
+
+**Mobile Adaptations:**
+- <Adaptation 1>
+- <Adaptation 2>
+
+**Tablet Adaptations:**
+- <Adaptation 1>
+- <Adaptation 2>
+
+---
+
+## 6. Common UI Patterns
+
+**Buttons:**
+- Primary: <Style>
+- Secondary: <Style>
+- Danger: <Style>
+
+**Forms:**
+- Input fields: <Style>
+- Validation messages: <Style>
+- Submit buttons: <Style>
+
+**Tables/Lists:**
+- Row style: <Style>
+- Hover state: <Style>
+- Selection: <Style>
+
+**Modals/Dialogs:**
+- Size: <Dimensions>
+- Overlay: <Style>
+- Close button: <Position>
+
+---
+
+## 7. Accessibility Considerations
+
+**Keyboard Navigation:**
+- <Requirement 1>
+- <Requirement 2>
+
+**Screen Reader Support:**
+- <Requirement 1>
+- <Requirement 2>
+
+**Color Contrast:**
+- <Requirement>
+
+---
+
+## 8. Visual Resources
+
+**Design Tools:**
+> Reference tools used (Figma, Axure, Uizard, etc.)
+
+**Wireframe Files:**
+- Low-fidelity: `<path/to/wireframe.png>` or `<Figma Link>`
+- High-fidelity: `<path/to/mockup.png>` or `<Figma Link>`
+
+**Prototype Links:**
+> Add links to interactive prototypes when available.
+- Interactive prototype: `<Figma/InVision/Other Link>`
+
+**Image Placeholders:**
+> For markdown documents, you can reference images:
+```markdown
+![Screen Name Wireframe](screens/screen-name-wireframe.png)
+![Screen Name Mockup](screens/screen-name-mockup.png)
+```
+
+---
+
+## 9. Notes
+
+**Visual Guidelines:**
+> Tips for creating better visual mockups:
+- Use consistent spacing (8px grid system)
+- Show actual content examples, not just "Lorem ipsum"
+- Include error states and empty states
+- Show hover/active states for interactive elements
+
+**Future Enhancements:**
+- <Enhancement 1>
+- <Enhancement 2>

package/templates/detail_design/common/architecture-overview-template.md

@@ -0,0 +1,302 @@
+# Architecture Overview: <Project Name>
+
+> This document describes the system-wide architecture, technology stack, design principles, and architectural patterns used across all features.
+
+**Source Requirements:** SRS Section 2 (Overall Description), Section 7 (Quality Attributes)
+
+---
+
+## 1. Overview
+
+**Purpose:**
+> Describe the purpose of this architecture document and its scope.
+
+**Architecture Principles:**
+- <Principle 1: e.g., Microservices architecture, separation of concerns>
+- <Principle 2: e.g., API-first design>
+- <Principle 3: e.g., Scalability and high availability>
+- <Principle 4: e.g., Security by design>
+
+**Design Goals:**
+- <Goal 1>
+- <Goal 2>
+- <Goal 3>
+
+---
+
+## 2. System Context (C4 Level 1)
+
+> High-level view showing the system and its relationships with users and external systems.
+
+```mermaid
+C4Context
+    title System Context Diagram
+    
+    Person(user, "User", "End user of the system")
+    System(softwareSystem, "<System Name>", "Provides core functionality")
+    System_Ext(emailSystem, "Email Service", "External email service")
+    System_Ext(paymentSystem, "Payment Gateway", "External payment service")
+    
+    Rel(user, softwareSystem, "Uses")
+    Rel(softwareSystem, emailSystem, "Sends emails via")
+    Rel(softwareSystem, paymentSystem, "Processes payments via")
+```
+
+**External Systems:**
+- <External System 1>: <Purpose and relationship>
+- <External System 2>: <Purpose and relationship>
+
+**Users:**
+- <User Type 1>: <Role and interaction>
+- <User Type 2>: <Role and interaction>
+
+---
+
+## 3. Container Architecture (C4 Level 2)
+
+> Shows the high-level technical building blocks (applications, databases, file systems, etc.).
+
+```mermaid
+C4Container
+    title Container Diagram
+    
+    Person(user, "User")
+    System_Boundary(systemBoundary, "<System Name>") {
+        Container(webApp, "Web Application", "React/Next.js", "Provides UI")
+        Container(api, "API Gateway", "Node.js/Express", "REST API")
+        Container(authService, "Authentication Service", "Node.js", "Handles authentication")
+        ContainerDb(database, "Database", "PostgreSQL", "Stores data")
+        Container(messageQueue, "Message Queue", "RabbitMQ", "Handles async processing")
+    }
+    
+    System_Ext(emailService, "Email Service")
+    
+    Rel(user, webApp, "Uses")
+    Rel(webApp, api, "API calls")
+    Rel(api, authService, "Validates tokens")
+    Rel(api, database, "Reads from and writes to")
+    Rel(api, messageQueue, "Publishes messages")
+    Rel(messageQueue, emailService, "Sends emails")
+```
+
+**Containers:**
+
+| Container | Technology | Purpose | Responsibilities |
+|-----------|------------|---------|------------------|
+| Web Application | <Tech Stack> | <Purpose> | <Responsibilities> |
+| API Gateway | <Tech Stack> | <Purpose> | <Responsibilities> |
+| Database | <DBMS> | <Purpose> | <Responsibilities> |
+| Message Queue | <MQ Technology> | <Purpose> | <Responsibilities> |
+
+---
+
+## 4. Component Architecture (C4 Level 3)
+
+> Shows how containers are broken down into components (for key containers only).
+
+**Example: API Gateway Components**
+
+```mermaid
+C4Component
+    title API Gateway Component Diagram
+    
+    Container_Boundary(apiGateway, "API Gateway") {
+        Component(authController, "Auth Controller", "Express Router", "Handles authentication endpoints")
+        Component(userController, "User Controller", "Express Router", "Handles user management")
+        Component(validationMiddleware, "Validation Middleware", "Express Middleware", "Validates requests")
+        Component(errorHandler, "Error Handler", "Express Middleware", "Handles errors")
+        ComponentDb(database, "Database")
+    }
+    
+    Rel(authController, validationMiddleware, "Uses")
+    Rel(authController, errorHandler, "Uses")
+    Rel(userController, validationMiddleware, "Uses")
+    Rel(userController, database, "Reads from and writes to")
+```
+
+---
+
+## 5. Technology Stack
+
+**Frontend:**
+- Framework: <React/Vue/Angular>
+- Language: <TypeScript/JavaScript>
+- Build Tool: <Webpack/Vite>
+- State Management: <Redux/Zustand>
+- UI Library: <Material-UI/Ant Design>
+
+**Backend:**
+- Runtime: <Node.js/Python/Java>
+- Framework: <Express/FastAPI/Spring Boot>
+- Language: <TypeScript/Python/Java>
+
+**Database:**
+- Primary Database: <PostgreSQL/MySQL/MongoDB>
+- Caching: <Redis/Memcached>
+- Search: <Elasticsearch/OpenSearch> (if applicable)
+
+**Infrastructure:**
+- Containerization: <Docker>
+- Orchestration: <Kubernetes/Docker Compose>
+- Cloud Provider: <AWS/Azure/GCP>
+- CI/CD: <GitHub Actions/Jenkins/GitLab CI>
+
+**Other Services:**
+- Message Queue: <RabbitMQ/Apache Kafka>
+- Monitoring: <Prometheus/Grafana>
+- Logging: <ELK Stack/CloudWatch>
+
+---
+
+## 6. Architectural Patterns
+
+**Pattern 1: <Pattern Name>**
+- **Description:** <Description of the pattern>
+- **Rationale:** <Why this pattern is used>
+- **Implementation:** <How it's implemented>
+
+**Pattern 2: <Pattern Name>**
+- **Description:** <Description>
+- **Rationale:** <Rationale>
+- **Implementation:** <Implementation>
+
+**Common Patterns:**
+- **Layered Architecture:** <Description>
+- **Microservices:** <Description>
+- **Event-Driven Architecture:** <Description>
+- **API Gateway Pattern:** <Description>
+- **Database per Service:** <Description>
+
+---
+
+## 7. Design Principles
+
+**Separation of Concerns:**
+> Each component/module should have a single, well-defined responsibility.
+
+**Loose Coupling:**
+> Components should interact through well-defined interfaces, minimizing dependencies.
+
+**High Cohesion:**
+> Related functionality should be grouped together within components.
+
+**Scalability:**
+> System should be designed to handle growth in users, data, and transactions.
+
+**Security:**
+> Security should be built into every layer of the architecture.
+
+**Observability:**
+> System should provide visibility into its operations through logging, monitoring, and tracing.
+
+---
+
+## 8. System Boundaries
+
+**Internal Components:**
+- <Component 1>
+- <Component 2>
+
+**External Dependencies:**
+- <External Service 1>: <Purpose, SLA>
+- <External Service 2>: <Purpose, SLA>
+
+**Integration Points:**
+- <Integration Point 1>: <Protocol, format>
+- <Integration Point 2>: <Protocol, format>
+
+---
+
+## 9. Data Flow
+
+**High-Level Data Flow:**
+
+```mermaid
+flowchart LR
+    User[User] -->|Request| WebApp[Web Application]
+    WebApp -->|API Call| APIGateway[API Gateway]
+    APIGateway -->|Query| Database[(Database)]
+    APIGateway -->|Publish| MessageQueue[Message Queue]
+    MessageQueue -->|Process| WorkerService[Worker Service]
+    WorkerService -->|Update| Database
+```
+
+**Data Flow Patterns:**
+- **Request-Response:** <Description>
+- **Event-Driven:** <Description>
+- **Batch Processing:** <Description>
+
+---
+
+## 10. Non-Functional Requirements
+
+**Performance:**
+- API Response Time: <Target, e.g., < 200ms for 95th percentile>
+- Throughput: <Target, e.g., 1000 requests/second>
+- Database Query Time: <Target>
+
+**Scalability:**
+- Horizontal Scaling: <Approach>
+- Vertical Scaling: <Approach>
+- Auto-scaling: <Configuration>
+
+**Availability:**
+- Target Uptime: <99.9%>
+- Disaster Recovery: <Strategy>
+- Backup Strategy: <Strategy>
+
+**Security:**
+- Authentication: <Method>
+- Authorization: <Method>
+- Data Encryption: <At rest, in transit>
+- Compliance: <Standards>
+
+---
+
+## 11. Deployment Architecture
+
+**Environments:**
+- Development: <Description>
+- Staging: <Description>
+- Production: <Description>
+
+**Deployment Strategy:**
+- <Blue-Green/Canary/Rolling Update>
+
+**Infrastructure Components:**
+- Load Balancer: <Type and configuration>
+- Application Servers: <Number and configuration>
+- Database: <Configuration and replication>
+- Caching Layer: <Configuration>
+
+---
+
+## 12. References
+
+**Related Documents:**
+- [Security Patterns](../common/security-patterns-template.md)
+- [Performance Standards](../common/performance-standards-template.md)
+- [Integration Patterns](../common/integration-patterns-template.md)
+- [Deployment & Infrastructure](../common/deployment-infrastructure-template.md)
+- [Basic Design - API Design](../../basic_design/api-design-template.md)
+- [Basic Design - Database Design](../../basic_design/db-design-template.md)
+
+**SRS References:**
+- SRS Section 2: Overall Description
+- SRS Section 7: Quality Attributes
+
+---
+
+## 13. Notes
+
+**Design Decisions:**
+- <Decision 1>: <Rationale>
+- <Decision 2>: <Rationale>
+
+**Trade-offs:**
+- <Trade-off 1>: <Decision and rationale>
+- <Trade-off 2>: <Decision and rationale>
+
+**Future Considerations:**
+- <Future enhancement 1>
+- <Future enhancement 2>