feat: improve docs, technical preference usage
This commit is contained in:
@@ -136,7 +136,7 @@ Common patterns to consider:
|
|||||||
|
|
||||||
[[LLM: This is the DEFINITIVE technology selection section. Work with the user to make specific choices:
|
[[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
|
2. For each category, present 2-3 viable options with pros/cons
|
||||||
3. Make a clear recommendation based on project needs
|
3. Make a clear recommendation based on project needs
|
||||||
4. Get explicit user approval for each selection
|
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
|
```yaml
|
||||||
openapi: 3.0.0
|
openapi: 3.0.0
|
||||||
info:
|
info:
|
||||||
title: { { api_title } }
|
title:
|
||||||
version: { { api_version } }
|
'[object Object]': null
|
||||||
description: { { api_description } }
|
version:
|
||||||
|
'[object Object]': null
|
||||||
|
description:
|
||||||
|
'[object Object]': null
|
||||||
servers:
|
servers:
|
||||||
- url: { { api_base_url } }
|
- url:
|
||||||
description: { { environment } }
|
'[object Object]': null
|
||||||
# ... OpenAPI specification continues
|
description:
|
||||||
```
|
'[object Object]': null
|
||||||
|
```text
|
||||||
|
|
||||||
^^/CONDITION: has_rest_api^^
|
^^/CONDITION: has_rest_api^^
|
||||||
|
|
||||||
@@ -463,7 +466,7 @@ Get user input on deployment preferences and CI/CD tool choices.]]
|
|||||||
|
|
||||||
### Environment Promotion Flow
|
### Environment Promotion Flow
|
||||||
|
|
||||||
```
|
```text
|
||||||
{{promotion_flow_diagram}}
|
{{promotion_flow_diagram}}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -88,7 +88,7 @@
|
|||||||
|
|
||||||
[[LLM: Gather technical decisions that will guide the Architect. Steps:
|
[[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
|
2. Ask user about: languages, frameworks, starter templates, libraries, APIs, deployment targets
|
||||||
3. For unknowns, offer guidance based on project goals and MVP scope
|
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)
|
4. Document ALL technical choices with rationale (why this choice fits the project)
|
||||||
|
|||||||
@@ -88,7 +88,7 @@
|
|||||||
|
|
||||||
[[LLM: Gather technical decisions that will be used for this simple technical PRD that includes architecture decisions. Steps:
|
[[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
|
2. Ask user about: languages, frameworks, starter templates, libraries, APIs, deployment targets
|
||||||
3. For unknowns, offer guidance based on project goals and MVP scope
|
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)
|
4. Document ALL technical choices with rationale (why this choice fits the project)
|
||||||
|
|||||||
Reference in New Issue
Block a user