smart-spec-kit-mcp 2.2.5 → 2.2.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +115 -26
- package/dist/tools/agentTools.d.ts +2 -1
- package/dist/tools/agentTools.d.ts.map +1 -1
- package/dist/tools/agentTools.js +21 -22
- package/dist/tools/agentTools.js.map +1 -1
- package/dist/utils/agentLoader.d.ts +53 -0
- package/dist/utils/agentLoader.d.ts.map +1 -0
- package/dist/utils/agentLoader.js +225 -0
- package/dist/utils/agentLoader.js.map +1 -0
- package/dist/utils/starterKitInstaller.d.ts.map +1 -1
- package/dist/utils/starterKitInstaller.js +27 -1
- package/dist/utils/starterKitInstaller.js.map +1 -1
- package/dist/utils/workflowLoader.d.ts +1 -1
- package/dist/utils/workflowLoader.js +3 -3
- package/dist/utils/workflowLoader.js.map +1 -1
- package/docs/DOCUMENTATION.md +247 -6
- package/package.json +1 -1
- package/starter-kit/agents/GovAgent.md +53 -0
- package/starter-kit/agents/PlanAgent.md +51 -0
- package/starter-kit/agents/SpecAgent.md +51 -0
- package/starter-kit/agents/TestAgent.md +52 -0
- package/starter-kit/agents/_CustomAgent.template.md +69 -0
- package/starter-kit/templates/bugfix-report.md +22 -2
- package/starter-kit/templates/functional-spec.md +12 -1
- package/starter-kit/templates/plan-template.md +6 -1
- package/starter-kit/templates/tasks-template.md +4 -3
- package/templates/bugfix-report.md +0 -184
- package/templates/functional-spec.md +0 -191
- package/workflows/bugfix-quick.yaml +0 -53
- package/workflows/bugfix.yaml +0 -99
- package/workflows/feature-full.yaml +0 -344
- package/workflows/feature-quick.yaml +0 -69
- package/workflows/feature-standard.yaml +0 -92
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: CustomAgent
|
|
3
|
+
displayName: "Custom Agent Template"
|
|
4
|
+
description: "Template for creating your own custom agent - copy and modify this file"
|
|
5
|
+
capabilities:
|
|
6
|
+
- Your first capability
|
|
7
|
+
- Your second capability
|
|
8
|
+
- Your third capability
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## System Prompt
|
|
12
|
+
|
|
13
|
+
You are CustomAgent, an expert in [your domain].
|
|
14
|
+
|
|
15
|
+
### Your Role
|
|
16
|
+
|
|
17
|
+
[Describe what this agent does and its expertise]
|
|
18
|
+
|
|
19
|
+
### Core Principles
|
|
20
|
+
|
|
21
|
+
1. **Principle 1**: [Description]
|
|
22
|
+
2. **Principle 2**: [Description]
|
|
23
|
+
3. **Principle 3**: [Description]
|
|
24
|
+
|
|
25
|
+
### Guidelines
|
|
26
|
+
|
|
27
|
+
- [Guideline 1]
|
|
28
|
+
- [Guideline 2]
|
|
29
|
+
- [Guideline 3]
|
|
30
|
+
|
|
31
|
+
### Output Format
|
|
32
|
+
|
|
33
|
+
[Describe the expected output format]
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## How to Create Your Own Agent
|
|
38
|
+
|
|
39
|
+
1. Copy this file to `.spec-kit/agents/MyAgentName.md`
|
|
40
|
+
2. Update the frontmatter (name, displayName, description, capabilities)
|
|
41
|
+
3. Write your custom system prompt
|
|
42
|
+
4. Use in workflows: `agent: MyAgentName`
|
|
43
|
+
|
|
44
|
+
### Example: Creating a SecurityAgent
|
|
45
|
+
|
|
46
|
+
```yaml
|
|
47
|
+
---
|
|
48
|
+
name: SecurityAgent
|
|
49
|
+
displayName: "Security Review Agent"
|
|
50
|
+
description: "Expert in application security and vulnerability assessment"
|
|
51
|
+
capabilities:
|
|
52
|
+
- Identify security vulnerabilities
|
|
53
|
+
- Recommend secure coding practices
|
|
54
|
+
- Review authentication and authorization
|
|
55
|
+
- Check for OWASP Top 10 issues
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
You are SecurityAgent, an expert in application security...
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Then reference it in your workflow:
|
|
62
|
+
|
|
63
|
+
```yaml
|
|
64
|
+
steps:
|
|
65
|
+
- id: security-review
|
|
66
|
+
agent: SecurityAgent
|
|
67
|
+
action: call_agent
|
|
68
|
+
description: "Review code for security issues"
|
|
69
|
+
```
|
|
@@ -14,9 +14,11 @@ severity: "[Critical/High/Medium/Low]"
|
|
|
14
14
|
## 1. Bug Summary
|
|
15
15
|
|
|
16
16
|
### 1.1 Description
|
|
17
|
+
|
|
17
18
|
[TO FILL: Clear, concise description of the bug]
|
|
18
19
|
|
|
19
20
|
### 1.2 Impact
|
|
21
|
+
|
|
20
22
|
- **Severity**: [Critical/High/Medium/Low]
|
|
21
23
|
- **Affected Users**: [TO FILL: Who is affected]
|
|
22
24
|
- **Business Impact**: [TO FILL: How this affects the business]
|
|
@@ -26,6 +28,7 @@ severity: "[Critical/High/Medium/Low]"
|
|
|
26
28
|
## 2. Reproduction
|
|
27
29
|
|
|
28
30
|
### 2.1 Environment
|
|
31
|
+
|
|
29
32
|
| Component | Value |
|
|
30
33
|
|-----------|-------|
|
|
31
34
|
| OS | [TO FILL] |
|
|
@@ -33,18 +36,22 @@ severity: "[Critical/High/Medium/Low]"
|
|
|
33
36
|
| Version | [TO FILL] |
|
|
34
37
|
|
|
35
38
|
### 2.2 Steps to Reproduce
|
|
39
|
+
|
|
36
40
|
1. [TO FILL: Step 1]
|
|
37
41
|
2. [TO FILL: Step 2]
|
|
38
42
|
3. [TO FILL: Step 3]
|
|
39
43
|
|
|
40
44
|
### 2.3 Expected Behavior
|
|
45
|
+
|
|
41
46
|
[TO FILL: What should happen]
|
|
42
47
|
|
|
43
48
|
### 2.4 Actual Behavior
|
|
49
|
+
|
|
44
50
|
[TO FILL: What actually happens]
|
|
45
51
|
|
|
46
52
|
### 2.5 Evidence
|
|
47
|
-
|
|
53
|
+
|
|
54
|
+
```text
|
|
48
55
|
[TO FILL: Error messages, logs, screenshots]
|
|
49
56
|
```
|
|
50
57
|
|
|
@@ -53,13 +60,16 @@ severity: "[Critical/High/Medium/Low]"
|
|
|
53
60
|
## 3. Root Cause Analysis
|
|
54
61
|
|
|
55
62
|
### 3.1 Investigation
|
|
63
|
+
|
|
56
64
|
[TO FILL: What was investigated and findings]
|
|
57
65
|
|
|
58
66
|
### 3.2 Root Cause
|
|
67
|
+
|
|
59
68
|
[TO FILL: The underlying cause of the bug]
|
|
60
69
|
|
|
61
70
|
### 3.3 Related Code
|
|
62
|
-
|
|
71
|
+
|
|
72
|
+
```text
|
|
63
73
|
File: [path/to/file]
|
|
64
74
|
Line: [line numbers]
|
|
65
75
|
```
|
|
@@ -69,14 +79,17 @@ Line: [line numbers]
|
|
|
69
79
|
## 4. Fix Proposal
|
|
70
80
|
|
|
71
81
|
### 4.1 Solution
|
|
82
|
+
|
|
72
83
|
[TO FILL: Proposed fix approach]
|
|
73
84
|
|
|
74
85
|
### 4.2 Changes Required
|
|
86
|
+
|
|
75
87
|
| File | Change |
|
|
76
88
|
|------|--------|
|
|
77
89
|
| [TO FILL] | [TO FILL] |
|
|
78
90
|
|
|
79
91
|
### 4.3 Risks
|
|
92
|
+
|
|
80
93
|
- [TO FILL: Any risks with the proposed fix]
|
|
81
94
|
|
|
82
95
|
---
|
|
@@ -84,12 +97,14 @@ Line: [line numbers]
|
|
|
84
97
|
## 5. Testing
|
|
85
98
|
|
|
86
99
|
### 5.1 Test Cases
|
|
100
|
+
|
|
87
101
|
| ID | Scenario | Expected Result |
|
|
88
102
|
|----|----------|-----------------|
|
|
89
103
|
| TC-001 | [TO FILL: Original bug scenario] | Bug no longer occurs |
|
|
90
104
|
| TC-002 | [TO FILL: Regression test] | Existing functionality intact |
|
|
91
105
|
|
|
92
106
|
### 5.2 Verification Steps
|
|
107
|
+
|
|
93
108
|
1. [TO FILL: How to verify the fix]
|
|
94
109
|
2. [TO FILL: Regression testing steps]
|
|
95
110
|
|
|
@@ -98,12 +113,14 @@ Line: [line numbers]
|
|
|
98
113
|
## 6. Deployment
|
|
99
114
|
|
|
100
115
|
### 6.1 Deployment Plan
|
|
116
|
+
|
|
101
117
|
- [ ] Code review completed
|
|
102
118
|
- [ ] Tests passing
|
|
103
119
|
- [ ] Staging verification
|
|
104
120
|
- [ ] Production deployment
|
|
105
121
|
|
|
106
122
|
### 6.2 Rollback Plan
|
|
123
|
+
|
|
107
124
|
[TO FILL: How to rollback if issues occur]
|
|
108
125
|
|
|
109
126
|
---
|
|
@@ -111,6 +128,7 @@ Line: [line numbers]
|
|
|
111
128
|
## 7. Post-Mortem (Optional)
|
|
112
129
|
|
|
113
130
|
### 7.1 Timeline
|
|
131
|
+
|
|
114
132
|
| Time | Event |
|
|
115
133
|
|------|-------|
|
|
116
134
|
| [TO FILL] | Bug reported |
|
|
@@ -119,9 +137,11 @@ Line: [line numbers]
|
|
|
119
137
|
| [TO FILL] | Fix deployed |
|
|
120
138
|
|
|
121
139
|
### 7.2 Lessons Learned
|
|
140
|
+
|
|
122
141
|
- [TO FILL: What can we improve to prevent similar issues]
|
|
123
142
|
|
|
124
143
|
### 7.3 Action Items
|
|
144
|
+
|
|
125
145
|
| Item | Owner | Due Date |
|
|
126
146
|
|------|-------|----------|
|
|
127
147
|
| [TO FILL] | [TO FILL] | [TO FILL] |
|
|
@@ -14,16 +14,21 @@ last_updated: "[TO FILL: Date]"
|
|
|
14
14
|
## 1. Overview
|
|
15
15
|
|
|
16
16
|
### 1.1 Purpose
|
|
17
|
+
|
|
17
18
|
[TO FILL: Brief description of the feature's purpose and the problem it solves]
|
|
18
19
|
|
|
19
20
|
### 1.2 Scope
|
|
21
|
+
|
|
20
22
|
**In Scope:**
|
|
23
|
+
|
|
21
24
|
- [TO FILL: What is included]
|
|
22
25
|
|
|
23
26
|
**Out of Scope:**
|
|
27
|
+
|
|
24
28
|
- [TO FILL: What is explicitly excluded]
|
|
25
29
|
|
|
26
30
|
### 1.3 Background
|
|
31
|
+
|
|
27
32
|
[TO FILL: Context and history leading to this feature request]
|
|
28
33
|
|
|
29
34
|
---
|
|
@@ -79,6 +84,7 @@ Feature: [TO FILL: Feature Name]
|
|
|
79
84
|
### 4.1 User Personas
|
|
80
85
|
|
|
81
86
|
**Persona 1: [TO FILL: Name]**
|
|
87
|
+
|
|
82
88
|
- Role: [TO FILL]
|
|
83
89
|
- Goals: [TO FILL]
|
|
84
90
|
- Pain Points: [TO FILL]
|
|
@@ -92,7 +98,7 @@ Feature: [TO FILL: Feature Name]
|
|
|
92
98
|
|
|
93
99
|
### 4.3 User Flow
|
|
94
100
|
|
|
95
|
-
```
|
|
101
|
+
```text
|
|
96
102
|
[TO FILL: Describe or link to user flow diagram]
|
|
97
103
|
┌─────────┐ ┌─────────┐ ┌─────────┐
|
|
98
104
|
│ Step 1 │───▶│ Step 2 │───▶│ Step 3 │
|
|
@@ -104,12 +110,15 @@ Feature: [TO FILL: Feature Name]
|
|
|
104
110
|
## 5. Technical Considerations
|
|
105
111
|
|
|
106
112
|
### 5.1 Dependencies
|
|
113
|
+
|
|
107
114
|
- [TO FILL: External systems, services, or components this feature depends on]
|
|
108
115
|
|
|
109
116
|
### 5.2 Constraints
|
|
117
|
+
|
|
110
118
|
- [TO FILL: Technical or business constraints]
|
|
111
119
|
|
|
112
120
|
### 5.3 Data Requirements
|
|
121
|
+
|
|
113
122
|
- [TO FILL: Data entities, storage, and access patterns]
|
|
114
123
|
|
|
115
124
|
---
|
|
@@ -117,11 +126,13 @@ Feature: [TO FILL: Feature Name]
|
|
|
117
126
|
## 6. Assumptions & Risks
|
|
118
127
|
|
|
119
128
|
### 6.1 Assumptions
|
|
129
|
+
|
|
120
130
|
| ID | Assumption | Impact if Wrong |
|
|
121
131
|
|----|------------|-----------------|
|
|
122
132
|
| A-001 | [TO FILL] | [TO FILL] |
|
|
123
133
|
|
|
124
134
|
### 6.2 Risks
|
|
135
|
+
|
|
125
136
|
| ID | Risk | Probability | Impact | Mitigation |
|
|
126
137
|
|----|------|-------------|--------|------------|
|
|
127
138
|
| R-001 | [TO FILL] | Medium | High | [TO FILL] |
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
## Technical Context
|
|
10
10
|
|
|
11
11
|
### Tech Stack
|
|
12
|
+
|
|
12
13
|
| Component | Technology | Version |
|
|
13
14
|
|-----------|------------|---------|
|
|
14
15
|
| Language | [TO FILL] | |
|
|
@@ -18,7 +19,7 @@
|
|
|
18
19
|
|
|
19
20
|
### Architecture Overview
|
|
20
21
|
|
|
21
|
-
```
|
|
22
|
+
```text
|
|
22
23
|
[TO FILL: ASCII diagram or description of architecture]
|
|
23
24
|
|
|
24
25
|
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
|
@@ -50,6 +51,7 @@ tests/
|
|
|
50
51
|
## Implementation Phases
|
|
51
52
|
|
|
52
53
|
### Phase 0: Research & Design
|
|
54
|
+
|
|
53
55
|
**Duration**: [X days]
|
|
54
56
|
**Output**: research.md, data-model.md
|
|
55
57
|
|
|
@@ -59,6 +61,7 @@ tests/
|
|
|
59
61
|
- [ ] Define API contracts
|
|
60
62
|
|
|
61
63
|
### Phase 1: Foundation
|
|
64
|
+
|
|
62
65
|
**Duration**: [X days]
|
|
63
66
|
**Dependencies**: Phase 0
|
|
64
67
|
|
|
@@ -68,6 +71,7 @@ tests/
|
|
|
68
71
|
- [ ] Set up database schema
|
|
69
72
|
|
|
70
73
|
### Phase 2: Core Implementation
|
|
74
|
+
|
|
71
75
|
**Duration**: [X days]
|
|
72
76
|
**Dependencies**: Phase 1
|
|
73
77
|
|
|
@@ -76,6 +80,7 @@ tests/
|
|
|
76
80
|
- [ ] Add unit tests
|
|
77
81
|
|
|
78
82
|
### Phase 3: Integration & Polish
|
|
83
|
+
|
|
79
84
|
**Duration**: [X days]
|
|
80
85
|
**Dependencies**: Phase 2
|
|
81
86
|
|
|
@@ -8,11 +8,12 @@
|
|
|
8
8
|
|
|
9
9
|
## Task Format
|
|
10
10
|
|
|
11
|
-
```
|
|
11
|
+
```text
|
|
12
12
|
- [ ] T### [P?] [Story?] Description - `path/to/file.ext`
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
**Legend**:
|
|
16
|
+
|
|
16
17
|
- `T###`: Task ID (sequential)
|
|
17
18
|
- `[P]`: Can be executed in parallel with other `[P]` tasks in same phase
|
|
18
19
|
- `[Story?]`: Associated user story ID (optional)
|
|
@@ -107,7 +108,7 @@
|
|
|
107
108
|
|
|
108
109
|
## Dependencies & Execution Order
|
|
109
110
|
|
|
110
|
-
```
|
|
111
|
+
```text
|
|
111
112
|
Phase 1 (Setup)
|
|
112
113
|
│
|
|
113
114
|
▼
|
|
@@ -129,7 +130,7 @@ Phase 3 (US-1) Phase 4 (US-2) Phase 5 (US-3) ← Can run in parallel
|
|
|
129
130
|
|
|
130
131
|
Tasks marked `[P]` within the same phase can run simultaneously:
|
|
131
132
|
|
|
132
|
-
```
|
|
133
|
+
```text
|
|
133
134
|
Phase 3, Story 1:
|
|
134
135
|
├── T010 Create model (sequential - others depend on this)
|
|
135
136
|
│
|
|
@@ -1,184 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: "[TO FILL: Bug Title]"
|
|
3
|
-
workitem_id: "[TO FILL]"
|
|
4
|
-
type: Bug Fix Report
|
|
5
|
-
version: "1.0"
|
|
6
|
-
status: Draft
|
|
7
|
-
author: "[TO FILL]"
|
|
8
|
-
created: "[TO FILL: Date]"
|
|
9
|
-
severity: "[TO FILL: Critical/High/Medium/Low]"
|
|
10
|
-
azure_devops_link: "[TO FILL: Link to ADO Bug]"
|
|
11
|
-
---
|
|
12
|
-
|
|
13
|
-
# Bug Fix Report: [TO FILL: Bug Title]
|
|
14
|
-
|
|
15
|
-
## 1. Bug Summary
|
|
16
|
-
|
|
17
|
-
| Field | Value |
|
|
18
|
-
|-------|-------|
|
|
19
|
-
| **Bug ID** | [TO FILL] |
|
|
20
|
-
| **Severity** | [TO FILL: Critical/High/Medium/Low] |
|
|
21
|
-
| **Priority** | [TO FILL: P1/P2/P3/P4] |
|
|
22
|
-
| **Reported By** | [TO FILL] |
|
|
23
|
-
| **Reported Date** | [TO FILL] |
|
|
24
|
-
| **Environment** | [TO FILL: Production/Staging/Dev] |
|
|
25
|
-
| **Affected Version** | [TO FILL] |
|
|
26
|
-
|
|
27
|
-
---
|
|
28
|
-
|
|
29
|
-
## 2. Problem Description
|
|
30
|
-
|
|
31
|
-
### 2.1 Expected Behavior
|
|
32
|
-
|
|
33
|
-
[TO FILL: What should happen]
|
|
34
|
-
|
|
35
|
-
### 2.2 Actual Behavior
|
|
36
|
-
|
|
37
|
-
[TO FILL: What actually happens]
|
|
38
|
-
|
|
39
|
-
### 2.3 Reproduction Steps
|
|
40
|
-
|
|
41
|
-
1. [TO FILL: Step 1]
|
|
42
|
-
2. [TO FILL: Step 2]
|
|
43
|
-
3. [TO FILL: Step 3]
|
|
44
|
-
4. [TO FILL: Observe error]
|
|
45
|
-
|
|
46
|
-
### 2.4 Error Details
|
|
47
|
-
|
|
48
|
-
```
|
|
49
|
-
[TO FILL: Error message, stack trace, logs]
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
### 2.5 Screenshots/Evidence
|
|
53
|
-
|
|
54
|
-
[TO FILL: Attach or link screenshots]
|
|
55
|
-
|
|
56
|
-
---
|
|
57
|
-
|
|
58
|
-
## 3. Impact Assessment
|
|
59
|
-
|
|
60
|
-
### 3.1 User Impact
|
|
61
|
-
|
|
62
|
-
| Aspect | Assessment |
|
|
63
|
-
|--------|------------|
|
|
64
|
-
| Users Affected | [TO FILL: All/Subset/Specific role] |
|
|
65
|
-
| Frequency | [TO FILL: Always/Sometimes/Rare] |
|
|
66
|
-
| Workaround Available | [TO FILL: Yes/No] |
|
|
67
|
-
| Business Impact | [TO FILL: Description] |
|
|
68
|
-
|
|
69
|
-
### 3.2 Affected Components
|
|
70
|
-
|
|
71
|
-
- [ ] Frontend
|
|
72
|
-
- [ ] Backend API
|
|
73
|
-
- [ ] Database
|
|
74
|
-
- [ ] External Service
|
|
75
|
-
- [ ] Infrastructure
|
|
76
|
-
|
|
77
|
-
Component details: [TO FILL]
|
|
78
|
-
|
|
79
|
-
---
|
|
80
|
-
|
|
81
|
-
## 4. Root Cause Analysis
|
|
82
|
-
|
|
83
|
-
### 4.1 Investigation Summary
|
|
84
|
-
|
|
85
|
-
[TO FILL: Summary of investigation steps taken]
|
|
86
|
-
|
|
87
|
-
### 4.2 Root Cause
|
|
88
|
-
|
|
89
|
-
[TO FILL: Identified root cause of the bug]
|
|
90
|
-
|
|
91
|
-
### 4.3 Why It Wasn't Caught
|
|
92
|
-
|
|
93
|
-
[TO FILL: Gap in testing/review that allowed this bug]
|
|
94
|
-
|
|
95
|
-
---
|
|
96
|
-
|
|
97
|
-
## 5. Fix Proposal
|
|
98
|
-
|
|
99
|
-
### 5.1 Proposed Solution
|
|
100
|
-
|
|
101
|
-
[TO FILL: Description of the fix]
|
|
102
|
-
|
|
103
|
-
### 5.2 Files/Components to Modify
|
|
104
|
-
|
|
105
|
-
| File/Component | Change Type | Description |
|
|
106
|
-
|----------------|-------------|-------------|
|
|
107
|
-
| [TO FILL] | Modify | [TO FILL] |
|
|
108
|
-
| [TO FILL] | Add | [TO FILL] |
|
|
109
|
-
|
|
110
|
-
### 5.3 Risk Assessment
|
|
111
|
-
|
|
112
|
-
| Risk | Probability | Impact | Mitigation |
|
|
113
|
-
|------|-------------|--------|------------|
|
|
114
|
-
| Regression in X | [TO FILL] | [TO FILL] | [TO FILL] |
|
|
115
|
-
|
|
116
|
-
### 5.4 Rollback Plan
|
|
117
|
-
|
|
118
|
-
[TO FILL: How to rollback if the fix causes issues]
|
|
119
|
-
|
|
120
|
-
---
|
|
121
|
-
|
|
122
|
-
## 6. Validation Checklist
|
|
123
|
-
|
|
124
|
-
### 6.1 Security Review
|
|
125
|
-
|
|
126
|
-
- [ ] No new vulnerabilities introduced
|
|
127
|
-
- [ ] Input validation maintained
|
|
128
|
-
- [ ] No sensitive data exposure
|
|
129
|
-
- [ ] Auth/Authz intact
|
|
130
|
-
|
|
131
|
-
### 6.2 Testing
|
|
132
|
-
|
|
133
|
-
- [ ] Unit test for bug scenario added
|
|
134
|
-
- [ ] Regression tests pass
|
|
135
|
-
- [ ] Manual testing completed
|
|
136
|
-
- [ ] Edge cases covered
|
|
137
|
-
|
|
138
|
-
### 6.3 Code Quality
|
|
139
|
-
|
|
140
|
-
- [ ] Code review completed
|
|
141
|
-
- [ ] No new technical debt
|
|
142
|
-
- [ ] Follows coding standards
|
|
143
|
-
- [ ] Documentation updated
|
|
144
|
-
|
|
145
|
-
---
|
|
146
|
-
|
|
147
|
-
## 7. Resolution
|
|
148
|
-
|
|
149
|
-
### 7.1 Fix Implementation
|
|
150
|
-
|
|
151
|
-
| Field | Value |
|
|
152
|
-
|-------|-------|
|
|
153
|
-
| **Fix Branch** | [TO FILL] |
|
|
154
|
-
| **PR Link** | [TO FILL] |
|
|
155
|
-
| **Deployed To** | [TO FILL] |
|
|
156
|
-
| **Deployed Date** | [TO FILL] |
|
|
157
|
-
| **Verified By** | [TO FILL] |
|
|
158
|
-
|
|
159
|
-
### 7.2 Lessons Learned
|
|
160
|
-
|
|
161
|
-
[TO FILL: What can be improved to prevent similar bugs]
|
|
162
|
-
|
|
163
|
-
### 7.3 Follow-up Actions
|
|
164
|
-
|
|
165
|
-
- [ ] [TO FILL: Action item 1]
|
|
166
|
-
- [ ] [TO FILL: Action item 2]
|
|
167
|
-
|
|
168
|
-
---
|
|
169
|
-
|
|
170
|
-
## 8. Approval
|
|
171
|
-
|
|
172
|
-
| Role | Name | Date | Status |
|
|
173
|
-
|------|------|------|--------|
|
|
174
|
-
| Developer | [TO FILL] | | ☐ Completed |
|
|
175
|
-
| Code Reviewer | [TO FILL] | | ☐ Approved |
|
|
176
|
-
| QA | [TO FILL] | | ☐ Verified |
|
|
177
|
-
|
|
178
|
-
---
|
|
179
|
-
|
|
180
|
-
## Revision History
|
|
181
|
-
|
|
182
|
-
| Version | Date | Author | Changes |
|
|
183
|
-
|---------|------|--------|---------|
|
|
184
|
-
| 1.0 | [TO FILL] | [TO FILL] | Initial report |
|
|
@@ -1,191 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: "[TO FILL: Feature Title]"
|
|
3
|
-
workitem_id: "[TO FILL]"
|
|
4
|
-
type: Functional Specification
|
|
5
|
-
version: "1.0"
|
|
6
|
-
status: Draft
|
|
7
|
-
author: "[TO FILL]"
|
|
8
|
-
created: "[TO FILL: Date]"
|
|
9
|
-
last_updated: "[TO FILL: Date]"
|
|
10
|
-
azure_devops_link: "[TO FILL: Link to ADO Work Item]"
|
|
11
|
-
---
|
|
12
|
-
|
|
13
|
-
# Functional Specification: [TO FILL: Feature Title]
|
|
14
|
-
|
|
15
|
-
## 1. Overview
|
|
16
|
-
|
|
17
|
-
### 1.1 Purpose
|
|
18
|
-
[TO FILL: Brief description of the feature's purpose and the problem it solves]
|
|
19
|
-
|
|
20
|
-
### 1.2 Scope
|
|
21
|
-
[TO FILL: What is included and explicitly excluded from this feature]
|
|
22
|
-
|
|
23
|
-
### 1.3 Background
|
|
24
|
-
[TO FILL: Context and history leading to this feature request]
|
|
25
|
-
|
|
26
|
-
---
|
|
27
|
-
|
|
28
|
-
## 2. Stakeholders
|
|
29
|
-
|
|
30
|
-
| Role | Name | Responsibility |
|
|
31
|
-
|------|------|----------------|
|
|
32
|
-
| Product Owner | [TO FILL] | Requirements validation |
|
|
33
|
-
| Tech Lead | [TO FILL] | Technical decisions |
|
|
34
|
-
| QA Lead | [TO FILL] | Test strategy |
|
|
35
|
-
| UX Designer | [TO FILL] | User experience |
|
|
36
|
-
|
|
37
|
-
---
|
|
38
|
-
|
|
39
|
-
## 3. Requirements
|
|
40
|
-
|
|
41
|
-
### 3.1 Functional Requirements
|
|
42
|
-
|
|
43
|
-
| ID | Requirement | Priority | Source |
|
|
44
|
-
|----|-------------|----------|--------|
|
|
45
|
-
| FR-001 | [TO FILL] | Must Have | ADO #{workitem_id} |
|
|
46
|
-
| FR-002 | [TO FILL] | Should Have | |
|
|
47
|
-
| FR-003 | [TO FILL] | Could Have | |
|
|
48
|
-
|
|
49
|
-
### 3.2 Non-Functional Requirements
|
|
50
|
-
|
|
51
|
-
| ID | Category | Requirement | Target |
|
|
52
|
-
|----|----------|-------------|--------|
|
|
53
|
-
| NFR-001 | Performance | [TO FILL] | [TO FILL] |
|
|
54
|
-
| NFR-002 | Security | [TO FILL] | [TO FILL] |
|
|
55
|
-
| NFR-003 | Availability | [TO FILL] | [TO FILL] |
|
|
56
|
-
| NFR-004 | Scalability | [TO FILL] | [TO FILL] |
|
|
57
|
-
|
|
58
|
-
### 3.3 Acceptance Criteria
|
|
59
|
-
|
|
60
|
-
```gherkin
|
|
61
|
-
Feature: [TO FILL: Feature Name]
|
|
62
|
-
|
|
63
|
-
Scenario: [TO FILL: Main Success Scenario]
|
|
64
|
-
Given [TO FILL: Initial context]
|
|
65
|
-
When [TO FILL: Action performed]
|
|
66
|
-
Then [TO FILL: Expected outcome]
|
|
67
|
-
|
|
68
|
-
Scenario: [TO FILL: Alternative Scenario]
|
|
69
|
-
Given [TO FILL]
|
|
70
|
-
When [TO FILL]
|
|
71
|
-
Then [TO FILL]
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
---
|
|
75
|
-
|
|
76
|
-
## 4. User Experience
|
|
77
|
-
|
|
78
|
-
### 4.1 User Personas
|
|
79
|
-
|
|
80
|
-
**Persona 1: [TO FILL: Name]**
|
|
81
|
-
- Role: [TO FILL]
|
|
82
|
-
- Goals: [TO FILL]
|
|
83
|
-
- Pain Points: [TO FILL]
|
|
84
|
-
|
|
85
|
-
### 4.2 User Stories
|
|
86
|
-
|
|
87
|
-
| ID | As a... | I want to... | So that... |
|
|
88
|
-
|----|---------|--------------|------------|
|
|
89
|
-
| US-001 | [TO FILL] | [TO FILL] | [TO FILL] |
|
|
90
|
-
| US-002 | [TO FILL] | [TO FILL] | [TO FILL] |
|
|
91
|
-
|
|
92
|
-
### 4.3 User Flow
|
|
93
|
-
|
|
94
|
-
```
|
|
95
|
-
[TO FILL: Describe or link to user flow diagram]
|
|
96
|
-
┌─────────┐ ┌─────────┐ ┌─────────┐
|
|
97
|
-
│ Step 1 │───▶│ Step 2 │───▶│ Step 3 │
|
|
98
|
-
└─────────┘ └─────────┘ └─────────┘
|
|
99
|
-
```
|
|
100
|
-
|
|
101
|
-
---
|
|
102
|
-
|
|
103
|
-
## 5. Technical Considerations
|
|
104
|
-
|
|
105
|
-
### 5.1 Architecture Impact
|
|
106
|
-
[TO FILL: How this feature affects the existing architecture]
|
|
107
|
-
|
|
108
|
-
### 5.2 Dependencies
|
|
109
|
-
|
|
110
|
-
| Dependency | Type | Status | Notes |
|
|
111
|
-
|------------|------|--------|-------|
|
|
112
|
-
| [TO FILL] | Service/API | [TO FILL] | |
|
|
113
|
-
| [TO FILL] | Library | [TO FILL] | |
|
|
114
|
-
|
|
115
|
-
### 5.3 Data Model Changes
|
|
116
|
-
[TO FILL: New entities, modified schemas, migrations needed]
|
|
117
|
-
|
|
118
|
-
### 5.4 API Changes
|
|
119
|
-
[TO FILL: New endpoints, modified contracts]
|
|
120
|
-
|
|
121
|
-
---
|
|
122
|
-
|
|
123
|
-
## 6. Risks & Assumptions
|
|
124
|
-
|
|
125
|
-
### 6.1 Assumptions
|
|
126
|
-
|
|
127
|
-
| ID | Assumption | Impact if Wrong |
|
|
128
|
-
|----|------------|-----------------|
|
|
129
|
-
| A-001 | [TO FILL] | [TO FILL] |
|
|
130
|
-
|
|
131
|
-
### 6.2 Risks
|
|
132
|
-
|
|
133
|
-
| ID | Risk | Probability | Impact | Mitigation |
|
|
134
|
-
|----|------|-------------|--------|------------|
|
|
135
|
-
| R-001 | [TO FILL] | Medium | High | [TO FILL] |
|
|
136
|
-
|
|
137
|
-
### 6.3 Open Questions
|
|
138
|
-
|
|
139
|
-
- [ ] [TO FILL: Question 1]
|
|
140
|
-
- [ ] [TO FILL: Question 2]
|
|
141
|
-
|
|
142
|
-
---
|
|
143
|
-
|
|
144
|
-
## 7. Implementation Notes
|
|
145
|
-
|
|
146
|
-
### 7.1 Suggested Approach
|
|
147
|
-
[TO FILL: High-level implementation strategy]
|
|
148
|
-
|
|
149
|
-
### 7.2 Phasing (if applicable)
|
|
150
|
-
|
|
151
|
-
| Phase | Scope | Target Date |
|
|
152
|
-
|-------|-------|-------------|
|
|
153
|
-
| Phase 1 | [TO FILL] | [TO FILL] |
|
|
154
|
-
| Phase 2 | [TO FILL] | [TO FILL] |
|
|
155
|
-
|
|
156
|
-
---
|
|
157
|
-
|
|
158
|
-
## 8. Testing Strategy
|
|
159
|
-
|
|
160
|
-
### 8.1 Test Scenarios
|
|
161
|
-
[TO FILL: Key scenarios to test]
|
|
162
|
-
|
|
163
|
-
### 8.2 Test Data Requirements
|
|
164
|
-
[TO FILL: Special data needed for testing]
|
|
165
|
-
|
|
166
|
-
---
|
|
167
|
-
|
|
168
|
-
## 9. Documentation & Training
|
|
169
|
-
|
|
170
|
-
- [ ] User documentation required
|
|
171
|
-
- [ ] Admin documentation required
|
|
172
|
-
- [ ] Training materials needed
|
|
173
|
-
- [ ] Release notes entry
|
|
174
|
-
|
|
175
|
-
---
|
|
176
|
-
|
|
177
|
-
## 10. Approval
|
|
178
|
-
|
|
179
|
-
| Role | Name | Date | Signature |
|
|
180
|
-
|------|------|------|-----------|
|
|
181
|
-
| Product Owner | | | ☐ Approved |
|
|
182
|
-
| Tech Lead | | | ☐ Approved |
|
|
183
|
-
| QA Lead | | | ☐ Approved |
|
|
184
|
-
|
|
185
|
-
---
|
|
186
|
-
|
|
187
|
-
## Revision History
|
|
188
|
-
|
|
189
|
-
| Version | Date | Author | Changes |
|
|
190
|
-
|---------|------|--------|---------|
|
|
191
|
-
| 1.0 | [TO FILL] | [TO FILL] | Initial draft |
|