@jadeit/forge-ai 0.0.0 → 1.4.0
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/agents/build-agent.md +206 -0
- package/agents/deploy-agent.md +256 -0
- package/agents/design-agent.md +261 -0
- package/agents/feature-dev/approach.md +169 -0
- package/agents/feature-dev/clarify.md +131 -0
- package/agents/feature-dev/discover.md +113 -0
- package/agents/feature-dev/explore.md +124 -0
- package/agents/feature-dev/implement.md +211 -0
- package/agents/feature-dev/review.md +208 -0
- package/agents/feature-dev/summarise.md +199 -0
- package/agents/feature-dev/validate.md +211 -0
- package/agents/forge-orchestrator.md +188 -0
- package/agents/maintain-agent.md +251 -0
- package/agents/plan-agent.md +192 -0
- package/agents/test-agent.md +215 -0
- package/commands/forge-1-plan.md +48 -0
- package/commands/forge-2-design.md +51 -0
- package/commands/forge-3-build-1-discover.md +34 -0
- package/commands/forge-3-build-2-explore.md +30 -0
- package/commands/forge-3-build-3-clarify.md +39 -0
- package/commands/forge-3-build-4-approach.md +38 -0
- package/commands/forge-3-build-5-implement.md +38 -0
- package/commands/forge-3-build-6-review.md +50 -0
- package/commands/forge-3-build-7-validate.md +49 -0
- package/commands/forge-3-build-8-summarise.md +49 -0
- package/commands/forge-3-build.md +54 -0
- package/commands/forge-4-test.md +45 -0
- package/commands/forge-5-deploy.md +50 -0
- package/commands/forge-6-maintain.md +66 -0
- package/commands/forge-init.md +111 -0
- package/commands/forge-status.md +94 -0
- package/commands/forge.md +77 -0
- package/dist/agents/build-agent.md +29 -44
- package/dist/agents/design-agent.md +41 -1
- package/dist/agents/feature-dev/implement.md +11 -0
- package/dist/agents/feature-dev/review.md +3 -0
- package/dist/agents/feature-dev/summarise.md +12 -0
- package/dist/agents/plan-agent.md +12 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +171 -2
- package/dist/index.js.map +1 -1
- package/dist/skills/forge-build/SKILL.md +48 -0
- package/dist/skills/forge-build-approach/SKILL.md +39 -0
- package/dist/skills/forge-build-clarify/SKILL.md +40 -0
- package/dist/skills/forge-build-discover/SKILL.md +35 -0
- package/dist/skills/forge-build-explore/SKILL.md +31 -0
- package/dist/skills/forge-build-implement/SKILL.md +39 -0
- package/dist/skills/forge-build-review/SKILL.md +51 -0
- package/dist/skills/forge-build-summarise/SKILL.md +51 -0
- package/dist/skills/forge-build-validate/SKILL.md +50 -0
- package/dist/skills/forge-deploy/SKILL.md +52 -0
- package/dist/skills/forge-design/SKILL.md +53 -0
- package/dist/skills/forge-init/SKILL.md +83 -0
- package/dist/skills/forge-maintain/SKILL.md +53 -0
- package/dist/skills/forge-plan/SKILL.md +50 -0
- package/dist/skills/forge-status/SKILL.md +59 -0
- package/dist/skills/forge-test/SKILL.md +47 -0
- package/package.json +7 -3
- package/skills/forge-build/SKILL.md +48 -0
- package/skills/forge-build-approach/SKILL.md +39 -0
- package/skills/forge-build-clarify/SKILL.md +40 -0
- package/skills/forge-build-discover/SKILL.md +35 -0
- package/skills/forge-build-explore/SKILL.md +31 -0
- package/skills/forge-build-implement/SKILL.md +39 -0
- package/skills/forge-build-review/SKILL.md +51 -0
- package/skills/forge-build-summarise/SKILL.md +51 -0
- package/skills/forge-build-validate/SKILL.md +50 -0
- package/skills/forge-context-loader/SKILL.md +99 -0
- package/skills/forge-deploy/SKILL.md +52 -0
- package/skills/forge-design/SKILL.md +53 -0
- package/skills/forge-init/SKILL.md +83 -0
- package/skills/forge-maintain/SKILL.md +53 -0
- package/skills/forge-plan/SKILL.md +50 -0
- package/skills/forge-quality-checker/SKILL.md +227 -0
- package/skills/forge-state-manager/SKILL.md +235 -0
- package/skills/forge-status/SKILL.md +59 -0
- package/skills/forge-template-loader/SKILL.md +162 -0
- package/skills/forge-test/SKILL.md +47 -0
- package/templates/defects/DEFECT_TEMPLATE.md +96 -0
- package/templates/design/design-decisions.md +64 -0
- package/templates/design/task-list.md +56 -0
- package/templates/design/tasks/TASK_TEMPLATE.md +87 -0
- package/templates/planning/implementation-plan.md +59 -0
- package/templates/planning/project-scope.md +53 -0
- package/templates/planning/technology-and-architecture.md +80 -0
- package/templates/planning/user-stories.md +48 -0
- package/templates/testing/uat-results.md +68 -0
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: forge-template-loader
|
|
3
|
+
description: Load and apply Forge document templates for all phases and artifacts
|
|
4
|
+
license: MIT
|
|
5
|
+
compatibility: opencode
|
|
6
|
+
metadata:
|
|
7
|
+
audience: forge-users
|
|
8
|
+
workflow: document-creation
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Forge Template Loader
|
|
12
|
+
|
|
13
|
+
Load and apply Forge document templates for all phases and artifacts.
|
|
14
|
+
|
|
15
|
+
## Template Locations
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
.forge/templates/
|
|
19
|
+
├── planning/
|
|
20
|
+
│ ├── project-scope.md
|
|
21
|
+
│ ├── user-stories.md
|
|
22
|
+
│ ├── implementation-plan.md
|
|
23
|
+
│ └── technology-and-architecture.md
|
|
24
|
+
├── design/
|
|
25
|
+
│ ├── design-decisions.md
|
|
26
|
+
│ ├── task-list.md
|
|
27
|
+
│ └── tasks/
|
|
28
|
+
│ └── TASK_TEMPLATE.md
|
|
29
|
+
├── testing/
|
|
30
|
+
│ └── uat-results.md
|
|
31
|
+
└── defects/
|
|
32
|
+
└── DEFECT_TEMPLATE.md
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Usage by Phase
|
|
36
|
+
|
|
37
|
+
### Phase 1: Planning Templates
|
|
38
|
+
|
|
39
|
+
Load from `.forge/templates/planning/`:
|
|
40
|
+
|
|
41
|
+
| Document | Template | Output Location |
|
|
42
|
+
|----------|----------|-----------------|
|
|
43
|
+
| Project Scope | `project-scope.md` | `docs/planning/project-scope.md` |
|
|
44
|
+
| User Stories | `user-stories.md` | `docs/planning/user-stories.md` |
|
|
45
|
+
| Implementation Plan | `implementation-plan.md` | `docs/planning/implementation-plan.md` |
|
|
46
|
+
| Technology & Architecture | `technology-and-architecture.md` | `docs/planning/technology-and-architecture.md` |
|
|
47
|
+
|
|
48
|
+
### Phase 2: Design Templates
|
|
49
|
+
|
|
50
|
+
Load from `.forge/templates/design/`:
|
|
51
|
+
|
|
52
|
+
| Document | Template | Output Location |
|
|
53
|
+
|----------|----------|-----------------|
|
|
54
|
+
| Design Decisions | `design-decisions.md` | `docs/design/design-decisions.md` |
|
|
55
|
+
| Task List | `task-list.md` | `docs/design/task-list.md` |
|
|
56
|
+
| Individual Task | `tasks/TASK_TEMPLATE.md` | `docs/design/tasks/{task-slug}.md` |
|
|
57
|
+
|
|
58
|
+
### Phase 4: Testing Templates
|
|
59
|
+
|
|
60
|
+
| Document | Template | Output Location |
|
|
61
|
+
|----------|----------|-----------------|
|
|
62
|
+
| UAT Results | `testing/uat-results.md` | `docs/testing/uat-results.md` |
|
|
63
|
+
|
|
64
|
+
### Defect Templates
|
|
65
|
+
|
|
66
|
+
| Document | Template | Output Location |
|
|
67
|
+
|----------|----------|-----------------|
|
|
68
|
+
| Defect Report | `defects/DEFECT_TEMPLATE.md` | `docs/defects/{defect-slug}.md` |
|
|
69
|
+
|
|
70
|
+
## Template Variables
|
|
71
|
+
|
|
72
|
+
When applying templates, replace these placeholders:
|
|
73
|
+
|
|
74
|
+
| Variable | Description | Example |
|
|
75
|
+
|----------|-------------|---------|
|
|
76
|
+
| `[Task Title]` | Title of the task | "Implement user authentication" |
|
|
77
|
+
| `[Task Slug]` | URL-safe identifier | "implement-user-auth" |
|
|
78
|
+
| `[YYYY-MM-DD]` | Date placeholder | "2026-03-22" |
|
|
79
|
+
| `[timestamp]` | ISO 8601 timestamp | "2026-03-22T10:00:00Z" |
|
|
80
|
+
| `[Persona]` | User persona name | "End User" |
|
|
81
|
+
| `[Goal]` | User goal | "reset my password" |
|
|
82
|
+
| `[Benefit]` | User benefit | " regain access to my account" |
|
|
83
|
+
|
|
84
|
+
## Required Frontmatter Fields
|
|
85
|
+
|
|
86
|
+
### Task Document
|
|
87
|
+
|
|
88
|
+
```yaml
|
|
89
|
+
---
|
|
90
|
+
title: [Task Title]
|
|
91
|
+
status: not-started
|
|
92
|
+
mode: greenfield | brownfield
|
|
93
|
+
complexity: small | medium | large
|
|
94
|
+
categories:
|
|
95
|
+
- backend
|
|
96
|
+
affected_modules: []
|
|
97
|
+
dependencies: []
|
|
98
|
+
---
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### Defect Document
|
|
102
|
+
|
|
103
|
+
```yaml
|
|
104
|
+
---
|
|
105
|
+
title: [Defect Title]
|
|
106
|
+
severity: critical | high | medium | low
|
|
107
|
+
classification: design | implementation
|
|
108
|
+
status: open
|
|
109
|
+
source:
|
|
110
|
+
type: sentry | logs | test | uat | user-report
|
|
111
|
+
url: null
|
|
112
|
+
discovered: [timestamp]
|
|
113
|
+
affected_features: []
|
|
114
|
+
routed_to: null
|
|
115
|
+
---
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## Template Application Process
|
|
119
|
+
|
|
120
|
+
### Creating a New Document
|
|
121
|
+
|
|
122
|
+
1. **Read the template** from `.forge/templates/`
|
|
123
|
+
2. **Replace placeholders** with actual values
|
|
124
|
+
3. **Set initial status** in frontmatter (e.g., `status: in-progress`)
|
|
125
|
+
4. **Set dates** to current timestamp
|
|
126
|
+
5. **Write to destination** in `docs/`
|
|
127
|
+
|
|
128
|
+
### Example: Creating a Task Document
|
|
129
|
+
|
|
130
|
+
```
|
|
131
|
+
Input: TASK_TEMPLATE.md
|
|
132
|
+
Variables:
|
|
133
|
+
title = "Implement user authentication"
|
|
134
|
+
slug = "implement-user-auth"
|
|
135
|
+
complexity = "medium"
|
|
136
|
+
categories = ["backend", "database"]
|
|
137
|
+
|
|
138
|
+
Output: docs/design/tasks/implement-user-auth.md
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## Template Validation
|
|
142
|
+
|
|
143
|
+
After creating a document, validate:
|
|
144
|
+
|
|
145
|
+
1. **Frontmatter present** - Document starts with `---`
|
|
146
|
+
2. **Required fields** - All required fields populated
|
|
147
|
+
3. **Valid enums** - Status, mode, complexity use valid values
|
|
148
|
+
4. **File path** - Correct location and naming
|
|
149
|
+
|
|
150
|
+
## Modifying Templates
|
|
151
|
+
|
|
152
|
+
Templates can be customized per project:
|
|
153
|
+
|
|
154
|
+
1. Copy from `.forge/templates/` to project root
|
|
155
|
+
2. Modify as needed
|
|
156
|
+
3. Use project-local template instead of global
|
|
157
|
+
|
|
158
|
+
Or extend `.forge/config.yaml`:
|
|
159
|
+
```yaml
|
|
160
|
+
templates:
|
|
161
|
+
custom_path: .forge/templates-custom/
|
|
162
|
+
```
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: forge-test
|
|
3
|
+
description: Forge AI Phase 4 - Functional testing and UAT
|
|
4
|
+
license: MIT
|
|
5
|
+
compatibility: opencode
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Forge AI: Phase 4 - Testing
|
|
9
|
+
|
|
10
|
+
Invoke the `@forge-test` agent to begin User Acceptance Testing.
|
|
11
|
+
|
|
12
|
+
## What Happens
|
|
13
|
+
|
|
14
|
+
1. User stories and acceptance criteria are loaded
|
|
15
|
+
2. UAT checklist is presented
|
|
16
|
+
3. For each item, you confirm: passed / failed / skipped
|
|
17
|
+
4. Failed items → defect reports created in `docs/defects/`
|
|
18
|
+
5. Results → `docs/testing/uat-results.md`
|
|
19
|
+
6. State updated after your sign-off
|
|
20
|
+
|
|
21
|
+
## UAT Gate Process
|
|
22
|
+
|
|
23
|
+
1. Present checklist of user stories with acceptance criteria
|
|
24
|
+
2. You verify each by running the project locally
|
|
25
|
+
3. For each item: PASSED / FAILED / SKIPPED
|
|
26
|
+
4. Failed items produce defect reports
|
|
27
|
+
5. Skipped items logged with reason
|
|
28
|
+
6. Phase 5 proceeds only after your sign-off
|
|
29
|
+
|
|
30
|
+
## Requirements
|
|
31
|
+
|
|
32
|
+
User acceptance testing MUST be done by:
|
|
33
|
+
- Running the project locally
|
|
34
|
+
- Validating each user story against implementation
|
|
35
|
+
- NOT just running automated tests
|
|
36
|
+
|
|
37
|
+
## Defect Handling
|
|
38
|
+
|
|
39
|
+
For failed items:
|
|
40
|
+
1. Create defect report in `docs/defects/`
|
|
41
|
+
2. Document reproduction steps
|
|
42
|
+
3. Classify: design or implementation
|
|
43
|
+
4. Route to appropriate phase
|
|
44
|
+
|
|
45
|
+
## Next Steps
|
|
46
|
+
|
|
47
|
+
After Phase 4 complete, use `/forge-deploy` for Phase 5: Deployment.
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: [Defect Title]
|
|
3
|
+
severity: critical
|
|
4
|
+
classification: implementation
|
|
5
|
+
status: open
|
|
6
|
+
source:
|
|
7
|
+
type: sentry
|
|
8
|
+
url: null
|
|
9
|
+
discovered: null
|
|
10
|
+
affected_features: []
|
|
11
|
+
routed_to: null
|
|
12
|
+
reproduction_steps: []
|
|
13
|
+
expected_behaviour: null
|
|
14
|
+
actual_behaviour: null
|
|
15
|
+
created: null
|
|
16
|
+
last_updated: null
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
# Defect Report: [Title]
|
|
20
|
+
|
|
21
|
+
## Summary
|
|
22
|
+
|
|
23
|
+
<!-- One-line summary of the defect -->
|
|
24
|
+
|
|
25
|
+
## Severity
|
|
26
|
+
|
|
27
|
+
- [ ] Critical - System unusable, data loss risk
|
|
28
|
+
- [ ] High - Major feature broken, no workaround
|
|
29
|
+
- [ ] Medium - Feature broken, workaround exists
|
|
30
|
+
- [ ] Low - Minor issue, cosmetic
|
|
31
|
+
|
|
32
|
+
## Classification
|
|
33
|
+
|
|
34
|
+
- **Design** - Flawed design that needs revisiting
|
|
35
|
+
- **Implementation** - Incorrect implementation of correct design
|
|
36
|
+
|
|
37
|
+
## Source
|
|
38
|
+
|
|
39
|
+
| Field | Value |
|
|
40
|
+
|-------|-------|
|
|
41
|
+
| Type | sentry / logs / test / uat / user-report |
|
|
42
|
+
| URL | |
|
|
43
|
+
| Discovered | |
|
|
44
|
+
|
|
45
|
+
## Affected Features
|
|
46
|
+
|
|
47
|
+
-
|
|
48
|
+
|
|
49
|
+
## Reproduction Steps
|
|
50
|
+
|
|
51
|
+
1.
|
|
52
|
+
2.
|
|
53
|
+
3.
|
|
54
|
+
|
|
55
|
+
## Expected Behaviour
|
|
56
|
+
|
|
57
|
+
<!-- What should happen -->
|
|
58
|
+
|
|
59
|
+
## Actual Behaviour
|
|
60
|
+
|
|
61
|
+
<!-- What actually happens -->
|
|
62
|
+
|
|
63
|
+
## Screenshots / Logs
|
|
64
|
+
|
|
65
|
+
<!-- Include relevant screenshots or log excerpts -->
|
|
66
|
+
|
|
67
|
+
## Environment
|
|
68
|
+
|
|
69
|
+
| Field | Value |
|
|
70
|
+
|-------|-------|
|
|
71
|
+
| Browser/OS | |
|
|
72
|
+
| Version | |
|
|
73
|
+
| User Type | |
|
|
74
|
+
|
|
75
|
+
## Resolution
|
|
76
|
+
|
|
77
|
+
### Routed To
|
|
78
|
+
|
|
79
|
+
- Design phase (`forge 2:design`)
|
|
80
|
+
- Build phase (`forge 3:build`)
|
|
81
|
+
|
|
82
|
+
### Root Cause
|
|
83
|
+
|
|
84
|
+
<!-- Analysis of the root cause -->
|
|
85
|
+
|
|
86
|
+
### Fix Applied
|
|
87
|
+
|
|
88
|
+
<!-- How the defect was resolved -->
|
|
89
|
+
|
|
90
|
+
### Resolution Date
|
|
91
|
+
|
|
92
|
+
## Changelog
|
|
93
|
+
|
|
94
|
+
| Date | Action | By |
|
|
95
|
+
|------|--------|-----|
|
|
96
|
+
| | | |
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Design Decisions
|
|
3
|
+
phase: 2
|
|
4
|
+
status: in-progress
|
|
5
|
+
created: null
|
|
6
|
+
last_updated: null
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Design Decisions
|
|
10
|
+
|
|
11
|
+
## Decision Record Template
|
|
12
|
+
|
|
13
|
+
| Field | Value |
|
|
14
|
+
|-------|-------|
|
|
15
|
+
| **Decision ID** | ADDR-001 |
|
|
16
|
+
| **Date** | YYYY-MM-DD |
|
|
17
|
+
| **Status** | Proposed / Accepted / Deprecated |
|
|
18
|
+
| **Deciders** | |
|
|
19
|
+
| **Context** | |
|
|
20
|
+
| **Decision** | |
|
|
21
|
+
| **Consequences** | |
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## ADDR-001: [Title]
|
|
26
|
+
|
|
27
|
+
**Status:** Accepted
|
|
28
|
+
|
|
29
|
+
### Context
|
|
30
|
+
|
|
31
|
+
<!-- What is the issue or decision being addressed? -->
|
|
32
|
+
|
|
33
|
+
### Decision
|
|
34
|
+
|
|
35
|
+
<!-- What is the change that is proposed or has been made? -->
|
|
36
|
+
|
|
37
|
+
### Alternatives Considered
|
|
38
|
+
|
|
39
|
+
1. **Option A:**
|
|
40
|
+
- Pros:
|
|
41
|
+
- Cons:
|
|
42
|
+
|
|
43
|
+
2. **Option B:**
|
|
44
|
+
- Pros:
|
|
45
|
+
- Cons:
|
|
46
|
+
|
|
47
|
+
### Consequences
|
|
48
|
+
|
|
49
|
+
**Positive:**
|
|
50
|
+
-
|
|
51
|
+
|
|
52
|
+
**Negative:**
|
|
53
|
+
-
|
|
54
|
+
|
|
55
|
+
**Neutral:**
|
|
56
|
+
-
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
## Decision Index
|
|
61
|
+
|
|
62
|
+
| ID | Title | Status | Date |
|
|
63
|
+
|----|-------|--------|------|
|
|
64
|
+
| ADDR-001 | | | |
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Task List
|
|
3
|
+
phase: 2
|
|
4
|
+
status: in-progress
|
|
5
|
+
created: null
|
|
6
|
+
last_updated: null
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Task List
|
|
10
|
+
|
|
11
|
+
## Summary
|
|
12
|
+
|
|
13
|
+
| Total Tasks | Small | Medium | Large |
|
|
14
|
+
|-------------|-------|--------|-------|
|
|
15
|
+
| | | | |
|
|
16
|
+
|
|
17
|
+
## Tasks by Category
|
|
18
|
+
|
|
19
|
+
### Backend
|
|
20
|
+
| Task Slug | Title | Complexity | Dependencies |
|
|
21
|
+
|-----------|-------|------------|--------------|
|
|
22
|
+
| | | | |
|
|
23
|
+
|
|
24
|
+
### Frontend
|
|
25
|
+
| Task Slug | Title | Complexity | Dependencies |
|
|
26
|
+
|-----------|-------|------------|--------------|
|
|
27
|
+
| | | | |
|
|
28
|
+
|
|
29
|
+
### Infrastructure
|
|
30
|
+
| Task Slug | Title | Complexity | Dependencies |
|
|
31
|
+
|-----------|-------|------------|--------------|
|
|
32
|
+
| | | | |
|
|
33
|
+
|
|
34
|
+
### Database
|
|
35
|
+
| Task Slug | Title | Complexity | Dependencies |
|
|
36
|
+
|-----------|-------|------------|--------------|
|
|
37
|
+
| | | | |
|
|
38
|
+
|
|
39
|
+
### Documentation
|
|
40
|
+
| Task Slug | Title | Complexity | Dependencies |
|
|
41
|
+
|-----------|-------|------------|--------------|
|
|
42
|
+
| | | | |
|
|
43
|
+
|
|
44
|
+
## Task Dependencies Graph
|
|
45
|
+
|
|
46
|
+
```mermaid
|
|
47
|
+
flowchart LR
|
|
48
|
+
A[Task A] --> B[Task B]
|
|
49
|
+
B --> C[Task C]
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Implementation Order Recommendation
|
|
53
|
+
|
|
54
|
+
1.
|
|
55
|
+
2.
|
|
56
|
+
3.
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: [Task Title]
|
|
3
|
+
status: not-started
|
|
4
|
+
mode: greenfield
|
|
5
|
+
complexity: medium
|
|
6
|
+
categories:
|
|
7
|
+
- backend
|
|
8
|
+
affected_modules: []
|
|
9
|
+
dependencies: []
|
|
10
|
+
acceptance_criteria: []
|
|
11
|
+
created: null
|
|
12
|
+
last_updated: null
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# Task: [Title]
|
|
16
|
+
|
|
17
|
+
## Summary / Objective
|
|
18
|
+
|
|
19
|
+
<!-- What this task achieves and why it is needed -->
|
|
20
|
+
|
|
21
|
+
## User Story Reference
|
|
22
|
+
|
|
23
|
+
<!-- Link to the user story this task supports: US-XXX -->
|
|
24
|
+
|
|
25
|
+
## Acceptance Criteria
|
|
26
|
+
|
|
27
|
+
- [ ] Criterion 1
|
|
28
|
+
- [ ] Criterion 2
|
|
29
|
+
- [ ] Criterion 3
|
|
30
|
+
|
|
31
|
+
## Implementation Detail
|
|
32
|
+
|
|
33
|
+
### Approach
|
|
34
|
+
|
|
35
|
+
<!-- How to implement this task -->
|
|
36
|
+
|
|
37
|
+
### Components to Create/Modify
|
|
38
|
+
|
|
39
|
+
| Component | Action | Description |
|
|
40
|
+
|-----------|--------|-------------|
|
|
41
|
+
| | | |
|
|
42
|
+
|
|
43
|
+
### Illustrative Code
|
|
44
|
+
|
|
45
|
+
```typescript
|
|
46
|
+
// Example interface or pseudo-code
|
|
47
|
+
interface Example {
|
|
48
|
+
id: string;
|
|
49
|
+
// ...
|
|
50
|
+
}
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### API Changes
|
|
54
|
+
|
|
55
|
+
| Endpoint | Method | Description |
|
|
56
|
+
|----------|--------|-------------|
|
|
57
|
+
| | | |
|
|
58
|
+
|
|
59
|
+
## Testing Criteria
|
|
60
|
+
|
|
61
|
+
### Unit Tests
|
|
62
|
+
|
|
63
|
+
- Test case 1
|
|
64
|
+
- Test case 2
|
|
65
|
+
|
|
66
|
+
### Integration Tests
|
|
67
|
+
|
|
68
|
+
- Integration scenario 1
|
|
69
|
+
|
|
70
|
+
### Manual Tests
|
|
71
|
+
|
|
72
|
+
- Manual verification step 1
|
|
73
|
+
|
|
74
|
+
## Edge Cases
|
|
75
|
+
|
|
76
|
+
- Edge case 1 and how it is handled
|
|
77
|
+
- Edge case 2 and how it is handled
|
|
78
|
+
|
|
79
|
+
## Notes
|
|
80
|
+
|
|
81
|
+
<!-- Additional context, concerns, or decisions -->
|
|
82
|
+
|
|
83
|
+
## Changelog
|
|
84
|
+
|
|
85
|
+
| Date | Change | By |
|
|
86
|
+
|------|--------|-----|
|
|
87
|
+
| | | |
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Implementation Plan
|
|
3
|
+
phase: 1
|
|
4
|
+
status: in-progress
|
|
5
|
+
created: null
|
|
6
|
+
last_updated: null
|
|
7
|
+
phases: []
|
|
8
|
+
timeline_estimate: null
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Implementation Plan
|
|
12
|
+
|
|
13
|
+
## Overview
|
|
14
|
+
|
|
15
|
+
<!-- Brief description of the implementation approach -->
|
|
16
|
+
|
|
17
|
+
## Phase Breakdown
|
|
18
|
+
|
|
19
|
+
| Phase | Description | Estimated Duration | Dependencies |
|
|
20
|
+
|-------|-------------|-------------------|--------------|
|
|
21
|
+
| 1 | Planning | | - |
|
|
22
|
+
| 2 | Design | | Phase 1 |
|
|
23
|
+
| 3 | Build | | Phase 2 |
|
|
24
|
+
| 4 | Test | | Phase 3 |
|
|
25
|
+
| 5 | Deploy | | Phase 4 |
|
|
26
|
+
| 6 | Maintain | | Phase 5 |
|
|
27
|
+
|
|
28
|
+
## Phase 3 Implementation Groups
|
|
29
|
+
|
|
30
|
+
### Group 1: Foundation
|
|
31
|
+
| Task | Description | Complexity |
|
|
32
|
+
|------|-------------|------------|
|
|
33
|
+
| | | |
|
|
34
|
+
|
|
35
|
+
### Group 2: Core Features
|
|
36
|
+
| Task | Description | Complexity |
|
|
37
|
+
|------|-------------|------------|
|
|
38
|
+
| | | |
|
|
39
|
+
|
|
40
|
+
### Group 3: Polish
|
|
41
|
+
| Task | Description | Complexity |
|
|
42
|
+
|------|-------------|------------|
|
|
43
|
+
| | | |
|
|
44
|
+
|
|
45
|
+
## Timeline Estimate
|
|
46
|
+
|
|
47
|
+
**Total Estimated Duration:**
|
|
48
|
+
|
|
49
|
+
## Milestones
|
|
50
|
+
|
|
51
|
+
| Milestone | Target Date | Delivered By |
|
|
52
|
+
|-----------|-------------|--------------|
|
|
53
|
+
| | | |
|
|
54
|
+
|
|
55
|
+
## Risk Assessment
|
|
56
|
+
|
|
57
|
+
| Risk | Impact | Likelihood | Mitigation |
|
|
58
|
+
|------|--------|------------|------------|
|
|
59
|
+
| | | | |
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Project Scope
|
|
3
|
+
phase: 1
|
|
4
|
+
status: in-progress
|
|
5
|
+
created: null
|
|
6
|
+
last_updated: null
|
|
7
|
+
stakeholders: []
|
|
8
|
+
user_personas: []
|
|
9
|
+
high_level_goals: []
|
|
10
|
+
constraints: []
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Project Scope
|
|
14
|
+
|
|
15
|
+
## Aim
|
|
16
|
+
|
|
17
|
+
<!-- What the project aims to achieve -->
|
|
18
|
+
|
|
19
|
+
## High-Level Design
|
|
20
|
+
|
|
21
|
+
<!-- Overview of the solution approach -->
|
|
22
|
+
|
|
23
|
+
## High-Level Technology Choices
|
|
24
|
+
|
|
25
|
+
<!-- Major technologies and frameworks chosen -->
|
|
26
|
+
|
|
27
|
+
## Stakeholders
|
|
28
|
+
|
|
29
|
+
| Name | Role | Contact |
|
|
30
|
+
|------|------|---------|
|
|
31
|
+
| | | |
|
|
32
|
+
|
|
33
|
+
## User Personas
|
|
34
|
+
|
|
35
|
+
| Persona | Description | Needs |
|
|
36
|
+
|---------|-------------|-------|
|
|
37
|
+
| | | |
|
|
38
|
+
|
|
39
|
+
## High-Level Goals
|
|
40
|
+
|
|
41
|
+
1.
|
|
42
|
+
2.
|
|
43
|
+
3.
|
|
44
|
+
|
|
45
|
+
## Constraints
|
|
46
|
+
|
|
47
|
+
-
|
|
48
|
+
-
|
|
49
|
+
|
|
50
|
+
## Success Criteria
|
|
51
|
+
|
|
52
|
+
-
|
|
53
|
+
-
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Technology & Architecture
|
|
3
|
+
phase: 1
|
|
4
|
+
status: in-progress
|
|
5
|
+
created: null
|
|
6
|
+
last_updated: null
|
|
7
|
+
architecture_diagram: null
|
|
8
|
+
tech_stack: []
|
|
9
|
+
diagram_type: c4
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Technology & Architecture
|
|
13
|
+
|
|
14
|
+
## Architecture Diagram
|
|
15
|
+
|
|
16
|
+
```mermaid
|
|
17
|
+
%% C4 Model Context Diagram
|
|
18
|
+
C4Context
|
|
19
|
+
title System Context diagram for [System Name]
|
|
20
|
+
|
|
21
|
+
Person(personAlias, "Actor Name", "Actor Description")
|
|
22
|
+
System(systemAlias, "System Name", "System Description")
|
|
23
|
+
|
|
24
|
+
Rel(personAlias, systemAlias, "Uses")
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
<!-- For C4 Level 1 (Context), use:
|
|
28
|
+
- Person: actors/users
|
|
29
|
+
- System: the system being built and external systems
|
|
30
|
+
-->
|
|
31
|
+
|
|
32
|
+
## Technology Stack
|
|
33
|
+
|
|
34
|
+
| Category | Technology | Version | Rationale |
|
|
35
|
+
|----------|------------|---------|-----------|
|
|
36
|
+
| Language | | | |
|
|
37
|
+
| Framework | | | |
|
|
38
|
+
| Database | | | |
|
|
39
|
+
| Infrastructure | | | |
|
|
40
|
+
| CI/CD | | | |
|
|
41
|
+
| Monitoring | | | |
|
|
42
|
+
|
|
43
|
+
## Infrastructure Overview
|
|
44
|
+
|
|
45
|
+
<!-- Describe deployment environment, cloud provider, etc. -->
|
|
46
|
+
|
|
47
|
+
## System Components
|
|
48
|
+
|
|
49
|
+
| Component | Responsibility | Technology |
|
|
50
|
+
|-----------|---------------|------------|
|
|
51
|
+
| | | |
|
|
52
|
+
|
|
53
|
+
## Data Architecture
|
|
54
|
+
|
|
55
|
+
### Data Stores
|
|
56
|
+
|
|
57
|
+
| Store | Purpose | Technology |
|
|
58
|
+
|-------|---------|------------|
|
|
59
|
+
| | | |
|
|
60
|
+
|
|
61
|
+
### Data Flows
|
|
62
|
+
|
|
63
|
+
```mermaid
|
|
64
|
+
flowchart LR
|
|
65
|
+
A[Client] --> B[API]
|
|
66
|
+
B --> C[(Database)]
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Security Considerations
|
|
70
|
+
|
|
71
|
+
-
|
|
72
|
+
-
|
|
73
|
+
|
|
74
|
+
## Non-Functional Requirements
|
|
75
|
+
|
|
76
|
+
| Requirement | Target | Measurement |
|
|
77
|
+
|-------------|--------|-------------|
|
|
78
|
+
| Performance | | |
|
|
79
|
+
| Availability | | |
|
|
80
|
+
| Scalability | | |
|