@sandrinio/vbounce 1.3.2 โ 1.5.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/README.md +28 -2
- package/bin/vbounce.mjs +30 -0
- package/brains/AGENTS.md +19 -13
- package/brains/CHANGELOG.md +24 -0
- package/brains/CLAUDE.md +22 -14
- package/brains/GEMINI.md +21 -13
- package/brains/SETUP.md +7 -10
- package/brains/claude-agents/architect.md +28 -6
- package/brains/claude-agents/developer.md +20 -7
- package/brains/claude-agents/devops.md +28 -12
- package/brains/claude-agents/qa.md +22 -6
- package/brains/claude-agents/scribe.md +24 -7
- package/brains/cursor-rules/vbounce-docs.mdc +12 -8
- package/brains/cursor-rules/vbounce-process.mdc +5 -4
- package/brains/cursor-rules/vbounce-rules.mdc +9 -6
- package/package.json +2 -2
- package/scripts/validate_report.mjs +11 -5
- package/scripts/vbounce_index.mjs +2 -2
- package/scripts/verify_framework.mjs +17 -0
- package/skills/agent-team/SKILL.md +93 -66
- package/skills/doc-manager/SKILL.md +58 -44
- package/skills/improve/SKILL.md +179 -0
- package/templates/charter.md +8 -8
- package/templates/delivery_plan.md +22 -177
- package/templates/epic.md +19 -19
- package/templates/hotfix.md +9 -12
- package/templates/risk_registry.md +8 -10
- package/templates/roadmap.md +8 -10
- package/templates/sprint.md +48 -0
- package/templates/sprint_report.md +66 -28
- package/templates/story.md +17 -15
package/README.md
CHANGED
|
@@ -18,12 +18,24 @@ Instead of treating your AI as a solo developer, V-Bounce OS forces distinct, sp
|
|
|
18
18
|
|
|
19
19
|
1. **Requirements (`product_plans/`)**: The Team Lead defines standard, immutable templates (Charter, Epic, Story) before a single line of code is written.
|
|
20
20
|
2. **Bounce Reports (`.bounce/`)**: During implementation, the QA and Architect agents do not edit code. They run deep codebase audits and emit structured "Bounce Reports" summarizing anti-patterns and regressions. The Developer must fix the issues and run the loop again until the code passes validation.
|
|
21
|
-
3. **Product Documentation (`
|
|
21
|
+
3. **Product Documentation (`vdocs/`)**: The Scribe agent explores the *actual* codebase post-merge and uses our integrated `vdoc` tool to update feature-centric documentation and the semantic `_manifest.json` map.
|
|
22
22
|
|
|
23
23
|
The next time an agent writes code, it reads the `_manifest.json` and the `LESSONS.md` file from previous sprints. The context loop closes. Your AI writes better code because it finally understands the reality of your evolving system.
|
|
24
24
|
|
|
25
25
|
---
|
|
26
26
|
|
|
27
|
+
## ๐ State-Based Folder Structure
|
|
28
|
+
|
|
29
|
+
V-Bounce OS organizes planning documents (`product_plans/`) through a strict state machine based on folder location:
|
|
30
|
+
|
|
31
|
+
- **`strategy/`**: High-level context (Charter, Roadmap, Risk Registry, Release Plans). Frozen during active sprints.
|
|
32
|
+
- **`backlog/`**: Where unassigned work lives. Epics and their child Stories are refined here until selected for a sprint.
|
|
33
|
+
- **`sprints/`**: The active execution workspace. A physical `sprint-XX/` boundary is created and Stories are moved in. Only one sprint is "Active" at a time.
|
|
34
|
+
- **`hotfixes/`**: Trivial, emergency tasks that bypass sprint cycles.
|
|
35
|
+
- **`archive/`**: Immutable history. Finished sprint folders and fully completed Epics are permanently moved here.
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
27
39
|
## ๐ ๏ธ The Tech Stack
|
|
28
40
|
|
|
29
41
|
V-Bounce OS is built to be **local-first, privacy-conscious, and blazing fast**.
|
|
@@ -71,7 +83,7 @@ npx @sandrinio/vbounce install codex
|
|
|
71
83
|
- **Templates:** Markdown templates for your Charter, Roadmap, Epics, and Stories.
|
|
72
84
|
- **Bundled Scripts:** Our validation pipeline (`validate_report.mjs`) and RAG synchronization engine (`pre_bounce_sync.sh`).
|
|
73
85
|
- **Autonomous RAG Setup:** The installer automatically runs `npm install` for required libraries and initializes your local LanceDB knowledge base (`.bounce/.lancedb/`).
|
|
74
|
-
- **vdoc Integration:**
|
|
86
|
+
- **vdoc Integration:** The installer offers to install [`@sandrinio/vdoc`](https://github.com/sandrinio/vdoc) for your platform โ enabling automatic semantic product documentation generation via the Scribe agent.
|
|
75
87
|
|
|
76
88
|
### ๐งฐ The Bundled Skills
|
|
77
89
|
V-Bounce OS installs a powerful suite of specialized markdown `skills/` directly into your workspace. These act as modular capabilities you can invoke dynamically or that the Team Lead agent will invoke automatically during the SDLC process:
|
|
@@ -84,6 +96,7 @@ V-Bounce OS installs a powerful suite of specialized markdown `skills/` directly
|
|
|
84
96
|
| `react-best-practices` | Developer | A strict set of frontend execution rules the Developer must follow during implementation. <mark>*(Note: This skill serves as a template and must be customized by the human according to the specific tech stack being used.)*</mark> |
|
|
85
97
|
| `vibe-code-review` | QA/Architect | Runs distinct review modes (Quick Scan, Deep Audit) to validate code against Acceptance Criteria and Architecture rules. |
|
|
86
98
|
| `write-skill` | Lead | Allows the Team Lead to autonomously write and deploy entirely *new* skills if the team repeatedly encounters a novel problem. |
|
|
99
|
+
| `improve` | Lead | The framework's self-improvement loop. Reads agent friction signals from sprint retros and proposes targeted changes to templates, skills, brain files, and scripts โ with human approval. |
|
|
87
100
|
|
|
88
101
|
---
|
|
89
102
|
|
|
@@ -111,6 +124,19 @@ When a sprint concludes, V-Bounce OS generates structured reports so human revie
|
|
|
111
124
|
### 4. Progressive Learning (`LESSONS.md`)
|
|
112
125
|
Every time the AI makes a mistake during the Bounce Loop, it flags the issue. During the sprint retrospective, these mistakes are recorded in `LESSONS.md`โa permanent project memory that all agents read *before* writing any future code. **Your AI gets smarter about your specific codebase with every single sprint.**
|
|
113
126
|
|
|
127
|
+
### 5. Self-Improving Framework (`improve` skill)
|
|
128
|
+
V-Bounce OS doesn't just improve your code โ it improves *itself*. Every agent report includes a **Process Feedback** section where agents flag friction with the framework: a template missing a critical field, a handoff that lost context, a RAG query that returned irrelevant results, or a skill instruction that was unclear.
|
|
129
|
+
|
|
130
|
+
These signals are aggregated into the Sprint Report's **Framework Self-Assessment** โ categorized by area (Templates, Handoffs, RAG Pipeline, Skills, Process Flow, Tooling) with severity ratings and suggested fixes.
|
|
131
|
+
|
|
132
|
+
After every 2-3 sprints, the Team Lead runs the `improve` skill which:
|
|
133
|
+
1. Reads accumulated friction signals across sprints
|
|
134
|
+
2. Identifies recurring patterns (same complaint from multiple agents = real problem)
|
|
135
|
+
3. Proposes specific, targeted changes to templates, skills, brain files, or scripts
|
|
136
|
+
4. **Applies nothing without your approval** โ you review every proposed change
|
|
137
|
+
|
|
138
|
+
The result: templates get sharper, handoffs get cleaner, skills get more precise, and the bounce loop gets tighter โ all driven by the agents who actually use the framework every day.
|
|
139
|
+
|
|
114
140
|
---
|
|
115
141
|
|
|
116
142
|
## ๐ Keywords for Searchability
|
package/bin/vbounce.mjs
CHANGED
|
@@ -58,6 +58,16 @@ if (!command || command !== 'install' || !targetPlatform) {
|
|
|
58
58
|
|
|
59
59
|
const CWD = process.cwd();
|
|
60
60
|
|
|
61
|
+
// Map vbounce platform names to vdoc platform names
|
|
62
|
+
const vdocPlatformMap = {
|
|
63
|
+
claude: 'claude',
|
|
64
|
+
cursor: 'cursor',
|
|
65
|
+
gemini: 'gemini',
|
|
66
|
+
codex: 'agents',
|
|
67
|
+
vscode: 'vscode',
|
|
68
|
+
copilot: 'vscode'
|
|
69
|
+
};
|
|
70
|
+
|
|
61
71
|
const platformMappings = {
|
|
62
72
|
claude: [
|
|
63
73
|
{ src: 'brains/CLAUDE.md', dest: 'CLAUDE.md' },
|
|
@@ -196,5 +206,25 @@ askQuestion('Proceed with installation? [y/N] ').then(async answer => {
|
|
|
196
206
|
console.error(' \x1b[31mโ\x1b[0m Failed to initialize knowledge base. Run ./scripts/pre_bounce_sync.sh manually.');
|
|
197
207
|
}
|
|
198
208
|
|
|
209
|
+
// vdoc integration
|
|
210
|
+
const vdocPlatform = vdocPlatformMap[targetPlatform];
|
|
211
|
+
if (vdocPlatform) {
|
|
212
|
+
const rl2 = readline.createInterface({ input: process.stdin, output: process.stdout });
|
|
213
|
+
const vdocAnswer = await new Promise(resolve => rl2.question('\n๐ Install vdoc (AI-powered documentation generator)? [y/N] ', resolve));
|
|
214
|
+
rl2.close();
|
|
215
|
+
|
|
216
|
+
if (vdocAnswer.trim().toLowerCase() === 'y' || vdocAnswer.trim().toLowerCase() === 'yes') {
|
|
217
|
+
console.log(`\n๐ Installing vdoc for ${vdocPlatform}...`);
|
|
218
|
+
try {
|
|
219
|
+
execSync(`npx @sandrinio/vdoc install ${vdocPlatform}`, { stdio: 'inherit', cwd: CWD });
|
|
220
|
+
console.log(' \x1b[32mโ\x1b[0m vdoc installed.');
|
|
221
|
+
} catch (err) {
|
|
222
|
+
console.error(` \x1b[31mโ\x1b[0m Failed to install vdoc. Run manually: npx @sandrinio/vdoc install ${vdocPlatform}`);
|
|
223
|
+
}
|
|
224
|
+
} else {
|
|
225
|
+
console.log(`\n Skipped. You can install later: npx @sandrinio/vdoc install ${vdocPlatform}`);
|
|
226
|
+
}
|
|
227
|
+
}
|
|
228
|
+
|
|
199
229
|
console.log('\nโ
V-Bounce OS successfully installed! Welcome to the team.\n');
|
|
200
230
|
});
|
package/brains/AGENTS.md
CHANGED
|
@@ -20,6 +20,7 @@ Skills are in the `skills/` directory. Each skill has a `SKILL.md` with instruct
|
|
|
20
20
|
| `skills/react-best-practices/` | Frontend coding patterns and anti-patterns | Developer |
|
|
21
21
|
| `skills/vibe-code-review/` | Code quality review (4 modes) | QA, Architect |
|
|
22
22
|
| `skills/write-skill/` | Creating and refining agent skills | Team Lead |
|
|
23
|
+
| `skills/improve/` | Framework self-improvement from agent feedback | Team Lead |
|
|
23
24
|
|
|
24
25
|
## The V-Bounce Process
|
|
25
26
|
|
|
@@ -32,9 +33,12 @@ Before starting any sprint, the Team Lead MUST:
|
|
|
32
33
|
- **Triage the Request**: Is this an L1 Trivial change (1-2 files, cosmetic/minor)?
|
|
33
34
|
- If YES โ Use the **Hotfix Path** (create a Hotfix document, bypass Epic/Story).
|
|
34
35
|
- If NO โ Use the **Standard Path** (create/find Epic, Story).
|
|
36
|
+
- **Determine Execution Mode**: Full Bounce vs Fast Track.
|
|
37
|
+
- **Dependency Check**: Stories with `Depends On:` must execute sequentially.
|
|
35
38
|
- Read RISK_REGISTRY.md โ flag high-severity risks that affect planned stories.
|
|
36
|
-
- Read
|
|
37
|
-
- If
|
|
39
|
+
- Read `sprint-{XX}.md` ยง2 Sprint Open Questions โ do not bounce stories with unresolved blocking questions.
|
|
40
|
+
- If `vdocs/_manifest.json` exists, read it.
|
|
41
|
+
- **Strategic Freeze**: Charter/Roadmap frozen during sprints. Use **Impact Analysis Protocol** if emergency changes occur. Evaluate active stories against new strategy. Pause until human approval.
|
|
38
42
|
|
|
39
43
|
### Phase 2: The Bounce (Implementation)
|
|
40
44
|
**Standard Path (L2-L4 Stories):**
|
|
@@ -57,7 +61,7 @@ Before starting any sprint, the Team Lead MUST:
|
|
|
57
61
|
|
|
58
62
|
### Phase 3: Review
|
|
59
63
|
Sprint Report โ Human review โ Delivery Plan updated โ Lessons recorded โ Next sprint.
|
|
60
|
-
If sprint delivered new features or Dev reports flagged stale product docs โ spawn Scribe agent to generate/update
|
|
64
|
+
If sprint delivered new features or Dev reports flagged stale product docs โ spawn Scribe agent to generate/update vdocs/ via vdoc.
|
|
61
65
|
|
|
62
66
|
## Story States
|
|
63
67
|
|
|
@@ -83,7 +87,8 @@ Bouncing โ Escalated (3+ failures)
|
|
|
83
87
|
### During Implementation
|
|
84
88
|
4. Follow the Safe Zone. No new patterns or libraries without Architect approval.
|
|
85
89
|
5. No Gold-Plating. Implement exactly what the Story specifies.
|
|
86
|
-
6. Self-
|
|
90
|
+
6. Write Self-Documenting Code. JSDoc/docstrings required on all exports to prevent RAG poisoning.
|
|
91
|
+
7. Self-assess Correction Tax. Track % human intervention.
|
|
87
92
|
|
|
88
93
|
### After Implementation
|
|
89
94
|
7. Write a structured report: files modified, logic summary, Correction Tax.
|
|
@@ -109,18 +114,19 @@ V-Bounce OS/
|
|
|
109
114
|
|
|
110
115
|
## Document Locations
|
|
111
116
|
|
|
112
|
-
Planning docs live in `product_plans/`.
|
|
117
|
+
Planning docs live in `product_plans/`. It uses a state-based architecture (`strategy/`, `backlog/`, `sprints/`, `archive/`). Completed items are archived to `product_plans/archive/`.
|
|
113
118
|
|
|
114
119
|
| Document | Output |
|
|
115
120
|
|----------|--------|
|
|
116
|
-
| Charter | `product_plans/{project}_charter.md` |
|
|
117
|
-
| Roadmap | `product_plans/{project}_roadmap.md` |
|
|
118
|
-
| Risk Registry | `product_plans/RISK_REGISTRY.md` |
|
|
119
|
-
| Delivery Plan | `product_plans/{delivery}
|
|
120
|
-
|
|
|
121
|
-
|
|
|
122
|
-
|
|
|
123
|
-
|
|
|
121
|
+
| Charter | `product_plans/strategy/{project}_charter.md` |
|
|
122
|
+
| Roadmap | `product_plans/strategy/{project}_roadmap.md` |
|
|
123
|
+
| Risk Registry | `product_plans/strategy/RISK_REGISTRY.md` |
|
|
124
|
+
| Delivery Plan | `product_plans/strategy/{delivery}_delivery_plan.md` |
|
|
125
|
+
| Sprint Plan | `product_plans/sprints/sprint-{XX}/sprint-{XX}.md` |
|
|
126
|
+
| Epic | `product_plans/backlog/EPIC-{NNN}_{name}/EPIC-{NNN}.md` |
|
|
127
|
+
| Story | `product_plans/backlog/EPIC-{NNN}_{name}/STORY-{EpicID}-{StoryID}-{StoryName}.md` |
|
|
128
|
+
| Sprint Report | `product_plans/sprints/sprint-{XX}/sprint-report.md` |
|
|
129
|
+
| Product Docs | `vdocs/*.md` + `_manifest.json` |
|
|
124
130
|
|
|
125
131
|
## Report Formats
|
|
126
132
|
|
package/brains/CHANGELOG.md
CHANGED
|
@@ -5,3 +5,27 @@ Per **Rule 13: Framework Integrity**, anytime an entry is made here, the orchest
|
|
|
5
5
|
|
|
6
6
|
## [2026-03-02]
|
|
7
7
|
- **Initialized**: Created strict Framework Integrity tracking, YAML context handoffs, and RAG validation pipeline.
|
|
8
|
+
|
|
9
|
+
## [2026-03-06]
|
|
10
|
+
- **Fixed**: All brain files (`CLAUDE.md`, `GEMINI.md`, `AGENTS.md`) incorrectly referenced `DELIVERY_PLAN.md ยง5 Open Questions` or `ACTIVE_SPRINT.md ยง3 Open Questions`. Corrected to `sprint-{XX}.md ยง2 Sprint Open Questions` to match the authoritative `agent-team/SKILL.md` and `sprint.md` template.
|
|
11
|
+
- **Fixed**: Removed duplicate "Product Plans Folder Structure" header in `doc-manager/SKILL.md`.
|
|
12
|
+
- **Fixed**: `cursor-rules/vbounce-process.mdc` was missing Execution Mode, Sequential Dependencies, Impact Analysis Protocol, and Strategic Freeze rules from the 2026-03-05 update. Propagated.
|
|
13
|
+
- **Removed**: `templates/active_sprint.md` โ orphaned by the state-based refactor. Superseded by `templates/sprint.md`.
|
|
14
|
+
- **Modified**: `cursor-rules/vbounce-rules.mdc` โ added Rule 6 (JSDoc/docstrings), Rule 13 (YAML Frontmatter), Rule 14 (Framework Integrity) to match other brains.
|
|
15
|
+
- **Modified**: `cursor-rules/vbounce-docs.mdc` โ added Hotfix and Sprint Report entries to Document Locations table.
|
|
16
|
+
- **Modified**: `cursor-rules/vbounce-process.mdc` โ added `pre_bounce_sync.sh` and `validate_report.mjs` steps to Phase 2.
|
|
17
|
+
- **Modified**: Renamed `product_documentation/` โ `vdocs/` across all brains, skills, agents, templates, scripts, diagrams, README, OVERVIEW, and SETUP to align with `@sandrinio/vdoc` output conventions.
|
|
18
|
+
- **Modified**: `bin/vbounce.mjs` โ added optional vdoc installation step that auto-maps the user's chosen platform to the corresponding `npx @sandrinio/vdoc install <platform>` command.
|
|
19
|
+
- **Modified**: `brains/SETUP.md` โ updated folder structure diagram to reflect state-based `product_plans/` layout.
|
|
20
|
+
- **Added**: `skills/improve/SKILL.md` โ framework self-improvement skill. Reads agent Process Feedback from sprint retros, identifies patterns, proposes changes to templates/skills/brains/scripts with human approval.
|
|
21
|
+
- **Modified**: All agent report templates (`developer.md`, `qa.md`, `architect.md`, `devops.md`, `scribe.md`) โ added `## Process Feedback` section for framework friction signals.
|
|
22
|
+
- **Modified**: `templates/sprint_report.md` ยง5 Retrospective โ restructured into categorized Framework Self-Assessment (Templates, Handoffs, RAG, Skills, Process Flow, Tooling) with severity and suggested fixes.
|
|
23
|
+
- **Modified**: `skills/agent-team/SKILL.md` Step 7 โ added Framework Self-Assessment aggregation and `improve` skill trigger.
|
|
24
|
+
- **Modified**: All brain files and `README.md` โ added `improve` skill to skill references.
|
|
25
|
+
|
|
26
|
+
## [2026-03-05]
|
|
27
|
+
- **Modified**: Added `tokens_used` tracking to all agent instructions (`brains/claude-agents/*`).
|
|
28
|
+
- **Modified**: Updated `skills/agent-team/SKILL.md` to consolidate tokens into `sprint_report.md`.
|
|
29
|
+
- **Modified**: Updated `scripts/validate_report.mjs` to enforce `tokens_used` schema presence.
|
|
30
|
+
- **Modified**: Refactored `STORY-{EpicID}-{StoryID}` file naming convention to `STORY-{EpicID}-{StoryID}-{StoryName}` across all templates, agent instructions, skill definitions, and architecture files for better human readability.
|
|
31
|
+
- **Modified**: Refactored the generic `product_plans` folder into a state-based architecture (`strategy/`, `backlog/`, `sprints/`, `hotfixes/`, `archive/`). Separated Sprint tracking logic from `DELIVERY_PLAN.md` into a new `sprint.md` template. Updated `doc-manager` and `agent-team` orchestration to adhere to these physical transition rules.
|
package/brains/CLAUDE.md
CHANGED
|
@@ -16,6 +16,7 @@ You MUST follow the V-Bounce process. Deviating from it โ skipping validation,
|
|
|
16
16
|
@skills/react-best-practices/SKILL.md
|
|
17
17
|
@skills/vibe-code-review/SKILL.md
|
|
18
18
|
@skills/write-skill/SKILL.md
|
|
19
|
+
@skills/improve/SKILL.md
|
|
19
20
|
|
|
20
21
|
## Subagents
|
|
21
22
|
|
|
@@ -44,9 +45,14 @@ Before starting any sprint, the Team Lead MUST:
|
|
|
44
45
|
- **Triage the Request**: Is this an L1 Trivial change (1-2 files, cosmetic/minor)?
|
|
45
46
|
- If YES โ Use the **Hotfix Path** (create a Hotfix document, bypass Epic/Story).
|
|
46
47
|
- If NO โ Use the **Standard Path** (create/find Epic, Story).
|
|
48
|
+
- **Determine Execution Mode**:
|
|
49
|
+
- Full Bounce (Default): dev โ qa โ arch โ devops.
|
|
50
|
+
- Fast Track (L1/L2 Minor): dev โ devops only (skip QA/Arch gates).
|
|
51
|
+
- **Dependency Check**: Stories with `Depends On:` must execute sequentially. Wait for DevOps merge of Story A before starting Story B.
|
|
47
52
|
- Read RISK_REGISTRY.md โ flag high-severity risks that affect planned stories.
|
|
48
|
-
- Read
|
|
49
|
-
- If `
|
|
53
|
+
- Read `sprint-{XX}.md` ยง2 Sprint Open Questions โ do not bounce stories with unresolved blocking questions.
|
|
54
|
+
- If `vdocs/_manifest.json` exists, read it.
|
|
55
|
+
- **Strategic Freeze**: Charter and Roadmap are frozen during sprints. If emergency changes are needed, run the **Impact Analysis Protocol**: Evaluate sprint stories against new strategy. Pause work until human approval.
|
|
50
56
|
|
|
51
57
|
### Phase 2: The Bounce (Implementation)
|
|
52
58
|
**Standard Path (L2-L4 Stories):**
|
|
@@ -69,7 +75,7 @@ Before starting any sprint, the Team Lead MUST:
|
|
|
69
75
|
|
|
70
76
|
### Phase 3: Review
|
|
71
77
|
Sprint Report โ Human review โ Delivery Plan updated โ Lessons recorded โ Next sprint.
|
|
72
|
-
If sprint delivered new features or Developer reports flagged stale product docs โ spawn Scribe agent to generate/update
|
|
78
|
+
If sprint delivered new features or Developer reports flagged stale product docs โ spawn Scribe agent to generate/update vdocs/ via vdoc.
|
|
73
79
|
|
|
74
80
|
## Story States
|
|
75
81
|
|
|
@@ -97,7 +103,8 @@ Draft โ Refinement โ Ready to Bounce โ Bouncing โ QA Passed โ Architec
|
|
|
97
103
|
### During Implementation
|
|
98
104
|
4. **Follow the Safe Zone**. No new patterns or libraries without Architect approval.
|
|
99
105
|
5. **No Gold-Plating**. Implement exactly what the Story specifies.
|
|
100
|
-
6. **Self-
|
|
106
|
+
6. **Write Self-Documenting Code**. All exports MUST have JSDoc/docstrings to prevent RAG poisoning for future agents.
|
|
107
|
+
7. **Self-assess Correction Tax**. Track % human intervention.
|
|
101
108
|
|
|
102
109
|
### After Implementation
|
|
103
110
|
7. **Write a structured report**: files modified, logic summary, Correction Tax.
|
|
@@ -123,19 +130,20 @@ V-Bounce OS/
|
|
|
123
130
|
|
|
124
131
|
## Document Locations
|
|
125
132
|
|
|
126
|
-
All planning documents live in `product_plans
|
|
133
|
+
All planning documents live in `product_plans/`, separated by state (`strategy/`, `backlog/`, `sprints/`, `archive/`).
|
|
127
134
|
|
|
128
135
|
| Document | Template | Output |
|
|
129
136
|
|----------|----------|--------|
|
|
130
|
-
| Charter | `templates/charter.md` | `product_plans/{project}_charter.md` |
|
|
131
|
-
| Roadmap | `templates/roadmap.md` | `product_plans/{project}_roadmap.md` |
|
|
132
|
-
| Risk Registry | `templates/risk_registry.md` | `product_plans/RISK_REGISTRY.md` |
|
|
133
|
-
| Delivery Plan | `templates/delivery_plan.md` | `product_plans/{delivery}
|
|
134
|
-
|
|
|
135
|
-
|
|
|
136
|
-
|
|
|
137
|
-
|
|
|
138
|
-
|
|
|
137
|
+
| Charter | `templates/charter.md` | `product_plans/strategy/{project}_charter.md` |
|
|
138
|
+
| Roadmap | `templates/roadmap.md` | `product_plans/strategy/{project}_roadmap.md` |
|
|
139
|
+
| Risk Registry | `templates/risk_registry.md` | `product_plans/strategy/RISK_REGISTRY.md` |
|
|
140
|
+
| Delivery Plan | `templates/delivery_plan.md` | `product_plans/strategy/{delivery}_delivery_plan.md` |
|
|
141
|
+
| Sprint Plan | `templates/sprint.md` | `product_plans/sprints/sprint-{XX}/sprint-{XX}.md` |
|
|
142
|
+
| Epic | `templates/epic.md` | `product_plans/backlog/EPIC-{NNN}_{name}/EPIC-{NNN}.md` |
|
|
143
|
+
| Story | `templates/story.md` | `product_plans/backlog/EPIC-{NNN}_{name}/STORY-{EpicID}-{StoryID}-{StoryName}.md` |
|
|
144
|
+
| Sprint Report | `templates/sprint_report.md` | `product_plans/sprints/sprint-{XX}/sprint-report.md` |
|
|
145
|
+
| Product Docs | (generated by vdoc) | `vdocs/*.md` |
|
|
146
|
+
| Doc Manifest | (generated by vdoc) | `vdocs/_manifest.json` |
|
|
139
147
|
|
|
140
148
|
Completed deliveries are archived to `product_plans/archive/` and logged in Roadmap ยง7 Delivery Log.
|
|
141
149
|
|
package/brains/GEMINI.md
CHANGED
|
@@ -23,6 +23,7 @@ For Antigravity: copy skills to `.agents/skills/` for workspace-scoped discovery
|
|
|
23
23
|
| `skills/react-best-practices/` | Frontend coding patterns and anti-patterns | Developer |
|
|
24
24
|
| `skills/vibe-code-review/` | Code quality review (4 modes) | QA, Architect |
|
|
25
25
|
| `skills/write-skill/` | Creating and refining agent skills | Team Lead |
|
|
26
|
+
| `skills/improve/` | Framework self-improvement from agent feedback | Team Lead |
|
|
26
27
|
|
|
27
28
|
## The V-Bounce Process
|
|
28
29
|
|
|
@@ -35,9 +36,14 @@ Before starting any sprint, the Team Lead MUST:
|
|
|
35
36
|
- **Triage the Request**: Is this an L1 Trivial change (1-2 files, cosmetic/minor)?
|
|
36
37
|
- If YES โ Use the **Hotfix Path** (create a Hotfix document, bypass Epic/Story).
|
|
37
38
|
- If NO โ Use the **Standard Path** (create/find Epic, Story).
|
|
39
|
+
- **Determine Execution Mode**:
|
|
40
|
+
- Full Bounce (Default): dev โ qa โ arch โ devops.
|
|
41
|
+
- Fast Track (L1/L2 Minor): dev โ devops only (skip QA/Arch gates).
|
|
42
|
+
- **Dependency Check**: Stories with `Depends On:` must execute sequentially. Wait for DevOps merge of Story A before starting Story B.
|
|
38
43
|
- Read RISK_REGISTRY.md โ flag high-severity risks that affect planned stories.
|
|
39
|
-
- Read
|
|
40
|
-
- If `
|
|
44
|
+
- Read `sprint-{XX}.md` ยง2 Sprint Open Questions โ do not bounce stories with unresolved blocking questions.
|
|
45
|
+
- If `vdocs/_manifest.json` exists, read it.
|
|
46
|
+
- **Strategic Freeze**: Charter and Roadmap are frozen during sprints. If emergency changes are needed, run the **Impact Analysis Protocol**: Evaluate sprint stories against new strategy. Pause work until human approval.
|
|
41
47
|
|
|
42
48
|
### Phase 2: The Bounce (Implementation)
|
|
43
49
|
**Standard Path (L2-L4 Stories):**
|
|
@@ -60,7 +66,7 @@ Before starting any sprint, the Team Lead MUST:
|
|
|
60
66
|
|
|
61
67
|
### Phase 3: Review
|
|
62
68
|
Sprint Report โ Human review โ Delivery Plan updated โ Lessons recorded โ Next sprint.
|
|
63
|
-
If sprint delivered new features or Dev reports flagged stale product docs โ spawn Scribe agent to generate/update
|
|
69
|
+
If sprint delivered new features or Dev reports flagged stale product docs โ spawn Scribe agent to generate/update vdocs/ via vdoc.
|
|
64
70
|
|
|
65
71
|
## Story States
|
|
66
72
|
|
|
@@ -88,7 +94,8 @@ Draft โ Refinement โ Ready to Bounce โ Bouncing โ QA Passed โ Architec
|
|
|
88
94
|
### During Implementation
|
|
89
95
|
4. **Follow the Safe Zone**. No new patterns or libraries without Architect approval.
|
|
90
96
|
5. **No Gold-Plating**. Implement exactly what the Story specifies.
|
|
91
|
-
6. **Self-
|
|
97
|
+
6. **Write Self-Documenting Code**. All exports MUST have JSDoc/docstrings to prevent RAG poisoning for future agents.
|
|
98
|
+
7. **Self-assess Correction Tax**. Track % human intervention.
|
|
92
99
|
|
|
93
100
|
### After Implementation
|
|
94
101
|
7. **Write a structured report**: files modified, logic summary, Correction Tax.
|
|
@@ -114,18 +121,19 @@ V-Bounce OS/
|
|
|
114
121
|
|
|
115
122
|
## Document Locations
|
|
116
123
|
|
|
117
|
-
Planning docs live in `product_plans/`.
|
|
124
|
+
Planning docs live in `product_plans/`. It uses a state-based architecture (`strategy/`, `backlog/`, `sprints/`, `archive/`). Completed items are archived to `product_plans/archive/`.
|
|
118
125
|
|
|
119
126
|
| Document | Output |
|
|
120
127
|
|----------|--------|
|
|
121
|
-
| Charter | `product_plans/{project}_charter.md` |
|
|
122
|
-
| Roadmap | `product_plans/{project}_roadmap.md` |
|
|
123
|
-
| Risk Registry | `product_plans/RISK_REGISTRY.md` |
|
|
124
|
-
| Delivery Plan | `product_plans/{delivery}
|
|
125
|
-
|
|
|
126
|
-
|
|
|
127
|
-
|
|
|
128
|
-
|
|
|
128
|
+
| Charter | `product_plans/strategy/{project}_charter.md` |
|
|
129
|
+
| Roadmap | `product_plans/strategy/{project}_roadmap.md` |
|
|
130
|
+
| Risk Registry | `product_plans/strategy/RISK_REGISTRY.md` |
|
|
131
|
+
| Delivery Plan | `product_plans/strategy/{delivery}_delivery_plan.md` |
|
|
132
|
+
| Sprint Plan | `product_plans/sprints/sprint-{XX}/sprint-{XX}.md` |
|
|
133
|
+
| Epic | `product_plans/backlog/EPIC-{NNN}_{name}/EPIC-{NNN}.md` |
|
|
134
|
+
| Story | `product_plans/backlog/EPIC-{NNN}_{name}/STORY-{EpicID}-{StoryID}-{StoryName}.md` |
|
|
135
|
+
| Sprint Report | `product_plans/sprints/sprint-{XX}/sprint-report.md` |
|
|
136
|
+
| Product Docs | `vdocs/*.md` + `_manifest.json` |
|
|
129
137
|
|
|
130
138
|
## Report Formats
|
|
131
139
|
|
package/brains/SETUP.md
CHANGED
|
@@ -143,16 +143,13 @@ your-project/
|
|
|
143
143
|
โ โโโ react-best-practices/
|
|
144
144
|
โ โโโ write-skill/
|
|
145
145
|
โโโ templates/ โ document templates
|
|
146
|
-
โโโ product_plans/ โ planning documents
|
|
147
|
-
โ โโโ
|
|
148
|
-
โ โโโ
|
|
149
|
-
โ โโโ
|
|
150
|
-
โ
|
|
151
|
-
โ
|
|
152
|
-
|
|
153
|
-
โ โโโ EPIC-001.md
|
|
154
|
-
โ โโโ STORY-001-01.md
|
|
155
|
-
โโโ product_documentation/ โ generated by Scribe (post-sprint)
|
|
146
|
+
โโโ product_plans/ โ planning documents (state-based)
|
|
147
|
+
โ โโโ strategy/ โ charter, roadmap, risk registry, delivery plan
|
|
148
|
+
โ โโโ backlog/ โ epics and unassigned stories
|
|
149
|
+
โ โโโ sprints/ โ active sprint execution workspace
|
|
150
|
+
โ โโโ hotfixes/ โ L1 emergency tasks
|
|
151
|
+
โ โโโ archive/ โ completed sprints and epics
|
|
152
|
+
โโโ vdocs/ โ generated by Scribe (post-sprint)
|
|
156
153
|
โโโ .bounce/ โ reports & sprint archives (archive/ is committed)
|
|
157
154
|
โ โโโ reports/ โ active reports (gitignored)
|
|
158
155
|
โ โโโ archive/ โ completed sprint history (committed to git)
|
|
@@ -15,7 +15,7 @@ Audit the codebase for structural integrity, standards compliance, and long-term
|
|
|
15
15
|
## Before Auditing
|
|
16
16
|
|
|
17
17
|
1. **Query Project Lessons**: Run `./scripts/vbounce_ask.mjs "architectural constraints and historical mistakes for <story summary>"` to retrieve relevant context from `LESSONS.md` and past reports.
|
|
18
|
-
2. **Read all reports** for this story (`.bounce/reports/STORY-{ID}-*.md`) โ Dev Report, QA Report.
|
|
18
|
+
2. **Read all reports** for this story (`.bounce/reports/STORY-{ID}-{StoryName}-*.md`) โ Dev Report, QA Report.
|
|
19
19
|
3. **Read the full Story spec** โ especially ยง3 Implementation Guide and ยง3.1 ADR References.
|
|
20
20
|
4. **Read Roadmap ยง3 ADRs** โ every architecture decision the implementation must comply with.
|
|
21
21
|
|
|
@@ -63,21 +63,30 @@ Check that the changes don't break existing functionality:
|
|
|
63
63
|
- Check for modified shared utilities, types, or config
|
|
64
64
|
- Verify imports and exports haven't broken dependency chains
|
|
65
65
|
|
|
66
|
+
### Documentation Verification (RAG Hygiene)
|
|
67
|
+
Check that the codebase remains self-documenting for downstream RAG consumption:
|
|
68
|
+
- Does the implementation match the existing `vdocs/_manifest.json` (if one exists)?
|
|
69
|
+
- If it diverges entirely, you MUST fail the audit and instruct the Developer to update their report's Documentation Delta.
|
|
70
|
+
- Are exported functions, components, and schemas adequately JSDoc commented? Code must explain the *why*.
|
|
71
|
+
|
|
66
72
|
## Your Output
|
|
67
73
|
|
|
68
|
-
Write an **Architectural Audit Report** to `.bounce/reports/STORY-{ID}-arch.md`.
|
|
74
|
+
Write an **Architectural Audit Report** to `.bounce/reports/STORY-{ID}-{StoryName}-arch.md`.
|
|
69
75
|
You MUST include the YAML frontmatter block exactly as shown below:
|
|
70
76
|
|
|
77
|
+
**Token Tracking**: Before generating this report, retrieve your session's token usage (if you are Claude, ask your CLI; if Gemini, read your context estimate; if Codex, read your log output) and populate `tokens_used`.
|
|
78
|
+
|
|
71
79
|
### If Audit PASSES:
|
|
72
80
|
```markdown
|
|
73
81
|
---
|
|
74
82
|
status: "PASS"
|
|
75
83
|
safe_zone_score: {SCORE}
|
|
84
|
+
tokens_used: {number}
|
|
76
85
|
ai_isms_detected: {count}
|
|
77
86
|
regression_risk: "{Low/Medium/High}"
|
|
78
87
|
---
|
|
79
88
|
|
|
80
|
-
# Architectural Audit Report: STORY-{ID} โ PASS
|
|
89
|
+
# Architectural Audit Report: STORY-{ID}-{StoryName} โ PASS
|
|
81
90
|
|
|
82
91
|
## Safe Zone Compliance: {SCORE}/10
|
|
83
92
|
|
|
@@ -110,6 +119,12 @@ regression_risk: "{Low/Medium/High}"
|
|
|
110
119
|
## Lessons for Future Prompts
|
|
111
120
|
- {What should we tell the Dev Agent differently next time?}
|
|
112
121
|
|
|
122
|
+
## Process Feedback
|
|
123
|
+
> Optional. Note friction with the V-Bounce framework itself โ templates, handoffs, RAG quality, skills.
|
|
124
|
+
|
|
125
|
+
- {e.g., "vibe-code-review Deep Audit checklist missing a dimension for accessibility"}
|
|
126
|
+
- {e.g., "None"}
|
|
127
|
+
|
|
113
128
|
## Recommendation
|
|
114
129
|
PASS โ Ready for Sprint Review.
|
|
115
130
|
```
|
|
@@ -119,10 +134,11 @@ PASS โ Ready for Sprint Review.
|
|
|
119
134
|
---
|
|
120
135
|
status: "FAIL"
|
|
121
136
|
bounce_count: {N}
|
|
137
|
+
tokens_used: {number}
|
|
122
138
|
critical_failures: {count}
|
|
123
139
|
---
|
|
124
140
|
|
|
125
|
-
# Architectural Audit Report: STORY-{ID} โ FAIL
|
|
141
|
+
# Architectural Audit Report: STORY-{ID}-{StoryName} โ FAIL
|
|
126
142
|
|
|
127
143
|
## Critical Failures
|
|
128
144
|
### Issue 1: {Short description}
|
|
@@ -132,6 +148,12 @@ critical_failures: {count}
|
|
|
132
148
|
- **What's wrong (plain language)**: {Non-coder analogy}
|
|
133
149
|
- **Fix required**: {What the Dev needs to change}
|
|
134
150
|
|
|
151
|
+
## Process Feedback
|
|
152
|
+
> Optional. Note friction with the V-Bounce framework itself โ templates, handoffs, RAG quality, skills.
|
|
153
|
+
|
|
154
|
+
- {e.g., "Trend Check had no baseline โ first sprint, but the template still requires comparison"}
|
|
155
|
+
- {e.g., "None"}
|
|
156
|
+
|
|
135
157
|
## Recommendation
|
|
136
158
|
FAIL โ Returning to Developer. Architect bounce count: {N}.
|
|
137
159
|
```
|
|
@@ -146,10 +168,10 @@ When the Team Lead asks for a **Sprint Integration Audit** (after all stories pa
|
|
|
146
168
|
|
|
147
169
|
## Checkpointing
|
|
148
170
|
|
|
149
|
-
After completing each major phase of your audit (e.g., Deep Audit done, Trend Check done, ADR compliance checked), write a progress checkpoint to `.bounce/reports/STORY-{ID}-arch-checkpoint.md`:
|
|
171
|
+
After completing each major phase of your audit (e.g., Deep Audit done, Trend Check done, ADR compliance checked), write a progress checkpoint to `.bounce/reports/STORY-{ID}-{StoryName}-arch-checkpoint.md`:
|
|
150
172
|
|
|
151
173
|
```markdown
|
|
152
|
-
# Architect Checkpoint: STORY-{ID}
|
|
174
|
+
# Architect Checkpoint: STORY-{ID}-{StoryName}
|
|
153
175
|
## Completed
|
|
154
176
|
- {Which audit phases are done}
|
|
155
177
|
## Remaining
|
|
@@ -17,7 +17,7 @@ Implement features and fix bugs as specified in Story documents. You write code
|
|
|
17
17
|
3. **Read the Story spec** โ ยง1 The Spec for requirements, ยง3 Implementation Guide for technical approach.
|
|
18
18
|
3. **Check ADR references** in ยง3.1 โ comply with all architecture decisions from the Roadmap.
|
|
19
19
|
4. **Read relevant react-best-practices rules** โ consult `skills/react-best-practices/` for patterns matching your task.
|
|
20
|
-
5. **Check product documentation** โ if the task file references product docs from `
|
|
20
|
+
5. **Check product documentation** โ if the task file references product docs from `vdocs/`, read them. Understand how the existing feature works before changing adjacent code. If your implementation changes behavior described in a product doc, flag it in your report.
|
|
21
21
|
|
|
22
22
|
## During Implementation
|
|
23
23
|
|
|
@@ -27,32 +27,36 @@ Implement features and fix bugs as specified in Story documents. You write code
|
|
|
27
27
|
3. **Refactor:** Clean up the code for readability and architecture without breaking the tests.
|
|
28
28
|
|
|
29
29
|
- **Follow the Safe Zone.** Do not introduce new patterns, libraries, or architectural changes.
|
|
30
|
+
- **Write Self-Documenting Code.** To prevent RAG poisoning downstream, you MUST write clear JSDoc/docstrings for all exported functions, components, schemas, and routing logic. Explain the *why*, not just the *what*. If you fail to document your code, the Scribe agent cannot generate an accurate `_manifest.json` for future sprints.
|
|
30
31
|
- **No Gold-Plating.** Implement exactly what the Story specifies. Extra features are defects, not bonuses.
|
|
31
32
|
- **Track your Correction Tax.** Note every point where you needed human intervention or made a wrong turn.
|
|
32
33
|
|
|
33
34
|
## If You Discover the Spec is Wrong
|
|
34
35
|
|
|
35
36
|
Do NOT proceed with a broken spec. Instead:
|
|
36
|
-
- Write a **Spec Conflict Report** to `.bounce/reports/STORY-{ID}-conflict.md`
|
|
37
|
+
- Write a **Spec Conflict Report** to `.bounce/reports/STORY-{ID}-{StoryName}-conflict.md`
|
|
37
38
|
- Describe exactly what's wrong (missing API, changed schema, contradictory requirements)
|
|
38
39
|
- Stop implementation and wait for the Lead to resolve
|
|
39
40
|
|
|
40
41
|
## Your Output
|
|
41
42
|
|
|
42
|
-
Write a **Developer Implementation Report** to `.bounce/reports/STORY-{ID}-dev.md`.
|
|
43
|
+
Write a **Developer Implementation Report** to `.bounce/reports/STORY-{ID}-{StoryName}-dev.md`.
|
|
43
44
|
You MUST include the YAML frontmatter block exactly as shown below:
|
|
44
45
|
|
|
45
46
|
```markdown
|
|
46
47
|
---
|
|
47
48
|
status: "implemented"
|
|
48
49
|
correction_tax: {X}
|
|
50
|
+
tokens_used: {number}
|
|
49
51
|
tests_written: {number of tests generated}
|
|
50
52
|
files_modified:
|
|
51
53
|
- "path/to/file.ts"
|
|
52
54
|
lessons_flagged: {number of lessons}
|
|
53
55
|
---
|
|
54
56
|
|
|
55
|
-
# Developer Implementation Report: STORY-{ID}
|
|
57
|
+
# Developer Implementation Report: STORY-{ID}-{StoryName}
|
|
58
|
+
|
|
59
|
+
**Token Tracking**: Before generating this report, retrieve your session's token usage (if you are Claude, ask your CLI; if Gemini, read your context estimate; if Codex, read your log output) and populate `tokens_used`.
|
|
56
60
|
|
|
57
61
|
## Files Modified
|
|
58
62
|
- `path/to/file.ts` โ {what changed and why}
|
|
@@ -68,22 +72,31 @@ lessons_flagged: {number of lessons}
|
|
|
68
72
|
- {Any gotchas, non-obvious behaviors, or multi-attempt fixes worth recording}
|
|
69
73
|
|
|
70
74
|
## Product Docs Affected
|
|
71
|
-
- {List any
|
|
75
|
+
- {List any vdocs/ docs whose described behavior changed due to this implementation. "None" if no docs affected.}
|
|
72
76
|
|
|
73
77
|
## Status
|
|
74
78
|
- [ ] Code compiles without errors
|
|
75
79
|
- [ ] Automated tests were written FIRST (Red) and now pass (Green)
|
|
76
80
|
- [ ] LESSONS.md was read before implementation
|
|
77
81
|
- [ ] ADRs from Roadmap ยง3 were followed
|
|
82
|
+
- [ ] Code is self-documenting (JSDoc/docstrings added to all exports to prevent RAG poisoning)
|
|
78
83
|
- [ ] No new patterns or libraries introduced
|
|
84
|
+
|
|
85
|
+
## Process Feedback
|
|
86
|
+
> Optional. Note friction with the V-Bounce framework itself โ templates, handoffs, RAG quality, tooling.
|
|
87
|
+
> These are about the *process*, not the *code*. Aggregated into Sprint Retro for framework improvement.
|
|
88
|
+
|
|
89
|
+
- {e.g., "Story template ยง3 didn't mention which existing modules to reuse โ had to search manually"}
|
|
90
|
+
- {e.g., "RAG query for 'auth constraints' returned irrelevant results from an old sprint"}
|
|
91
|
+
- {e.g., "None"}
|
|
79
92
|
```
|
|
80
93
|
|
|
81
94
|
## Checkpointing
|
|
82
95
|
|
|
83
|
-
After completing each major phase of your work (e.g., initial implementation done, tests written, bug fixes applied), write a progress checkpoint to `.bounce/reports/STORY-{ID}-dev-checkpoint.md`:
|
|
96
|
+
After completing each major phase of your work (e.g., initial implementation done, tests written, bug fixes applied), write a progress checkpoint to `.bounce/reports/STORY-{ID}-{StoryName}-dev-checkpoint.md`:
|
|
84
97
|
|
|
85
98
|
```markdown
|
|
86
|
-
# Developer Checkpoint: STORY-{ID}
|
|
99
|
+
# Developer Checkpoint: STORY-{ID}-{StoryName}
|
|
87
100
|
## Completed
|
|
88
101
|
- {What's done so far}
|
|
89
102
|
## Remaining
|