@bugzy-ai/bugzy 1.8.0 → 1.9.1
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/LICENSE +21 -21
- package/README.md +273 -273
- package/dist/cli/index.cjs +294 -39
- package/dist/cli/index.cjs.map +1 -1
- package/dist/cli/index.js +293 -38
- package/dist/cli/index.js.map +1 -1
- package/dist/index.cjs +265 -10
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +265 -10
- package/dist/index.js.map +1 -1
- package/dist/subagents/index.cjs +250 -10
- package/dist/subagents/index.cjs.map +1 -1
- package/dist/subagents/index.js +250 -10
- package/dist/subagents/index.js.map +1 -1
- package/dist/subagents/metadata.cjs +9 -0
- package/dist/subagents/metadata.cjs.map +1 -1
- package/dist/subagents/metadata.js +9 -0
- package/dist/subagents/metadata.js.map +1 -1
- package/dist/tasks/index.cjs.map +1 -1
- package/dist/tasks/index.js.map +1 -1
- package/package.json +95 -95
- package/templates/init/.bugzy/runtime/knowledge-base.md +61 -61
- package/templates/init/.bugzy/runtime/knowledge-maintenance-guide.md +97 -97
- package/templates/init/.bugzy/runtime/project-context.md +35 -35
- package/templates/init/.bugzy/runtime/subagent-memory-guide.md +87 -87
- package/templates/init/.bugzy/runtime/templates/test-plan-template.md +50 -50
- package/templates/init/.bugzy/runtime/templates/test-result-schema.md +498 -498
- package/templates/init/.bugzy/runtime/test-execution-strategy.md +535 -535
- package/templates/init/.bugzy/runtime/testing-best-practices.md +724 -724
- package/templates/init/.env.testdata +18 -18
- package/templates/init/.gitignore-template +24 -24
- package/templates/init/AGENTS.md +155 -155
- package/templates/init/CLAUDE.md +157 -157
- package/templates/init/test-runs/README.md +45 -45
- package/templates/playwright/BasePage.template.ts +190 -190
- package/templates/playwright/auth.setup.template.ts +89 -89
- package/templates/playwright/dataGenerators.helper.template.ts +148 -148
- package/templates/playwright/dateUtils.helper.template.ts +96 -96
- package/templates/playwright/pages.fixture.template.ts +50 -50
- package/templates/playwright/playwright.config.template.ts +97 -97
- package/templates/playwright/reporters/bugzy-reporter.ts +454 -454
- package/dist/templates/init/.bugzy/runtime/knowledge-base.md +0 -61
- package/dist/templates/init/.bugzy/runtime/knowledge-maintenance-guide.md +0 -97
- package/dist/templates/init/.bugzy/runtime/project-context.md +0 -35
- package/dist/templates/init/.bugzy/runtime/subagent-memory-guide.md +0 -87
- package/dist/templates/init/.bugzy/runtime/templates/test-plan-template.md +0 -50
- package/dist/templates/init/.bugzy/runtime/templates/test-result-schema.md +0 -498
- package/dist/templates/init/.bugzy/runtime/test-execution-strategy.md +0 -535
- package/dist/templates/init/.bugzy/runtime/testing-best-practices.md +0 -632
- package/dist/templates/init/.gitignore-template +0 -25
package/package.json
CHANGED
|
@@ -1,95 +1,95 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@bugzy-ai/bugzy",
|
|
3
|
-
"version": "1.
|
|
4
|
-
"description": "Open-source AI agent configuration for QA automation with Claude Code",
|
|
5
|
-
"publishConfig": {
|
|
6
|
-
"access": "public"
|
|
7
|
-
},
|
|
8
|
-
"keywords": [
|
|
9
|
-
"ai",
|
|
10
|
-
"testing",
|
|
11
|
-
"qa",
|
|
12
|
-
"automation",
|
|
13
|
-
"claude",
|
|
14
|
-
"mcp",
|
|
15
|
-
"agent",
|
|
16
|
-
"test-automation",
|
|
17
|
-
"claude-code"
|
|
18
|
-
],
|
|
19
|
-
"homepage": "https://github.com/bugzy-ai/bugzy#readme",
|
|
20
|
-
"bugs": {
|
|
21
|
-
"url": "https://github.com/bugzy-ai/bugzy/issues"
|
|
22
|
-
},
|
|
23
|
-
"repository": {
|
|
24
|
-
"type": "git",
|
|
25
|
-
"url": "git+https://github.com/bugzy-ai/bugzy.git"
|
|
26
|
-
},
|
|
27
|
-
"license": "MIT",
|
|
28
|
-
"author": "Bugzy Team",
|
|
29
|
-
"type": "module",
|
|
30
|
-
"exports": {
|
|
31
|
-
".": {
|
|
32
|
-
"types": "./dist/index.d.ts",
|
|
33
|
-
"import": "./dist/index.js",
|
|
34
|
-
"require": "./dist/index.cjs"
|
|
35
|
-
},
|
|
36
|
-
"./tasks": {
|
|
37
|
-
"types": "./dist/tasks/index.d.ts",
|
|
38
|
-
"import": "./dist/tasks/index.js"
|
|
39
|
-
},
|
|
40
|
-
"./subagents": {
|
|
41
|
-
"types": "./dist/subagents/index.d.ts",
|
|
42
|
-
"import": "./dist/subagents/index.js"
|
|
43
|
-
},
|
|
44
|
-
"./subagents/metadata": {
|
|
45
|
-
"types": "./dist/subagents/metadata.d.ts",
|
|
46
|
-
"import": "./dist/subagents/metadata.js"
|
|
47
|
-
}
|
|
48
|
-
},
|
|
49
|
-
"main": "./dist/index.cjs",
|
|
50
|
-
"module": "./dist/index.js",
|
|
51
|
-
"types": "./dist/index.d.ts",
|
|
52
|
-
"bin": {
|
|
53
|
-
"bugzy": "./dist/cli/index.js"
|
|
54
|
-
},
|
|
55
|
-
"files": [
|
|
56
|
-
"dist",
|
|
57
|
-
"templates",
|
|
58
|
-
"README.md",
|
|
59
|
-
"LICENSE"
|
|
60
|
-
],
|
|
61
|
-
"scripts": {
|
|
62
|
-
"build": "tsup",
|
|
63
|
-
"dev": "tsup --watch",
|
|
64
|
-
"test": "vitest run",
|
|
65
|
-
"test:ci": "vitest run",
|
|
66
|
-
"type-check": "tsc --noEmit",
|
|
67
|
-
"lint": "eslint src",
|
|
68
|
-
"prepublishOnly": "pnpm run build && pnpm run test:ci"
|
|
69
|
-
},
|
|
70
|
-
"dependencies": {
|
|
71
|
-
"chalk": "^5.3.0",
|
|
72
|
-
"commander": "^11.1.0",
|
|
73
|
-
"dotenv": "^16.3.1",
|
|
74
|
-
"figlet": "^1.9.3",
|
|
75
|
-
"gradient-string": "^3.0.0",
|
|
76
|
-
"
|
|
77
|
-
"
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
"@types/
|
|
82
|
-
"@types/
|
|
83
|
-
"@types/
|
|
84
|
-
"@
|
|
85
|
-
"@typescript-eslint/
|
|
86
|
-
"eslint": "^
|
|
87
|
-
"
|
|
88
|
-
"tsup": "^8.0.1",
|
|
89
|
-
"typescript": "^5.3.3",
|
|
90
|
-
"vitest": "^1.1.0"
|
|
91
|
-
},
|
|
92
|
-
"engines": {
|
|
93
|
-
"node": ">=18.0.0"
|
|
94
|
-
}
|
|
95
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "@bugzy-ai/bugzy",
|
|
3
|
+
"version": "1.9.1",
|
|
4
|
+
"description": "Open-source AI agent configuration for QA automation with Claude Code",
|
|
5
|
+
"publishConfig": {
|
|
6
|
+
"access": "public"
|
|
7
|
+
},
|
|
8
|
+
"keywords": [
|
|
9
|
+
"ai",
|
|
10
|
+
"testing",
|
|
11
|
+
"qa",
|
|
12
|
+
"automation",
|
|
13
|
+
"claude",
|
|
14
|
+
"mcp",
|
|
15
|
+
"agent",
|
|
16
|
+
"test-automation",
|
|
17
|
+
"claude-code"
|
|
18
|
+
],
|
|
19
|
+
"homepage": "https://github.com/bugzy-ai/bugzy#readme",
|
|
20
|
+
"bugs": {
|
|
21
|
+
"url": "https://github.com/bugzy-ai/bugzy/issues"
|
|
22
|
+
},
|
|
23
|
+
"repository": {
|
|
24
|
+
"type": "git",
|
|
25
|
+
"url": "git+https://github.com/bugzy-ai/bugzy.git"
|
|
26
|
+
},
|
|
27
|
+
"license": "MIT",
|
|
28
|
+
"author": "Bugzy Team",
|
|
29
|
+
"type": "module",
|
|
30
|
+
"exports": {
|
|
31
|
+
".": {
|
|
32
|
+
"types": "./dist/index.d.ts",
|
|
33
|
+
"import": "./dist/index.js",
|
|
34
|
+
"require": "./dist/index.cjs"
|
|
35
|
+
},
|
|
36
|
+
"./tasks": {
|
|
37
|
+
"types": "./dist/tasks/index.d.ts",
|
|
38
|
+
"import": "./dist/tasks/index.js"
|
|
39
|
+
},
|
|
40
|
+
"./subagents": {
|
|
41
|
+
"types": "./dist/subagents/index.d.ts",
|
|
42
|
+
"import": "./dist/subagents/index.js"
|
|
43
|
+
},
|
|
44
|
+
"./subagents/metadata": {
|
|
45
|
+
"types": "./dist/subagents/metadata.d.ts",
|
|
46
|
+
"import": "./dist/subagents/metadata.js"
|
|
47
|
+
}
|
|
48
|
+
},
|
|
49
|
+
"main": "./dist/index.cjs",
|
|
50
|
+
"module": "./dist/index.js",
|
|
51
|
+
"types": "./dist/index.d.ts",
|
|
52
|
+
"bin": {
|
|
53
|
+
"bugzy": "./dist/cli/index.js"
|
|
54
|
+
},
|
|
55
|
+
"files": [
|
|
56
|
+
"dist",
|
|
57
|
+
"templates",
|
|
58
|
+
"README.md",
|
|
59
|
+
"LICENSE"
|
|
60
|
+
],
|
|
61
|
+
"scripts": {
|
|
62
|
+
"build": "tsup",
|
|
63
|
+
"dev": "tsup --watch",
|
|
64
|
+
"test": "vitest run",
|
|
65
|
+
"test:ci": "vitest run",
|
|
66
|
+
"type-check": "tsc --noEmit",
|
|
67
|
+
"lint": "eslint src",
|
|
68
|
+
"prepublishOnly": "pnpm run build && pnpm run test:ci"
|
|
69
|
+
},
|
|
70
|
+
"dependencies": {
|
|
71
|
+
"chalk": "^5.3.0",
|
|
72
|
+
"commander": "^11.1.0",
|
|
73
|
+
"dotenv": "^16.3.1",
|
|
74
|
+
"figlet": "^1.9.3",
|
|
75
|
+
"gradient-string": "^3.0.0",
|
|
76
|
+
"gray-matter": "^4.0.3",
|
|
77
|
+
"inquirer": "^9.2.12",
|
|
78
|
+
"ora": "^7.0.1"
|
|
79
|
+
},
|
|
80
|
+
"devDependencies": {
|
|
81
|
+
"@types/figlet": "^1.7.0",
|
|
82
|
+
"@types/gradient-string": "^1.1.6",
|
|
83
|
+
"@types/inquirer": "^9.0.7",
|
|
84
|
+
"@types/node": "^20.10.5",
|
|
85
|
+
"@typescript-eslint/eslint-plugin": "^6.15.0",
|
|
86
|
+
"@typescript-eslint/parser": "^6.15.0",
|
|
87
|
+
"eslint": "^8.56.0",
|
|
88
|
+
"tsup": "^8.0.1",
|
|
89
|
+
"typescript": "^5.3.3",
|
|
90
|
+
"vitest": "^1.1.0"
|
|
91
|
+
},
|
|
92
|
+
"engines": {
|
|
93
|
+
"node": ">=18.0.0"
|
|
94
|
+
}
|
|
95
|
+
}
|
|
@@ -1,61 +1,61 @@
|
|
|
1
|
-
# Knowledge Base
|
|
2
|
-
|
|
3
|
-
> A curated collection of factual knowledge about this project - what we currently know and believe to be true. This is NOT a historical log, but a living reference that evolves as understanding improves.
|
|
4
|
-
|
|
5
|
-
**Maintenance Guide**: See `knowledge-maintenance-guide.md` for instructions on how to maintain this knowledge base.
|
|
6
|
-
|
|
7
|
-
**Core Principle**: This document represents current understanding, not a history. When knowledge evolves, update existing entries rather than appending new ones.
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
## Project Knowledge
|
|
12
|
-
|
|
13
|
-
_This knowledge base will be populated as you work. Add new discoveries, update existing understanding, and remove outdated information following the maintenance guide principles._
|
|
14
|
-
|
|
15
|
-
### When to Update This File
|
|
16
|
-
|
|
17
|
-
- **ADD**: New factual information discovered, new patterns emerge, new areas become relevant
|
|
18
|
-
- **UPDATE**: Facts change, understanding deepens, multiple facts can be consolidated, language can be clarified
|
|
19
|
-
- **REMOVE**: Information becomes irrelevant, facts proven incorrect, entries superseded by better content
|
|
20
|
-
|
|
21
|
-
### Format Guidelines
|
|
22
|
-
|
|
23
|
-
- Use clear, declarative statements in present tense
|
|
24
|
-
- State facts confidently when known; flag uncertainty when it exists
|
|
25
|
-
- Write for someone reading this 6 months from now
|
|
26
|
-
- Keep entries relevant and actionable
|
|
27
|
-
- Favor consolidation over accumulation
|
|
28
|
-
|
|
29
|
-
---
|
|
30
|
-
|
|
31
|
-
## Example Structure
|
|
32
|
-
|
|
33
|
-
Below is an example structure. Feel free to organize knowledge in the way that makes most sense for this project:
|
|
34
|
-
|
|
35
|
-
### Architecture & Infrastructure
|
|
36
|
-
|
|
37
|
-
_System architecture, deployment patterns, infrastructure details_
|
|
38
|
-
|
|
39
|
-
### Testing Patterns
|
|
40
|
-
|
|
41
|
-
_Test strategies, common test scenarios, testing conventions_
|
|
42
|
-
|
|
43
|
-
### UI/UX Patterns
|
|
44
|
-
|
|
45
|
-
_User interface conventions, interaction patterns, design system details_
|
|
46
|
-
|
|
47
|
-
### Data & APIs
|
|
48
|
-
|
|
49
|
-
_Data models, API behaviors, integration patterns_
|
|
50
|
-
|
|
51
|
-
### Known Issues & Workarounds
|
|
52
|
-
|
|
53
|
-
_Current limitations, known bugs, and their workarounds_
|
|
54
|
-
|
|
55
|
-
### Domain Knowledge
|
|
56
|
-
|
|
57
|
-
_Business domain facts, terminology, rules, and context_
|
|
58
|
-
|
|
59
|
-
---
|
|
60
|
-
|
|
61
|
-
**Remember**: Every entry should answer "Will this help someone working on this project in 6 months?"
|
|
1
|
+
# Knowledge Base
|
|
2
|
+
|
|
3
|
+
> A curated collection of factual knowledge about this project - what we currently know and believe to be true. This is NOT a historical log, but a living reference that evolves as understanding improves.
|
|
4
|
+
|
|
5
|
+
**Maintenance Guide**: See `knowledge-maintenance-guide.md` for instructions on how to maintain this knowledge base.
|
|
6
|
+
|
|
7
|
+
**Core Principle**: This document represents current understanding, not a history. When knowledge evolves, update existing entries rather than appending new ones.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Project Knowledge
|
|
12
|
+
|
|
13
|
+
_This knowledge base will be populated as you work. Add new discoveries, update existing understanding, and remove outdated information following the maintenance guide principles._
|
|
14
|
+
|
|
15
|
+
### When to Update This File
|
|
16
|
+
|
|
17
|
+
- **ADD**: New factual information discovered, new patterns emerge, new areas become relevant
|
|
18
|
+
- **UPDATE**: Facts change, understanding deepens, multiple facts can be consolidated, language can be clarified
|
|
19
|
+
- **REMOVE**: Information becomes irrelevant, facts proven incorrect, entries superseded by better content
|
|
20
|
+
|
|
21
|
+
### Format Guidelines
|
|
22
|
+
|
|
23
|
+
- Use clear, declarative statements in present tense
|
|
24
|
+
- State facts confidently when known; flag uncertainty when it exists
|
|
25
|
+
- Write for someone reading this 6 months from now
|
|
26
|
+
- Keep entries relevant and actionable
|
|
27
|
+
- Favor consolidation over accumulation
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## Example Structure
|
|
32
|
+
|
|
33
|
+
Below is an example structure. Feel free to organize knowledge in the way that makes most sense for this project:
|
|
34
|
+
|
|
35
|
+
### Architecture & Infrastructure
|
|
36
|
+
|
|
37
|
+
_System architecture, deployment patterns, infrastructure details_
|
|
38
|
+
|
|
39
|
+
### Testing Patterns
|
|
40
|
+
|
|
41
|
+
_Test strategies, common test scenarios, testing conventions_
|
|
42
|
+
|
|
43
|
+
### UI/UX Patterns
|
|
44
|
+
|
|
45
|
+
_User interface conventions, interaction patterns, design system details_
|
|
46
|
+
|
|
47
|
+
### Data & APIs
|
|
48
|
+
|
|
49
|
+
_Data models, API behaviors, integration patterns_
|
|
50
|
+
|
|
51
|
+
### Known Issues & Workarounds
|
|
52
|
+
|
|
53
|
+
_Current limitations, known bugs, and their workarounds_
|
|
54
|
+
|
|
55
|
+
### Domain Knowledge
|
|
56
|
+
|
|
57
|
+
_Business domain facts, terminology, rules, and context_
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
**Remember**: Every entry should answer "Will this help someone working on this project in 6 months?"
|
|
@@ -1,97 +1,97 @@
|
|
|
1
|
-
# Knowledge Maintenance Guide
|
|
2
|
-
|
|
3
|
-
## Overview
|
|
4
|
-
|
|
5
|
-
This document provides instructions for maintaining a **Context** or **Knowledge Base** - a living collection of factual knowledge that is actively curated and updated rather than simply accumulated over time.
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## Core Principle: This is a Curated Snapshot, Not a Log
|
|
10
|
-
|
|
11
|
-
This document represents **what we currently know and believe to be true**, not a history of what we've learned. Think of it as a living reference that evolves as understanding improves.
|
|
12
|
-
|
|
13
|
-
---
|
|
14
|
-
|
|
15
|
-
## When to ADD
|
|
16
|
-
|
|
17
|
-
Add new entries when:
|
|
18
|
-
|
|
19
|
-
- New factual information is discovered
|
|
20
|
-
- New patterns or relationships emerge
|
|
21
|
-
- New areas of knowledge become relevant
|
|
22
|
-
|
|
23
|
-
**Check first**: Does this duplicate or overlap with existing entries?
|
|
24
|
-
|
|
25
|
-
---
|
|
26
|
-
|
|
27
|
-
## When to UPDATE
|
|
28
|
-
|
|
29
|
-
Update existing entries when:
|
|
30
|
-
|
|
31
|
-
- Facts change or we discover more accurate information
|
|
32
|
-
- Understanding deepens (replace shallow with deeper insight)
|
|
33
|
-
- Multiple related facts can be consolidated into one coherent statement
|
|
34
|
-
- Language can be clarified or made more precise
|
|
35
|
-
|
|
36
|
-
**Goal**: Replace outdated understanding with current understanding
|
|
37
|
-
|
|
38
|
-
---
|
|
39
|
-
|
|
40
|
-
## When to REMOVE
|
|
41
|
-
|
|
42
|
-
Remove entries when:
|
|
43
|
-
|
|
44
|
-
- Information becomes irrelevant to current needs
|
|
45
|
-
- Facts are proven incorrect (unless there's value in noting the correction)
|
|
46
|
-
- Information is superseded by better, more comprehensive entries
|
|
47
|
-
- Entry is redundant with other content
|
|
48
|
-
|
|
49
|
-
**Key question**: "If someone reads this in 6 months, will it help them?"
|
|
50
|
-
|
|
51
|
-
---
|
|
52
|
-
|
|
53
|
-
## Maintenance Principles
|
|
54
|
-
|
|
55
|
-
### 1. Favor Consolidation Over Addition
|
|
56
|
-
|
|
57
|
-
- Before adding, ask: "Can this merge with existing knowledge?"
|
|
58
|
-
- Example: Instead of 10 facts about a person, maintain 2-3 well-organized paragraphs
|
|
59
|
-
|
|
60
|
-
### 2. Update Rather Than Append
|
|
61
|
-
|
|
62
|
-
- When information evolves, replace the old statement
|
|
63
|
-
- Keep history only if the evolution itself is important
|
|
64
|
-
- Example: ~~"User is learning Python"~~ → "User is proficient in Python and focusing on FastAPI"
|
|
65
|
-
|
|
66
|
-
### 3. Regular Pruning
|
|
67
|
-
|
|
68
|
-
- Periodically review for outdated or low-value entries
|
|
69
|
-
- Ask: "Is this still accurate? Still relevant? Could it be stated better?"
|
|
70
|
-
- Aim for signal-to-noise ratio improvement
|
|
71
|
-
|
|
72
|
-
### 4. Quality Over Completeness
|
|
73
|
-
|
|
74
|
-
- Better to have 50 highly relevant, accurate facts than 500 marginally useful ones
|
|
75
|
-
- Prioritize insights over raw data
|
|
76
|
-
- Focus on what's actionable or decision-relevant
|
|
77
|
-
|
|
78
|
-
### 5. Resolve Contradictions Immediately
|
|
79
|
-
|
|
80
|
-
- If new information contradicts old, investigate and keep only the truth
|
|
81
|
-
- Don't accumulate conflicting statements
|
|
82
|
-
|
|
83
|
-
### 6. Use Clear, Declarative Statements
|
|
84
|
-
|
|
85
|
-
- Write in present tense: "User works at X" not "User mentioned they work at X"
|
|
86
|
-
- State facts confidently when known; flag uncertainty when it exists
|
|
87
|
-
- Avoid hedging unless genuinely uncertain
|
|
88
|
-
|
|
89
|
-
---
|
|
90
|
-
|
|
91
|
-
## Anti-Patterns to Avoid
|
|
92
|
-
|
|
93
|
-
| ❌ Don't Do This | ✅ Do This Instead |
|
|
94
|
-
|-----------------|-------------------|
|
|
95
|
-
| "On Tuesday user said X, then on Friday user said Y" | "User's position on X is Y" (keep most current) |
|
|
96
|
-
| Keeping every detail ever mentioned | Keeping relevant, current details |
|
|
97
|
-
| "User might like coffee, user mentioned tea once, user drinks water" | "User prefers tea; also drinks coffee occasionally" |
|
|
1
|
+
# Knowledge Maintenance Guide
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
This document provides instructions for maintaining a **Context** or **Knowledge Base** - a living collection of factual knowledge that is actively curated and updated rather than simply accumulated over time.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Core Principle: This is a Curated Snapshot, Not a Log
|
|
10
|
+
|
|
11
|
+
This document represents **what we currently know and believe to be true**, not a history of what we've learned. Think of it as a living reference that evolves as understanding improves.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## When to ADD
|
|
16
|
+
|
|
17
|
+
Add new entries when:
|
|
18
|
+
|
|
19
|
+
- New factual information is discovered
|
|
20
|
+
- New patterns or relationships emerge
|
|
21
|
+
- New areas of knowledge become relevant
|
|
22
|
+
|
|
23
|
+
**Check first**: Does this duplicate or overlap with existing entries?
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## When to UPDATE
|
|
28
|
+
|
|
29
|
+
Update existing entries when:
|
|
30
|
+
|
|
31
|
+
- Facts change or we discover more accurate information
|
|
32
|
+
- Understanding deepens (replace shallow with deeper insight)
|
|
33
|
+
- Multiple related facts can be consolidated into one coherent statement
|
|
34
|
+
- Language can be clarified or made more precise
|
|
35
|
+
|
|
36
|
+
**Goal**: Replace outdated understanding with current understanding
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## When to REMOVE
|
|
41
|
+
|
|
42
|
+
Remove entries when:
|
|
43
|
+
|
|
44
|
+
- Information becomes irrelevant to current needs
|
|
45
|
+
- Facts are proven incorrect (unless there's value in noting the correction)
|
|
46
|
+
- Information is superseded by better, more comprehensive entries
|
|
47
|
+
- Entry is redundant with other content
|
|
48
|
+
|
|
49
|
+
**Key question**: "If someone reads this in 6 months, will it help them?"
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## Maintenance Principles
|
|
54
|
+
|
|
55
|
+
### 1. Favor Consolidation Over Addition
|
|
56
|
+
|
|
57
|
+
- Before adding, ask: "Can this merge with existing knowledge?"
|
|
58
|
+
- Example: Instead of 10 facts about a person, maintain 2-3 well-organized paragraphs
|
|
59
|
+
|
|
60
|
+
### 2. Update Rather Than Append
|
|
61
|
+
|
|
62
|
+
- When information evolves, replace the old statement
|
|
63
|
+
- Keep history only if the evolution itself is important
|
|
64
|
+
- Example: ~~"User is learning Python"~~ → "User is proficient in Python and focusing on FastAPI"
|
|
65
|
+
|
|
66
|
+
### 3. Regular Pruning
|
|
67
|
+
|
|
68
|
+
- Periodically review for outdated or low-value entries
|
|
69
|
+
- Ask: "Is this still accurate? Still relevant? Could it be stated better?"
|
|
70
|
+
- Aim for signal-to-noise ratio improvement
|
|
71
|
+
|
|
72
|
+
### 4. Quality Over Completeness
|
|
73
|
+
|
|
74
|
+
- Better to have 50 highly relevant, accurate facts than 500 marginally useful ones
|
|
75
|
+
- Prioritize insights over raw data
|
|
76
|
+
- Focus on what's actionable or decision-relevant
|
|
77
|
+
|
|
78
|
+
### 5. Resolve Contradictions Immediately
|
|
79
|
+
|
|
80
|
+
- If new information contradicts old, investigate and keep only the truth
|
|
81
|
+
- Don't accumulate conflicting statements
|
|
82
|
+
|
|
83
|
+
### 6. Use Clear, Declarative Statements
|
|
84
|
+
|
|
85
|
+
- Write in present tense: "User works at X" not "User mentioned they work at X"
|
|
86
|
+
- State facts confidently when known; flag uncertainty when it exists
|
|
87
|
+
- Avoid hedging unless genuinely uncertain
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## Anti-Patterns to Avoid
|
|
92
|
+
|
|
93
|
+
| ❌ Don't Do This | ✅ Do This Instead |
|
|
94
|
+
|-----------------|-------------------|
|
|
95
|
+
| "On Tuesday user said X, then on Friday user said Y" | "User's position on X is Y" (keep most current) |
|
|
96
|
+
| Keeping every detail ever mentioned | Keeping relevant, current details |
|
|
97
|
+
| "User might like coffee, user mentioned tea once, user drinks water" | "User prefers tea; also drinks coffee occasionally" |
|
|
@@ -1,35 +1,35 @@
|
|
|
1
|
-
# Project Context
|
|
2
|
-
|
|
3
|
-
## Customer Information
|
|
4
|
-
**Customer Name:** {{CUSTOMER_NAME}}
|
|
5
|
-
**Primary Contact:** [To be filled]
|
|
6
|
-
|
|
7
|
-
## Project Information
|
|
8
|
-
**Project Name:** {{PROJECT_NAME}}
|
|
9
|
-
**Description:** [To be filled]
|
|
10
|
-
**Repository:** [To be filled]
|
|
11
|
-
|
|
12
|
-
## Development Process
|
|
13
|
-
**Methodology:** [Agile/Waterfall/Hybrid - To be filled]
|
|
14
|
-
**Sprint Length:** [e.g., 2 weeks - To be filled]
|
|
15
|
-
**Current Sprint:** [To be filled]
|
|
16
|
-
|
|
17
|
-
## QA Integration
|
|
18
|
-
**QA Entry Point:** [e.g., After development complete, During development - To be filled]
|
|
19
|
-
**Definition of Done:** [QA criteria for story completion - To be filled]
|
|
20
|
-
**Sign-off Process:** [Who approves test results - To be filled]
|
|
21
|
-
|
|
22
|
-
## Tools & Systems
|
|
23
|
-
**Bug Tracking:** {{BUG_TRACKING_SYSTEM}}
|
|
24
|
-
**Documentation:** {{DOCUMENTATION_SYSTEM}}
|
|
25
|
-
**CI/CD Platform:** [e.g., GitHub Actions, Jenkins - To be filled]
|
|
26
|
-
**Communication:** [e.g., Slack channel - To be filled]
|
|
27
|
-
|
|
28
|
-
## Team Contacts
|
|
29
|
-
**Product Owner:** [Name and contact - To be filled]
|
|
30
|
-
**Tech Lead:** [Name and contact - To be filled]
|
|
31
|
-
**QA Lead:** [Name and contact - To be filled]
|
|
32
|
-
**DevOps Contact:** [Name and contact - To be filled]
|
|
33
|
-
|
|
34
|
-
## Notes
|
|
35
|
-
[Any additional context about the project, special requirements, or considerations]
|
|
1
|
+
# Project Context
|
|
2
|
+
|
|
3
|
+
## Customer Information
|
|
4
|
+
**Customer Name:** {{CUSTOMER_NAME}}
|
|
5
|
+
**Primary Contact:** [To be filled]
|
|
6
|
+
|
|
7
|
+
## Project Information
|
|
8
|
+
**Project Name:** {{PROJECT_NAME}}
|
|
9
|
+
**Description:** [To be filled]
|
|
10
|
+
**Repository:** [To be filled]
|
|
11
|
+
|
|
12
|
+
## Development Process
|
|
13
|
+
**Methodology:** [Agile/Waterfall/Hybrid - To be filled]
|
|
14
|
+
**Sprint Length:** [e.g., 2 weeks - To be filled]
|
|
15
|
+
**Current Sprint:** [To be filled]
|
|
16
|
+
|
|
17
|
+
## QA Integration
|
|
18
|
+
**QA Entry Point:** [e.g., After development complete, During development - To be filled]
|
|
19
|
+
**Definition of Done:** [QA criteria for story completion - To be filled]
|
|
20
|
+
**Sign-off Process:** [Who approves test results - To be filled]
|
|
21
|
+
|
|
22
|
+
## Tools & Systems
|
|
23
|
+
**Bug Tracking:** {{BUG_TRACKING_SYSTEM}}
|
|
24
|
+
**Documentation:** {{DOCUMENTATION_SYSTEM}}
|
|
25
|
+
**CI/CD Platform:** [e.g., GitHub Actions, Jenkins - To be filled]
|
|
26
|
+
**Communication:** [e.g., Slack channel - To be filled]
|
|
27
|
+
|
|
28
|
+
## Team Contacts
|
|
29
|
+
**Product Owner:** [Name and contact - To be filled]
|
|
30
|
+
**Tech Lead:** [Name and contact - To be filled]
|
|
31
|
+
**QA Lead:** [Name and contact - To be filled]
|
|
32
|
+
**DevOps Contact:** [Name and contact - To be filled]
|
|
33
|
+
|
|
34
|
+
## Notes
|
|
35
|
+
[Any additional context about the project, special requirements, or considerations]
|