Skip to content

Commit ea421ad

Browse files
Brian MadisonBrian Madison
authored andcommitted
create and edit workflow minor fixes
1 parent 2a8a438 commit ea421ad

File tree

8 files changed

+48
-67
lines changed

8 files changed

+48
-67
lines changed

src/modules/bmb/workflows/create-agent/steps/step-01-brainstorm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Wait for clear user response (yes/no or y/n).
9090

9191
- Load brainstorming workflow: `{brainstormWorkflow}`
9292
- Pass context data: `{brainstormContext}`
93-
- Execute brainstorming session scoped specifically to brainstorming a new agent.
93+
- Execute brainstorming session scoped specifically utilizing the brainstormContext to guide the scope and outcome
9494
- Capture all brainstorming output for next step
9595
- Return to this step after brainstorming completes
9696

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
---
22
stepsCompleted: []
33
---
4+
5+
# Agent Design and Build Plan

src/modules/bmb/workflows/create-agent/templates/expert-agent.template.md

Lines changed: 13 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -28,28 +28,22 @@ Domain-specific agents with persistent memory, sidecar files, and restricted acc
2828
```yaml
2929
agent:
3030
metadata:
31+
id: _bmad/agents/{agent-name}/{agent-name}.md
3132
name: 'Persona Name'
3233
title: 'Agent Title'
3334
icon: 'emoji'
34-
type: 'expert'
35+
module: stand-alone # or module name
3536

3637
persona:
37-
role: 'Domain Expert with specialized capability'
38+
role: |
39+
First-person description of primary function (1-2 sentences)
3840
3941
identity: |
40-
Background and expertise in first-person voice.
41-
{{#if user_preference}}
42-
Customization based on install_config.
43-
{{/if}}
42+
Background, experience, specializations in first-person (2-3 sentences)
4443
4544
communication_style: |
46-
{{#if tone_style == "gentle"}}
47-
Gentle and supportive communication...
48-
{{/if}}
49-
{{#if tone_style == "direct"}}
50-
Direct and efficient communication...
51-
{{/if}}
52-
I reference past conversations naturally.
45+
1-2 short sentence describe how the agent speaks and communicates
46+
5347
5448
principles:
5549
- Core belief about the domain
@@ -89,29 +83,17 @@ agent:
8983
Reference stored information naturally.
9084
9185
menu:
92-
- trigger: action1
86+
- trigger: MF or fuzzy match on main function
9387
action: '#main-function'
94-
description: 'Primary agent function'
88+
description: '[MF] Main agent function'
9589

96-
- trigger: remember
90+
- trigger: SM or fuzzy match on save-memory
9791
action: 'Update ./{agent-name}-sidecar/memories.md with session insights'
98-
description: 'Save what we discussed today'
92+
description: '[SM] Save memory what we discussed today'
9993

100-
- trigger: insight
94+
- trigger: RI or fuzzy match on record-insight
10195
action: 'Document breakthrough in ./{agent-name}-sidecar/breakthroughs.md'
102-
description: 'Record a significant insight'
103-
104-
- multi: "[DF] Do Foo or start [CH] Chat with expert"
105-
triggers:
106-
- do-foo
107-
- input: [DF] or fuzzy match on do foo
108-
- action: '#main-action'
109-
- data: what is being discussed or suggested with the command, along with custom party custom agents if specified
110-
- type: action
111-
- expert-chat:
112-
- input: [CH] or fuzzy match validate agent
113-
- action: agent responds as expert based on its persona to converse
114-
- type: action
96+
description: '[RI] Record a significant insight'
11597

11698
install_config:
11799
compile_time_only: true

src/modules/bmb/workflows/create-agent/templates/simple-agent.template.md

Lines changed: 10 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -18,25 +18,17 @@ agent:
1818
name: 'Persona Name'
1919
title: 'Agent Title'
2020
icon: 'emoji'
21-
type: simple
21+
module: stand-alone # or module name
2222

2323
persona:
2424
role: |
2525
First-person description of primary function (1-2 sentences)
2626
2727
identity: |
2828
Background, experience, specializations in first-person (2-5 sentences)
29-
{{#if custom_variable}}
30-
Conditional identity text based on install_config
31-
{{/if}}
3229
3330
communication_style: |
34-
{{#if style_choice == "professional"}}
35-
Professional and systematic approach...
36-
{{/if}}
37-
{{#if style_choice == "casual"}}
38-
Friendly and approachable tone...
39-
{{/if}}
31+
1-2 short sentence describe how the agent speaks and communicates
4032
4133
principles:
4234
- Core belief or methodology
@@ -58,26 +50,18 @@ agent:
5850
3. Final step
5951
</process>
6052
61-
- id: another-action
53+
- id: foo-bar
6254
content: |
6355
Another reusable prompt template
6456
6557
menu:
66-
- trigger: inline
67-
action: 'Direct inline prompt text'
68-
description: 'Execute inline action'
69-
70-
- multi: "[DF] Do Foo or start [CH] Chat with expert"
71-
triggers:
72-
- do-foo
73-
- input: [DF] or fuzzy match on do foo
74-
- action: '#main-action'
75-
- data: what is being discussed or suggested with the command, along with custom party custom agents if specified
76-
- type: action
77-
- expert-chat:
78-
- input: [CH] or fuzzy match validate agent
79-
- action: agent responds as expert based on its persona to converse
80-
- type: action
58+
- trigger: FB or fuzzy match on foo-bar
59+
action: '#foo-bar'
60+
description: '[FB] Foo Bar inline action'
61+
62+
- trigger: IA or fuzzy match on main-action
63+
action: '#main-action'
64+
description: '[IA] Execute inline action'
8165

8266
install_config:
8367
compile_time_only: true

src/modules/bmb/workflows/create-workflow/steps/step-06-design.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,9 @@ Read: {project-root}/_bmad/bmb/docs/workflows/templates/step-1b-template.md
9696

9797
This shows the continuation step pattern for workflows that might take multiple sessions.
9898

99-
Based on the approved plan, collaboratively design:
99+
Based on the approved plan, collaboratively design the info to answer the following for the build plan:
100100

101-
- How many major steps does this workflow need? (Recommend 3-7)
101+
- How many major steps does this workflow need?
102102
- What is the goal of each step?
103103
- Which steps are optional vs required?
104104
- Should any steps repeat or loop?

src/modules/bmb/workflows/create-workflow/steps/step-07-build.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ To generate all the workflow files (workflow.md, step files, templates, and supp
7272
- When building continuable step-01-init.md files, use template `{project-root}/_bmad/bmb/docs/workflows/templates/step-01-init-continuable-template.md`
7373
- When building continuation steps, use template `{project-root}/_bmad/bmb/docs/workflows/templates/step-1b-template.md`
7474
- When building the main workflow.md file, you must follow template `{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md`
75-
- Example step files from {project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md for patterns
75+
- Example step files from {project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md for patterns - this is an idealized workflow so all files can give good insight into format and structure to be followed
7676

7777
## FILE GENERATION SEQUENCE:
7878

@@ -182,6 +182,20 @@ For document workflows:
182182
- Include all variables from design
183183
- Ensure variable naming consistency
184184

185+
Remember that the output format design we aligned on chose one of the following - and what it means practically when creating the workflow steps:
186+
1. **Strict Template** - Must follow exact format with specific fields
187+
1. This is similar to the example where there are multiple template fragements that are specific with all fields to be in the final output.
188+
2. generally there will be 1 fragment to a step to complete in the overall template.
189+
2. **Structured** - Required sections but flexible within each
190+
1. Usually there will just be one template file - and in this mode it lists out all the section headings (generally level 2 sections in the md) with a handlebars style placeholder for each section.
191+
2. Step files responsible for a specific section will upon user Continue of that step ensure output is written to the templates proper section
192+
3. **Semi-structured** - Core sections plus optional additions
193+
1. Similar to the prior 2, but not all sections or content are listed in the template, some steps might offer various paths or options to go to different steps (or variance within a step) that can determine what sections end up in the final document
194+
4. **Free-form** - Content-driven with minimal structure
195+
1. These are the easiest and most flexible. The single template usually only has the front matter fence with a stepsCompleted array and maybe some other fields, and outside of the front matter just the level 1 doc title
196+
2. With free form, any step that could produce content just appends to the end of the document, so its progressively build in the order of ste[s completed.
197+
3. Its good to have in this type of workflow a final polish output doc type step that cohesively can update the doc built up in this progressive manner, improving flow, reducing duplication, and ensure all information is aligned and where it belongs.
198+
185199
### 6. Generate Supporting Files
186200

187201
Based on design requirements:

src/modules/bmb/workflows/edit-workflow/steps/step-01-analyze.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -127,18 +127,17 @@ Based on what the user wants to edit:
127127

128128
#### Compliance Analysis
129129

130-
Load reference documentation as needed:
130+
Load reference documentation to understand what ideal workflow files sound be when doing the review:
131131

132132
- `{project-root}/_bmad/bmb/docs/workflows/architecture.md`
133133
- `{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md`
134134
- `{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md`
135135

136136
Check against best practices:
137137

138-
- Step file size and structure
139-
- Menu handling implementation
140-
- Frontmatter variable usage
141-
- Path reference consistency
138+
- Step file size and structure (each step file 80-250 lines)
139+
- Menu handling implementation (every menu item has a handler, and continue will only proceed after writes to output if applicable have completed)
140+
- Frontmatter variable usage - no unused variables in the specific step front matter, and all files referenced in the file are done through a variable in the front matter
142141

143142
### 5. Present Analysis Findings
144143

src/modules/bmb/workflows/edit-workflow/workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ This uses **step-file architecture** for disciplined execution:
5151

5252
Load and read full config from {project-root}/_bmad/bmb/config.yaml and resolve:
5353

54-
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`
54+
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, `bmb_creations_output_folder`
5555

5656
### 2. First Step EXECUTION
5757

0 commit comments

Comments
 (0)