chore: cleaned up bad architecture file calls, legacy doc references, and case sensitivity issues to remove ambiguity (#718)

This commit is contained in:
PinkyD
2025-10-10 07:26:49 -07:00
committed by GitHub
parent 5977227efc
commit d76bcb5586
18 changed files with 59 additions and 80 deletions

View File

@@ -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

View File

@@ -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"