Skip to content

Commit d76bcb5

Browse files
authored
chore: cleaned up bad architecture file calls, legacy doc references, and case sensitivity issues to remove ambiguity (#718)
1 parent 5977227 commit d76bcb5

18 files changed

Lines changed: 59 additions & 80 deletions

File tree

src/modules/bmm/_module-installer/assets/technical-decisions-template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ _Auto-updated during discovery and planning sessions - you can also add informat
44

55
## Purpose
66

7-
This document captures technical decisions, preferences, and constraints discovered during project discussions. It serves as input for architecture.md and solution design documents.
7+
This document captures technical decisions, preferences, and constraints discovered during project discussions. It serves as input for solution-architecture.md and solution design documents.
88

99
## Confirmed Decisions
1010

@@ -26,5 +26,5 @@ This document captures technical decisions, preferences, and constraints discove
2626

2727
- This file is automatically updated when technical information is mentioned
2828
- Decisions here are inputs, not final architecture
29-
- Final technical decisions belong in architecture.md
29+
- Final technical decisions belong in solution-architecture.md
3030
- Implementation details belong in solutions/\*.md and story context or dev notes.

src/modules/bmm/agents/dev.agent.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ agent:
1010

1111
persona:
1212
role: Senior Implementation Engineer
13-
identity: Executes approved stories with strict adherence to acceptance criteria, using the Story Context JSON and existing code to minimize rework and hallucinations.
13+
identity: Executes approved stories with strict adherence to acceptance criteria, using the Story Context XML and existing code to minimize rework and hallucinations.
1414
communication_style: Succinct, checklist-driven, cites paths and AC IDs; asks only when inputs are missing or ambiguous.
1515
principles:
16-
- I treat the Story Context JSON as the single source of truth, trusting it over any training priors while refusing to invent solutions when information is missing.
16+
- I treat the Story Context XML as the single source of truth, trusting it over any training priors while refusing to invent solutions when information is missing.
1717
- My implementation philosophy prioritizes reusing existing interfaces and artifacts over rebuilding from scratch, ensuring every change maps directly to specific acceptance criteria and tasks.
1818
- I operate strictly within a human-in-the-loop workflow, only proceeding when stories bear explicit approval, maintaining traceability and preventing scope drift through disciplined adherence to defined requirements.
1919

src/modules/bmm/agents/sm.agent.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ agent:
1818
- I never cross into implementation territory, focusing entirely on creating developer-ready specifications that eliminate ambiguity and enable efficient sprint execution.
1919

2020
critical_actions:
21-
- "When running *create-story, run non-interactively: use HLA, PRD, Tech Spec, and epics to generate a complete draft without elicitation."
21+
- "When running *create-story, run non-interactively: use solution-architecture, PRD, Tech Spec, and epics to generate a complete draft without elicitation."
2222

2323
menu:
2424
- trigger: correct-course

src/modules/bmm/workflows/1-analysis/research/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ workflow research --type domain
104104

105105
```bash
106106
workflow research --type market --input product-brief.md --input competitor-list.md
107-
workflow research --type technical --input requirements.md --input architecture.md
107+
workflow research --type technical --input requirements.md --input solution-architecture.md
108108
workflow research --type deep_prompt --input research-question.md
109109
```
110110

src/modules/bmm/workflows/2-plan/prd/instructions-lg.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ Since this is a Level {{project_level}} project, you need architecture before st
189189
- Run `architecture` workflow
190190
- Consider reference architectures
191191
- Generate solution fragments
192-
- Create architecture.md
192+
- Create solution-architecture.md
193193

194194
## Complete Next Steps Checklist
195195

@@ -200,18 +200,18 @@ Since this is a Level {{project_level}} project, you need architecture before st
200200
- [ ] **Run architecture workflow** (REQUIRED)
201201
- Command: `workflow architecture`
202202
- Input: PRD.md, epics.md
203-
- Output: architecture.md
203+
- Output: solution-architecture.md
204204

205205
<check if="project has significant UX/UI components (Level 3-4 typically does)">
206206

207-
- [ ] **Run UX specification workflow** (HIGHLY RECOMMENDED for user-facing systems) - Command: `workflow plan-project` then select "UX specification" - Or continue within this workflow if UI-heavy - Input: PRD.md, epics.md, architecture.md (once available) - Output: ux-specification.md - Optional: AI Frontend Prompt for rapid prototyping - Note: Creates comprehensive UX/UI spec including IA, user flows, components
207+
- [ ] **Run UX specification workflow** (HIGHLY RECOMMENDED for user-facing systems) - Command: `workflow plan-project` then select "UX specification" - Or continue within this workflow if UI-heavy - Input: PRD.md, epics.md, solution-architecture.md (once available) - Output: ux-specification.md - Optional: AI Frontend Prompt for rapid prototyping - Note: Creates comprehensive UX/UI spec including IA, user flows, components
208208
</check>
209209

210210
### Phase 2: Detailed Planning
211211

212212
- [ ] **Generate detailed user stories**
213213
- Command: `workflow generate-stories`
214-
- Input: epics.md + architecture.md
214+
- Input: epics.md + solution-architecture.md
215215
- Output: user-stories.md with full acceptance criteria
216216

217217
- [ ] **Create technical design documents**

src/modules/bmm/workflows/2-plan/ux/instructions-ux.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ If no: We'll gather basic requirements to create the UX spec
3737
- PRD.md (primary source for requirements and user journeys)
3838
- epics.md or epic-stories.md (helps understand feature grouping)
3939
- tech-spec.md (understand technical constraints)
40-
- architecture.md (if Level 3-4 project)
40+
- solution-architecture.md (if Level 3-4 project)
4141
- project-workflow-analysis.md (understand project level and scope)
4242

4343
</check>

src/modules/bmm/workflows/3-solutioning/checklist.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Use this checklist during workflow execution and review.
5353

5454
- [ ] Template sections determined dynamically
5555
- [ ] User approved section list
56-
- [ ] architecture.md generated with ALL sections
56+
- [ ] solution-architecture.md generated with ALL sections
5757
- [ ] Technology and Library Decision Table included with specific versions
5858
- [ ] Proposed Source Tree included
5959
- [ ] Design-level only (no extensive code)
@@ -76,7 +76,7 @@ Use this checklist during workflow execution and review.
7676
- [ ] DevOps assessed (simple inline or complex placeholder)
7777
- [ ] Security assessed (simple inline or complex placeholder)
7878
- [ ] Testing assessed (simple inline or complex placeholder)
79-
- [ ] Specialist sections added to END of architecture.md
79+
- [ ] Specialist sections added to END of solution-architecture.md
8080

8181
### Step 8: PRD Updates (Optional)
8282

@@ -105,15 +105,15 @@ Use this checklist during workflow execution and review.
105105

106106
### Technology and Library Decision Table
107107

108-
- [ ] Table exists in architecture.md
108+
- [ ] Table exists in solution-architecture.md
109109
- [ ] ALL technologies have specific versions (e.g., "pino 8.17.0")
110110
- [ ] NO vague entries ("a logging library", "appropriate caching")
111111
- [ ] NO multi-option entries without decision ("Pino or Winston")
112112
- [ ] Grouped logically (core stack, libraries, devops)
113113

114114
### Proposed Source Tree
115115

116-
- [ ] Section exists in architecture.md
116+
- [ ] Section exists in solution-architecture.md
117117
- [ ] Complete directory structure shown
118118
- [ ] For polyrepo: ALL repo structures included
119119
- [ ] Matches technology stack conventions
@@ -137,7 +137,7 @@ Use this checklist during workflow execution and review.
137137

138138
### Required Files
139139

140-
- [ ] /docs/architecture.md (or solution-architecture.md)
140+
- [ ] /docs/solution-architecture.md (or architecture.md)
141141
- [ ] /docs/cohesion-check-report.md
142142
- [ ] /docs/epic-alignment-matrix.md
143143
- [ ] /docs/tech-spec-epic-1.md
@@ -153,7 +153,7 @@ Use this checklist during workflow execution and review.
153153
### Updated Files
154154

155155
- [ ] analysis-template.md (workflow status updated)
156-
- [ ] prd.md (if architectural discoveries required updates)
156+
- [ ] PRD.md (if architectural discoveries required updates)
157157

158158
## Next Steps After Workflow
159159

src/modules/bmm/workflows/3-solutioning/instructions.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ Sub-step 6.2: Fill Template Placeholders
368368
- Ask user for any missing information
369369
- Generate appropriate content based on user_skill_level
370370

371-
8. Generate final architecture.md document
371+
8. Generate final solution-architecture.md document
372372

373373
CRITICAL REQUIREMENTS:
374374
- MUST include "Technology and Library Decisions" section with table:
@@ -438,7 +438,7 @@ Run cohesion check validation inline (NO separate workflow for now):
438438
5. Generate Epic Alignment Matrix:
439439
| Epic | Stories | Components | Data Models | APIs | Integration Points | Status |
440440

441-
This matrix is SEPARATE OUTPUT (not in architecture.md)
441+
This matrix is SEPARATE OUTPUT (not in solution-architecture.md)
442442

443443
6. Generate Cohesion Check Report with:
444444
- Executive summary (READY vs GAPS)
@@ -464,7 +464,7 @@ Issues found:
464464
{{list_critical_issues}}
465465

466466
Options:
467-
1. I'll fix these issues now (update architecture.md)
467+
1. I'll fix these issues now (update solution-architecture.md)
468468
2. You'll fix them manually
469469
3. Proceed anyway (not recommended)
470470

@@ -478,7 +478,7 @@ Proceed? (y/n)
478478
</ask>
479479

480480
<action if="user_chooses_option_1">
481-
Update architecture.md to address critical issues, then re-validate.
481+
Update solution-architecture.md to address critical issues, then re-validate.
482482
</action>
483483
</step>
484484

@@ -498,7 +498,7 @@ Testing Assessment:
498498
- Simple: Basic unit + E2E → Handle INLINE
499499
- Complex: Mission-critical UI, comprehensive coverage needed → Create PLACEHOLDER
500500

501-
For INLINE: Add 1-3 paragraph sections to architecture.md
501+
For INLINE: Add 1-3 paragraph sections to solution-architecture.md
502502
For PLACEHOLDER: Add handoff section with specialist agent invocation instructions
503503
</action>
504504

@@ -522,7 +522,7 @@ I'll handle {{specialist_area}} inline with essentials.
522522
</ask>
523523

524524
<action>
525-
Update architecture.md with specialist sections (inline or placeholders) at the END of document.
525+
Update solution-architecture.md with specialist sections (inline or placeholders) at the END of document.
526526
</action>
527527

528528
<template-output>specialist_sections</template-output>
@@ -598,12 +598,12 @@ For polyrepo projects:
598598
Example: frontend-repo, api-repo, worker-repo, mobile-repo
599599

600600
2. Strategy: Copy FULL documentation to ALL repos
601-
- architecture.md → Copy to each repo
601+
- solution-architecture.md → Copy to each repo
602602
- tech-spec-epic-X.md → Copy to each repo (full set)
603603
- cohesion-check-report.md → Copy to each repo
604604

605605
3. Add repo-specific README pointing to docs:
606-
"See /docs/architecture.md for complete solution architecture"
606+
"See /docs/solution-architecture.md for complete solution architecture"
607607

608608
4. Later phases extract per-epic and per-story contexts as needed
609609

@@ -621,7 +621,7 @@ For monorepo projects:
621621
<action>
622622
Final validation checklist:
623623

624-
- [x] architecture.md exists and is complete
624+
- [x] solution-architecture.md exists and is complete
625625
- [x] Technology and Library Decision Table has specific versions
626626
- [x] Proposed Source Tree section included
627627
- [x] Cohesion check passed (or issues addressed)

src/modules/bmm/workflows/3-solutioning/tech-spec/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,17 @@ workflow tech-spec
2525

2626
```bash
2727
# With specific PRD and architecture
28-
workflow tech-spec --input prd.md --input architecture.md
28+
workflow tech-spec --input PRD.md --input solution-architecture.md
2929

3030
# With comprehensive inputs
31-
workflow tech-spec --input prd.md --input architecture.md --input front-end-spec.md
31+
workflow tech-spec --input PRD.md --input solution-architecture.md --input front-end-spec.md
3232
```
3333

3434
### Configuration
3535

3636
- **output_folder**: Location for generated technical specification
3737
- **epic_id**: Used in output filename (extracted from PRD or prompted)
38-
- **recommended_inputs**: PRD, architecture, front-end spec, brownfield notes
38+
- **recommended_inputs**: PRD, solution-architecture, front-end spec, brownfield notes
3939

4040
## Workflow Structure
4141

@@ -104,7 +104,7 @@ tech-spec/
104104
### Output Structure
105105

106106
1. **Overview and Scope** - Project context and boundaries
107-
2. **System Architecture Alignment** - Connection to high-level architecture
107+
2. **System Architecture Alignment** - Connection to solution-architecture
108108
3. **Detailed Design** - Services, data models, APIs, and workflows
109109
4. **Non-Functional Requirements** - Performance, security, reliability, observability
110110
5. **Dependencies and Integrations** - External systems and technical dependencies
@@ -116,7 +116,7 @@ tech-spec/
116116
## Requirements
117117

118118
- **PRD Document**: Product Requirements Document with clear acceptance criteria
119-
- **Architecture Document**: High-level architecture or technical design
119+
- **Architecture Document**: solution-architecture or technical design
120120
- **Repository Access**: For dependency analysis and framework detection
121121
- **Epic Context**: Clear epic identification and scope definition
122122

src/modules/bmm/workflows/3-solutioning/tech-spec/workflow.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ date: system-generated
1111

1212
# Inputs expected (ask user if missing)
1313
recommended_inputs:
14-
- prd: "{project-root}/docs/prd.md"
15-
- architecture: "{project-root}/docs/architecture.md"
14+
- prd: "{project-root}/docs/PRD.md"
15+
- architecture: "{project-root}/docs/solution-architecture.md"
1616
- frontend_spec: "{project-root}/docs/front-end-spec.md"
1717
- brownfield_notes: "{project-root}/docs/brownfield-notes.md"
1818

0 commit comments

Comments
 (0)