chore: cleaned up bad architecture file calls, legacy doc references, and case sensitivity issues to remove ambiguity (#718)
This commit is contained in:
@@ -53,7 +53,7 @@ Use this checklist during workflow execution and review.
|
||||
|
||||
- [ ] Template sections determined dynamically
|
||||
- [ ] User approved section list
|
||||
- [ ] architecture.md generated with ALL sections
|
||||
- [ ] solution-architecture.md generated with ALL sections
|
||||
- [ ] Technology and Library Decision Table included with specific versions
|
||||
- [ ] Proposed Source Tree included
|
||||
- [ ] Design-level only (no extensive code)
|
||||
@@ -76,7 +76,7 @@ Use this checklist during workflow execution and review.
|
||||
- [ ] DevOps assessed (simple inline or complex placeholder)
|
||||
- [ ] Security assessed (simple inline or complex placeholder)
|
||||
- [ ] Testing assessed (simple inline or complex placeholder)
|
||||
- [ ] Specialist sections added to END of architecture.md
|
||||
- [ ] Specialist sections added to END of solution-architecture.md
|
||||
|
||||
### Step 8: PRD Updates (Optional)
|
||||
|
||||
@@ -105,7 +105,7 @@ Use this checklist during workflow execution and review.
|
||||
|
||||
### Technology and Library Decision Table
|
||||
|
||||
- [ ] Table exists in architecture.md
|
||||
- [ ] Table exists in solution-architecture.md
|
||||
- [ ] ALL technologies have specific versions (e.g., "pino 8.17.0")
|
||||
- [ ] NO vague entries ("a logging library", "appropriate caching")
|
||||
- [ ] NO multi-option entries without decision ("Pino or Winston")
|
||||
@@ -113,7 +113,7 @@ Use this checklist during workflow execution and review.
|
||||
|
||||
### Proposed Source Tree
|
||||
|
||||
- [ ] Section exists in architecture.md
|
||||
- [ ] Section exists in solution-architecture.md
|
||||
- [ ] Complete directory structure shown
|
||||
- [ ] For polyrepo: ALL repo structures included
|
||||
- [ ] Matches technology stack conventions
|
||||
@@ -137,7 +137,7 @@ Use this checklist during workflow execution and review.
|
||||
|
||||
### Required Files
|
||||
|
||||
- [ ] /docs/architecture.md (or solution-architecture.md)
|
||||
- [ ] /docs/solution-architecture.md (or architecture.md)
|
||||
- [ ] /docs/cohesion-check-report.md
|
||||
- [ ] /docs/epic-alignment-matrix.md
|
||||
- [ ] /docs/tech-spec-epic-1.md
|
||||
@@ -153,7 +153,7 @@ Use this checklist during workflow execution and review.
|
||||
### Updated Files
|
||||
|
||||
- [ ] analysis-template.md (workflow status updated)
|
||||
- [ ] prd.md (if architectural discoveries required updates)
|
||||
- [ ] PRD.md (if architectural discoveries required updates)
|
||||
|
||||
## Next Steps After Workflow
|
||||
|
||||
|
||||
@@ -368,7 +368,7 @@ Sub-step 6.2: Fill Template Placeholders
|
||||
- Ask user for any missing information
|
||||
- Generate appropriate content based on user_skill_level
|
||||
|
||||
8. Generate final architecture.md document
|
||||
8. Generate final solution-architecture.md document
|
||||
|
||||
CRITICAL REQUIREMENTS:
|
||||
- MUST include "Technology and Library Decisions" section with table:
|
||||
@@ -438,7 +438,7 @@ Run cohesion check validation inline (NO separate workflow for now):
|
||||
5. Generate Epic Alignment Matrix:
|
||||
| Epic | Stories | Components | Data Models | APIs | Integration Points | Status |
|
||||
|
||||
This matrix is SEPARATE OUTPUT (not in architecture.md)
|
||||
This matrix is SEPARATE OUTPUT (not in solution-architecture.md)
|
||||
|
||||
6. Generate Cohesion Check Report with:
|
||||
- Executive summary (READY vs GAPS)
|
||||
@@ -464,7 +464,7 @@ Issues found:
|
||||
{{list_critical_issues}}
|
||||
|
||||
Options:
|
||||
1. I'll fix these issues now (update architecture.md)
|
||||
1. I'll fix these issues now (update solution-architecture.md)
|
||||
2. You'll fix them manually
|
||||
3. Proceed anyway (not recommended)
|
||||
|
||||
@@ -478,7 +478,7 @@ Proceed? (y/n)
|
||||
</ask>
|
||||
|
||||
<action if="user_chooses_option_1">
|
||||
Update architecture.md to address critical issues, then re-validate.
|
||||
Update solution-architecture.md to address critical issues, then re-validate.
|
||||
</action>
|
||||
</step>
|
||||
|
||||
@@ -498,7 +498,7 @@ Testing Assessment:
|
||||
- Simple: Basic unit + E2E → Handle INLINE
|
||||
- Complex: Mission-critical UI, comprehensive coverage needed → Create PLACEHOLDER
|
||||
|
||||
For INLINE: Add 1-3 paragraph sections to architecture.md
|
||||
For INLINE: Add 1-3 paragraph sections to solution-architecture.md
|
||||
For PLACEHOLDER: Add handoff section with specialist agent invocation instructions
|
||||
</action>
|
||||
|
||||
@@ -522,7 +522,7 @@ I'll handle {{specialist_area}} inline with essentials.
|
||||
</ask>
|
||||
|
||||
<action>
|
||||
Update architecture.md with specialist sections (inline or placeholders) at the END of document.
|
||||
Update solution-architecture.md with specialist sections (inline or placeholders) at the END of document.
|
||||
</action>
|
||||
|
||||
<template-output>specialist_sections</template-output>
|
||||
@@ -598,12 +598,12 @@ For polyrepo projects:
|
||||
Example: frontend-repo, api-repo, worker-repo, mobile-repo
|
||||
|
||||
2. Strategy: Copy FULL documentation to ALL repos
|
||||
- architecture.md → Copy to each repo
|
||||
- solution-architecture.md → Copy to each repo
|
||||
- tech-spec-epic-X.md → Copy to each repo (full set)
|
||||
- cohesion-check-report.md → Copy to each repo
|
||||
|
||||
3. Add repo-specific README pointing to docs:
|
||||
"See /docs/architecture.md for complete solution architecture"
|
||||
"See /docs/solution-architecture.md for complete solution architecture"
|
||||
|
||||
4. Later phases extract per-epic and per-story contexts as needed
|
||||
|
||||
@@ -621,7 +621,7 @@ For monorepo projects:
|
||||
<action>
|
||||
Final validation checklist:
|
||||
|
||||
- [x] architecture.md exists and is complete
|
||||
- [x] solution-architecture.md exists and is complete
|
||||
- [x] Technology and Library Decision Table has specific versions
|
||||
- [x] Proposed Source Tree section included
|
||||
- [x] Cohesion check passed (or issues addressed)
|
||||
|
||||
@@ -25,17 +25,17 @@ workflow tech-spec
|
||||
|
||||
```bash
|
||||
# With specific PRD and architecture
|
||||
workflow tech-spec --input prd.md --input architecture.md
|
||||
workflow tech-spec --input PRD.md --input solution-architecture.md
|
||||
|
||||
# With comprehensive inputs
|
||||
workflow tech-spec --input prd.md --input architecture.md --input front-end-spec.md
|
||||
workflow tech-spec --input PRD.md --input solution-architecture.md --input front-end-spec.md
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
||||
- **output_folder**: Location for generated technical specification
|
||||
- **epic_id**: Used in output filename (extracted from PRD or prompted)
|
||||
- **recommended_inputs**: PRD, architecture, front-end spec, brownfield notes
|
||||
- **recommended_inputs**: PRD, solution-architecture, front-end spec, brownfield notes
|
||||
|
||||
## Workflow Structure
|
||||
|
||||
@@ -104,7 +104,7 @@ tech-spec/
|
||||
### Output Structure
|
||||
|
||||
1. **Overview and Scope** - Project context and boundaries
|
||||
2. **System Architecture Alignment** - Connection to high-level architecture
|
||||
2. **System Architecture Alignment** - Connection to solution-architecture
|
||||
3. **Detailed Design** - Services, data models, APIs, and workflows
|
||||
4. **Non-Functional Requirements** - Performance, security, reliability, observability
|
||||
5. **Dependencies and Integrations** - External systems and technical dependencies
|
||||
@@ -116,7 +116,7 @@ tech-spec/
|
||||
## Requirements
|
||||
|
||||
- **PRD Document**: Product Requirements Document with clear acceptance criteria
|
||||
- **Architecture Document**: High-level architecture or technical design
|
||||
- **Architecture Document**: solution-architecture or technical design
|
||||
- **Repository Access**: For dependency analysis and framework detection
|
||||
- **Epic Context**: Clear epic identification and scope definition
|
||||
|
||||
|
||||
@@ -11,8 +11,8 @@ date: system-generated
|
||||
|
||||
# Inputs expected (ask user if missing)
|
||||
recommended_inputs:
|
||||
- prd: "{project-root}/docs/prd.md"
|
||||
- architecture: "{project-root}/docs/architecture.md"
|
||||
- prd: "{project-root}/docs/PRD.md"
|
||||
- architecture: "{project-root}/docs/solution-architecture.md"
|
||||
- frontend_spec: "{project-root}/docs/front-end-spec.md"
|
||||
- brownfield_notes: "{project-root}/docs/brownfield-notes.md"
|
||||
|
||||
|
||||
Reference in New Issue
Block a user