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,82 @@
|
|
|
1
|
+
# Final Approval Report
|
|
2
|
+
|
|
3
|
+
## Document Info
|
|
4
|
+
| Field | Value |
|
|
5
|
+
|-------|-------|
|
|
6
|
+
| Date | [YYYY-MM-DD] |
|
|
7
|
+
| Author | @STAKEHOLDER |
|
|
8
|
+
| Project | [Project Name] |
|
|
9
|
+
| Version | [Final Version] |
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## 1. Project Summary
|
|
14
|
+
| Metric | Target | Achieved |
|
|
15
|
+
|--------|--------|----------|
|
|
16
|
+
| Features (Must-Have) | [X] | [X] ✅/❌ |
|
|
17
|
+
| Features (Should-Have) | [X] | [X] ✅/❌ |
|
|
18
|
+
| Features (Could-Have) | [X] | [X] ✅/❌ |
|
|
19
|
+
| Timeline | [Date] | [Date] ✅/❌ |
|
|
20
|
+
|
|
21
|
+
## 2. Acceptance Criteria Review
|
|
22
|
+
| Requirement | Status | Notes |
|
|
23
|
+
|-------------|--------|-------|
|
|
24
|
+
| [REQ-001] [Description] | ✅ Met / ❌ Not Met | [Notes] |
|
|
25
|
+
| [REQ-002] [Description] | ✅ Met / ❌ Not Met | [Notes] |
|
|
26
|
+
|
|
27
|
+
## 3. Quality Assessment
|
|
28
|
+
| Area | Status | Reviewer |
|
|
29
|
+
|------|--------|----------|
|
|
30
|
+
| Functionality | ✅/⚠️/❌ | @TESTER |
|
|
31
|
+
| Security | ✅/⚠️/❌ | @SECA |
|
|
32
|
+
| Performance | ✅/⚠️/❌ | @DEVOPS |
|
|
33
|
+
| Usability | ✅/⚠️/❌ | @UIUX |
|
|
34
|
+
|
|
35
|
+
## 4. Outstanding Issues
|
|
36
|
+
| Issue | Severity | Decision |
|
|
37
|
+
|-------|----------|----------|
|
|
38
|
+
| [Issue description] | Low/Med/High | Accept / Defer / Block |
|
|
39
|
+
|
|
40
|
+
## 5. Documentation Checklist
|
|
41
|
+
- [ ] Project Plan (final version)
|
|
42
|
+
- [ ] Design Specifications
|
|
43
|
+
- [ ] Test Reports
|
|
44
|
+
- [ ] Deployment Documentation
|
|
45
|
+
- [ ] User Guide (if applicable)
|
|
46
|
+
- [ ] Final Project Report
|
|
47
|
+
|
|
48
|
+
## 6. Stakeholder Sign-Off
|
|
49
|
+
|
|
50
|
+
### Decision
|
|
51
|
+
☐ **APPROVED** - Project accepted, ready for production
|
|
52
|
+
☐ **APPROVED WITH CONDITIONS** - Accepted with noted limitations
|
|
53
|
+
☐ **REJECTED** - Requires additional work before acceptance
|
|
54
|
+
|
|
55
|
+
### Conditions (if applicable)
|
|
56
|
+
- [Condition 1]
|
|
57
|
+
- [Condition 2]
|
|
58
|
+
|
|
59
|
+
### Approver
|
|
60
|
+
| Field | Value |
|
|
61
|
+
|-------|-------|
|
|
62
|
+
| Name | [Stakeholder name] |
|
|
63
|
+
| Role | @STAKEHOLDER |
|
|
64
|
+
| Date | [YYYY-MM-DD] |
|
|
65
|
+
| Signature | [Approved/Rejected] |
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## 7. Post-Approval Actions
|
|
70
|
+
|
|
71
|
+
### If Approved:
|
|
72
|
+
- @DEVOPS - Proceed with production deployment
|
|
73
|
+
- @REPORTER - Finalize all documentation
|
|
74
|
+
- @PM - Close project and notify user
|
|
75
|
+
|
|
76
|
+
### If Rejected:
|
|
77
|
+
- @PM - Initiate cycle repeat with updated requirements
|
|
78
|
+
- @REPORTER - Document rejection reasons
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
#stakeholder-review #reporting
|
|
@@ -0,0 +1,280 @@
|
|
|
1
|
+
# Final Project Report - [Project Name]
|
|
2
|
+
|
|
3
|
+
## Document Info
|
|
4
|
+
| Field | Value |
|
|
5
|
+
|-------|-------|
|
|
6
|
+
| Project | [Project Name] |
|
|
7
|
+
| Version | [Final Version] |
|
|
8
|
+
| Date | [YYYY-MM-DD] |
|
|
9
|
+
| Author | @REPORTER |
|
|
10
|
+
| Status | Complete |
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Executive Summary
|
|
15
|
+
|
|
16
|
+
### Project Overview
|
|
17
|
+
[Brief 2-3 sentence summary of what was built and why]
|
|
18
|
+
|
|
19
|
+
### Key Achievements
|
|
20
|
+
- [Achievement 1]
|
|
21
|
+
- [Achievement 2]
|
|
22
|
+
- [Achievement 3]
|
|
23
|
+
|
|
24
|
+
### Final Verdict
|
|
25
|
+
☐ **SUCCESS** - All objectives met, ready for production
|
|
26
|
+
☐ **PARTIAL SUCCESS** - Core objectives met with noted limitations
|
|
27
|
+
☐ **REQUIRES FOLLOW-UP** - Additional work needed
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## 1. Project Scope Delivery
|
|
32
|
+
|
|
33
|
+
### Requirements Fulfillment
|
|
34
|
+
| Category | Planned | Delivered | Status |
|
|
35
|
+
|----------|---------|-----------|--------|
|
|
36
|
+
| Must-Have Features | [X] | [X] | ✅ [100%] |
|
|
37
|
+
| Should-Have Features | [X] | [X] | ✅ [X%] |
|
|
38
|
+
| Could-Have Features | [X] | [X] | ⚠️ [X%] |
|
|
39
|
+
|
|
40
|
+
### Feature Breakdown
|
|
41
|
+
| Feature ID | Feature Name | Priority | Status | Notes |
|
|
42
|
+
|------------|--------------|----------|--------|-------|
|
|
43
|
+
| F-001 | [Name] | Must-Have | ✅ Complete | [Notes] |
|
|
44
|
+
| F-002 | [Name] | Should-Have | ✅ Complete | [Notes] |
|
|
45
|
+
| F-003 | [Name] | Could-Have | ⏭️ Deferred | [Reason] |
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## 2. Quality Metrics
|
|
50
|
+
|
|
51
|
+
### Testing Summary
|
|
52
|
+
| Metric | Target | Achieved | Status |
|
|
53
|
+
|--------|--------|----------|--------|
|
|
54
|
+
| Test Coverage | [X]% | [X]% | ✅/⚠️/❌ |
|
|
55
|
+
| Test Pass Rate | [X]% | [X]% | ✅/⚠️/❌ |
|
|
56
|
+
| Critical Bugs | 0 | [X] | ✅/⚠️/❌ |
|
|
57
|
+
| High Priority Bugs | 0 | [X] | ✅/⚠️/❌ |
|
|
58
|
+
|
|
59
|
+
### Code Quality
|
|
60
|
+
| Metric | Target | Achieved |
|
|
61
|
+
|--------|--------|----------|
|
|
62
|
+
| Code Reviews | 100% | [X]% |
|
|
63
|
+
| Documentation | Complete | [Status] |
|
|
64
|
+
| Technical Debt | Low | [Status] |
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## 3. Timeline & Effort
|
|
69
|
+
|
|
70
|
+
### Project Timeline
|
|
71
|
+
| Phase | Planned | Actual | Variance |
|
|
72
|
+
|-------|---------|--------|----------|
|
|
73
|
+
| Planning | [X days] | [X days] | [+/- X days] |
|
|
74
|
+
| Design | [X days] | [X days] | [+/- X days] |
|
|
75
|
+
| Development | [X days] | [X days] | [+/- X days] |
|
|
76
|
+
| Testing | [X days] | [X days] | [+/- X days] |
|
|
77
|
+
| Deployment | [X days] | [X days] | [+/- X days] |
|
|
78
|
+
| **Total** | **[X days]** | **[X days]** | **[+/- X days]** |
|
|
79
|
+
|
|
80
|
+
### Sprint Summary
|
|
81
|
+
| Sprint | Focus | Completed | Status |
|
|
82
|
+
|--------|-------|-----------|--------|
|
|
83
|
+
| Sprint 1 | [Focus] | [X/Y items] | ✅ |
|
|
84
|
+
| Sprint 2 | [Focus] | [X/Y items] | ✅ |
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## 4. Technical Deliverables
|
|
89
|
+
|
|
90
|
+
### Architecture
|
|
91
|
+
**Platform:** [Web/Mobile/Desktop/Embedded/CLI/API/Library]
|
|
92
|
+
**Tech Stack:**
|
|
93
|
+
- Frontend: [Technologies]
|
|
94
|
+
- Backend: [Technologies]
|
|
95
|
+
- Database: [Technologies]
|
|
96
|
+
- Infrastructure: [Technologies]
|
|
97
|
+
|
|
98
|
+
### Key Components Delivered
|
|
99
|
+
| Component | Description | Status |
|
|
100
|
+
|-----------|-------------|--------|
|
|
101
|
+
| [Component 1] | [Description] | ✅ Complete |
|
|
102
|
+
| [Component 2] | [Description] | ✅ Complete |
|
|
103
|
+
|
|
104
|
+
### Deployment Status
|
|
105
|
+
| Environment | URL/Location | Status | Notes |
|
|
106
|
+
|-------------|--------------|--------|-------|
|
|
107
|
+
| Development | [URL] | ✅ Active | [Notes] |
|
|
108
|
+
| Staging | [URL] | ✅ Active | [Notes] |
|
|
109
|
+
| Production | [URL] | ✅ Deployed | [Notes] |
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
## 5. Documentation Delivered
|
|
114
|
+
|
|
115
|
+
### Technical Documentation
|
|
116
|
+
- [ ] System Design Specification
|
|
117
|
+
- [ ] UI/UX Design Specification
|
|
118
|
+
- [ ] API Documentation
|
|
119
|
+
- [ ] Database Schema
|
|
120
|
+
- [ ] Deployment Guide
|
|
121
|
+
- [ ] Architecture Diagrams
|
|
122
|
+
|
|
123
|
+
### User Documentation
|
|
124
|
+
- [ ] User Guide / Manual
|
|
125
|
+
- [ ] Installation Instructions
|
|
126
|
+
- [ ] Configuration Guide
|
|
127
|
+
- [ ] Troubleshooting Guide
|
|
128
|
+
- [ ] FAQ
|
|
129
|
+
|
|
130
|
+
### Process Documentation
|
|
131
|
+
- [ ] Project Plan
|
|
132
|
+
- [ ] Test Reports
|
|
133
|
+
- [ ] Security Review
|
|
134
|
+
- [ ] Phase Reports
|
|
135
|
+
- [ ] Master Documentation
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
## 6. Issues & Resolutions
|
|
140
|
+
|
|
141
|
+
### Major Challenges Overcome
|
|
142
|
+
| Challenge | Impact | Resolution | Outcome |
|
|
143
|
+
|-----------|--------|------------|---------|
|
|
144
|
+
| [Challenge 1] | [Impact] | [How resolved] | ✅ Resolved |
|
|
145
|
+
|
|
146
|
+
### Outstanding Issues
|
|
147
|
+
| Issue | Severity | Status | Plan |
|
|
148
|
+
|-------|----------|--------|------|
|
|
149
|
+
| [Issue 1] | Low | Accepted | [Plan for future] |
|
|
150
|
+
|
|
151
|
+
### Deferred Items
|
|
152
|
+
| Item | Reason | Target Version |
|
|
153
|
+
|------|--------|----------------|
|
|
154
|
+
| [Feature] | [Reason] | v2.0 |
|
|
155
|
+
|
|
156
|
+
---
|
|
157
|
+
|
|
158
|
+
## 7. Lessons Learned
|
|
159
|
+
|
|
160
|
+
### What Went Well
|
|
161
|
+
- [Success 1]
|
|
162
|
+
- [Success 2]
|
|
163
|
+
- [Success 3]
|
|
164
|
+
|
|
165
|
+
### What Could Be Improved
|
|
166
|
+
- [Improvement area 1]
|
|
167
|
+
- [Improvement area 2]
|
|
168
|
+
|
|
169
|
+
### Recommendations for Future Projects
|
|
170
|
+
- [Recommendation 1]
|
|
171
|
+
- [Recommendation 2]
|
|
172
|
+
|
|
173
|
+
---
|
|
174
|
+
|
|
175
|
+
## 8. Team Performance
|
|
176
|
+
|
|
177
|
+
### Role Contributions
|
|
178
|
+
| Role | Key Contributions | Status |
|
|
179
|
+
|------|-------------------|--------|
|
|
180
|
+
| @PM | [Contributions] | ✅ Complete |
|
|
181
|
+
| @SA | [Contributions] | ✅ Complete |
|
|
182
|
+
| @UIUX | [Contributions] | ✅ Complete |
|
|
183
|
+
| @DEV | [Contributions] | ✅ Complete |
|
|
184
|
+
| @DEVOPS | [Contributions] | ✅ Complete |
|
|
185
|
+
| @TESTER | [Contributions] | ✅ Complete |
|
|
186
|
+
|
|
187
|
+
### Collaboration Highlights
|
|
188
|
+
- [Highlight 1]
|
|
189
|
+
- [Highlight 2]
|
|
190
|
+
|
|
191
|
+
---
|
|
192
|
+
|
|
193
|
+
## 9. Stakeholder Feedback
|
|
194
|
+
|
|
195
|
+
### Stakeholder Review Summary
|
|
196
|
+
**Reviewer:** @STAKEHOLDER
|
|
197
|
+
**Review Date:** [Date]
|
|
198
|
+
**Decision:** ✅ Approved / ⚠️ Approved with Conditions / ❌ Rejected
|
|
199
|
+
|
|
200
|
+
**Key Feedback:**
|
|
201
|
+
- [Feedback 1]
|
|
202
|
+
- [Feedback 2]
|
|
203
|
+
|
|
204
|
+
**Conditions (if any):**
|
|
205
|
+
- [Condition 1]
|
|
206
|
+
|
|
207
|
+
---
|
|
208
|
+
|
|
209
|
+
## 10. Post-Launch Plan
|
|
210
|
+
|
|
211
|
+
### Immediate Actions
|
|
212
|
+
- [ ] Production deployment complete
|
|
213
|
+
- [ ] Monitoring active
|
|
214
|
+
- [ ] User training complete
|
|
215
|
+
- [ ] Support channels established
|
|
216
|
+
|
|
217
|
+
### Maintenance & Support
|
|
218
|
+
| Activity | Frequency | Owner |
|
|
219
|
+
|----------|-----------|-------|
|
|
220
|
+
| Bug fixes | As needed | @DEV |
|
|
221
|
+
| Security updates | Monthly | @DEVOPS |
|
|
222
|
+
| Performance monitoring | Continuous | @DEVOPS |
|
|
223
|
+
| User support | Daily | [Team] |
|
|
224
|
+
|
|
225
|
+
### Future Roadmap
|
|
226
|
+
| Version | Target Date | Key Features |
|
|
227
|
+
|---------|-------------|--------------|
|
|
228
|
+
| v1.1 | [Date] | [Features] |
|
|
229
|
+
| v2.0 | [Date] | [Features] |
|
|
230
|
+
|
|
231
|
+
---
|
|
232
|
+
|
|
233
|
+
## 11. Project Closure
|
|
234
|
+
|
|
235
|
+
### Acceptance Criteria Met
|
|
236
|
+
- [x] All Must-Have features delivered
|
|
237
|
+
- [x] All critical bugs resolved
|
|
238
|
+
- [x] Security review passed
|
|
239
|
+
- [x] Performance targets met
|
|
240
|
+
- [x] Documentation complete
|
|
241
|
+
- [x] Stakeholder approval received
|
|
242
|
+
|
|
243
|
+
### Sign-Off
|
|
244
|
+
| Role | Name | Date | Signature |
|
|
245
|
+
|------|------|------|-----------|
|
|
246
|
+
| Project Manager | | | ☐ Approved |
|
|
247
|
+
| Stakeholder | | | ☐ Approved |
|
|
248
|
+
| Technical Lead | | | ☐ Approved |
|
|
249
|
+
|
|
250
|
+
### Project Status
|
|
251
|
+
**Status:** ✅ CLOSED - Successfully Delivered
|
|
252
|
+
|
|
253
|
+
**Closure Date:** [YYYY-MM-DD]
|
|
254
|
+
|
|
255
|
+
---
|
|
256
|
+
|
|
257
|
+
## 12. Appendices
|
|
258
|
+
|
|
259
|
+
### A. Key Artifacts
|
|
260
|
+
- Project Plan: `docs/sprints/sprint-1/plans/Project-Plan-v1.md`
|
|
261
|
+
- System Design: `docs/sprints/sprint-1/designs/System-Design-Spec-v1.md`
|
|
262
|
+
- Test Reports: `docs/sprints/sprint-1/tests/Test-Report-v1.md`
|
|
263
|
+
- Master Documentation: `docs/global/Master-Documentation.md`
|
|
264
|
+
|
|
265
|
+
### B. Metrics Dashboard
|
|
266
|
+
[Link to metrics/analytics dashboard if available]
|
|
267
|
+
|
|
268
|
+
### C. Repository Information
|
|
269
|
+
- **Repository:** [Git URL]
|
|
270
|
+
- **Final Commit:** [Commit hash]
|
|
271
|
+
- **Release Tag:** [Tag name]
|
|
272
|
+
|
|
273
|
+
---
|
|
274
|
+
|
|
275
|
+
### Next Step:
|
|
276
|
+
- @PM - Archive project documentation
|
|
277
|
+
- @DEVOPS - Transition to maintenance mode
|
|
278
|
+
- User notified of successful delivery
|
|
279
|
+
|
|
280
|
+
#reporting #project-complete
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
# Knowledge Entry - [Title]
|
|
2
|
+
|
|
3
|
+
## Document Info
|
|
4
|
+
| Field | Value |
|
|
5
|
+
|-------|-------|
|
|
6
|
+
| ID | KB-[YYYY-MM-DD]-[###] |
|
|
7
|
+
| Date | [YYYY-MM-DD] |
|
|
8
|
+
| Author | @[ROLE] |
|
|
9
|
+
| Category | Bug Pattern / Feature Solution / Performance / Security / Architecture |
|
|
10
|
+
| Severity | Critical / High / Medium / Low |
|
|
11
|
+
| Project | [Project name or "General"] |
|
|
12
|
+
| Tags | [tag1, tag2, tag3] |
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Problem / Challenge
|
|
17
|
+
|
|
18
|
+
### Description
|
|
19
|
+
[Clear description of the problem, bug, or challenging feature]
|
|
20
|
+
|
|
21
|
+
### Context
|
|
22
|
+
- **Platform:** [Web/Mobile/Desktop/CLI/API/etc.]
|
|
23
|
+
- **Technology:** [Specific tech stack]
|
|
24
|
+
- **Environment:** [Development/Staging/Production]
|
|
25
|
+
- **Affected Components:** [List components]
|
|
26
|
+
|
|
27
|
+
### Symptoms
|
|
28
|
+
- [Symptom 1]
|
|
29
|
+
- [Symptom 2]
|
|
30
|
+
- [How it manifested]
|
|
31
|
+
|
|
32
|
+
### Impact
|
|
33
|
+
- **Users Affected:** [Number or percentage]
|
|
34
|
+
- **Business Impact:** [Description]
|
|
35
|
+
- **Technical Impact:** [Description]
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## Root Cause Analysis
|
|
40
|
+
|
|
41
|
+
### What Happened
|
|
42
|
+
[Detailed technical explanation]
|
|
43
|
+
|
|
44
|
+
### Why It Happened
|
|
45
|
+
[Root cause - code bug, design flaw, configuration error, etc.]
|
|
46
|
+
|
|
47
|
+
### Contributing Factors
|
|
48
|
+
- [Factor 1]
|
|
49
|
+
- [Factor 2]
|
|
50
|
+
|
|
51
|
+
### Code/Configuration Example (if applicable)
|
|
52
|
+
```[language]
|
|
53
|
+
// Problematic code
|
|
54
|
+
[code snippet]
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## Solution
|
|
60
|
+
|
|
61
|
+
### Approach
|
|
62
|
+
[Describe the solution approach]
|
|
63
|
+
|
|
64
|
+
### Implementation
|
|
65
|
+
```[language]
|
|
66
|
+
// Fixed code
|
|
67
|
+
[code snippet]
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Configuration Changes
|
|
71
|
+
```
|
|
72
|
+
[Configuration changes if applicable]
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Steps to Resolve
|
|
76
|
+
1. [Step 1]
|
|
77
|
+
2. [Step 2]
|
|
78
|
+
3. [Step 3]
|
|
79
|
+
|
|
80
|
+
### Time to Resolve
|
|
81
|
+
- **First Attempt:** [X hours/days]
|
|
82
|
+
- **Total Attempts:** [X]
|
|
83
|
+
- **Final Resolution:** [X hours/days]
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## Prevention
|
|
88
|
+
|
|
89
|
+
### How to Avoid in Future
|
|
90
|
+
- [Prevention measure 1]
|
|
91
|
+
- [Prevention measure 2]
|
|
92
|
+
|
|
93
|
+
### Detection Strategy
|
|
94
|
+
- [How to detect this early]
|
|
95
|
+
- [Monitoring/alerts to add]
|
|
96
|
+
|
|
97
|
+
### Code Review Checklist
|
|
98
|
+
- [ ] [Check 1]
|
|
99
|
+
- [ ] [Check 2]
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
## Related Issues
|
|
104
|
+
|
|
105
|
+
### Similar Bugs/Features
|
|
106
|
+
- [Link to similar issue 1]
|
|
107
|
+
- [Link to similar issue 2]
|
|
108
|
+
|
|
109
|
+
### Related Documentation
|
|
110
|
+
- [Link to docs]
|
|
111
|
+
- [Link to external resources]
|
|
112
|
+
|
|
113
|
+
### Related Knowledge Entries
|
|
114
|
+
- KB-[ID]: [Title]
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
## Lessons Learned
|
|
119
|
+
|
|
120
|
+
### What Worked Well
|
|
121
|
+
- [Success 1]
|
|
122
|
+
- [Success 2]
|
|
123
|
+
|
|
124
|
+
### What Didn't Work
|
|
125
|
+
- [Failed approach 1]
|
|
126
|
+
- [Failed approach 2]
|
|
127
|
+
|
|
128
|
+
### Key Takeaways
|
|
129
|
+
1. [Takeaway 1]
|
|
130
|
+
2. [Takeaway 2]
|
|
131
|
+
|
|
132
|
+
---
|
|
133
|
+
|
|
134
|
+
## Search Keywords
|
|
135
|
+
[keyword1, keyword2, keyword3, error-message, technology-name, component-name]
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
## Verification
|
|
140
|
+
|
|
141
|
+
### How to Test
|
|
142
|
+
```bash
|
|
143
|
+
# Test commands or steps
|
|
144
|
+
[commands]
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Expected Result
|
|
148
|
+
[What should happen after fix]
|
|
149
|
+
|
|
150
|
+
### Regression Test
|
|
151
|
+
- [ ] Test case added to prevent recurrence
|
|
152
|
+
- [ ] Automated test created
|
|
153
|
+
|
|
154
|
+
---
|
|
155
|
+
|
|
156
|
+
## References
|
|
157
|
+
- Bug Report: [Link to original bug report]
|
|
158
|
+
- Pull Request: [Link to PR]
|
|
159
|
+
- Documentation: [Link to docs]
|
|
160
|
+
- External Resources: [Links]
|
|
161
|
+
|
|
162
|
+
---
|
|
163
|
+
|
|
164
|
+
#knowledge-base #[category] #[technology]
|