specweave 0.1.0

package/src/templates/docs/adr-template.md

@@ -0,0 +1,118 @@
+# ADR 0001: [Decision Title]
+
+**Status**: draft | review | approved | deprecated
+**Author**: [Your Name]
+**Created**: YYYY-MM-DD
+**Last Updated**: YYYY-MM-DD
+**Reviewers**: @architect, @tech-lead
+
+---
+
+## Status
+
+**Current**: draft | review | approved | deprecated
+
+**If deprecated**:
+- **Superseded by**: [Link to new ADR]
+- **Reason**: Why this decision was changed
+
+## Context
+
+**What's the situation?**
+
+Describe the context and background:
+- What problem are we solving?
+- What constraints exist?
+- What are the requirements?
+- Who are the stakeholders?
+
+## Decision
+
+**What did we decide?**
+
+Clearly state the decision made:
+- What are we doing?
+- How are we implementing it?
+- What technology/approach are we using?
+
+**Example**:
+> We will use **Next.js** as our frontend framework for the web application.
+
+### Architecture Diagram (Optional)
+
+**Diagram File**: `0001-{decision-title}.context.mmd` (co-located with this file)
+
+If the decision involves architecture changes, include a diagram:
+
+```mermaid
+graph TB
+    Client[Client] --> NextJS[Next.js App]
+    NextJS --> API[API Server]
+    API --> DB[(Database)]
+```
+
+**See**: [Diagram Conventions](../delivery/guides/diagram-conventions-comprehensive.md) for best practices.
+
+## Consequences
+
+**What's the impact?**
+
+### Positive Consequences ✅
+- **Pro 1**: Benefit of this decision
+- **Pro 2**: Benefit of this decision
+- **Pro 3**: Benefit of this decision
+
+### Negative Consequences ❌
+- **Con 1**: Drawback of this decision
+- **Con 2**: Drawback of this decision
+- **Con 3**: Drawback of this decision
+
+### Neutral Consequences
+- **Impact 1**: Neither positive nor negative
+- **Impact 2**: Neither positive nor negative
+
+## Alternatives Considered
+
+**What else did we consider?**
+
+### Alternative 1: [Name]
+- **Description**: What is it?
+- **Pros**: Benefits
+- **Cons**: Drawbacks
+- **Why not chosen**: Reason we didn't select this
+
+### Alternative 2: [Name]
+- **Description**: What is it?
+- **Pros**: Benefits
+- **Cons**: Drawbacks
+- **Why not chosen**: Reason we didn't select this
+
+### Alternative 3: [Name]
+- **Description**: What is it?
+- **Pros**: Benefits
+- **Cons**: Drawbacks
+- **Why not chosen**: Reason we didn't select this
+
+## References
+
+**Related documentation and resources**
+
+- [PRD: Product Requirements](../../strategy/prd-{feature}.md)
+- [HLD: System Design](../hld-{system}.md)
+- [RFC: API Design](../rfc/0001-{feature}.md)
+- External resources: Links to articles, documentation, etc.
+
+## Notes
+
+**Additional context**
+
+- Discussion notes
+- Meeting decisions
+- Future considerations
+
+---
+
+**Approval**:
+- [ ] Architect: @name
+- [ ] Tech Lead: @name
+- [ ] Security (if applicable): @name

package/src/templates/docs/hld-template.md

