specpulse 1.4.0__py3-none-any.whl → 1.4.2__py3-none-any.whl

specpulse/resources/templates/plan.md

@@ -1,230 +1,139 @@
-<!-- SpecPulse Implementation Plan Template v4.0 - AI-Optimized -->
-<!-- AI Instructions: Generate plan from specification following SDD gates -->
-
-# Implementation Plan: {{ feature_name }}
+# Implementation Plan: {{feature_name}}
 
 ## Specification Reference
-- **Spec ID**: SPEC-{{ feature_id }}
-- **Branch**: {{ branch_name }}
-- **Generated**: {{ date }}
-- **Optimization Focus**: {{ optimization_focus | default("SIMPLICITY") }}
-
-## Phase -1: Pre-Implementation Gates
-
-### SDD Compliance Check
-**ENSURE SPECIFICATION-DRIVEN DEVELOPMENT PRINCIPLES ARE FOLLOWED**
-
-#### Principle 1: Specification First
-- [ ] Clear specifications written?
-- [ ] User stories and acceptance criteria defined?
-- [ ] [NEEDS CLARIFICATION] markers for unknowns?
-- [ ] Functional and non-functional requirements documented?
-
-#### Principle 2: Incremental Planning
-- [ ] Work broken into phases?
-- [ ] Each phase delivers value?
-- [ ] Milestones and checkpoints defined?
-- [ ] Features prioritized by business value?
-
-#### Principle 3: Task Decomposition
-- [ ] Tasks are specific and actionable?
-- [ ] Effort estimates provided?
-- [ ] Definition of Done clear?
-- [ ] Tasks can be picked up immediately?
-
-#### Principle 4: Traceable Implementation
-- [ ] Code will reference spec requirements?
-- [ ] Commits will link to tasks?
-- [ ] Bidirectional traceability planned?
-- [ ] Spec updates process defined?
-
-#### Principle 5: Continuous Validation
-- [ ] Validation checkpoints identified?
-- [ ] Acceptance tests planned?
-- [ ] Spec-code sync process defined?
-- [ ] Regular validation scheduled?
-
-#### Principle 6: Quality Assurance
-- [ ] Test strategy appropriate for project type?
-- [ ] Acceptance criteria testable?
-- [ ] Code review process defined?
-- [ ] Quality metrics identified?
-
-#### Principle 7: Architecture Documentation
-- [ ] Technology choices documented?
-- [ ] Integration points identified?
-- [ ] Technical debt tracking planned?
-- [ ] ADR process established?
-
-#### Principle 8: Iterative Refinement
-- [ ] Feedback loops established?
-- [ ] Spec versioning process defined?
-- [ ] Learning capture process planned?
-- [ ] Refinement triggers identified?
-
-#### Principle 9: Stakeholder Alignment
-- [ ] Stakeholders identified?
-- [ ] Communication plan established?
-- [ ] Approval process defined?
-- [ ] Change management process clear?
-
-**Gate Status**: {{ gate_status | default("[ ] PENDING") }}
-
-## Architecture Decisions
-{% if architectural_decisions %}
-{% for decision in architectural_decisions %}
-### Decision {{ loop.index }}
-- **Area**: {{ decision.area }}
-- **Decision**: {{ decision.decision }}
-- **Rationale**: {{ decision.rationale }}
-- **Trade-offs**: {{ decision.trade_offs }}
-{% endfor %}
-{% else %}
-No significant architectural decisions documented yet.
-{% endif %}
-
-## Technology Stack
-
-### Core Technologies
-{% for tech in core_technologies %}
-- **{{ tech.name }}**: {{ tech.version }} - {{ tech.purpose }}
-{% endfor %}
-
-### Dependencies
-{% for dep in dependencies %}
-- **{{ dep.name }}**: {{ dep.reason }}
-{% endfor %}
+- **Spec ID**: SPEC-{{spec_id}}
+- **Generated**: {{date}}
+- **Optimization Focus**: {{optimization_focus}}
 
 ## Architecture Overview
