agentic-sdlc 1.0.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/.agent/ide-integration/README.md +298 -0
- package/.agent/ide-integration/aider-commands.md +40 -0
- package/.agent/ide-integration/cline-config.json +108 -0
- package/.agent/ide-integration/cursor-rules.md +63 -0
- package/.agent/ide-integration/github-copilot-instructions.md +75 -0
- package/.agent/ide-integration/vscode-commands.json +190 -0
- package/.agent/ide-integration/windsurf-cascade.md +125 -0
- package/.agent/knowledge-base/README.md +202 -0
- package/.agent/knowledge-base/architecture/.gitkeep +1 -0
- package/.agent/knowledge-base/bugs/.gitkeep +1 -0
- package/.agent/knowledge-base/features/.gitkeep +1 -0
- package/.agent/knowledge-base/index.md +202 -0
- package/.agent/knowledge-base/performance/.gitkeep +1 -0
- package/.agent/knowledge-base/platform-specific/.gitkeep +1 -0
- package/.agent/knowledge-base/security/.gitkeep +1 -0
- package/.agent/legacy/roles/designer.md +311 -0
- package/.agent/legacy/roles/dev.md +177 -0
- package/.agent/legacy/roles/devops.md +146 -0
- package/.agent/legacy/roles/orchestrator.md +339 -0
- package/.agent/legacy/roles/pm.md +120 -0
- package/.agent/legacy/roles/po.md +89 -0
- package/.agent/legacy/roles/qa.md +108 -0
- package/.agent/legacy/roles/reporter.md +70 -0
- package/.agent/legacy/roles/sa.md +118 -0
- package/.agent/legacy/roles/seca.md +112 -0
- package/.agent/legacy/roles/stakeholder.md +111 -0
- package/.agent/legacy/roles/tester.md +129 -0
- package/.agent/rules/artifacts.md +58 -0
- package/.agent/rules/git-workflow.md +65 -0
- package/.agent/rules/global.md +154 -0
- package/.agent/rules/global.md.bak +154 -0
- package/.agent/rules/knowledge-base.md +45 -0
- package/.agent/templates/Design-Verification-Report-Template.md +67 -0
- package/.agent/templates/DevOps-Plan-Template.md +90 -0
- package/.agent/templates/Development-Log-Template.md +51 -0
- package/.agent/templates/Final-Approval-Report-Template.md +82 -0
- package/.agent/templates/Final-Project-Report-Template.md +280 -0
- package/.agent/templates/Knowledge-Entry-Template.md +164 -0
- package/.agent/templates/Master-Documentation-Template.md +269 -0
- package/.agent/templates/Phase-Report-Template.md +70 -0
- package/.agent/templates/Product-Backlog-Template.md +84 -0
- package/.agent/templates/Project-Plan-Template.md +79 -0
- package/.agent/templates/Security-Review-Report-Template.md +80 -0
- package/.agent/templates/System-Design-Spec-Template.md +170 -0
- package/.agent/templates/Test-Report-Template.md +97 -0
- package/.agent/templates/UIUX-Design-Spec-Template.md +280 -0
- package/.agent/templates/definition-of-done.md +151 -0
- package/.agent/templates/incident-response.md +111 -0
- package/.agent/usage.md +653 -0
- package/.agent/workflows/auto.md +35 -0
- package/.agent/workflows/brain.md +56 -0
- package/.agent/workflows/dev.md +30 -0
- package/.agent/workflows/devops.md +28 -0
- package/.agent/workflows/kb-search.md +22 -0
- package/.agent/workflows/pm.md +42 -0
- package/.agent/workflows/po.md +21 -0
- package/.agent/workflows/qa.md +31 -0
- package/.agent/workflows/reporter.md +21 -0
- package/.agent/workflows/sa.md +51 -0
- package/.agent/workflows/seca.md +21 -0
- package/.agent/workflows/stakeholder.md +26 -0
- package/.agent/workflows/tester.md +21 -0
- package/.agent/workflows/uiux.md +38 -0
- package/.cursorrules +49 -0
- package/.env.template +10 -0
- package/.github/ISSUE_TEMPLATE/bug_report.yml +47 -0
- package/.github/ISSUE_TEMPLATE/config.yml +8 -0
- package/.github/ISSUE_TEMPLATE/feature_request.yml +33 -0
- package/.github/ISSUE_TEMPLATE/security_alert.yml +28 -0
- package/.github/ISSUE_TEMPLATE/task_implementation.yml +37 -0
- package/.github/copilot-instructions.md +60 -0
- package/CHANGELOG.md +13 -0
- package/README.md +136 -0
- package/bin/cli.js +104 -0
- package/bin/commands/create.js +96 -0
- package/bin/commands/help.js +69 -0
- package/bin/commands/ide.js +116 -0
- package/bin/commands/init-kb.js +74 -0
- package/bin/commands/install.js +68 -0
- package/bin/commands/list.js +35 -0
- package/bin/graph_brain.py +86 -0
- package/bin/sync_github.py +75 -0
- package/bin/utils/args-parser.js +33 -0
- package/bin/utils/colors.js +21 -0
- package/bin/verify_neo4j.py +25 -0
- package/docs/OUTLINE.md +23 -0
- package/docs/architecture/brain.md +36 -0
- package/docs/architecture/neo4j-learning-queries.md +49 -0
- package/docs/guides/CLI-EXAMPLES.md +649 -0
- package/docs/guides/INTEGRATION-GUIDE.md +709 -0
- package/docs/guides/MCP-GUIDE.md +53 -0
- package/docs/guides/QUICK-START.md +104 -0
- package/docs/reports/comparison-leann-neo4j.md +49 -0
- package/docs/setup/github-management.md +37 -0
- package/docs/sprints/sprint-github-issues.md +36 -0
- package/docs/sprints/sprint-leann-integration.md +41 -0
- package/docs/sprints/sprint-neo4j-brain.md +38 -0
- package/package.json +16 -0
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
# System Design Specification - Version [X]
|
|
2
|
+
|
|
3
|
+
## Document Info
|
|
4
|
+
| Field | Value |
|
|
5
|
+
|-------|-------|
|
|
6
|
+
| Version | [X.0] |
|
|
7
|
+
| Date | [YYYY-MM-DD] |
|
|
8
|
+
| Author | @SA |
|
|
9
|
+
| Project Type | Web / Mobile / Desktop / Embedded / CLI / API / Library |
|
|
10
|
+
| Status | Draft / Review / Approved |
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## 1. Architecture Overview
|
|
15
|
+
|
|
16
|
+
```
|
|
17
|
+
โโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโ
|
|
18
|
+
โ Client โโโโโโถโ System โโโโโโถโ Storage โ
|
|
19
|
+
โ โ โ Layer โ โ โ
|
|
20
|
+
โโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโ
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## 2. Technology Stack
|
|
24
|
+
| Layer | Technology | Justification |
|
|
25
|
+
|-------|------------|---------------|
|
|
26
|
+
| Platform | [e.g., Web/iOS/Android/Windows/Linux] | [Reason] |
|
|
27
|
+
| Runtime | [e.g., Node.js 20/Python 3.11/JVM] | [Reason] |
|
|
28
|
+
| Framework | [e.g., SvelteKit/React Native/Electron] | [Reason] |
|
|
29
|
+
| Storage | [e.g., PostgreSQL/SQLite/File System] | [Reason] |
|
|
30
|
+
| Auth | [e.g., Supabase Auth/OAuth/JWT] | [Reason] |
|
|
31
|
+
|
|
32
|
+
## 3. Interface Design
|
|
33
|
+
|
|
34
|
+
### 3.1 API Endpoints (for Web/Mobile Backend)
|
|
35
|
+
| Method | Endpoint | Description | Auth |
|
|
36
|
+
|--------|----------|-------------|------|
|
|
37
|
+
| GET | /api/[resource] | List all | Required |
|
|
38
|
+
| POST | /api/[resource] | Create new | Required |
|
|
39
|
+
|
|
40
|
+
**Request/Response Example:**
|
|
41
|
+
```json
|
|
42
|
+
// POST /api/[resource]
|
|
43
|
+
// Request
|
|
44
|
+
{ "field": "value" }
|
|
45
|
+
|
|
46
|
+
// Response 201
|
|
47
|
+
{ "id": "uuid", "field": "value", "createdAt": "ISO8601" }
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### 3.2 Public API (for Libraries/SDKs)
|
|
51
|
+
```typescript
|
|
52
|
+
// Main interface
|
|
53
|
+
interface [LibraryName] {
|
|
54
|
+
method1(param: Type): ReturnType;
|
|
55
|
+
method2(options: Options): Promise<Result>;
|
|
56
|
+
}
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### 3.3 CLI Commands (for CLI Tools)
|
|
60
|
+
```bash
|
|
61
|
+
# Command structure
|
|
62
|
+
tool-name <command> [options]
|
|
63
|
+
|
|
64
|
+
# Examples
|
|
65
|
+
tool-name init --template=basic
|
|
66
|
+
tool-name build --output=dist
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### 3.4 Communication Protocol (for Embedded/IoT)
|
|
70
|
+
```
|
|
71
|
+
Message Format: [Header][Payload][Checksum]
|
|
72
|
+
- Header: 4 bytes (command ID + length)
|
|
73
|
+
- Payload: Variable length
|
|
74
|
+
- Checksum: 2 bytes CRC16
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## 4. Data Model
|
|
78
|
+
|
|
79
|
+
### 4.1 Database Schema (for Web/Mobile with DB)
|
|
80
|
+
| Table | Columns | Constraints |
|
|
81
|
+
|-------|---------|-------------|
|
|
82
|
+
| [table_name] | id, field1, field2 | PK, FK, etc. |
|
|
83
|
+
|
|
84
|
+
### 4.2 Data Structures (for Desktop/CLI/Library)
|
|
85
|
+
```typescript
|
|
86
|
+
interface DataModel {
|
|
87
|
+
id: string;
|
|
88
|
+
field: Type;
|
|
89
|
+
}
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### 4.3 File Format (for Desktop/CLI tools)
|
|
93
|
+
```json
|
|
94
|
+
{
|
|
95
|
+
"version": "1.0",
|
|
96
|
+
"data": {}
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### 4.4 Relationships
|
|
101
|
+
```
|
|
102
|
+
[Entity A] 1โโโโโโN [Entity B]
|
|
103
|
+
โโโ foreign_key: entity_a_id
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
## 5. Authentication & Authorization
|
|
107
|
+
| Role | Permissions | Platform Notes |
|
|
108
|
+
|------|-------------|----------------|
|
|
109
|
+
| Guest | Read public | N/A for CLI tools |
|
|
110
|
+
| User | Read/Write own | Session/Token based |
|
|
111
|
+
| Admin | Full access | Elevated privileges |
|
|
112
|
+
|
|
113
|
+
## 6. Error Handling
|
|
114
|
+
| Code/Type | Meaning | Response |
|
|
115
|
+
|-----------|---------|----------|
|
|
116
|
+
| 400 / InvalidInput | Bad Request | { "error": "message" } |
|
|
117
|
+
| 401 / Unauthorized | Not authenticated | { "error": "Not authenticated" } |
|
|
118
|
+
| 403 / Forbidden | Access denied | { "error": "Access denied" } |
|
|
119
|
+
| 404 / NotFound | Resource not found | { "error": "Resource not found" } |
|
|
120
|
+
| 500 / InternalError | Server Error | { "error": "Internal error" } |
|
|
121
|
+
|
|
122
|
+
## 7. Platform-Specific Considerations
|
|
123
|
+
|
|
124
|
+
### For Mobile Apps:
|
|
125
|
+
- Offline support strategy: [describe]
|
|
126
|
+
- Background sync: [describe]
|
|
127
|
+
- Push notifications: [describe]
|
|
128
|
+
- Battery optimization: [describe]
|
|
129
|
+
|
|
130
|
+
### For Desktop Apps:
|
|
131
|
+
- Auto-update mechanism: [describe]
|
|
132
|
+
- Multi-window support: [describe]
|
|
133
|
+
- System tray integration: [describe]
|
|
134
|
+
|
|
135
|
+
### For Embedded Systems:
|
|
136
|
+
- Memory constraints: [X KB RAM, Y KB Flash]
|
|
137
|
+
- Power management: [describe]
|
|
138
|
+
- Firmware update: [OTA/USB/etc.]
|
|
139
|
+
|
|
140
|
+
### For CLI Tools:
|
|
141
|
+
- Configuration file location: [~/.config/tool/]
|
|
142
|
+
- Output formats: [JSON/YAML/Table]
|
|
143
|
+
- Piping support: [Yes/No]
|
|
144
|
+
|
|
145
|
+
### For Libraries:
|
|
146
|
+
- Dependency management: [peer/bundled]
|
|
147
|
+
- Tree-shaking support: [Yes/No]
|
|
148
|
+
- TypeScript definitions: [Included/Separate]
|
|
149
|
+
|
|
150
|
+
## 8. Performance & Scalability
|
|
151
|
+
| Metric | Target | Strategy |
|
|
152
|
+
|--------|--------|----------|
|
|
153
|
+
| Response Time | < 200ms | Caching, indexing |
|
|
154
|
+
| Throughput | [X req/s] | Load balancing |
|
|
155
|
+
| Memory Usage | < [X MB] | Optimization |
|
|
156
|
+
| Battery Impact | Minimal | Background throttling |
|
|
157
|
+
|
|
158
|
+
## 9. Open Questions
|
|
159
|
+
- [ ] @UIUX: [Question about UI requirements]
|
|
160
|
+
- [ ] @PO: [Question about business logic]
|
|
161
|
+
- [ ] @DEVOPS: [Question about deployment]
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
### Next Step:
|
|
166
|
+
- @QA - Review design for testability
|
|
167
|
+
- @SECA - Security review of architecture and interfaces
|
|
168
|
+
- @DEV - Prepare for implementation
|
|
169
|
+
|
|
170
|
+
#designing
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
# Test Report - Version [X]
|
|
2
|
+
|
|
3
|
+
## Document Info
|
|
4
|
+
| Field | Value |
|
|
5
|
+
|-------|-------|
|
|
6
|
+
| Version | [X.0] |
|
|
7
|
+
| Date | [YYYY-MM-DD] |
|
|
8
|
+
| Author | @TESTER |
|
|
9
|
+
| Environment | Staging / Production |
|
|
10
|
+
| Build | [Build #/Version] |
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## 1. Test Summary
|
|
15
|
+
| Metric | Value |
|
|
16
|
+
|--------|-------|
|
|
17
|
+
| Total Test Cases | [X] |
|
|
18
|
+
| Passed | [X] |
|
|
19
|
+
| Failed | [X] |
|
|
20
|
+
| Blocked | [X] |
|
|
21
|
+
| Pass Rate | [X]% |
|
|
22
|
+
|
|
23
|
+
## 2. Test Coverage
|
|
24
|
+
| Feature | Test Cases | Passed | Failed |
|
|
25
|
+
|---------|------------|--------|--------|
|
|
26
|
+
| [Feature 1] | [X] | [X] | [X] |
|
|
27
|
+
| [Feature 2] | [X] | [X] | [X] |
|
|
28
|
+
|
|
29
|
+
## 3. Test Cases
|
|
30
|
+
|
|
31
|
+
### TC-001: [Test Case Name]
|
|
32
|
+
| Field | Value |
|
|
33
|
+
|-------|-------|
|
|
34
|
+
| Feature | [Feature name] |
|
|
35
|
+
| Priority | High/Medium/Low |
|
|
36
|
+
| Status | โ
Pass / โ Fail / โธ๏ธ Blocked |
|
|
37
|
+
|
|
38
|
+
**Steps:**
|
|
39
|
+
1. [Step 1]
|
|
40
|
+
2. [Step 2]
|
|
41
|
+
|
|
42
|
+
**Expected Result:** [Expected behavior]
|
|
43
|
+
**Actual Result:** [Actual behavior]
|
|
44
|
+
**Evidence:** [Screenshot/Recording link]
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
### TC-002: [Test Case Name]
|
|
49
|
+
| Field | Value |
|
|
50
|
+
|-------|-------|
|
|
51
|
+
| Feature | [Feature name] |
|
|
52
|
+
| Priority | High/Medium/Low |
|
|
53
|
+
| Status | โ
Pass / โ Fail / โธ๏ธ Blocked |
|
|
54
|
+
|
|
55
|
+
**Steps:**
|
|
56
|
+
1. [Step 1]
|
|
57
|
+
|
|
58
|
+
**Expected Result:** [Expected behavior]
|
|
59
|
+
**Actual Result:** [Actual behavior]
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## 4. Bugs Found
|
|
64
|
+
| Bug ID | Title | Severity | Status | Assigned |
|
|
65
|
+
|--------|-------|----------|--------|----------|
|
|
66
|
+
| BUG-001 | [Title] | Critical/High/Med/Low | Open | @DEV |
|
|
67
|
+
| BUG-002 | [Title] | Critical/High/Med/Low | Open | @DEV |
|
|
68
|
+
|
|
69
|
+
### BUG-001: [Bug Title]
|
|
70
|
+
| Field | Value |
|
|
71
|
+
|-------|-------|
|
|
72
|
+
| Severity | Critical / #fixbug-critical |
|
|
73
|
+
| Steps to Reproduce | [Steps] |
|
|
74
|
+
| Expected | [Expected behavior] |
|
|
75
|
+
| Actual | [Actual behavior] |
|
|
76
|
+
| Evidence | [Screenshot/Recording] |
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
## 5. Test Verdict
|
|
81
|
+
โ **PASS** - All critical tests passed, ready for production
|
|
82
|
+
โ **CONDITIONAL PASS** - Minor issues, can proceed with known limitations
|
|
83
|
+
โ **FAIL** - Critical/High bugs must be fixed before release
|
|
84
|
+
|
|
85
|
+
## 6. Blockers
|
|
86
|
+
| Blocker | Impact | Status |
|
|
87
|
+
|---------|--------|--------|
|
|
88
|
+
| [Blocker description] | [Impact] | Open/Resolved |
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
### Next Step:
|
|
93
|
+
- @DEV - Fix bugs: [BUG-001, BUG-002]
|
|
94
|
+
- @DEVOPS - Deploy to production (if approved)
|
|
95
|
+
- @REPORTER - Include test results in phase report
|
|
96
|
+
|
|
97
|
+
#testing
|
|
@@ -0,0 +1,280 @@
|
|
|
1
|
+
# UI/UX Design Specification - Version [X]
|
|
2
|
+
|
|
3
|
+
## Document Info
|
|
4
|
+
| Field | Value |
|
|
5
|
+
|-------|-------|
|
|
6
|
+
| Version | [X.0] |
|
|
7
|
+
| Date | [YYYY-MM-DD] |
|
|
8
|
+
| Author | @UIUX |
|
|
9
|
+
| Platform | Web / Mobile (iOS/Android) / Desktop / Embedded / CLI |
|
|
10
|
+
| Status | Draft / Review / Approved |
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## 1. Design Overview
|
|
15
|
+
**Target Users:** [Primary user personas]
|
|
16
|
+
**Platform:** [Web/Mobile/Desktop/Embedded/CLI]
|
|
17
|
+
**Design Goals:** [Key objectives]
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## 2. User Personas
|
|
22
|
+
|
|
23
|
+
### Persona 1: [Name]
|
|
24
|
+
| Attribute | Details |
|
|
25
|
+
|-----------|---------|
|
|
26
|
+
| Role | [e.g., End User, Admin, Developer] |
|
|
27
|
+
| Age Range | [e.g., 25-40] |
|
|
28
|
+
| Goals | [What they want to achieve] |
|
|
29
|
+
| Pain Points | [Current frustrations] |
|
|
30
|
+
| Tech Savviness | Low / Medium / High |
|
|
31
|
+
| Platform Usage | [Desktop/Mobile/Both] |
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## 3. User Flows
|
|
36
|
+
|
|
37
|
+
### Flow 1: [Primary User Journey]
|
|
38
|
+
```
|
|
39
|
+
โโโโโโโโโโโโ โโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโ
|
|
40
|
+
โ Entry โโโโโถโ Action โโโโโถโ Result โ
|
|
41
|
+
โ Point โ โ โ โ โ
|
|
42
|
+
โโโโโโโโโโโโ โโโโโโโโโฌโโโโโโโโ โโโโโโโโโโโโโโโ
|
|
43
|
+
โ
|
|
44
|
+
โผ (Error)
|
|
45
|
+
โโโโโโโโโโโโโโโโโ
|
|
46
|
+
โ Error Handlingโ
|
|
47
|
+
โโโโโโโโโโโโโโโโโ
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Flow 2: [Secondary Journey]
|
|
51
|
+
[Add flow diagrams for key user journeys]
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## 4. Screen/Interface Specifications
|
|
56
|
+
|
|
57
|
+
### 4.1 [Screen/View Name]
|
|
58
|
+
|
|
59
|
+
**Layout (for GUI platforms):**
|
|
60
|
+
```
|
|
61
|
+
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
|
|
62
|
+
โ [Header/Nav] โ
|
|
63
|
+
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
|
|
64
|
+
โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
|
|
65
|
+
โ โ Main Content โ โ
|
|
66
|
+
โ โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ โ
|
|
67
|
+
โ โ โ Component 1 โ โ โ
|
|
68
|
+
โ โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ โ
|
|
69
|
+
โ โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ โ
|
|
70
|
+
โ โ โ Component 2 โ โ โ
|
|
71
|
+
โ โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ โ
|
|
72
|
+
โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
|
|
73
|
+
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
**Command Structure (for CLI):**
|
|
77
|
+
```bash
|
|
78
|
+
# Command syntax
|
|
79
|
+
tool-name <command> [options]
|
|
80
|
+
|
|
81
|
+
# Interactive prompts
|
|
82
|
+
? Select option: (Use arrow keys)
|
|
83
|
+
โฏ Option 1
|
|
84
|
+
Option 2
|
|
85
|
+
Option 3
|
|
86
|
+
|
|
87
|
+
# Output format
|
|
88
|
+
โ Success message
|
|
89
|
+
โ Error message
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
**Specifications:**
|
|
93
|
+
| Element | Specification |
|
|
94
|
+
|---------|---------------|
|
|
95
|
+
| Container | [Size, padding, margins] |
|
|
96
|
+
| Typography | [Font, size, weight] |
|
|
97
|
+
| Colors | [Primary, secondary, etc.] |
|
|
98
|
+
| Spacing | [Grid system] |
|
|
99
|
+
| Interactive Elements | [Buttons, inputs, etc.] |
|
|
100
|
+
|
|
101
|
+
**States:**
|
|
102
|
+
- Default: [Description]
|
|
103
|
+
- Hover/Focus: [Description]
|
|
104
|
+
- Active: [Description]
|
|
105
|
+
- Disabled: [Description]
|
|
106
|
+
- Loading: [Description]
|
|
107
|
+
- Error: [Description]
|
|
108
|
+
|
|
109
|
+
**Platform-Specific Notes:**
|
|
110
|
+
- **Mobile:** Touch targets โฅ 44x44px, swipe gestures
|
|
111
|
+
- **Desktop:** Keyboard shortcuts, window management
|
|
112
|
+
- **CLI:** Color support, progress indicators
|
|
113
|
+
- **Embedded:** Display constraints, button mapping
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## 5. Design System
|
|
118
|
+
|
|
119
|
+
### 5.1 Color Palette
|
|
120
|
+
|
|
121
|
+
| Token | Hex/RGB | Usage | Accessibility |
|
|
122
|
+
|-------|---------|-------|---------------|
|
|
123
|
+
| `--color-primary` | #0066FF | CTAs, links | WCAG AA โ |
|
|
124
|
+
| `--color-secondary` | #6B7280 | Secondary text | WCAG AA โ |
|
|
125
|
+
| `--color-success` | #10B981 | Success states | WCAG AA โ |
|
|
126
|
+
| `--color-warning` | #F59E0B | Warnings | WCAG AA โ |
|
|
127
|
+
| `--color-error` | #EF4444 | Errors | WCAG AA โ |
|
|
128
|
+
| `--color-bg` | #F9FAFB | Background | - |
|
|
129
|
+
| `--color-text` | #111827 | Primary text | WCAG AAA โ |
|
|
130
|
+
|
|
131
|
+
### 5.2 Typography
|
|
132
|
+
|
|
133
|
+
| Token | Font | Size | Weight | Line Height | Usage |
|
|
134
|
+
|-------|------|------|--------|-------------|-------|
|
|
135
|
+
| `--font-h1` | [Font] | 32px | 700 | 1.2 | Page titles |
|
|
136
|
+
| `--font-h2` | [Font] | 24px | 600 | 1.3 | Section headers |
|
|
137
|
+
| `--font-body` | [Font] | 16px | 400 | 1.5 | Body text |
|
|
138
|
+
| `--font-small` | [Font] | 14px | 400 | 1.4 | Captions |
|
|
139
|
+
| `--font-mono` | [Mono] | 14px | 400 | 1.5 | Code, CLI output |
|
|
140
|
+
|
|
141
|
+
### 5.3 Spacing System
|
|
142
|
+
|
|
143
|
+
| Token | Value | Usage |
|
|
144
|
+
|-------|-------|-------|
|
|
145
|
+
| `--space-xs` | 4px | Tight spacing |
|
|
146
|
+
| `--space-sm` | 8px | Component padding |
|
|
147
|
+
| `--space-md` | 16px | Card padding |
|
|
148
|
+
| `--space-lg` | 24px | Section gaps |
|
|
149
|
+
| `--space-xl` | 32px | Page margins |
|
|
150
|
+
|
|
151
|
+
### 5.4 Component Library
|
|
152
|
+
|
|
153
|
+
| Component | Variants | States | Platform Notes |
|
|
154
|
+
|-----------|----------|--------|----------------|
|
|
155
|
+
| Button | Primary, Secondary, Ghost | Default, Hover, Active, Disabled | Touch-friendly on mobile |
|
|
156
|
+
| Input | Text, Password, Number | Default, Focus, Error, Disabled | Auto-complete support |
|
|
157
|
+
| Card | Default, Elevated, Outlined | Default, Hover | Swipeable on mobile |
|
|
158
|
+
| Modal | Small, Medium, Large | Open, Closing | Full-screen on mobile |
|
|
159
|
+
| Progress | Linear, Circular, Spinner | Indeterminate, Determinate | CLI: ASCII progress bar |
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
|
|
163
|
+
## 6. Responsive/Adaptive Design
|
|
164
|
+
|
|
165
|
+
### 6.1 Breakpoints (for Web/Desktop)
|
|
166
|
+
| Breakpoint | Width | Layout Changes |
|
|
167
|
+
|------------|-------|----------------|
|
|
168
|
+
| Mobile | < 768px | Single column, bottom nav |
|
|
169
|
+
| Tablet | 768-1024px | 2 columns, side nav |
|
|
170
|
+
| Desktop | > 1024px | 3 columns, full nav |
|
|
171
|
+
|
|
172
|
+
### 6.2 Platform Adaptations
|
|
173
|
+
- **iOS:** Native navigation patterns, SF Symbols
|
|
174
|
+
- **Android:** Material Design 3, FAB patterns
|
|
175
|
+
- **Desktop:** Menu bar, keyboard shortcuts
|
|
176
|
+
- **CLI:** Terminal width detection, color support check
|
|
177
|
+
|
|
178
|
+
---
|
|
179
|
+
|
|
180
|
+
## 7. Interactions & Animations
|
|
181
|
+
|
|
182
|
+
| Interaction | Animation | Duration | Platform |
|
|
183
|
+
|-------------|-----------|----------|----------|
|
|
184
|
+
| Button press | Scale 0.98 | 100ms | GUI |
|
|
185
|
+
| Modal open | Fade + slide | 200ms | GUI |
|
|
186
|
+
| Page transition | Fade | 300ms | GUI |
|
|
187
|
+
| Loading | Spinner/Progress | Continuous | All |
|
|
188
|
+
| CLI command | Typing effect | 50ms/char | CLI |
|
|
189
|
+
|
|
190
|
+
**Animation Principles:**
|
|
191
|
+
- Respect user motion preferences (prefers-reduced-motion)
|
|
192
|
+
- No animations on low-power devices (when applicable)
|
|
193
|
+
- Smooth 60fps animations
|
|
194
|
+
|
|
195
|
+
---
|
|
196
|
+
|
|
197
|
+
## 8. Accessibility Checklist
|
|
198
|
+
|
|
199
|
+
### Visual Accessibility
|
|
200
|
+
- [ ] Color contrast โฅ 4.5:1 (WCAG AA)
|
|
201
|
+
- [ ] Text resizable up to 200%
|
|
202
|
+
- [ ] No information conveyed by color alone
|
|
203
|
+
- [ ] Focus indicators visible on all interactive elements
|
|
204
|
+
|
|
205
|
+
### Keyboard & Navigation
|
|
206
|
+
- [ ] All functionality accessible via keyboard
|
|
207
|
+
- [ ] Logical tab order
|
|
208
|
+
- [ ] Skip navigation links (web)
|
|
209
|
+
- [ ] Keyboard shortcuts documented
|
|
210
|
+
|
|
211
|
+
### Screen Reader Support
|
|
212
|
+
- [ ] All images have alt text
|
|
213
|
+
- [ ] Form labels properly associated
|
|
214
|
+
- [ ] ARIA labels where needed
|
|
215
|
+
- [ ] Semantic HTML structure
|
|
216
|
+
|
|
217
|
+
### Platform-Specific
|
|
218
|
+
- [ ] **Mobile:** VoiceOver/TalkBack tested
|
|
219
|
+
- [ ] **Desktop:** Screen reader compatible
|
|
220
|
+
- [ ] **CLI:** Screen reader friendly output
|
|
221
|
+
|
|
222
|
+
---
|
|
223
|
+
|
|
224
|
+
## 9. Platform Guidelines Compliance
|
|
225
|
+
|
|
226
|
+
### iOS (if applicable)
|
|
227
|
+
- [ ] Human Interface Guidelines followed
|
|
228
|
+
- [ ] SF Symbols used appropriately
|
|
229
|
+
- [ ] Native navigation patterns
|
|
230
|
+
- [ ] Dark mode support
|
|
231
|
+
|
|
232
|
+
### Android (if applicable)
|
|
233
|
+
- [ ] Material Design 3 guidelines
|
|
234
|
+
- [ ] Adaptive icons
|
|
235
|
+
- [ ] System navigation support
|
|
236
|
+
- [ ] Dynamic color support
|
|
237
|
+
|
|
238
|
+
### Web (if applicable)
|
|
239
|
+
- [ ] Progressive enhancement
|
|
240
|
+
- [ ] Cross-browser compatibility
|
|
241
|
+
- [ ] Responsive design
|
|
242
|
+
- [ ] PWA capabilities (if needed)
|
|
243
|
+
|
|
244
|
+
---
|
|
245
|
+
|
|
246
|
+
## 10. Assets & Resources
|
|
247
|
+
|
|
248
|
+
### Required Assets
|
|
249
|
+
| Asset | Format | Size | Notes |
|
|
250
|
+
|-------|--------|------|-------|
|
|
251
|
+
| App Icon | PNG/SVG | [sizes] | Multiple resolutions |
|
|
252
|
+
| Logo | SVG | Scalable | Light/dark variants |
|
|
253
|
+
| Illustrations | SVG/PNG | Various | Optimized |
|
|
254
|
+
| Icons | SVG | 24x24 | Icon set |
|
|
255
|
+
|
|
256
|
+
### Design Files
|
|
257
|
+
- Figma/Sketch file: [Link]
|
|
258
|
+
- Component library: [Link]
|
|
259
|
+
- Style guide: [Link]
|
|
260
|
+
|
|
261
|
+
---
|
|
262
|
+
|
|
263
|
+
## 11. Open Questions
|
|
264
|
+
- [ ] @SA: [Technical feasibility question]
|
|
265
|
+
- [ ] @PO: [Business requirement clarification]
|
|
266
|
+
- [ ] @DEV: [Implementation complexity question]
|
|
267
|
+
|
|
268
|
+
---
|
|
269
|
+
|
|
270
|
+
## 12. Conclusion & Next Step
|
|
271
|
+
|
|
272
|
+
Design complete and ready for review.
|
|
273
|
+
|
|
274
|
+
### Next Step:
|
|
275
|
+
- @SA - Confirm system design supports UI requirements
|
|
276
|
+
- @QA - Review for usability and testability
|
|
277
|
+
- @SECA - Security review of user flows and data handling
|
|
278
|
+
- @PO - Validate against acceptance criteria
|
|
279
|
+
|
|
280
|
+
#uiux-design #designing
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
# Definition of Done (DoD) Checklist
|
|
2
|
+
**Version:** 1.0 | **Last Updated:** 2025-12-23
|
|
3
|
+
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
## Purpose
|
|
7
|
+
This checklist ensures consistent quality standards across all deliverables. A task is **NOT DONE** until ALL applicable items are checked.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## ๐ Development Task DoD
|
|
12
|
+
|
|
13
|
+
### Code Quality
|
|
14
|
+
- [ ] Code implemented according to approved design specs
|
|
15
|
+
- [ ] Follows project coding standards and conventions
|
|
16
|
+
- [ ] No hardcoded values (use config/environment variables)
|
|
17
|
+
- [ ] No console.log / debug code left in production code
|
|
18
|
+
- [ ] Proper error handling implemented
|
|
19
|
+
- [ ] Code is self-documenting with clear naming
|
|
20
|
+
|
|
21
|
+
### Testing
|
|
22
|
+
- [ ] Unit tests written and passing
|
|
23
|
+
- [ ] Local testing passed (all features work as expected)
|
|
24
|
+
- [ ] Edge cases handled and tested
|
|
25
|
+
- [ ] No regressions introduced
|
|
26
|
+
|
|
27
|
+
### Documentation
|
|
28
|
+
- [ ] Code comments for complex logic
|
|
29
|
+
- [ ] API documentation updated (if applicable)
|
|
30
|
+
- [ ] Tagged with `#development`
|
|
31
|
+
|
|
32
|
+
### Evidence
|
|
33
|
+
- [ ] Screenshots/recordings captured (if UI changes)
|
|
34
|
+
- [ ] Build logs showing success
|
|
35
|
+
|
|
36
|
+
### Handoff
|
|
37
|
+
- [ ] Development-Log artifact updated
|
|
38
|
+
- [ ] @TESTER tagged for testing
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## ๐งช Testing Task DoD
|
|
43
|
+
|
|
44
|
+
### Test Execution
|
|
45
|
+
- [ ] All test cases from Test Plan executed
|
|
46
|
+
- [ ] Happy path scenarios verified
|
|
47
|
+
- [ ] Error/edge case scenarios verified
|
|
48
|
+
- [ ] Acceptance criteria from user stories validated
|
|
49
|
+
|
|
50
|
+
### Bug Management
|
|
51
|
+
- [ ] All bugs logged with proper priority tags
|
|
52
|
+
- [ ] No `#fixbug-critical` or `#fixbug-high` bugs remaining open
|
|
53
|
+
- [ ] Responsible @DEV tagged for each bug
|
|
54
|
+
|
|
55
|
+
### Evidence
|
|
56
|
+
- [ ] Screenshots/recordings for key flows
|
|
57
|
+
- [ ] Screenshots/recordings for each bug found
|
|
58
|
+
|
|
59
|
+
### Documentation
|
|
60
|
+
- [ ] Test-Report artifact created/updated
|
|
61
|
+
- [ ] Tagged with `#testing`
|
|
62
|
+
|
|
63
|
+
### Handoff (if passed)
|
|
64
|
+
- [ ] @REPORTER tagged
|
|
65
|
+
- [ ] @STAKEHOLDER tagged (if ready for final review)
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## ๐ Deployment Task DoD
|
|
70
|
+
|
|
71
|
+
### Pre-Deployment
|
|
72
|
+
- [ ] All tests passing in CI/CD pipeline
|
|
73
|
+
- [ ] Security checklist completed
|
|
74
|
+
- [ ] Environment variables configured correctly
|
|
75
|
+
- [ ] Database migrations ready (if applicable)
|
|
76
|
+
|
|
77
|
+
### Staging
|
|
78
|
+
- [ ] Deployed to staging environment successfully
|
|
79
|
+
- [ ] Smoke tests passed on staging
|
|
80
|
+
- [ ] Tagged with `#deployed-staging`
|
|
81
|
+
|
|
82
|
+
### Production
|
|
83
|
+
- [ ] Staging approved by @TESTER
|
|
84
|
+
- [ ] Deployed to production environment
|
|
85
|
+
- [ ] Health checks passing
|
|
86
|
+
- [ ] Monitoring/alerting configured
|
|
87
|
+
- [ ] Tagged with `#deployed-production`
|
|
88
|
+
|
|
89
|
+
### Documentation
|
|
90
|
+
- [ ] DevOps-Plan-and-Log artifact updated
|
|
91
|
+
- [ ] Deployment steps documented
|
|
92
|
+
|
|
93
|
+
### Rollback
|
|
94
|
+
- [ ] Rollback plan documented and tested
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## ๐ Design Task DoD
|
|
99
|
+
|
|
100
|
+
### Design Quality
|
|
101
|
+
- [ ] All Must-Have requirements addressed
|
|
102
|
+
- [ ] Consistent with project plan scope
|
|
103
|
+
- [ ] Diagrams/mockups are clear and complete
|
|
104
|
+
- [ ] APIs designed for both UI needs and backend feasibility
|
|
105
|
+
|
|
106
|
+
### Review Readiness
|
|
107
|
+
- [ ] Design-Spec artifact created with proper naming
|
|
108
|
+
- [ ] Tagged with `#designing` or `#uiux-design`
|
|
109
|
+
|
|
110
|
+
### Handoff
|
|
111
|
+
- [ ] @QA tagged for design verification
|
|
112
|
+
- [ ] @SECA tagged for security review
|
|
113
|
+
|
|
114
|
+
---
|
|
115
|
+
|
|
116
|
+
## โ
Project Completion DoD
|
|
117
|
+
|
|
118
|
+
### Feature Delivery
|
|
119
|
+
- [ ] All Must-Have features implemented and verified
|
|
120
|
+
- [ ] All Should-Have features implemented (or justified deferral)
|
|
121
|
+
- [ ] No `#fixbug-critical` or `#fixbug-high` bugs remaining
|
|
122
|
+
|
|
123
|
+
### Approvals
|
|
124
|
+
- [ ] Design approved by QA + SecA
|
|
125
|
+
- [ ] Testing passed by TESTER
|
|
126
|
+
- [ ] STAKEHOLDER final approval received
|
|
127
|
+
|
|
128
|
+
### Documentation
|
|
129
|
+
- [ ] Master-Documentation.md complete and current
|
|
130
|
+
- [ ] Final-Project-Report.md created by REPORTER
|
|
131
|
+
- [ ] All artifacts versioned and archived
|
|
132
|
+
|
|
133
|
+
### Notification
|
|
134
|
+
- [ ] User notified of project completion
|
|
135
|
+
- [ ] Handover documentation provided (if applicable)
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
## Quick Reference Card
|
|
140
|
+
|
|
141
|
+
| Task Type | Key Criteria | Tags |
|
|
142
|
+
|-----------|--------------|------|
|
|
143
|
+
| **Development** | Code works, tests pass, evidence captured | `#development` |
|
|
144
|
+
| **Testing** | All cases run, no critical/high bugs | `#testing` |
|
|
145
|
+
| **Deployment** | CI passes, staging verified, rollback ready | `#deployed-*` |
|
|
146
|
+
| **Design** | Covers requirements, diagrams clear | `#designing` |
|
|
147
|
+
| **Project** | All features done, stakeholder approved | `#reporting` |
|
|
148
|
+
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
#global-rules #definition-of-done
|