sdd-workflow 1.1.0

package/templates/specify/templates/spec-template.md

@@ -0,0 +1,214 @@
+# 功能规格说明 (Specification)
+
+> 功能编号: {feature_id}
+> 创建日期: {date}
+> 状态: 草稿
+> 作者: {author}
+
+<!--
+Important: Spec describes What (what to do), not How (how to do it).
+Forbidden: SQL, code snippets, file paths, class/method names, modification lists.
+These belong in plan.md and tasks.md.
+-->
+
+## 0. Requirement Traceability
+
+> Record the original source of requirements for traceability
+
+### 0.1 Requirement Source
+| Item | Content |
+|------|---------|
+| Source Type | {source_type} <!-- KB/PRD/Verbal/Other --> |
+| Source URL | {source_url} <!-- if available --> |
+| Requirement Owner | {requirement_owner} |
+| Requirement Version | {requirement_version} |
+
+### 0.2 Original Requirement Document
+{#if has_source}
+**Original Requirement**: `requirements/original.md`
+
+This specification is based on the original requirement document. See original document for details.
+
+{#if has_child_pages}
+**Related Sub-pages**:
+{child_pages_list}
+{/if}
+{#else}
+*This feature is technology-driven or has no formal requirement document*
+{/if}
+
+### 0.3 Requirement Change Log
+| Date | Change | Changed By |
+|------|--------|------------|
+| {date} | Initial requirement | {author} |
+
+---
+
+## 1. Feature Overview
+
+### 1.1 Feature Name
+{feature_name}
+
+### 1.2 Feature Description
+<!-- Describe the core goal in 2-3 sentences -->
+{feature_description}
+
+### 1.3 Business Background
+
+#### Pain Points
+<!-- Describe current problems and difficulties users face -->
+{business_pain_points}
+
+#### Solution Overview
+<!-- Describe how to solve these problems in business language -->
+{solution_overview}
+
+### 1.4 Related Modules
+<!-- Only module names and business functions, no file paths or class names -->
+| Module | Business Function | Description |
+|--------|-------------------|-------------|
+| {module_name} | {business_function} | {description} |
+
+---
+
+## 2. User Stories
+
+### User Story 1: {story_title}
+**As** {user_role}
+**I want** {goal}
+**So that** {benefit}
+
+**Acceptance Criteria:**
+- [ ] Given {condition}, When {action}, Then {result}
+- [ ] Given {condition}, When {action}, Then {result}
+
+### User Story 2: {story_title}
+...
+
+---
+
+## 3. Functional Requirements
+
+### 3.1 Core Features
+| Feature | Description | Priority | Notes |
+|---------|-------------|----------|-------|
+| {feature_1} | {description} | P0 | |
+| {feature_2} | {description} | P1 | |
+
+### 3.2 UI Requirements
+
+#### 3.2.1 Page Layout
+<!-- Describe page structure in simple ASCII, focus on user-visible content -->
+{page_layout_description}
+
+#### 3.2.2 Interaction Flow
+<!-- Describe operation steps from user perspective -->
+{interaction_flow}
+
+#### 3.2.3 UI Components
+<!-- Describe component types needed (dropdown, table, dialog, etc.), no class names -->
+{ui_components}
+
+### 3.3 Data Requirements
+<!-- Describe business entities and field meanings, no SQL/DDL -->
+
+#### 3.3.1 Business Entities
+<!-- Describe business concepts and their relationships -->
+{business_entities}
+
+#### 3.3.2 Business Fields
+<!-- Describe fields from business perspective, not database implementation -->
+| Field | Meaning | Required | Business Rule |
+|-------|---------|----------|---------------|
+| {field_name} | {meaning} | Yes/No | {business_rule} |
+
+### 3.4 Interface Requirements
+<!-- Describe what interfaces are needed and their purpose, no API paths or code -->
+
+| Interface Purpose | Description | Notes |
+|-------------------|-------------|-------|
+| {interface_purpose} | {description} | {notes} |
+
+---
+
+## 4. Non-Functional Requirements
+
+### 4.1 Performance Requirements
+- Response time: {response_time}
+- Concurrency: {concurrency}
+
+### 4.2 Security Requirements
+{security_requirements}
+
+### 4.3 Compatibility
+- Browser: Chrome 80+, Edge 80+
+- Resolution: 1920x1080 and above
+
+---
+
+## 5. Boundary Conditions
+
+### 5.1 Preconditions
+{preconditions}
+
+### 5.2 Postconditions
+{postconditions}
+
+### 5.3 Exception Handling
+<!-- Describe exception scenarios and user-visible handling from business perspective -->
+| Exception Scenario | User-Visible Handling |
+|--------------------|-----------------------|
+| {scenario} | {handling} |
+
+---
+
+## 6. Acceptance Criteria
+
+### 6.1 Functional Acceptance
+- [ ] All user story acceptance criteria pass
+- [ ] Core feature tests pass
+- [ ] Boundary condition tests pass
+
+### 6.2 Quality Acceptance
+- [ ] Unit test coverage >= 80%
+- [ ] Code review passed
+- [ ] No critical bugs
+
+### 6.3 Documentation Acceptance
+- [ ] API documentation updated
+- [ ] User manual updated (if needed)
+
+---
+
+## 7. Appendix
+
+### 7.1 Glossary
+<!-- Define business terms to help understand requirements -->
+| Term | Definition |
+|------|------------|
+| {term} | {definition} |
+
+### 7.2 References
+- {reference_1}
+- {reference_2}
+
+### 7.3 Change Log
+| Date | Version | Change | Author |
+|------|---------|--------|--------|
+| {date} | v1.0 | Initial version | {author} |
+
+---
+
+*This document is generated based on SDD specification template*
+
+<!--
+Self-check list (check after generation):
+- [ ] No SQL statements
+- [ ] No code snippets (in any language)
+- [ ] No file paths (e.g., src/pages/xxx/xxx.jsx)
+- [ ] No class or method names
+- [ ] No "modification list" section
+- [ ] Related modules only have module names, not file paths
+- [ ] Data requirements describe business entities, not database table structures
+- [ ] Interface requirements describe purpose, not API code
+-->

package/templates/specify/templates/tasks-modular-template/README.md

@@ -0,0 +1,79 @@
+# {feature_name} - Task Breakdown Index
+
+> Version: {version}
+> Created: {create_date}
+> Updated: {update_date}
+> Related Spec: [spec.md](../spec.md)
+> Implementation Plan: [plan.md](../plan.md)
+> Test Cases: [testcases.md](../testcases.md)
+
+## Document Structure
+
+Tasks have been split into the following modules for easier management and on-demand loading:
+
+```
+tasks/
+├── README.md                    # This file - task index and overview
+├── phase-0-preparation.md       # Phase 0: Preparation
+├── phase-1-backend.md           # Phase 1: Backend development (test-first)
+├── phase-2-frontend.md          # Phase 2: Frontend development (test-first)
+├── phase-3-testing.md           # Phase 3: Testing & acceptance
+├── phase-N-*.md                 # Additional phases (iterations)
+├── dependencies.md              # Task dependency relationships
+├── checkpoints.md               # Checkpoints and acceptance criteria
+└── implementation-notes.md      # Implementation records and notes
+```
+
+## Task Overview
+
+| Phase | Task Count | Estimated Hours | Status | Document |
+|-------|------------|-----------------|--------|----------|
+| Phase 0: Preparation | {phase_0_tasks} | {phase_0_hours}h | {phase_0_status} | [phase-0-preparation.md](./phase-0-preparation.md) |
+| Phase 1: Backend Dev | {phase_1_tasks} | {phase_1_hours}h | {phase_1_status} | [phase-1-backend.md](./phase-1-backend.md) |
+| Phase 2: Frontend Dev | {phase_2_tasks} | {phase_2_hours}h | {phase_2_status} | [phase-2-frontend.md](./phase-2-frontend.md) |
+| Phase 3: Testing | {phase_3_tasks} | {phase_3_hours}h | {phase_3_status} | [phase-3-testing.md](./phase-3-testing.md) |
+| **Total** | **{total_tasks}** | **{total_hours}h** | **{progress}%** | - |
+
+## Quick Navigation
+
+### Core Phases
+- [Preparation](./phase-0-preparation.md) - Environment check, test data, code research
+- [Backend Development](./phase-1-backend.md) - Models, DTOs, services, controllers
+- [Frontend Development](./phase-2-frontend.md) - API services, stores, page components, routing
+- [Testing & Acceptance](./phase-3-testing.md) - E2E tests, boundary tests, performance tests
+
+### Auxiliary Documents
+- [Task Dependencies](./dependencies.md) - Dependency graph and execution order
+- [Checkpoints](./checkpoints.md) - Phase acceptance criteria
+- [Implementation Notes](./implementation-notes.md) - Actual vs planned differences, issue records
+
+## Current Progress
+
+**Current Phase**: {current_phase}
+
+**Recently Completed**:
+- {recent_task_1}
+- {recent_task_2}
+- {recent_task_3}
+
+**Next Steps**:
+- {next_task_1}
+- {next_task_2}
+
+## Usage Guide
+
+1. **View Overview**: Read this file to understand overall progress and structure
+2. **On-demand Loading**: Open the corresponding Phase document for your current work
+3. **Check Dependencies**: Before starting a task, check [dependencies.md](./dependencies.md) for prerequisites
+4. **Acceptance Criteria**: After completing a phase, refer to [checkpoints.md](./checkpoints.md) for validation
+5. **Issue Tracking**: When encountering issues, check [implementation-notes.md](./implementation-notes.md) for records
+
+## Change Log
+
+| Version | Date | Change |
+|---------|------|--------|
+| {version} | {date} | {change_description} |
+
+---
+
+*This document follows SDD test-first principles, tasks organized in Red-Green-Refactor cycles*

package/templates/specify/templates/tasks-template.md

@@ -0,0 +1,232 @@
+# Task Breakdown (Tasks)
+
+> Feature ID: {feature_id}
+> Related Plan: {plan_file}
+> Created: {date}
+> Status: Pending
+
+## Task Overview
+
+| Phase | Task Count | Estimated Hours | Status |
+|-------|------------|-----------------|--------|
+| Preparation | {count} | {hours}h | Not started |
+| Backend Development | {count} | {hours}h | Not started |
+| Frontend Development | {count} | {hours}h | Not started |
+| Testing & Acceptance | {count} | {hours}h | Not started |
+| **Total** | **{total}** | **{total_hours}h** | |
+
+---
+
+## Phase 0: Preparation
+
+### Task 0.1: Environment Setup
+- **Description**: {description}
+- **Files**: {files}
+- **Dependencies**: None
+- **Status**: [ ] Pending
+- **Acceptance Criteria**:
+  - {acceptance_criteria}
+
+### Task 0.2: Database Preparation
+- **Description**: Execute database DDL scripts
+- **Files**: `scripts/{feature_id}.sql`
+- **Dependencies**: Task 0.1
+- **Status**: [ ] Pending
+- **Acceptance Criteria**:
+  - Database tables created successfully
+  - Indexes created successfully
+
+---
+
+## Phase 1: Backend Development
+
+### Task 1.1: Domain/Model Design [P]
+- **Description**: Create domain entities and value objects
+- **Files**:
+  - `{backend_source_path}/models/{Entity}.{ext}`
+  - `{backend_source_path}/types/{ValueObject}.{ext}`
+- **Dependencies**: Task 0.2
+- **Status**: [ ] Pending
+- **Acceptance Criteria**:
+  - Entity classes follow project conventions
+  - Contains necessary fields and methods
+
+### Task 1.2: Repository/Data Access Interface [P]
+- **Description**: Define repository/data access interfaces
+- **Files**: `{backend_source_path}/repositories/{Repository}.{ext}`
+- **Dependencies**: Task 1.1
+- **Status**: [ ] Pending
+- **Acceptance Criteria**:
+  - Interface definition complete
+  - Method naming follows conventions
+
+### Task 1.3: Repository Implementation
+- **Description**: Implement repository/data access interfaces
+- **Files**:
+  - `{backend_source_path}/repositories/impl/{RepositoryImpl}.{ext}`
+  - `{backend_source_path}/mappers/{Mapper}.{ext}`
+- **Dependencies**: Task 1.2
+- **Status**: [ ] Pending
+- **Acceptance Criteria**:
+  - CRUD operations work correctly
+  - SQL queries are correct
+
+### Task 1.4: Service Layer
+- **Description**: Implement service/business logic layer
+- **Files**: `{backend_source_path}/services/{Service}.{ext}`
+- **Dependencies**: Task 1.3
+- **Status**: [ ] Pending
+- **Acceptance Criteria**:
+  - Business logic is correct
+  - Exception handling is complete
+
+### Task 1.5: API Controller/Handler
+- **Description**: Implement API endpoints
+- **Files**: `{backend_source_path}/controllers/{Controller}.{ext}`
+- **Dependencies**: Task 1.4
+- **Status**: [ ] Pending
+- **Acceptance Criteria**:
+  - API conforms to design document
+  - Parameter validation is complete
+
+### Task 1.6: Backend Unit Tests
+- **Description**: Write unit tests
+- **Files**: `{backend_test_path}/{Test}.{ext}`
+- **Dependencies**: Task 1.5
+- **Status**: [ ] Pending
+- **Acceptance Criteria**:
+  - Test coverage >= 80%
+  - All tests pass
+
+---
+
+## Phase 2: Frontend Development
+
+### Task 2.1: API Service Layer [P]
+- **Description**: Create API call services
+- **Files**: `{frontend_source_path}/api/{feature}.{ext}`
+- **Dependencies**: Task 1.5
+- **Status**: [ ] Pending
+- **Acceptance Criteria**:
+  - API calls are correct
+  - Error handling is complete
+
+### Task 2.2: Store/State Definition [P]
+- **Description**: Create state management store
+- **Files**: `{frontend_source_path}/stores/{Feature}Store.{ext}`
+- **Dependencies**: Task 2.1
+- **Status**: [ ] Pending
+- **Acceptance Criteria**:
+  - State management is correct
+  - Reactive updates work
+
+### Task 2.3: Page Components
+- **Description**: Create page components
+- **Files**: `{frontend_source_path}/pages/{module}/{Feature}/index.{ext}`
+- **Dependencies**: Task 2.2
+- **Status**: [ ] Pending
+- **Acceptance Criteria**:
+  - Page layout is correct
+  - Interaction conforms to design
+
+### Task 2.4: Sub-components Development
+- **Description**: Develop feature sub-components
+- **Files**: `{frontend_source_path}/pages/{module}/{Feature}/components/`
+- **Dependencies**: Task 2.3
+- **Status**: [ ] Pending
+- **Acceptance Criteria**:
+  - Component functionality is complete
+  - Reusability is good
+
+### Task 2.5: Route Configuration
+- **Description**: Configure page routes
+- **Files**: `{frontend_source_path}/routes.{ext}`
+- **Dependencies**: Task 2.3
+- **Status**: [ ] Pending
+- **Acceptance Criteria**:
+  - Route configuration is correct
+  - Access control is complete
+
+---
+
+## Phase 3: Testing & Acceptance
+
+### Task 3.1: Integration Testing
+- **Description**: Frontend-backend integration testing
+- **Dependencies**: Task 2.5
+- **Status**: [ ] Pending
+- **Acceptance Criteria**:
+  - All API calls work correctly
+  - Data displays correctly
+
+### Task 3.2: Functional Testing
+- **Description**: Execute functional test cases
+- **Dependencies**: Task 3.1
+- **Status**: [ ] Pending
+- **Acceptance Criteria**:
+  - All test cases pass
+  - No critical bugs
+
+### Task 3.3: Code Review
+- **Description**: Code review
+- **Dependencies**: Task 3.2
+- **Status**: [ ] Pending
+- **Acceptance Criteria**:
+  - Code follows conventions
+  - No obvious issues
+
+### Task 3.4: Documentation Update
+- **Description**: Update related documentation
+- **Files**:
+  - API documentation
+  - User manual (if needed)
+- **Dependencies**: Task 3.3
+- **Status**: [ ] Pending
+- **Acceptance Criteria**:
+  - Documentation is accurate and complete
+
+---
+
+## Acceptance Checkpoints
+
+### Checkpoint 1: Backend Development Complete
+- [ ] All backend tasks completed
+- [ ] Unit tests pass
+- [ ] APIs are accessible
+
+### Checkpoint 2: Frontend Development Complete
+- [ ] All frontend tasks completed
+- [ ] Pages are accessible
+- [ ] Basic functionality works
+
+### Checkpoint 3: Feature Acceptance Complete
+- [ ] All test cases pass
+- [ ] Code review passed
+- [ ] Documentation updated
+
+---
+
+## Risks and Dependencies
+
+### External Dependencies
+| Dependency | Provider | Status |
+|------------|----------|--------|
+| {dependency} | {provider} | {status} |
+
+### Risk Items
+| Risk | Mitigation |
+|------|------------|
+| {risk} | {mitigation} |
+
+---
+
+## Change Log
+
+| Date | Change | Author |
+|------|--------|--------|
+| {date} | Initial version | {author} |
+
+---
+
+*This document is generated based on SDD specification template*
+*Tasks marked [P] can be executed in parallel*