chore: update documentation to reflect recent architectural changes and improve clarity
This commit is contained in:
Sepehr
@@ -78,7 +78,7 @@ For **{{research_topic}}**, I will research:
|
||||
|
||||
- Document scope confirmation in research file
|
||||
- Update frontmatter: `stepsCompleted: [1]`
|
||||
- Load: `./step-02-technical-overview.md`
|
||||
- Load: `{project-root}/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -132,6 +132,6 @@ When user selects 'C', append scope confirmation:
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C', load `./step-02-technical-overview.md` to begin technology stack analysis.
|
||||
After user selects 'C', load `{project-root}/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md` to begin technology stack analysis.
|
||||
|
||||
Remember: This is SCOPE CONFIRMATION ONLY - no actual technical research yet, just confirming the research approach and scope!
|
||||
|
||||
@@ -180,7 +180,7 @@ _Source: [URL]_
|
||||
|
||||
- **CONTENT ALREADY WRITTEN TO DOCUMENT**
|
||||
- Update frontmatter: `stepsCompleted: [1, 2]`
|
||||
- Load: `./step-03-integration-patterns.md`
|
||||
- Load: `{project-root}/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -234,6 +234,6 @@ Content is already written to document when generated in step 4. No additional a
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C', load `./step-03-integration-patterns.md` to analyze APIs, communication protocols, and system interoperability for {{research_topic}}.
|
||||
After user selects 'C', load `{project-root}/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md` to analyze APIs, communication protocols, and system interoperability for {{research_topic}}.
|
||||
|
||||
Remember: Always write research content to document immediately and emphasize current technology data with rigorous source verification!
|
||||
|
||||
@@ -189,7 +189,7 @@ _Source: [URL]_
|
||||
|
||||
- **CONTENT ALREADY WRITTEN TO DOCUMENT**
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3]`
|
||||
- Load: `./step-04-architectural-patterns.md`
|
||||
- Load: `{project-root}/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -243,6 +243,6 @@ Content is already written to document when generated in step 4. No additional a
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C', load `./step-04-architectural-patterns.md` to analyze architectural patterns, design decisions, and system structures for {{research_topic}}.
|
||||
After user selects 'C', load `{project-root}/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md` to analyze architectural patterns, design decisions, and system structures for {{research_topic}}.
|
||||
|
||||
Remember: Always write research content to document immediately and emphasize current integration data with rigorous source verification!
|
||||
|
||||
@@ -156,7 +156,7 @@ Show the generated architectural patterns and present continue option:
|
||||
|
||||
- Append the final content to the research document
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4]`
|
||||
- Load: `./step-05-implementation-research.md`
|
||||
- Load: `{project-root}/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -197,6 +197,6 @@ When user selects 'C', append the content directly to the research document usin
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-05-implementation-research.md` to focus on implementation approaches and technology adoption.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md` to focus on implementation approaches and technology adoption.
|
||||
|
||||
Remember: Always emphasize current architectural data and rigorous source verification!
|
||||
|
||||
@@ -179,7 +179,7 @@ Show the generated implementation research and present continue option:
|
||||
|
||||
- Append the final content to the research document
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5]`
|
||||
- Load: `./step-06-research-synthesis.md`
|
||||
- Load: `{project-root}/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -230,4 +230,4 @@ When 'C' is selected:
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C', load `./step-06-research-synthesis.md` to produce the comprehensive technical research document with narrative introduction, detailed TOC, and executive summary.
|
||||
After user selects 'C', load `{project-root}/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md` to produce the comprehensive technical research document with narrative introduction, detailed TOC, and executive summary.
|
||||
|
||||
@@ -416,6 +416,7 @@ _This comprehensive technical research document serves as an authoritative techn
|
||||
|
||||
#### If 'C' (Complete Research):
|
||||
|
||||
- **Replace** the template placeholder `[Research overview and methodology will be appended here]` in the `## Research Overview` section near the top of the document with a concise 2-3 paragraph overview summarizing the research scope, key findings, and a pointer to the full executive summary in the Research Synthesis section
|
||||
- Append the complete technical document to the research file
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6]`
|
||||
- Complete the technical research workflow
|
||||
@@ -423,7 +424,7 @@ _This comprehensive technical research document serves as an authoritative techn
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the complete comprehensive technical research document using the full structure above.
|
||||
When user selects 'C', append the complete comprehensive technical research document using the full structure above. Also replace the `[Research overview and methodology will be appended here]` placeholder in the Research Overview section at the top of the document.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user