@@ -0,0 +1,220 @@
+# HLD: [System Name]
+
+**Status**: draft | review | approved | deprecated
+**Author**: [Your Name]
+**Created**: YYYY-MM-DD
+**Last Updated**: YYYY-MM-DD
+**Reviewers**: @architect, @tech-lead
+
+---
+
+## Context
+
+**Why does this system exist?**
+
+Link to the business requirements and explain the context:
+- **PRD**: [Link to PRD](../strategy/prd-{feature}.md)
+- **Business Problem**: What are we solving?
+- **Goals**: What are we trying to achieve?
+
+## Requirements (Functional / Non-functional)
+
+### Functional Requirements
+- **FR1**: Feature requirement 1
+- **FR2**: Feature requirement 2
+- **FR3**: Feature requirement 3
+
+### Non-Functional Requirements
+- **Performance**: <XXms latency, XX req/sec throughput
+- **Scalability**: Support XX concurrent users
+- **Availability**: XX% uptime (SLO)
+- **Reliability**: < XX errors per million requests
+- **Security**: Authentication, authorization, encryption
+- **Compliance**: GDPR, HIPAA, SOC 2, etc.
+
+## Architecture Overview (diagram)
+
+**High-level component diagram**
+
+**Diagram File**: `hld-{system-name}.context.mmd` (co-located with this file)
+
+```mermaid
+graph TB
+    Client[Client Application]
+    API[API Gateway]
+    Service1[Service 1]
+    Service2[Service 2]
+    DB[(Database)]
+    Cache[(Cache)]
+
+    Client --> API
+    API --> Service1
+    API --> Service2
+    Service1 --> DB
+    Service2 --> DB
+    Service1 --> Cache
+    Service2 --> Cache
+```
+
+**Component Description**:
+- **Client Application**: Web/mobile app
+- **API Gateway**: Entry point, authentication, rate limiting
+- **Service 1**: Core business logic
+- **Service 2**: Secondary service
+- **Database**: PostgreSQL, primary data store
+- **Cache**: Redis, caching layer
+
+**Related Diagrams**:
+- `hld-{system-name}.context.mmd` - System context (this diagram)
+- `hld-{system-name}.sequence-auth.mmd` - Authentication flow
+- `hld-{system-name}.entity.mmd` - Data model
+
+**See**: [Diagram Conventions](../delivery/guides/diagram-conventions-comprehensive.md) for best practices.
+
+## Data Model
+
+**Entities and relationships**
+
+```mermaid
+erDiagram
+    USER ||--o{ ORDER : places
+    ORDER ||--|{ ORDER_ITEM : contains
+    ORDER_ITEM }|--|| PRODUCT : references
+
+    USER {
+        uuid id PK
+        string email
+        string name
+        timestamp created_at
+    }
+
+    ORDER {
+        uuid id PK
+        uuid user_id FK
+        decimal total
+        string status
+        timestamp created_at
+    }
+
+    ORDER_ITEM {
+        uuid id PK
+        uuid order_id FK
+        uuid product_id FK
+        int quantity
+        decimal price
+    }
+
+    PRODUCT {
+        uuid id PK
+        string name
+        decimal price
+        int stock
+    }
+```
+
+**Schema Details**:
+- **Users**: User accounts, authentication
+- **Orders**: Purchase orders
+- **Order Items**: Line items in orders
+- **Products**: Product catalog
+
+## Integrations
+
+**External systems and APIs**
+
+### External Services
+- **Stripe**: Payment processing
+  - **Integration**: REST API
+  - **Authentication**: API key
+  - **Data Shared**: Payment details, customer info
+
+- **SendGrid**: Email delivery
+  - **Integration**: REST API
+  - **Authentication**: API key
+  - **Data Shared**: Email addresses, templates
+
+### Internal Services
+- **Auth Service**: Authentication/authorization
+- **Notification Service**: Email, SMS, push notifications
+
+## Security & Privacy
+
+### Authentication
+- **Method**: OAuth 2.0, JWT tokens
+- **MFA**: Optional multi-factor authentication
+- **Session Management**: 24-hour token expiry
+
+### Authorization
+- **Model**: Role-Based Access Control (RBAC)
+- **Roles**: Admin, User, Guest
+- **Permissions**: Resource-level permissions
+
+### Data Encryption
+- **In Transit**: TLS 1.3
+- **At Rest**: AES-256 encryption
+- **Secrets Management**: HashiCorp Vault / AWS Secrets Manager
+
+### Compliance
+- **GDPR**: User data deletion, consent management
+- **HIPAA**: (if applicable) PHI handling
+- **SOC 2**: Access controls, audit logging
+
+## Scaling & Capacity
+
+### Performance Targets
+- **Latency**: p95 < 200ms, p99 < 500ms
+- **Throughput**: 1000 req/sec
+- **Concurrent Users**: 10,000
+
+### Scaling Strategy
+- **Horizontal Scaling**: Auto-scaling groups
+- **Database**: Read replicas, connection pooling
+- **Caching**: Redis for frequently accessed data
+- **CDN**: CloudFlare for static assets
+
+### Capacity Planning
+- **Current**: XXX users, XXX req/sec
+- **6 months**: XXX users, XXX req/sec
+- **12 months**: XXX users, XXX req/sec
+
+## Trade-offs
+
+**Design compromises and rationale**
+
+### Trade-off 1: [Decision]
+- **Choice**: What we chose
+- **Alternative**: What we didn't choose
+- **Reason**: Why we made this choice
+- **Impact**: Consequences
+
+### Trade-off 2: [Decision]
+- **Choice**: What we chose
+- **Alternative**: What we didn't choose
+- **Reason**: Why we made this choice
+- **Impact**: Consequences
+
+## Open Questions
+
+**Unresolved issues**
+
+- [ ] **Q1**: Question about X?
+  - **Owner**: @name
+  - **Due Date**: YYYY-MM-DD
+
+- [ ] **Q2**: Question about Y?
+  - **Owner**: @name
+  - **Due Date**: YYYY-MM-DD
+
+## Related Documentation
+
+- [PRD: Product Requirements](../strategy/prd-{feature}.md)
+- [ADR: Architecture Decisions](adr/)
+- [RFC: API Specifications](rfc/)
+- [Runbook: Operations](../operations/runbook-{service}.md)
+
+---
+
+**Approval**:
+- [ ] Architect: @name
+- [ ] Tech Lead: @name
+- [ ] Security: @name