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,190 @@
|
|
|
1
|
+
{
|
|
2
|
+
"commands": [
|
|
3
|
+
{
|
|
4
|
+
"command": "/pm",
|
|
5
|
+
"description": "Project Manager - Planning, scope management, team coordination",
|
|
6
|
+
"prompt": "@PM - ",
|
|
7
|
+
"category": "TeamLifecycle",
|
|
8
|
+
"icon": "project",
|
|
9
|
+
"examples": [
|
|
10
|
+
"/pm Build a todo app with authentication",
|
|
11
|
+
"/pm Review current project status",
|
|
12
|
+
"/pm Update project plan based on feedback"
|
|
13
|
+
]
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
"command": "/orchestrator",
|
|
17
|
+
"description": "Orchestrator - Auto-execute entire workflow",
|
|
18
|
+
"prompt": "@ORCHESTRATOR - ",
|
|
19
|
+
"category": "TeamLifecycle",
|
|
20
|
+
"icon": "robot",
|
|
21
|
+
"examples": [
|
|
22
|
+
"/orchestrator Enable full-auto mode",
|
|
23
|
+
"/orchestrator Status",
|
|
24
|
+
"/orchestrator Pause"
|
|
25
|
+
]
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"command": "/po",
|
|
29
|
+
"description": "Product Owner - Backlog management, feature prioritization",
|
|
30
|
+
"prompt": "@PO - ",
|
|
31
|
+
"category": "TeamLifecycle",
|
|
32
|
+
"icon": "list-ordered",
|
|
33
|
+
"examples": [
|
|
34
|
+
"/po Prioritize backlog items",
|
|
35
|
+
"/po Add user story for authentication",
|
|
36
|
+
"/po Review acceptance criteria"
|
|
37
|
+
]
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
"command": "/sa",
|
|
41
|
+
"description": "System Analyst - Architecture, data models, API design",
|
|
42
|
+
"prompt": "@SA - ",
|
|
43
|
+
"category": "TeamLifecycle",
|
|
44
|
+
"icon": "server",
|
|
45
|
+
"examples": [
|
|
46
|
+
"/sa Design backend architecture",
|
|
47
|
+
"/sa Review database schema",
|
|
48
|
+
"/sa Define API endpoints"
|
|
49
|
+
]
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
"command": "/uiux",
|
|
53
|
+
"description": "UI/UX Designer - Interface design, user experience",
|
|
54
|
+
"prompt": "@UIUX - ",
|
|
55
|
+
"category": "TeamLifecycle",
|
|
56
|
+
"icon": "paintbrush",
|
|
57
|
+
"examples": [
|
|
58
|
+
"/uiux Design login page",
|
|
59
|
+
"/uiux Create mobile-first dashboard",
|
|
60
|
+
"/uiux Review accessibility compliance"
|
|
61
|
+
]
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
"command": "/qa",
|
|
65
|
+
"description": "QA Analyst - Design review, quality assurance",
|
|
66
|
+
"prompt": "@QA - ",
|
|
67
|
+
"category": "TeamLifecycle",
|
|
68
|
+
"icon": "checklist",
|
|
69
|
+
"examples": [
|
|
70
|
+
"/qa Review design specifications",
|
|
71
|
+
"/qa Verify testability",
|
|
72
|
+
"/qa Check requirements coverage"
|
|
73
|
+
]
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
"command": "/seca",
|
|
77
|
+
"description": "Security Analyst - Security assessment, vulnerability analysis",
|
|
78
|
+
"prompt": "@SECA - ",
|
|
79
|
+
"category": "TeamLifecycle",
|
|
80
|
+
"icon": "shield",
|
|
81
|
+
"examples": [
|
|
82
|
+
"/seca Review authentication flow",
|
|
83
|
+
"/seca Check for XSS vulnerabilities",
|
|
84
|
+
"/seca Audit API security"
|
|
85
|
+
]
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
"command": "/dev",
|
|
89
|
+
"description": "Developer - Code implementation",
|
|
90
|
+
"prompt": "@DEV - ",
|
|
91
|
+
"category": "TeamLifecycle",
|
|
92
|
+
"icon": "code",
|
|
93
|
+
"examples": [
|
|
94
|
+
"/dev Implement login feature",
|
|
95
|
+
"/dev Fix bug BUG-001",
|
|
96
|
+
"/dev Refactor authentication module"
|
|
97
|
+
]
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
"command": "/devops",
|
|
101
|
+
"description": "DevOps Engineer - CI/CD, deployment, infrastructure",
|
|
102
|
+
"prompt": "@DEVOPS - ",
|
|
103
|
+
"category": "TeamLifecycle",
|
|
104
|
+
"icon": "rocket",
|
|
105
|
+
"examples": [
|
|
106
|
+
"/devops Setup CI/CD pipeline",
|
|
107
|
+
"/devops Deploy to staging",
|
|
108
|
+
"/devops Configure monitoring"
|
|
109
|
+
]
|
|
110
|
+
},
|
|
111
|
+
{
|
|
112
|
+
"command": "/tester",
|
|
113
|
+
"description": "Tester - Functional testing, bug detection",
|
|
114
|
+
"prompt": "@TESTER - ",
|
|
115
|
+
"category": "TeamLifecycle",
|
|
116
|
+
"icon": "beaker",
|
|
117
|
+
"examples": [
|
|
118
|
+
"/tester Test login functionality",
|
|
119
|
+
"/tester Run E2E tests",
|
|
120
|
+
"/tester Verify bug fixes"
|
|
121
|
+
]
|
|
122
|
+
},
|
|
123
|
+
{
|
|
124
|
+
"command": "/reporter",
|
|
125
|
+
"description": "Reporter - Progress reports, documentation",
|
|
126
|
+
"prompt": "@REPORTER - ",
|
|
127
|
+
"category": "TeamLifecycle",
|
|
128
|
+
"icon": "file-text",
|
|
129
|
+
"examples": [
|
|
130
|
+
"/reporter Generate progress report",
|
|
131
|
+
"/reporter Update master documentation",
|
|
132
|
+
"/reporter Create phase report"
|
|
133
|
+
]
|
|
134
|
+
},
|
|
135
|
+
{
|
|
136
|
+
"command": "/stakeholder",
|
|
137
|
+
"description": "Stakeholder - Final approval, business acceptance",
|
|
138
|
+
"prompt": "@STAKEHOLDER - ",
|
|
139
|
+
"category": "TeamLifecycle",
|
|
140
|
+
"icon": "person",
|
|
141
|
+
"examples": [
|
|
142
|
+
"/stakeholder Review final deliverables",
|
|
143
|
+
"/stakeholder Approve project completion",
|
|
144
|
+
"/stakeholder Provide feedback"
|
|
145
|
+
]
|
|
146
|
+
},
|
|
147
|
+
{
|
|
148
|
+
"command": "/auto",
|
|
149
|
+
"description": "Start project with full automation",
|
|
150
|
+
"prompt": "@PM - {input} --mode=full-auto",
|
|
151
|
+
"category": "TeamLifecycle",
|
|
152
|
+
"icon": "zap",
|
|
153
|
+
"examples": [
|
|
154
|
+
"/auto Build a todo app with authentication"
|
|
155
|
+
]
|
|
156
|
+
},
|
|
157
|
+
{
|
|
158
|
+
"command": "/semi-auto",
|
|
159
|
+
"description": "Start project with semi-automation",
|
|
160
|
+
"prompt": "@PM - {input} --mode=semi-auto",
|
|
161
|
+
"category": "TeamLifecycle",
|
|
162
|
+
"icon": "play-circle",
|
|
163
|
+
"examples": [
|
|
164
|
+
"/semi-auto Build a mobile fitness app"
|
|
165
|
+
]
|
|
166
|
+
},
|
|
167
|
+
{
|
|
168
|
+
"command": "/kb-search",
|
|
169
|
+
"description": "Search knowledge base for solutions",
|
|
170
|
+
"prompt": "Search the knowledge base at .agent/knowledge-base/ for: {input}",
|
|
171
|
+
"category": "Knowledge Base",
|
|
172
|
+
"icon": "search",
|
|
173
|
+
"examples": [
|
|
174
|
+
"/kb-search authentication bug",
|
|
175
|
+
"/kb-search React hydration error",
|
|
176
|
+
"/kb-search performance optimization"
|
|
177
|
+
]
|
|
178
|
+
},
|
|
179
|
+
{
|
|
180
|
+
"command": "/kb-add",
|
|
181
|
+
"description": "Add entry to knowledge base",
|
|
182
|
+
"prompt": "Create a knowledge base entry using the template at .agent/templates/Knowledge-Entry-Template.md for: {input}",
|
|
183
|
+
"category": "Knowledge Base",
|
|
184
|
+
"icon": "plus-circle",
|
|
185
|
+
"examples": [
|
|
186
|
+
"/kb-add OAuth token refresh issue"
|
|
187
|
+
]
|
|
188
|
+
}
|
|
189
|
+
]
|
|
190
|
+
}
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
# Windsurf Cascade - TeamLifecycle Integration
|
|
2
|
+
|
|
3
|
+
## Custom Instructions for Windsurf Cascade
|
|
4
|
+
|
|
5
|
+
Add this to your project's `.windsurfrules` or Cascade settings:
|
|
6
|
+
|
|
7
|
+
```markdown
|
|
8
|
+
# TeamLifecycle SDLC Roles for Cascade
|
|
9
|
+
|
|
10
|
+
## Slash Commands
|
|
11
|
+
|
|
12
|
+
Cascade should recognize these slash commands as role invocations:
|
|
13
|
+
|
|
14
|
+
### Team Roles
|
|
15
|
+
- `/pm` - Project Manager (@PM)
|
|
16
|
+
- `/orchestrator` - Workflow Automation (@ORCHESTRATOR)
|
|
17
|
+
- `/po` - Product Owner (@PO)
|
|
18
|
+
- `/sa` - System Analyst (@SA)
|
|
19
|
+
- `/uiux` - UI/UX Designer (@UIUX)
|
|
20
|
+
- `/qa` - Quality Assurance (@QA)
|
|
21
|
+
- `/seca` - Security Analyst (@SECA)
|
|
22
|
+
- `/dev` - Developer (@DEV)
|
|
23
|
+
- `/devops` - DevOps Engineer (@DEVOPS)
|
|
24
|
+
- `/tester` - Tester (@TESTER)
|
|
25
|
+
- `/reporter` - Reporter (@REPORTER)
|
|
26
|
+
- `/stakeholder` - Stakeholder (@STAKEHOLDER)
|
|
27
|
+
|
|
28
|
+
### Automation
|
|
29
|
+
- `/auto` - Full automation mode
|
|
30
|
+
- `/semi-auto` - Semi-automation mode
|
|
31
|
+
|
|
32
|
+
### Knowledge Base
|
|
33
|
+
- `/kb-search` - Search knowledge base
|
|
34
|
+
- `/kb-add` - Add knowledge entry
|
|
35
|
+
|
|
36
|
+
## Command Behavior
|
|
37
|
+
|
|
38
|
+
When a slash command is used:
|
|
39
|
+
|
|
40
|
+
1. Load role definition from `.agent/workflows/[role].md`
|
|
41
|
+
2. Execute according to role responsibilities
|
|
42
|
+
3. Create artifacts in `docs/sprints/sprint-[N]/`
|
|
43
|
+
4. Follow global rules from `.agent/rules/global.md`
|
|
44
|
+
5. Use templates from `.agent/templates/`
|
|
45
|
+
|
|
46
|
+
## Multi-Agent Flow
|
|
47
|
+
|
|
48
|
+
Cascade's multi-agent capability maps perfectly to TeamLifecycle:
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
User → /pm → Planning Agent
|
|
52
|
+
→ /auto → Orchestrator Agent
|
|
53
|
+
→ Design Agents (SA, UIUX, PO in parallel)
|
|
54
|
+
→ Review Agents (QA, SecA in parallel)
|
|
55
|
+
→ Development Agents (DEV, DevOps in parallel)
|
|
56
|
+
→ Testing Agent (TESTER)
|
|
57
|
+
→ Reporting Agent (REPORTER)
|
|
58
|
+
→ Approval Agent (STAKEHOLDER)
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
## Cascade-Specific Features
|
|
62
|
+
|
|
63
|
+
### Parallel Execution
|
|
64
|
+
Use Cascade's multi-agent feature for parallel roles:
|
|
65
|
+
```
|
|
66
|
+
/orchestrator Enable full-auto mode
|
|
67
|
+
→ Cascade spawns: SA Agent + UIUX Agent + PO Agent (parallel)
|
|
68
|
+
→ Then spawns: QA Agent + SecA Agent (parallel)
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Context Sharing
|
|
72
|
+
All agents share context through:
|
|
73
|
+
- Artifacts in `docs/sprints/sprint-[N]/`
|
|
74
|
+
- Knowledge base in `.agent/knowledge-base/`
|
|
75
|
+
- Global rules in `.agent/rules/global.md`
|
|
76
|
+
|
|
77
|
+
### Agent Handoff
|
|
78
|
+
Each agent tags the next agent using @tags:
|
|
79
|
+
```
|
|
80
|
+
SA Agent completes → Tags @QA @SECA
|
|
81
|
+
→ Cascade spawns QA Agent + SecA Agent
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Examples
|
|
85
|
+
|
|
86
|
+
```
|
|
87
|
+
/pm Build a SaaS platform for project management
|
|
88
|
+
/auto Create an e-commerce mobile app
|
|
89
|
+
/dev Implement Stripe payment integration
|
|
90
|
+
/kb-search database connection pooling
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## Configuration
|
|
94
|
+
|
|
95
|
+
Add to Cascade settings or `.windsurfrules`:
|
|
96
|
+
|
|
97
|
+
```json
|
|
98
|
+
{
|
|
99
|
+
"customCommands": {
|
|
100
|
+
"pm": {
|
|
101
|
+
"description": "Project Manager",
|
|
102
|
+
"action": "loadRole",
|
|
103
|
+
"rolePath": ".agent/workflows/pm.md"
|
|
104
|
+
},
|
|
105
|
+
"orchestrator": {
|
|
106
|
+
"description": "Workflow Automation",
|
|
107
|
+
"action": "loadRole",
|
|
108
|
+
"rolePath": ".agent/workflows/orchestrator.md"
|
|
109
|
+
},
|
|
110
|
+
"auto": {
|
|
111
|
+
"description": "Full Auto Mode",
|
|
112
|
+
"action": "executeWorkflow",
|
|
113
|
+
"mode": "full-auto"
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
```
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
## Installation
|
|
121
|
+
|
|
122
|
+
1. Create `.windsurfrules` in project root
|
|
123
|
+
2. Copy configuration above
|
|
124
|
+
3. Restart Windsurf
|
|
125
|
+
4. Use `/` commands in Cascade chat
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
# Knowledge Base - Project Memory
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
This knowledge base stores lessons learned, bug patterns, difficult features, and solutions that required multiple attempts. Use this as a reference when encountering similar issues in the future.
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## 📁 Structure
|
|
9
|
+
|
|
10
|
+
```
|
|
11
|
+
knowledge-base/
|
|
12
|
+
├── README.md # This file
|
|
13
|
+
├── index.md # Searchable index of all entries
|
|
14
|
+
├── bugs/ # Bug patterns and fixes
|
|
15
|
+
│ ├── critical/
|
|
16
|
+
│ ├── high/
|
|
17
|
+
│ ├── medium/
|
|
18
|
+
│ └── low/
|
|
19
|
+
├── features/ # Complex feature implementations
|
|
20
|
+
│ ├── authentication/
|
|
21
|
+
│ ├── performance/
|
|
22
|
+
│ ├── integration/
|
|
23
|
+
│ └── ui-ux/
|
|
24
|
+
├── architecture/ # Architecture decisions and patterns
|
|
25
|
+
├── security/ # Security issues and solutions
|
|
26
|
+
├── performance/ # Performance optimizations
|
|
27
|
+
└── platform-specific/ # Platform-specific issues
|
|
28
|
+
├── web/
|
|
29
|
+
├── mobile/
|
|
30
|
+
├── desktop/
|
|
31
|
+
├── cli/
|
|
32
|
+
└── embedded/
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## 🔍 How to Use
|
|
38
|
+
|
|
39
|
+
### When to Create an Entry
|
|
40
|
+
Create a knowledge entry when:
|
|
41
|
+
- ✅ Bug required multiple attempts to fix (3+ attempts)
|
|
42
|
+
- ✅ Feature implementation was particularly challenging
|
|
43
|
+
- ✅ Solution was non-obvious or counter-intuitive
|
|
44
|
+
- ✅ Issue is likely to recur in similar projects
|
|
45
|
+
- ✅ Root cause analysis revealed important insights
|
|
46
|
+
- ✅ Performance issue required deep investigation
|
|
47
|
+
- ✅ Security vulnerability was discovered and fixed
|
|
48
|
+
|
|
49
|
+
### When to Search
|
|
50
|
+
Search the knowledge base when:
|
|
51
|
+
- 🔍 Encountering a new bug or error
|
|
52
|
+
- 🔍 Starting a complex feature implementation
|
|
53
|
+
- 🔍 Facing performance issues
|
|
54
|
+
- 🔍 Dealing with platform-specific problems
|
|
55
|
+
- 🔍 Making architecture decisions
|
|
56
|
+
- 🔍 Reviewing security concerns
|
|
57
|
+
|
|
58
|
+
### How to Search
|
|
59
|
+
1. **By Category:** Browse folders by type (bugs, features, etc.)
|
|
60
|
+
2. **By Severity:** Check critical/high priority entries first
|
|
61
|
+
3. **By Keywords:** Search for error messages, technology names, component names
|
|
62
|
+
4. **By Index:** Check `index.md` for quick reference
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## 📝 Creating an Entry
|
|
67
|
+
|
|
68
|
+
### Step 1: Use the Template
|
|
69
|
+
Copy `.gemini/instructions/templates/Knowledge-Entry-Template.md`
|
|
70
|
+
|
|
71
|
+
### Step 2: Fill in Details
|
|
72
|
+
- Provide clear problem description
|
|
73
|
+
- Include code snippets
|
|
74
|
+
- Document root cause
|
|
75
|
+
- Explain solution step-by-step
|
|
76
|
+
- Add prevention measures
|
|
77
|
+
|
|
78
|
+
### Step 3: Choose Location
|
|
79
|
+
Place entry in appropriate folder:
|
|
80
|
+
- **Bugs:** `knowledge-base/bugs/[severity]/KB-[date]-[id].md`
|
|
81
|
+
- **Features:** `knowledge-base/features/[category]/KB-[date]-[id].md`
|
|
82
|
+
- **Architecture:** `knowledge-base/architecture/KB-[date]-[id].md`
|
|
83
|
+
- **Security:** `knowledge-base/security/KB-[date]-[id].md`
|
|
84
|
+
- **Performance:** `knowledge-base/performance/KB-[date]-[id].md`
|
|
85
|
+
- **Platform:** `knowledge-base/platform-specific/[platform]/KB-[date]-[id].md`
|
|
86
|
+
|
|
87
|
+
### Step 4: Update Index
|
|
88
|
+
Add entry to `index.md` with:
|
|
89
|
+
- ID, Title, Category, Tags, Date
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## 🏷️ Tagging System
|
|
94
|
+
|
|
95
|
+
### Category Tags
|
|
96
|
+
- `#bug-pattern` - Recurring bug patterns
|
|
97
|
+
- `#feature-solution` - Complex feature implementations
|
|
98
|
+
- `#performance` - Performance optimizations
|
|
99
|
+
- `#security` - Security issues
|
|
100
|
+
- `#architecture` - Architecture decisions
|
|
101
|
+
- `#integration` - Third-party integrations
|
|
102
|
+
- `#platform-specific` - Platform-specific issues
|
|
103
|
+
|
|
104
|
+
### Technology Tags
|
|
105
|
+
- `#react`, `#nodejs`, `#python`, `#flutter`, etc.
|
|
106
|
+
- `#postgresql`, `#mongodb`, `#redis`, etc.
|
|
107
|
+
- `#aws`, `#docker`, `#kubernetes`, etc.
|
|
108
|
+
|
|
109
|
+
### Severity Tags
|
|
110
|
+
- `#critical` - System breaking, data loss
|
|
111
|
+
- `#high` - Major functionality affected
|
|
112
|
+
- `#medium` - Moderate impact
|
|
113
|
+
- `#low` - Minor issues
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## 📊 Entry Naming Convention
|
|
118
|
+
|
|
119
|
+
**Format:** `KB-[YYYY-MM-DD]-[###]-[short-title].md`
|
|
120
|
+
|
|
121
|
+
**Examples:**
|
|
122
|
+
- `KB-2025-12-29-001-react-hydration-error.md`
|
|
123
|
+
- `KB-2025-12-29-002-oauth-token-refresh.md`
|
|
124
|
+
- `KB-2025-12-29-003-mobile-memory-leak.md`
|
|
125
|
+
|
|
126
|
+
---
|
|
127
|
+
|
|
128
|
+
## 🔄 Maintenance
|
|
129
|
+
|
|
130
|
+
### Regular Reviews
|
|
131
|
+
- **Monthly:** Review and update entries
|
|
132
|
+
- **Quarterly:** Archive outdated entries
|
|
133
|
+
- **Yearly:** Consolidate similar entries
|
|
134
|
+
|
|
135
|
+
### Quality Standards
|
|
136
|
+
- ✅ Clear problem description
|
|
137
|
+
- ✅ Reproducible steps
|
|
138
|
+
- ✅ Working solution
|
|
139
|
+
- ✅ Prevention measures
|
|
140
|
+
- ✅ Proper tagging
|
|
141
|
+
|
|
142
|
+
### Archiving
|
|
143
|
+
Move outdated entries to `knowledge-base/archive/[year]/`
|
|
144
|
+
|
|
145
|
+
---
|
|
146
|
+
|
|
147
|
+
## 📈 Metrics to Track
|
|
148
|
+
|
|
149
|
+
Track these metrics in `index.md`:
|
|
150
|
+
- Total entries by category
|
|
151
|
+
- Most referenced entries
|
|
152
|
+
- Average resolution time
|
|
153
|
+
- Recurrence rate
|
|
154
|
+
|
|
155
|
+
---
|
|
156
|
+
|
|
157
|
+
## 🎯 Best Practices
|
|
158
|
+
|
|
159
|
+
### Writing Entries
|
|
160
|
+
1. **Be Specific:** Include exact error messages, versions, configurations
|
|
161
|
+
2. **Be Complete:** Document all attempts, not just the final solution
|
|
162
|
+
3. **Be Searchable:** Use clear keywords and tags
|
|
163
|
+
4. **Be Visual:** Include screenshots, diagrams, code snippets
|
|
164
|
+
5. **Be Preventive:** Focus on how to avoid the issue
|
|
165
|
+
|
|
166
|
+
### Using Entries
|
|
167
|
+
1. **Search First:** Always check knowledge base before starting
|
|
168
|
+
2. **Adapt Solutions:** Don't copy-paste blindly, understand the context
|
|
169
|
+
3. **Update Entries:** Add notes if you find better solutions
|
|
170
|
+
4. **Cross-Reference:** Link related entries together
|
|
171
|
+
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
## 🤝 Contributing
|
|
175
|
+
|
|
176
|
+
### Who Can Add Entries
|
|
177
|
+
- @DEV - Bug fixes, feature implementations
|
|
178
|
+
- @DEVOPS - Infrastructure, deployment issues
|
|
179
|
+
- @TESTER - Test patterns, edge cases
|
|
180
|
+
- @SECA - Security vulnerabilities
|
|
181
|
+
- @SA - Architecture decisions
|
|
182
|
+
- @UIUX - UI/UX patterns
|
|
183
|
+
|
|
184
|
+
### Review Process
|
|
185
|
+
1. Create entry using template
|
|
186
|
+
2. Tag @REPORTER for review
|
|
187
|
+
3. @REPORTER verifies completeness
|
|
188
|
+
4. Entry added to index
|
|
189
|
+
5. Team notified
|
|
190
|
+
|
|
191
|
+
---
|
|
192
|
+
|
|
193
|
+
## 📞 Questions?
|
|
194
|
+
|
|
195
|
+
If unsure about:
|
|
196
|
+
- **What to document:** Ask @PM or @REPORTER
|
|
197
|
+
- **Where to place entry:** Check this README or ask @REPORTER
|
|
198
|
+
- **How to search:** Use index.md or ask @REPORTER
|
|
199
|
+
|
|
200
|
+
---
|
|
201
|
+
|
|
202
|
+
#knowledge-base #documentation #lessons-learned
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
# This folder stores architecture decisions and patterns
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
# This folder stores bug patterns and solutions
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
# This folder stores complex feature implementations
|