From 764e7702b313f34bb13a8bcce3b637699bb2b8ec Mon Sep 17 00:00:00 2001 From: Brian Madison Date: Sun, 15 Jun 2025 21:27:37 -0500 Subject: [PATCH] feat: improve docs, technical preference usage --- .bmad-core/templates/architecture-tmpl.md | 23 +++++++++++-------- .bmad-core/templates/prd-tmpl.md | 2 +- .../templates/simple-project-prd-tmpl.md | 2 +- 3 files changed, 15 insertions(+), 12 deletions(-) diff --git a/.bmad-core/templates/architecture-tmpl.md b/.bmad-core/templates/architecture-tmpl.md index 1c8fd70c..f99cf0a1 100644 --- a/.bmad-core/templates/architecture-tmpl.md +++ b/.bmad-core/templates/architecture-tmpl.md @@ -136,7 +136,7 @@ Common patterns to consider: [[LLM: This is the DEFINITIVE technology selection section. Work with the user to make specific choices: -1. Review PRD technical assumptions and any preferences from `data#technical-preferences` +1. Review PRD technical assumptions and any preferences from `data#technical-preferences` or an attached `technical-preferences` 2. For each category, present 2-3 viable options with pros/cons 3. Make a clear recommendation based on project needs 4. Get explicit user approval for each selection @@ -344,15 +344,18 @@ Use YAML format for better readability. If no REST API, skip this section.]] ```yaml openapi: 3.0.0 info: - title: { { api_title } } - version: { { api_version } } - description: { { api_description } } - + title: + '[object Object]': null + version: + '[object Object]': null + description: + '[object Object]': null servers: - - url: { { api_base_url } } - description: { { environment } } -# ... OpenAPI specification continues -``` + - url: + '[object Object]': null + description: + '[object Object]': null +```text ^^/CONDITION: has_rest_api^^ @@ -463,7 +466,7 @@ Get user input on deployment preferences and CI/CD tool choices.]] ### Environment Promotion Flow -``` +```text {{promotion_flow_diagram}} ``` diff --git a/.bmad-core/templates/prd-tmpl.md b/.bmad-core/templates/prd-tmpl.md index b0f88d8f..1a5cb5b2 100644 --- a/.bmad-core/templates/prd-tmpl.md +++ b/.bmad-core/templates/prd-tmpl.md @@ -88,7 +88,7 @@ [[LLM: Gather technical decisions that will guide the Architect. Steps: -1. Check if `data#technical-preferences` file exists - use it to pre-populate choices +1. Check if `data#technical-preferences` or an attached `technical-preferences` file exists - use it to pre-populate choices 2. Ask user about: languages, frameworks, starter templates, libraries, APIs, deployment targets 3. For unknowns, offer guidance based on project goals and MVP scope 4. Document ALL technical choices with rationale (why this choice fits the project) diff --git a/.bmad-core/templates/simple-project-prd-tmpl.md b/.bmad-core/templates/simple-project-prd-tmpl.md index cbfd9711..044f687e 100644 --- a/.bmad-core/templates/simple-project-prd-tmpl.md +++ b/.bmad-core/templates/simple-project-prd-tmpl.md @@ -88,7 +88,7 @@ [[LLM: Gather technical decisions that will be used for this simple technical PRD that includes architecture decisions. Steps: -1. Check if `data#technical-preferences` file exists - use it to pre-populate choices +1. Check if `data#technical-preferences` or an attached `technical-preferences` file exists - use it to pre-populate choices 2. Ask user about: languages, frameworks, starter templates, libraries, APIs, deployment targets 3. For unknowns, offer guidance based on project goals and MVP scope 4. Document ALL technical choices with rationale (why this choice fits the project)