-
-### System Components
-{% for component in components %}
-#### {{ component.name }}
-- **Purpose**: {{ component.purpose }}
-- **Key Features**: {{ component.features }}
-- **Dependencies**: {{ component.dependencies | join(", ") }}
-{% endfor %}
-
-### Data Models
-{% for model in data_models %}
-#### {{ model.name }}
-- **Fields**: {{ model.fields | join(", ") }}
-- **Relationships**: {{ model.relationships }}
-- **Validation**: {{ model.validation }}
-{% endfor %}
-
-## Implementation Phases
-
-### Phase 0: Critical Path (Week {{ phase_0.weeks | default(1) }})
-{% for task in phase_0.tasks %}
-- [ ] {{ task.description }}
-{% endfor %}
-
-### Phase 1: Foundation (Week {{ phase_1.weeks | default(2) }})
-{% for task in phase_1.tasks %}
-- [ ] {{ task.description }}
-{% endfor %}
-
-### Phase 2: Core Features (Week {{ phase_2.weeks | default(3) }})
-{% for task in phase_2.tasks %}
-- [ ] {{ task.description }}
-{% endfor %}
-
-### Phase 3: Polish (Week {{ phase_3.weeks | default(1) }})
-{% for task in phase_3.tasks %}
-- [ ] {{ task.description }}
-{% endfor %}
-
-## API Contracts
-
-### Endpoints
-{% for endpoint in endpoints %}
-#### {{ endpoint.method }} {{ endpoint.path }}
-- **Description**: {{ endpoint.description }}
-- **Request**: {{ endpoint.request }}
-- **Response**: {{ endpoint.response }}
-- **Authentication**: {{ endpoint.auth | default("Required") }}
-{% endfor %}
-
-### Data Schemas
-{% for schema in schemas %}
-#### {{ schema.name }}
-```json
-{{ schema.json | indent(4) }}
+```mermaid
+graph TD
+    A[User Interface] --> B[Business Logic]
+    B --> C[Data Layer]
+    C --> D[Database]
 ```
-{% endfor %}
-
-## Testing Strategy
-
-### Test Categories
-- **Unit Tests**: {{ testing.unit.target | default("80% coverage") }}
-- **Integration Tests**: {{ testing.integration.target | default("Critical paths") }}
-- **E2E Tests**: {{ testing.e2e.target | default("Key user workflows") }}
-- **Performance Tests**: {{ testing.performance.target | default("Load testing") }}
-
-### Test Environment
-- **Database**: {{ testing.environment.database | default("PostgreSQL") }}
-- **Services**: {{ testing.environment.services | join(", ") }}
-- **Test Data**: {{ testing.environment.data_strategy | default("Seed with realistic data") }}
-
-## Security Considerations
-
-### Authentication & Authorization
-- **Method**: {{ security.auth_method | default("JWT tokens") }}
-- **Roles**: {{ security.roles | join(", ") }}
-- **Permissions**: {{ security.permissions_model | default("Role-based access control") }}
-
-### Data Protection
-- **Encryption**: {{ security.encryption.transit | default("TLS 1.3") }} in transit, {{ security.encryption.at_rest | default("AES-256") }} at rest
-- **Compliance**: {{ security.compliance | join(", ") }}
-
-## Deployment Strategy
-
-### Environments
-{% for env in environments %}
-#### {{ env.name }}
-- **URL**: {{ env.url }}
-- **Auto-deploy**: {{ env.auto_deploy | default("Manual") }}
-- **Health Checks**: {{ env.health_checks | default("Basic monitoring") }}
-{% endfor %}
-
-### Rollback Plan
-- **Strategy**: {{ rollback.strategy | default("Blue-green deployment") }}
-- **Triggers**: {{ rollback.triggers | join(", ") }}
-- **Recovery Time**: {{ rollback.recovery_time | default("< 5 minutes") }}
-
-## Success Criteria
-
-### Must-Have Metrics
-{% for metric in success_criteria.must %}
-- {{ metric.name }}: {{ metric.target }} ({{ metric.measurement }})
-{% endfor %}
-
-### Should-Have Metrics
-{% for metric in success_criteria.should %}
-- {{ metric.name }}: {{ metric.target }} ({{ metric.measurement }})
-{% endfor %}
-
-## Risk Assessment
-
-| Risk | Probability | Impact | Mitigation | Owner |
-|------|------------|--------|------------|-------|
-{% for risk in risks %}
-| {{ risk.description }} | {{ risk.probability }} | {{ risk.impact }} | {{ risk.mitigation }} | {{ risk.owner }} |
-{% endfor %}
-
-## Monitoring & Observability
-
-### Key Metrics
-{% for metric in monitoring.metrics %}
-- **{{ metric.name }}**: {{ metric.target }} ({{ metric.unit }})
-{% endfor %}
-
-### Alerting
-- **Critical Alerts**: {{ monitoring.alerts.critical | join(", ") }}
-- **Warning Alerts**: {{ monitoring.alerts.warnings | join(", ") }}
-
----
-**Generated by**: {{ ai_assistant }} on {{ date }}
-**SDD Gates**: {{ gate_status | default("PENDING") }}
-**Next Steps**: Use `/sp-task breakdown` to break down into executable tasks
+
+## Phase -1: Pre-Implementation Gates
+**SDD Compliance Check** - Must pass before coding:
+- [ ] Specification First - Complete spec with no ambiguities
+- [ ] Incremental Planning - Phases clearly defined
+- [ ] Task Decomposition - Tasks are concrete and executable
+- [ ] Quality Assurance - Testing strategy defined
+- [ ] Architecture Documentation - Technical decisions recorded
+
+## Phase 0: Foundation
+### Objectives
+- Set up project structure
+- Configure development environment
+- Initialize core components
+
+### Tasks
+- [ ] Create project scaffolding
+- [ ] Set up dependencies
+- [ ] Configure build system
+- [ ] Initialize testing framework
+
+### Success Criteria
+- Development environment operational
+- All team members can build and run
+- Basic CI/CD pipeline functional
+
+## Phase 1: Core Implementation
+### Objectives
+- Implement primary functionality
+- Create essential features
+- Establish data models
+
+### Tasks
+- [ ] Implement data models
+- [ ] Create core business logic
+- [ ] Build primary API endpoints
+- [ ] Develop basic UI components
+
+### Success Criteria
+- Core features working end-to-end
+- Unit tests passing
+- Integration tests defined
+
+## Phase 2: Enhancement
+### Objectives
+- Add secondary features
+- Improve user experience
+- Optimize performance
+
+### Tasks
+- [ ] Implement additional features
+- [ ] Add error handling
+- [ ] Optimize database queries
+- [ ] Enhance UI/UX
+
+### Success Criteria
+- All features implemented
+- Performance targets met
+- Error handling comprehensive
+
+## Phase 3: Polish & Deploy
+### Objectives
+- Final testing and bug fixes
+- Documentation completion
+- Production deployment
+
+### Tasks
+- [ ] Complete integration testing
+- [ ] Fix identified bugs
+- [ ] Write user documentation
+- [ ] Deploy to production
+
+### Success Criteria
+- All tests passing
+- Documentation complete
+- Successfully deployed
+
+## Technical Decisions
+
+### Architecture Pattern
+- **Pattern**: {{architecture_pattern}}
+- **Rationale**: [Why this pattern was chosen]
+
+### Technology Stack
+- **Frontend**: {{frontend_stack}}
+- **Backend**: {{backend_stack}}
+- **Database**: {{database}}
+- **Infrastructure**: {{infrastructure}}
+
+### Key Design Decisions
+1. **Decision 1**: [Description and rationale]
+2. **Decision 2**: [Description and rationale]
+3. **Decision 3**: [Description and rationale]
+
+## Risk Management
+
+### Identified Risks
+1. **Risk**: [Description]
+   - **Probability**: [High|Medium|Low]
+   - **Impact**: [High|Medium|Low]
+   - **Mitigation**: [Strategy]
+
+2. **Risk**: [Description]
+   - **Probability**: [High|Medium|Low]
+   - **Impact**: [High|Medium|Low]
+   - **Mitigation**: [Strategy]
+
+## Resource Requirements
+- **Team Size**: {{team_size}}
+- **Timeline**: {{timeline}}
+- **Budget**: {{budget}}
+- **Tools**: {{required_tools}}
+
+## Dependencies
+- External services required
+- Third-party libraries
+- Other team deliverables
+
+## Monitoring & Success Metrics
+- Performance metrics to track
+- Business metrics to measure
+- Quality metrics to monitor
+
+## Notes
+<!-- Additional implementation notes -->

specpulse/resources/templates/spec.md

@@ -1,125 +1,94 @@
-<!-- SpecPulse Specification Template v4.0 - AI-Optimized -->
-<!-- AI Instructions:
-    1. Replace all {{variable}} placeholders with actual values
-    2. Fill sections based on user input and requirements analysis
-    3. Mark ALL uncertainties with [NEEDS CLARIFICATION: specific question]
-    4. Keep requirements testable and unambiguous
-    5. Focus on WHAT and WHY, not HOW
--->
-
-# Specification: {{ feature_name }}
-
-## Metadata
-- **ID**: SPEC-{{ feature_id }}
-- **Branch**: {{ branch_name }}
-- **Created**: {{ date }}
-- **Author**: {{ author }}
-- **AI Assistant**: {{ ai_assistant }}
-- **Version**: 1.0.0
-- **Status**: DRAFT
-
-## Executive Summary
-{{ executive_summary | default("Brief description of what this feature does and why it's needed") }}
-
-## User Request
-```
-{{ user_input }}
-```
-
-## Problem Statement
-
-### Current State
-{{ current_state | default("Describe the current situation and pain points") }}
-
-### Desired State  
-{{ desired_state | default("Describe what should be achieved after implementation") }}
-
-## Clarifications Needed
-<!-- List ALL ambiguities from user input -->
-{% if clarifications %}
-{% for clarification in clarifications %}
-- [NEEDS CLARIFICATION: {{ clarification }}]
-{% endfor %}
-{% else %}
-- [NEEDS CLARIFICATION: Add specific questions based on user input]
-{% endif %}
-
-## User Stories
-
-### Primary Stories
-{% for story in user_stories %}
-#### Story {{ loop.index }}: {{ story.title }}
-**As a** {{ story.user_type }}
-**I want to** {{ story.action }}
-**So that** {{ story.benefit }}
-
-**Acceptance Criteria:**
-{% for criteria in story.acceptance_criteria %}
-- Given {{ criteria.given }}, when {{ criteria.when }}, then {{ criteria.then }}
-{% endfor %}
-{% endfor %}
-
-## Functional Requirements
-
-### MUST Have Requirements
-{% for req in must_requirements %}
-**FR-{{ "%03d" | format(loop.index0 + 1) }}**: {{ req.statement }}
-- **Rationale**: {{ req.rationale }}
-- **Testable**: Yes
-{% endfor %}
-
-### SHOULD Have Requirements
-{% for req in should_requirements %}
-**FR-{{ "%03d" | format(loop.index0 + len(must_requirements) + 1) }}**: {{ req.statement }}
-- **Rationale**: {{ req.rationale }}
-- **Testable**: Yes
-{% endfor %}
-
-## Non-Functional Requirements
-
-### Performance
-- Response time < {{ performance.response_time | default("200ms") }}
-- Support {{ performance.concurrent_users | default("1000") }} concurrent users
-
-### Security
-- All data encrypted in transit
-- {{ security.authentication | default("Authentication required for sensitive actions") }}
-
-## Acceptance Scenarios
-
-### Critical Path
-1. **Scenario**: {{ primary_scenario.name }}
-   - **When**: {{ primary_scenario.action }}
-   - **Then**: {{ primary_scenario.result }}
-
-### Error Cases
-1. **Scenario**: {{ error_scenario.name }}
-   - **When**: {{ error_scenario.action }}
-   - **Then**: {{ error_scenario.result }}
-
-## Success Metrics
-- Adoption rate: {{ metrics.adoption_rate | default("80% within 30 days") }}
-- Success rate: {{ metrics.success_rate | default("95% of attempts") }}
-- User satisfaction: {{ metrics.satisfaction | default("8/10 NPS") }}
-
-## Out of Scope
-<!-- Explicitly state what this feature will NOT do -->
-{% for item in out_of_scope %}
-- This feature will NOT {{ item }}
-{% endfor %}
-
-## Dependencies
-{% for dep in dependencies %}
-- {{ dep }}
-{% endfor %}
-
-## Validation Checklist
-- [ ] All MUST requirements implemented
-- [ ] All acceptance criteria pass
-- [ ] No [NEEDS CLARIFICATION] markers remain
-- [ ] Performance targets met
-- [ ] Security requirements validated
-
----
-**Generated by**: {{ ai_assistant }} on {{ date }}
-**Next Steps**: Use `/sp-plan generate` to create implementation plan
+# Specification: {{feature_name}}
+
+## Metadata
+- **ID**: SPEC-{{spec_id}}
+- **Created**: {{date}}
+- **Author**: {{author}}
+- **AI Assistant**: {{ai_assistant}}
+- **Version**: 1.0.0
+
+## Executive Summary
+[One paragraph description of what this feature does and why it's needed]
+
+## Problem Statement
+[Detailed description of the problem being solved]
+
+## Proposed Solution
+[High-level approach to solving the problem]
+
+## Detailed Requirements
+
+### Functional Requirements
+<!-- AI: Generate numbered list of specific, testable requirements -->
+
+FR-001: [Requirement]
+  - Acceptance: [How to verify this requirement is met]
+  - Priority: [MUST|SHOULD|COULD]
+
+FR-002: [Requirement]
+  - Acceptance: [How to verify this requirement is met]
+  - Priority: [MUST|SHOULD|COULD]
+
+### Non-Functional Requirements
+
+#### Performance
+- Response Time: [Target]
+- Throughput: [Target]
+- Resource Usage: [Limits]
+
+#### Security
+- Authentication: [Method]
+- Authorization: [Model]
+- Data Protection: [Requirements]
+
+#### Scalability
+- User Load: [Target]
+- Data Volume: [Target]
+- Geographic Distribution: [Requirements]
+
+## User Stories
+
+<!-- AI: Generate user stories in standard format -->
+
+### Story 1: [Title]
+**As a** [user type]
+**I want** [action/feature]
+**So that** [benefit/value]
+
+**Acceptance Criteria:**
+- [ ] [Criterion 1]
+- [ ] [Criterion 2]
+- [ ] [Criterion 3]
+
+### Story 2: [Title]
+**As a** [user type]
+**I want** [action/feature]
+**So that** [benefit/value]
+
+**Acceptance Criteria:**
+- [ ] [Criterion 1]
+- [ ] [Criterion 2]
+- [ ] [Criterion 3]
+
+## Technical Constraints
+<!-- List any technical limitations or requirements -->
+
+## Dependencies
+<!-- External services, libraries, or other features required -->
+
+## Risks and Mitigations
+<!-- Identify potential risks and how to address them -->
+
+## Success Criteria
+<!-- Define what success looks like for this feature -->
+- [ ] All functional requirements implemented
+- [ ] All user stories completed
+- [ ] Performance targets met
+- [ ] Security requirements satisfied
+
+## Open Questions
+<!-- Mark with [NEEDS CLARIFICATION] for items requiring user input -->
+- [NEEDS CLARIFICATION: Specific detail about requirement]
+
+## Appendix
+<!-- Additional diagrams, mockups, or references -->