docs: update all documentation and add AI tooling configs
- Rewrite README.md with current architecture, features and stack - Update docs/API.md with all current endpoints (corporate, BI, client 360) - Update docs/ARCHITECTURE.md with cache, modular queries, services, ETL - Update docs/GUIA-USUARIO.md for all roles (admin, corporate, agente) - Add docs/INDEX.md documentation index - Add PROJETO.md comprehensive project reference - Add BI-CCC-Implementation-Guide.md - Include AI agent configs (.claude, .agents, .gemini, _bmad) - Add netbird VPN configuration - Add status report Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
6
_bmad/core/skills/bmad-advanced-elicitation/SKILL.md
Normal file
6
_bmad/core/skills/bmad-advanced-elicitation/SKILL.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
name: bmad-advanced-elicitation
|
||||
description: 'Push the LLM to reconsider, refine, and improve its recent output.'
|
||||
---
|
||||
|
||||
Follow the instructions in ./workflow.md.
|
||||
@@ -0,0 +1 @@
|
||||
type: skill
|
||||
51
_bmad/core/skills/bmad-advanced-elicitation/methods.csv
Normal file
51
_bmad/core/skills/bmad-advanced-elicitation/methods.csv
Normal file
@@ -0,0 +1,51 @@
|
||||
num,category,method_name,description,output_pattern
|
||||
1,collaboration,Stakeholder Round Table,Convene multiple personas to contribute diverse perspectives - essential for requirements gathering and finding balanced solutions across competing interests,perspectives → synthesis → alignment
|
||||
2,collaboration,Expert Panel Review,Assemble domain experts for deep specialized analysis - ideal when technical depth and peer review quality are needed,expert views → consensus → recommendations
|
||||
3,collaboration,Debate Club Showdown,Two personas argue opposing positions while a moderator scores points - great for exploring controversial decisions and finding middle ground,thesis → antithesis → synthesis
|
||||
4,collaboration,User Persona Focus Group,Gather your product's user personas to react to proposals and share frustrations - essential for validating features and discovering unmet needs,reactions → concerns → priorities
|
||||
5,collaboration,Time Traveler Council,Past-you and future-you advise present-you on decisions - powerful for gaining perspective on long-term consequences vs short-term pressures,past wisdom → present choice → future impact
|
||||
6,collaboration,Cross-Functional War Room,Product manager + engineer + designer tackle a problem together - reveals trade-offs between feasibility desirability and viability,constraints → trade-offs → balanced solution
|
||||
7,collaboration,Mentor and Apprentice,Senior expert teaches junior while junior asks naive questions - surfaces hidden assumptions through teaching,explanation → questions → deeper understanding
|
||||
8,collaboration,Good Cop Bad Cop,Supportive persona and critical persona alternate - finds both strengths to build on and weaknesses to address,encouragement → criticism → balanced view
|
||||
9,collaboration,Improv Yes-And,Multiple personas build on each other's ideas without blocking - generates unexpected creative directions through collaborative building,idea → build → build → surprising result
|
||||
10,collaboration,Customer Support Theater,Angry customer and support rep roleplay to find pain points - reveals real user frustrations and service gaps,complaint → investigation → resolution → prevention
|
||||
11,advanced,Tree of Thoughts,Explore multiple reasoning paths simultaneously then evaluate and select the best - perfect for complex problems with multiple valid approaches,paths → evaluation → selection
|
||||
12,advanced,Graph of Thoughts,Model reasoning as an interconnected network of ideas to reveal hidden relationships - ideal for systems thinking and discovering emergent patterns,nodes → connections → patterns
|
||||
13,advanced,Thread of Thought,Maintain coherent reasoning across long contexts by weaving a continuous narrative thread - essential for RAG systems and maintaining consistency,context → thread → synthesis
|
||||
14,advanced,Self-Consistency Validation,Generate multiple independent approaches then compare for consistency - crucial for high-stakes decisions where verification matters,approaches → comparison → consensus
|
||||
15,advanced,Meta-Prompting Analysis,Step back to analyze the approach structure and methodology itself - valuable for optimizing prompts and improving problem-solving,current → analysis → optimization
|
||||
16,advanced,Reasoning via Planning,Build a reasoning tree guided by world models and goal states - excellent for strategic planning and sequential decision-making,model → planning → strategy
|
||||
17,competitive,Red Team vs Blue Team,Adversarial attack-defend analysis to find vulnerabilities - critical for security testing and building robust solutions,defense → attack → hardening
|
||||
18,competitive,Shark Tank Pitch,Entrepreneur pitches to skeptical investors who poke holes - stress-tests business viability and forces clarity on value proposition,pitch → challenges → refinement
|
||||
19,competitive,Code Review Gauntlet,Senior devs with different philosophies review the same code - surfaces style debates and finds consensus on best practices,reviews → debates → standards
|
||||
20,technical,Architecture Decision Records,Multiple architect personas propose and debate architectural choices with explicit trade-offs - ensures decisions are well-reasoned and documented,options → trade-offs → decision → rationale
|
||||
21,technical,Rubber Duck Debugging Evolved,Explain your code to progressively more technical ducks until you find the bug - forces clarity at multiple abstraction levels,simple → detailed → technical → aha
|
||||
22,technical,Algorithm Olympics,Multiple approaches compete on the same problem with benchmarks - finds optimal solution through direct comparison,implementations → benchmarks → winner
|
||||
23,technical,Security Audit Personas,Hacker + defender + auditor examine system from different threat models - comprehensive security review from multiple angles,vulnerabilities → defenses → compliance
|
||||
24,technical,Performance Profiler Panel,Database expert + frontend specialist + DevOps engineer diagnose slowness - finds bottlenecks across the full stack,symptoms → analysis → optimizations
|
||||
25,creative,SCAMPER Method,Apply seven creativity lenses (Substitute/Combine/Adapt/Modify/Put/Eliminate/Reverse) - systematic ideation for product innovation,S→C→A→M→P→E→R
|
||||
26,creative,Reverse Engineering,Work backwards from desired outcome to find implementation path - powerful for goal achievement and understanding endpoints,end state → steps backward → path forward
|
||||
27,creative,What If Scenarios,Explore alternative realities to understand possibilities and implications - valuable for contingency planning and exploration,scenarios → implications → insights
|
||||
28,creative,Random Input Stimulus,Inject unrelated concepts to spark unexpected connections - breaks creative blocks through forced lateral thinking,random word → associations → novel ideas
|
||||
29,creative,Exquisite Corpse Brainstorm,Each persona adds to the idea seeing only the previous contribution - generates surprising combinations through constrained collaboration,contribution → handoff → contribution → surprise
|
||||
30,creative,Genre Mashup,Combine two unrelated domains to find fresh approaches - innovation through unexpected cross-pollination,domain A + domain B → hybrid insights
|
||||
31,research,Literature Review Personas,Optimist researcher + skeptic researcher + synthesizer review sources - balanced assessment of evidence quality,sources → critiques → synthesis
|
||||
32,research,Thesis Defense Simulation,Student defends hypothesis against committee with different concerns - stress-tests research methodology and conclusions,thesis → challenges → defense → refinements
|
||||
33,research,Comparative Analysis Matrix,Multiple analysts evaluate options against weighted criteria - structured decision-making with explicit scoring,options → criteria → scores → recommendation
|
||||
34,risk,Pre-mortem Analysis,Imagine future failure then work backwards to prevent it - powerful technique for risk mitigation before major launches,failure scenario → causes → prevention
|
||||
35,risk,Failure Mode Analysis,Systematically explore how each component could fail - critical for reliability engineering and safety-critical systems,components → failures → prevention
|
||||
36,risk,Challenge from Critical Perspective,Play devil's advocate to stress-test ideas and find weaknesses - essential for overcoming groupthink,assumptions → challenges → strengthening
|
||||
37,risk,Identify Potential Risks,Brainstorm what could go wrong across all categories - fundamental for project planning and deployment preparation,categories → risks → mitigations
|
||||
38,risk,Chaos Monkey Scenarios,Deliberately break things to test resilience and recovery - ensures systems handle failures gracefully,break → observe → harden
|
||||
39,core,First Principles Analysis,Strip away assumptions to rebuild from fundamental truths - breakthrough technique for innovation and solving impossible problems,assumptions → truths → new approach
|
||||
40,core,5 Whys Deep Dive,Repeatedly ask why to drill down to root causes - simple but powerful for understanding failures,why chain → root cause → solution
|
||||
41,core,Socratic Questioning,Use targeted questions to reveal hidden assumptions and guide discovery - excellent for teaching and self-discovery,questions → revelations → understanding
|
||||
42,core,Critique and Refine,Systematic review to identify strengths and weaknesses then improve - standard quality check for drafts,strengths/weaknesses → improvements → refined
|
||||
43,core,Explain Reasoning,Walk through step-by-step thinking to show how conclusions were reached - crucial for transparency,steps → logic → conclusion
|
||||
44,core,Expand or Contract for Audience,Dynamically adjust detail level and technical depth for target audience - matches content to reader capabilities,audience → adjustments → refined content
|
||||
45,learning,Feynman Technique,Explain complex concepts simply as if teaching a child - the ultimate test of true understanding,complex → simple → gaps → mastery
|
||||
46,learning,Active Recall Testing,Test understanding without references to verify true knowledge - essential for identifying gaps,test → gaps → reinforcement
|
||||
47,philosophical,Occam's Razor Application,Find the simplest sufficient explanation by eliminating unnecessary complexity - essential for debugging,options → simplification → selection
|
||||
48,philosophical,Trolley Problem Variations,Explore ethical trade-offs through moral dilemmas - valuable for understanding values and difficult decisions,dilemma → analysis → decision
|
||||
49,retrospective,Hindsight Reflection,Imagine looking back from the future to gain perspective - powerful for project reviews,future view → insights → application
|
||||
50,retrospective,Lessons Learned Extraction,Systematically identify key takeaways and actionable improvements - essential for continuous improvement,experience → lessons → actions
|
||||
|
135
_bmad/core/skills/bmad-advanced-elicitation/workflow.md
Normal file
135
_bmad/core/skills/bmad-advanced-elicitation/workflow.md
Normal file
@@ -0,0 +1,135 @@
|
||||
---
|
||||
agent_party: '{project-root}/_bmad/_config/agent-manifest.csv'
|
||||
---
|
||||
|
||||
# Advanced Elicitation Workflow
|
||||
|
||||
**Goal:** Push the LLM to reconsider, refine, and improve its recent output.
|
||||
|
||||
---
|
||||
|
||||
## CRITICAL LLM INSTRUCTIONS
|
||||
|
||||
- **MANDATORY:** Execute ALL steps in the flow section IN EXACT ORDER
|
||||
- DO NOT skip steps or change the sequence
|
||||
- HALT immediately when halt-conditions are met
|
||||
- Each action within a step is a REQUIRED action to complete that step
|
||||
- Sections outside flow (validation, output, critical-context) provide essential context - review and apply throughout execution
|
||||
- **YOU MUST ALWAYS SPEAK OUTPUT in your Agent communication style with the `communication_language`**
|
||||
|
||||
---
|
||||
|
||||
## INTEGRATION (When Invoked Indirectly)
|
||||
|
||||
When invoked from another prompt or process:
|
||||
|
||||
1. Receive or review the current section content that was just generated
|
||||
2. Apply elicitation methods iteratively to enhance that specific content
|
||||
3. Return the enhanced version back when user selects 'x' to proceed and return back
|
||||
4. The enhanced content replaces the original section content in the output document
|
||||
|
||||
---
|
||||
|
||||
## FLOW
|
||||
|
||||
### Step 1: Method Registry Loading
|
||||
|
||||
**Action:** Load and read `./methods.csv` and `{agent_party}`
|
||||
|
||||
#### CSV Structure
|
||||
|
||||
- **category:** Method grouping (core, structural, risk, etc.)
|
||||
- **method_name:** Display name for the method
|
||||
- **description:** Rich explanation of what the method does, when to use it, and why it's valuable
|
||||
- **output_pattern:** Flexible flow guide using arrows (e.g., "analysis -> insights -> action")
|
||||
|
||||
#### Context Analysis
|
||||
|
||||
- Use conversation history
|
||||
- Analyze: content type, complexity, stakeholder needs, risk level, and creative potential
|
||||
|
||||
#### Smart Selection
|
||||
|
||||
1. Analyze context: Content type, complexity, stakeholder needs, risk level, creative potential
|
||||
2. Parse descriptions: Understand each method's purpose from the rich descriptions in CSV
|
||||
3. Select 5 methods: Choose methods that best match the context based on their descriptions
|
||||
4. Balance approach: Include mix of foundational and specialized techniques as appropriate
|
||||
|
||||
---
|
||||
|
||||
### Step 2: Present Options and Handle Responses
|
||||
|
||||
#### Display Format
|
||||
|
||||
```
|
||||
**Advanced Elicitation Options**
|
||||
_If party mode is active, agents will join in._
|
||||
Choose a number (1-5), [r] to Reshuffle, [a] List All, or [x] to Proceed:
|
||||
|
||||
1. [Method Name]
|
||||
2. [Method Name]
|
||||
3. [Method Name]
|
||||
4. [Method Name]
|
||||
5. [Method Name]
|
||||
r. Reshuffle the list with 5 new options
|
||||
a. List all methods with descriptions
|
||||
x. Proceed / No Further Actions
|
||||
```
|
||||
|
||||
#### Response Handling
|
||||
|
||||
**Case 1-5 (User selects a numbered method):**
|
||||
|
||||
- Execute the selected method using its description from the CSV
|
||||
- Adapt the method's complexity and output format based on the current context
|
||||
- Apply the method creatively to the current section content being enhanced
|
||||
- Display the enhanced version showing what the method revealed or improved
|
||||
- **CRITICAL:** Ask the user if they would like to apply the changes to the doc (y/n/other) and HALT to await response.
|
||||
- **CRITICAL:** ONLY if Yes, apply the changes. IF No, discard your memory of the proposed changes. If any other reply, try best to follow the instructions given by the user.
|
||||
- **CRITICAL:** Re-present the same 1-5,r,x prompt to allow additional elicitations
|
||||
|
||||
**Case r (Reshuffle):**
|
||||
|
||||
- Select 5 random methods from methods.csv, present new list with same prompt format
|
||||
- When selecting, try to think and pick a diverse set of methods covering different categories and approaches, with 1 and 2 being potentially the most useful for the document or section being discovered
|
||||
|
||||
**Case x (Proceed):**
|
||||
|
||||
- Complete elicitation and proceed
|
||||
- Return the fully enhanced content back to the invoking skill
|
||||
- The enhanced content becomes the final version for that section
|
||||
- Signal completion back to the invoking skill to continue with next section
|
||||
|
||||
**Case a (List All):**
|
||||
|
||||
- List all methods with their descriptions from the CSV in a compact table
|
||||
- Allow user to select any method by name or number from the full list
|
||||
- After selection, execute the method as described in the Case 1-5 above
|
||||
|
||||
**Case: Direct Feedback:**
|
||||
|
||||
- Apply changes to current section content and re-present choices
|
||||
|
||||
**Case: Multiple Numbers:**
|
||||
|
||||
- Execute methods in sequence on the content, then re-offer choices
|
||||
|
||||
---
|
||||
|
||||
### Step 3: Execution Guidelines
|
||||
|
||||
- **Method execution:** Use the description from CSV to understand and apply each method
|
||||
- **Output pattern:** Use the pattern as a flexible guide (e.g., "paths -> evaluation -> selection")
|
||||
- **Dynamic adaptation:** Adjust complexity based on content needs (simple to sophisticated)
|
||||
- **Creative application:** Interpret methods flexibly based on context while maintaining pattern consistency
|
||||
- Focus on actionable insights
|
||||
- **Stay relevant:** Tie elicitation to specific content being analyzed (the current section from the document being created unless user indicates otherwise)
|
||||
- **Identify personas:** For single or multi-persona methods, clearly identify viewpoints, and use party members if available in memory already
|
||||
- **Critical loop behavior:** Always re-offer the 1-5,r,a,x choices after each method execution
|
||||
- Continue until user selects 'x' to proceed with enhanced content, confirm or ask the user what should be accepted from the session
|
||||
- Each method application builds upon previous enhancements
|
||||
- **Content preservation:** Track all enhancements made during elicitation
|
||||
- **Iterative enhancement:** Each selected method (1-5) should:
|
||||
1. Apply to the current enhanced version of the content
|
||||
2. Show the improvements made
|
||||
3. Return to the prompt for additional elicitations or completion
|
||||
6
_bmad/core/skills/bmad-brainstorming/SKILL.md
Normal file
6
_bmad/core/skills/bmad-brainstorming/SKILL.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
name: bmad-brainstorming
|
||||
description: 'Facilitate interactive brainstorming sessions using diverse creative techniques and ideation methods. Use when the user says help me brainstorm or help me ideate.'
|
||||
---
|
||||
|
||||
Follow the instructions in ./workflow.md.
|
||||
@@ -0,0 +1 @@
|
||||
type: skill
|
||||
62
_bmad/core/skills/bmad-brainstorming/brain-methods.csv
Normal file
62
_bmad/core/skills/bmad-brainstorming/brain-methods.csv
Normal file
@@ -0,0 +1,62 @@
|
||||
category,technique_name,description
|
||||
collaborative,Yes And Building,"Build momentum through positive additions where each idea becomes a launching pad - use prompts like 'Yes and we could also...' or 'Building on that idea...' to create energetic collaborative flow that builds upon previous contributions"
|
||||
collaborative,Brain Writing Round Robin,"Silent idea generation followed by building on others' written concepts - gives quieter voices equal contribution while maintaining documentation through the sequence of writing silently, passing ideas, and building on received concepts"
|
||||
collaborative,Random Stimulation,"Use random words/images as creative catalysts to force unexpected connections - breaks through mental blocks with serendipitous inspiration by asking how random elements relate, what connections exist, and forcing relationships"
|
||||
collaborative,Role Playing,"Generate solutions from multiple stakeholder perspectives to build empathy while ensuring comprehensive consideration - embody different roles by asking what they want, how they'd approach problems, and what matters most to them"
|
||||
collaborative,Ideation Relay Race,"Rapid-fire idea building under time pressure creates urgency and breakthroughs - structure with 30-second additions, quick building on ideas, and fast passing to maintain creative momentum and prevent overthinking"
|
||||
creative,What If Scenarios,"Explore radical possibilities by questioning all constraints and assumptions - perfect for breaking through stuck thinking using prompts like 'What if we had unlimited resources?' 'What if the opposite were true?' or 'What if this problem didn't exist?'"
|
||||
creative,Analogical Thinking,"Find creative solutions by drawing parallels to other domains - transfer successful patterns by asking 'This is like what?' 'How is this similar to...' and 'What other examples come to mind?' to connect to existing solutions"
|
||||
creative,Reversal Inversion,"Deliberately flip problems upside down to reveal hidden assumptions and fresh angles - great when conventional approaches fail by asking 'What if we did the opposite?' 'How could we make this worse?' and 'What's the reverse approach?'"
|
||||
creative,First Principles Thinking,"Strip away assumptions to rebuild from fundamental truths - essential for breakthrough innovation by asking 'What do we know for certain?' 'What are the fundamental truths?' and 'If we started from scratch?'"
|
||||
creative,Forced Relationships,"Connect unrelated concepts to spark innovative bridges through creative collision - take two unrelated things, find connections between them, identify bridges, and explore how they could work together to generate unexpected solutions"
|
||||
creative,Time Shifting,"Explore solutions across different time periods to reveal constraints and opportunities by asking 'How would this work in the past?' 'What about 100 years from now?' 'Different era constraints?' and 'What time-based solutions apply?'"
|
||||
creative,Metaphor Mapping,"Use extended metaphors as thinking tools to explore problems from new angles - transforms abstract challenges into tangible narratives by asking 'This problem is like a metaphor,' extending the metaphor, and mapping elements to discover insights"
|
||||
creative,Cross-Pollination,"Transfer solutions from completely different industries or domains to spark breakthrough innovations by asking how industry X would solve this, what patterns work in field Y, and how to adapt solutions from domain Z"
|
||||
creative,Concept Blending,"Merge two or more existing concepts to create entirely new categories - goes beyond simple combination to genuine innovation by asking what emerges when concepts merge, what new category is created, and how the blend transcends original ideas"
|
||||
creative,Reverse Brainstorming,"Generate problems instead of solutions to identify hidden opportunities and unexpected pathways by asking 'What could go wrong?' 'How could we make this fail?' and 'What problems could we create?' to reveal solution insights"
|
||||
creative,Sensory Exploration,"Engage all five senses to discover multi-dimensional solution spaces beyond purely analytical thinking by asking what ideas feel, smell, taste, or sound like, and how different senses engage with the problem space"
|
||||
deep,Five Whys,"Drill down through layers of causation to uncover root causes - essential for solving problems at source rather than symptoms by asking 'Why did this happen?' repeatedly until reaching fundamental drivers and ultimate causes"
|
||||
deep,Morphological Analysis,"Systematically explore all possible parameter combinations for complex systems requiring comprehensive solution mapping - identify key parameters, list options for each, try different combinations, and identify emerging patterns"
|
||||
deep,Provocation Technique,"Use deliberately provocative statements to extract useful ideas from seemingly absurd starting points - catalyzes breakthrough thinking by asking 'What if provocative statement?' 'How could this be useful?' 'What idea triggers?' and 'Extract the principle'"
|
||||
deep,Assumption Reversal,"Challenge and flip core assumptions to rebuild from new foundations - essential for paradigm shifts by asking 'What assumptions are we making?' 'What if the opposite were true?' 'Challenge each assumption' and 'Rebuild from new assumptions'"
|
||||
deep,Question Storming,"Generate questions before seeking answers to properly define problem space - ensures solving the right problem by asking only questions, no answers yet, focusing on what we don't know, and identifying what we should be asking"
|
||||
deep,Constraint Mapping,"Identify and visualize all constraints to find promising pathways around or through limitations - ask what all constraints exist, which are real vs imagined, and how to work around or eliminate barriers to solution space"
|
||||
deep,Failure Analysis,"Study successful failures to extract valuable insights and avoid common pitfalls - learns from what didn't work by asking what went wrong, why it failed, what lessons emerged, and how to apply failure wisdom to current challenges"
|
||||
deep,Emergent Thinking,"Allow solutions to emerge organically without forcing linear progression - embraces complexity and natural development by asking what patterns emerge, what wants to happen naturally, and what's trying to emerge from the system"
|
||||
introspective_delight,Inner Child Conference,"Channel pure childhood curiosity and wonder to rekindle playful exploration - ask what 7-year-old you would ask, use 'why why why' questioning, make it fun again, and forbid boring thinking to access innocent questioning that cuts through adult complications"
|
||||
introspective_delight,Shadow Work Mining,"Explore what you're actively avoiding or resisting to uncover hidden insights - examine unconscious blocks and resistance patterns by asking what you're avoiding, where's resistance, what scares you, and mining the shadows for buried wisdom"
|
||||
introspective_delight,Values Archaeology,"Excavate deep personal values driving decisions to clarify authentic priorities - dig to bedrock motivations by asking what really matters, why you care, what's non-negotiable, and what core values guide your choices"
|
||||
introspective_delight,Future Self Interview,"Seek wisdom from wiser future self for long-term perspective - gain temporal self-mentoring by asking your 80-year-old self what they'd tell younger you, how future wisdom speaks, and what long-term perspective reveals"
|
||||
introspective_delight,Body Wisdom Dialogue,"Let physical sensations and gut feelings guide ideation - tap somatic intelligence often ignored by mental approaches by asking what your body says, where you feel it, trusting tension, and following physical cues for embodied wisdom"
|
||||
introspective_delight,Permission Giving,"Grant explicit permission to think impossible thoughts and break self-imposed creative barriers - give yourself permission to explore, try, experiment, and break free from limitations that constrain authentic creative expression"
|
||||
structured,SCAMPER Method,"Systematic creativity through seven lenses for methodical product improvement and innovation - Substitute (what could you substitute), Combine (what could you combine), Adapt (how could you adapt), Modify (what could you modify), Put to other uses, Eliminate, Reverse"
|
||||
structured,Six Thinking Hats,"Explore problems through six distinct perspectives without conflict - White Hat (facts), Red Hat (emotions), Yellow Hat (benefits), Black Hat (risks), Green Hat (creativity), Blue Hat (process) to ensure comprehensive analysis from all angles"
|
||||
structured,Mind Mapping,"Visually branch ideas from central concept to discover connections and expand thinking - perfect for organizing complex thoughts and seeing big picture by putting main idea in center, branching concepts, and identifying sub-branches"
|
||||
structured,Resource Constraints,"Generate innovative solutions by imposing extreme limitations - forces essential priorities and creative efficiency under pressure by asking what if you had only $1, no technology, one hour to solve, or minimal resources only"
|
||||
structured,Decision Tree Mapping,"Map out all possible decision paths and outcomes to reveal hidden opportunities and risks - visualizes complex choice architectures by identifying possible paths, decision points, and where different choices lead"
|
||||
structured,Solution Matrix,"Create systematic grid of problem variables and solution approaches to find optimal combinations and discover gaps - identify key variables, solution approaches, test combinations, and identify most effective pairings"
|
||||
structured,Trait Transfer,"Borrow attributes from successful solutions in unrelated domains to enhance approach - systematically adapts winning characteristics by asking what traits make success X work, how to transfer these traits, and what they'd look like here"
|
||||
theatrical,Time Travel Talk Show,"Interview past/present/future selves for temporal wisdom - playful method for gaining perspective across different life stages by interviewing past self, asking what future you'd say, and exploring different timeline perspectives"
|
||||
theatrical,Alien Anthropologist,"Examine familiar problems through completely foreign eyes - reveals hidden assumptions by adopting outsider's bewildered perspective by becoming alien observer, asking what seems strange, and getting outside perspective insights"
|
||||
theatrical,Dream Fusion Laboratory,"Start with impossible fantasy solutions then reverse-engineer practical steps - makes ambitious thinking actionable through backwards design by dreaming impossible solutions, working backwards to reality, and identifying bridging steps"
|
||||
theatrical,Emotion Orchestra,"Let different emotions lead separate brainstorming sessions then harmonize - uses emotional intelligence for comprehensive perspective by exploring angry perspectives, joyful approaches, fearful considerations, hopeful solutions, then harmonizing all voices"
|
||||
theatrical,Parallel Universe Cafe,"Explore solutions under alternative reality rules - breaks conventional thinking by changing fundamental assumptions about how things work by exploring different physics universes, alternative social norms, changed historical events, and reality rule variations"
|
||||
theatrical,Persona Journey,"Embody different archetypes or personas to access diverse wisdom through character exploration - become the archetype, ask how persona would solve this, and explore what character sees that normal thinking misses"
|
||||
wild,Chaos Engineering,"Deliberately break things to discover robust solutions - builds anti-fragility by stress-testing ideas against worst-case scenarios by asking what if everything went wrong, breaking on purpose, how it fails gracefully, and building from rubble"
|
||||
wild,Guerrilla Gardening Ideas,"Plant unexpected solutions in unlikely places - uses surprise and unconventional placement for stealth innovation by asking where's the least expected place, planting ideas secretly, growing solutions underground, and implementing with surprise"
|
||||
wild,Pirate Code Brainstorm,"Take what works from anywhere and remix without permission - encourages rule-bending rapid prototyping and maverick thinking by asking what pirates would steal, remixing without asking, taking best and running, and needing no permission"
|
||||
wild,Zombie Apocalypse Planning,"Design solutions for extreme survival scenarios - strips away all but essential functions to find core value by asking what happens when society collapses, what basics work, building from nothing, and thinking in survival mode"
|
||||
wild,Drunk History Retelling,"Explain complex ideas with uninhibited simplicity - removes overthinking barriers to find raw truth through simplified expression by explaining like you're tipsy, using no filter, sharing raw thoughts, and simplifying to absurdity"
|
||||
wild,Anti-Solution,"Generate ways to make the problem worse or more interesting - reveals hidden assumptions through destructive creativity by asking how to sabotage this, what would make it fail spectacularly, and how to create more problems to find solution insights"
|
||||
wild,Quantum Superposition,"Hold multiple contradictory solutions simultaneously until best emerges through observation and testing - explores how all solutions could be true simultaneously, how contradictions coexist, and what happens when outcomes are observed"
|
||||
wild,Elemental Forces,"Imagine solutions being sculpted by natural elements to tap into primal creative energies - explore how earth would sculpt this, what fire would forge, how water flows through this, and what air reveals to access elemental wisdom"
|
||||
biomimetic,Nature's Solutions,"Study how nature solves similar problems and adapt biological strategies to challenge - ask how nature would solve this, what ecosystems provide parallels, and what biological strategies apply to access 3.8 billion years of evolutionary wisdom"
|
||||
biomimetic,Ecosystem Thinking,"Analyze problem as ecosystem to identify symbiotic relationships, natural succession, and ecological principles - explore symbiotic relationships, natural succession application, and ecological principles for systems thinking"
|
||||
biomimetic,Evolutionary Pressure,"Apply evolutionary principles to gradually improve solutions through selective pressure and adaptation - ask how evolution would optimize this, what selective pressures apply, and how this adapts over time to harness natural selection wisdom"
|
||||
quantum,Observer Effect,"Recognize how observing and measuring solutions changes their behavior - uses quantum principles for innovation by asking how observing changes this, what measurement effects matter, and how to use observer effect advantageously"
|
||||
quantum,Entanglement Thinking,"Explore how different solution elements might be connected regardless of distance - reveals hidden relationships by asking what elements are entangled, how distant parts affect each other, and what hidden connections exist between solution components"
|
||||
quantum,Superposition Collapse,"Hold multiple potential solutions simultaneously until constraints force single optimal outcome - leverages quantum decision theory by asking what if all options were possible, what constraints force collapse, and which solution emerges when observed"
|
||||
cultural,Indigenous Wisdom,"Draw upon traditional knowledge systems and indigenous approaches overlooked by modern thinking - ask how specific cultures would approach this, what traditional knowledge applies, and what ancestral wisdom guides us to access overlooked problem-solving methods"
|
||||
cultural,Fusion Cuisine,"Mix cultural approaches and perspectives like fusion cuisine - creates innovation through cultural cross-pollination by asking what happens when mixing culture A with culture B, what cultural hybrids emerge, and what fusion creates"
|
||||
cultural,Ritual Innovation,"Apply ritual design principles to create transformative experiences and solutions - uses anthropological insights for human-centered design by asking what ritual would transform this, how to make it ceremonial, and what transformation this needs"
|
||||
cultural,Mythic Frameworks,"Use myths and archetypal stories as frameworks for understanding and solving problems - taps into collective unconscious by asking what myth parallels this, what archetypes are involved, and how mythic structure informs solution"
|
||||
|
@@ -0,0 +1,214 @@
|
||||
# Step 1: Session Setup and Continuation Detection
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- ✅ ALWAYS treat this as collaborative facilitation
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- 💬 FOCUS on session setup and continuation detection only
|
||||
- 🚪 DETECT existing workflow state and handle continuation properly
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show your analysis before taking any action
|
||||
- 💾 Initialize document and update frontmatter
|
||||
- 📖 Set up frontmatter `stepsCompleted: [1]` before loading next step
|
||||
- 🚫 FORBIDDEN to load next step until setup is complete
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Variables from workflow.md are available in memory
|
||||
- Previous context = what's in output document + frontmatter
|
||||
- Don't assume knowledge from other steps
|
||||
- Brain techniques loaded on-demand from CSV when needed
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Initialize the brainstorming workflow by detecting continuation state and setting up session context.
|
||||
|
||||
## INITIALIZATION SEQUENCE:
|
||||
|
||||
### 1. Check for Existing Sessions
|
||||
|
||||
First, check the brainstorming sessions folder for existing sessions:
|
||||
|
||||
- List all files in `{output_folder}/brainstorming/`
|
||||
- **DO NOT read any file contents** - only list filenames
|
||||
- If files exist, identify the most recent by date/time in the filename
|
||||
- If no files exist, this is a fresh workflow
|
||||
|
||||
### 2. Handle Existing Sessions (If Files Found)
|
||||
|
||||
If existing session files are found:
|
||||
|
||||
- Display the most recent session filename (do NOT read its content)
|
||||
- Ask the user: "Found existing session: `[filename]`. Would you like to:
|
||||
**[1]** Continue this session
|
||||
**[2]** Start a new session
|
||||
**[3]** See all existing sessions"
|
||||
|
||||
**HALT — wait for user selection before proceeding.**
|
||||
|
||||
- If user selects **[1]** (continue): Set `{brainstorming_session_output_file}` to that file path and load `./step-01b-continue.md`
|
||||
- If user selects **[2]** (new): Generate new filename with current date/time and proceed to step 3
|
||||
- If user selects **[3]** (see all): List all session filenames and ask which to continue or if new
|
||||
|
||||
### 3. Fresh Workflow Setup (If No Files or User Chooses New)
|
||||
|
||||
If no document exists or no `stepsCompleted` in frontmatter:
|
||||
|
||||
#### A. Initialize Document
|
||||
|
||||
Create the brainstorming session document:
|
||||
|
||||
```bash
|
||||
# Create directory if needed
|
||||
mkdir -p "$(dirname "{brainstorming_session_output_file}")"
|
||||
|
||||
# Initialize from template
|
||||
cp "../template.md" "{brainstorming_session_output_file}"
|
||||
```
|
||||
|
||||
#### B. Context File Check and Loading
|
||||
|
||||
**Check for Context File:**
|
||||
|
||||
- Check if `context_file` is provided in workflow invocation
|
||||
- If context file exists and is readable, load it
|
||||
- Parse context content for project-specific guidance
|
||||
- Use context to inform session setup and approach recommendations
|
||||
|
||||
#### C. Session Context Gathering
|
||||
|
||||
"Welcome {{user_name}}! I'm excited to facilitate your brainstorming session. I'll guide you through proven creativity techniques to generate innovative ideas and breakthrough solutions.
|
||||
|
||||
**Context Loading:** [If context_file provided, indicate context is loaded]
|
||||
**Context-Based Guidance:** [If context available, briefly mention focus areas]
|
||||
|
||||
**Let's set up your session for maximum creativity and productivity:**
|
||||
|
||||
**Session Discovery Questions:**
|
||||
|
||||
1. **What are we brainstorming about?** (The central topic or challenge)
|
||||
2. **What specific outcomes are you hoping for?** (Types of ideas, solutions, or insights)"
|
||||
|
||||
#### D. Process User Responses
|
||||
|
||||
Wait for user responses, then:
|
||||
|
||||
**Session Analysis:**
|
||||
"Based on your responses, I understand we're focusing on **[summarized topic]** with goals around **[summarized objectives]**.
|
||||
|
||||
**Session Parameters:**
|
||||
|
||||
- **Topic Focus:** [Clear topic articulation]
|
||||
- **Primary Goals:** [Specific outcome objectives]
|
||||
|
||||
**Does this accurately capture what you want to achieve?**"
|
||||
|
||||
#### E. Update Frontmatter and Document
|
||||
|
||||
Update the document frontmatter:
|
||||
|
||||
```yaml
|
||||
---
|
||||
stepsCompleted: [1]
|
||||
inputDocuments: []
|
||||
session_topic: '[session_topic]'
|
||||
session_goals: '[session_goals]'
|
||||
selected_approach: ''
|
||||
techniques_used: []
|
||||
ideas_generated: []
|
||||
context_file: '[context_file if provided]'
|
||||
---
|
||||
```
|
||||
|
||||
Append to document:
|
||||
|
||||
```markdown
|
||||
## Session Overview
|
||||
|
||||
**Topic:** [session_topic]
|
||||
**Goals:** [session_goals]
|
||||
|
||||
### Context Guidance
|
||||
|
||||
_[If context file provided, summarize key context and focus areas]_
|
||||
|
||||
### Session Setup
|
||||
|
||||
_[Content based on conversation about session parameters and facilitator approach]_
|
||||
```
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects approach, append the session overview content directly to `{brainstorming_session_output_file}` using the structure from above.
|
||||
|
||||
### E. Continue to Technique Selection
|
||||
|
||||
"**Session setup complete!** I have a clear understanding of your goals and can select the perfect techniques for your brainstorming needs.
|
||||
|
||||
**Ready to explore technique approaches?**
|
||||
[1] User-Selected Techniques - Browse our complete technique library
|
||||
[2] AI-Recommended Techniques - Get customized suggestions based on your goals
|
||||
[3] Random Technique Selection - Discover unexpected creative methods
|
||||
[4] Progressive Technique Flow - Start broad, then systematically narrow focus
|
||||
|
||||
Which approach appeals to you most? (Enter 1-4)"
|
||||
|
||||
**HALT — wait for user selection before proceeding.**
|
||||
|
||||
### 4. Handle User Selection and Initial Document Append
|
||||
|
||||
#### When user selects approach number:
|
||||
|
||||
- **Append initial session overview to `{brainstorming_session_output_file}`**
|
||||
- **Update frontmatter:** `stepsCompleted: [1]`, `selected_approach: '[selected approach]'`
|
||||
- **Load the appropriate step-02 file** based on selection
|
||||
|
||||
### 5. Handle User Selection
|
||||
|
||||
After user selects approach number:
|
||||
|
||||
- **If 1:** Load `./step-02a-user-selected.md`
|
||||
- **If 2:** Load `./step-02b-ai-recommended.md`
|
||||
- **If 3:** Load `./step-02c-random-selection.md`
|
||||
- **If 4:** Load `./step-02d-progressive-flow.md`
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Existing sessions detected without reading file contents
|
||||
✅ User prompted to continue existing session or start new
|
||||
✅ Correct session file selected for continuation
|
||||
✅ Fresh workflow initialized with correct document structure
|
||||
✅ Session context gathered and understood clearly
|
||||
✅ User's approach selection captured and routed correctly
|
||||
✅ Frontmatter properly updated with session state
|
||||
✅ Document initialized with session overview section
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Reading file contents during session detection (wastes context)
|
||||
❌ Not asking user before continuing existing session
|
||||
❌ Not properly routing user's continue/new session selection
|
||||
❌ Missing continuation detection leading to duplicate work
|
||||
❌ Insufficient session context gathering
|
||||
❌ Not properly routing user's approach selection
|
||||
❌ Frontmatter not updated with session parameters
|
||||
|
||||
## SESSION SETUP PROTOCOLS:
|
||||
|
||||
- Always list sessions folder WITHOUT reading file contents
|
||||
- Ask user before continuing any existing session
|
||||
- Only load continue step after user confirms
|
||||
- Load brain techniques CSV only when needed for technique presentation
|
||||
- Use collaborative facilitation language throughout
|
||||
- Maintain psychological safety for creative exploration
|
||||
- Clear next-step routing based on user preferences
|
||||
|
||||
## NEXT STEPS:
|
||||
|
||||
Based on user's approach selection, load the appropriate step-02 file for technique selection and facilitation.
|
||||
|
||||
Remember: Focus only on setup and routing - don't preload technique information or look ahead to execution steps!
|
||||
124
_bmad/core/skills/bmad-brainstorming/steps/step-01b-continue.md
Normal file
124
_bmad/core/skills/bmad-brainstorming/steps/step-01b-continue.md
Normal file
@@ -0,0 +1,124 @@
|
||||
# Step 1b: Workflow Continuation
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- ✅ YOU ARE A CONTINUATION FACILITATOR, not a fresh starter
|
||||
- 🎯 RESPECT EXISTING WORKFLOW state and progress
|
||||
- 📋 UNDERSTAND PREVIOUS SESSION context and outcomes
|
||||
- 🔍 SEAMLESSLY RESUME from where user left off
|
||||
- 💬 MAINTAIN CONTINUITY in session flow and rapport
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Load and analyze existing document thoroughly
|
||||
- 💾 Update frontmatter with continuation state
|
||||
- 📖 Present current status and next options clearly
|
||||
- 🚫 FORBIDDEN repeating completed work or asking same questions
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Existing document with frontmatter is available
|
||||
- Previous steps completed indicate session progress
|
||||
- Brain techniques CSV loaded when needed for remaining steps
|
||||
- User may want to continue, modify, or restart
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Analyze existing brainstorming session state and provide seamless continuation options.
|
||||
|
||||
## CONTINUATION SEQUENCE:
|
||||
|
||||
### 1. Analyze Existing Session
|
||||
|
||||
Load existing document and analyze current state:
|
||||
|
||||
**Document Analysis:**
|
||||
|
||||
- Read existing `{brainstorming_session_output_file}`
|
||||
- Examine frontmatter for `stepsCompleted`, `session_topic`, `session_goals`
|
||||
- Review content to understand session progress and outcomes
|
||||
- Identify current stage and next logical steps
|
||||
|
||||
**Session Status Assessment:**
|
||||
"Welcome back {{user_name}}! I can see your brainstorming session on **[session_topic]** from **[date]**.
|
||||
|
||||
**Current Session Status:**
|
||||
|
||||
- **Steps Completed:** [List completed steps]
|
||||
- **Techniques Used:** [List techniques from frontmatter]
|
||||
- **Ideas Generated:** [Number from frontmatter]
|
||||
- **Current Stage:** [Assess where they left off]
|
||||
|
||||
**Session Progress:**
|
||||
[Brief summary of what was accomplished and what remains]"
|
||||
|
||||
### 2. Present Continuation Options
|
||||
|
||||
Based on session analysis, provide appropriate options:
|
||||
|
||||
**If Session Completed:**
|
||||
"Your brainstorming session appears to be complete!
|
||||
|
||||
**Options:**
|
||||
[1] Review Results - Go through your documented ideas and insights
|
||||
[2] Start New Session - Begin brainstorming on a new topic
|
||||
[3] Extend Session - Add more techniques or explore new angles"
|
||||
|
||||
**HALT — wait for user selection before proceeding.**
|
||||
|
||||
**If Session In Progress:**
|
||||
"Let's continue where we left off!
|
||||
|
||||
**Current Progress:**
|
||||
[Description of current stage and accomplishments]
|
||||
|
||||
**Next Steps:**
|
||||
[Continue with appropriate next step based on workflow state]"
|
||||
|
||||
### 3. Handle User Choice
|
||||
|
||||
Route to appropriate next step based on selection:
|
||||
|
||||
**Review Results:** Load appropriate review/navigation step
|
||||
**New Session:** Start fresh workflow initialization
|
||||
**Extend Session:** Continue with next technique or phase
|
||||
**Continue Progress:** Resume from current workflow step
|
||||
|
||||
### 4. Update Session State
|
||||
|
||||
Update frontmatter to reflect continuation:
|
||||
|
||||
```yaml
|
||||
---
|
||||
stepsCompleted: [existing_steps]
|
||||
session_continued: true
|
||||
continuation_date: { { current_date } }
|
||||
---
|
||||
```
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Existing session state accurately analyzed and understood
|
||||
✅ Seamless continuation without loss of context or rapport
|
||||
✅ Appropriate continuation options presented based on progress
|
||||
✅ User choice properly routed to next workflow step
|
||||
✅ Session continuity maintained throughout interaction
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Not properly analyzing existing document state
|
||||
❌ Asking user to repeat information already provided
|
||||
❌ Losing continuity in session flow or context
|
||||
❌ Not providing appropriate continuation options
|
||||
|
||||
## CONTINUATION PROTOCOLS:
|
||||
|
||||
- Always acknowledge previous work and progress
|
||||
- Maintain established rapport and session dynamics
|
||||
- Build upon existing ideas and insights rather than starting over
|
||||
- Respect user's time by avoiding repetitive questions
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
Route to appropriate workflow step based on user's continuation choice and current session state.
|
||||
@@ -0,0 +1,229 @@
|
||||
# Step 2a: User-Selected Techniques
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- ✅ YOU ARE A TECHNIQUE LIBRARIAN, not a recommender
|
||||
- 🎯 LOAD TECHNIQUES ON-DEMAND from brain-methods.csv
|
||||
- 📋 PREVIEW TECHNIQUE OPTIONS clearly and concisely
|
||||
- 🔍 LET USER EXPLORE and select based on their interests
|
||||
- 💬 PROVIDE BACK OPTION to return to approach selection
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Load brain techniques CSV only when needed for presentation
|
||||
- ⚠️ Present [B] back option and [C] continue options
|
||||
- 💾 Update frontmatter with selected techniques
|
||||
- 📖 Route to technique execution after confirmation
|
||||
- 🚫 FORBIDDEN making recommendations or steering choices
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Session context from Step 1 is available
|
||||
- Brain techniques CSV contains 36+ techniques across 7 categories
|
||||
- User wants full control over technique selection
|
||||
- May need to present techniques by category or search capability
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Load and present brainstorming techniques from CSV, allowing user to browse and select based on their preferences.
|
||||
|
||||
## USER SELECTION SEQUENCE:
|
||||
|
||||
### 1. Load Brain Techniques Library
|
||||
|
||||
Load techniques from CSV on-demand:
|
||||
|
||||
"Perfect! Let's explore our complete brainstorming techniques library. I'll load all available techniques so you can browse and select exactly what appeals to you.
|
||||
|
||||
**Loading Brain Techniques Library...**"
|
||||
|
||||
**Load CSV and parse:**
|
||||
|
||||
- Read `../brain-methods.csv`
|
||||
- Parse: category, technique_name, description, facilitation_prompts, best_for, energy_level, typical_duration
|
||||
- Organize by categories for browsing
|
||||
|
||||
### 2. Present Technique Categories
|
||||
|
||||
Show available categories with brief descriptions:
|
||||
|
||||
"**Our Brainstorming Technique Library - 36+ Techniques Across 7 Categories:**
|
||||
|
||||
**[1] Structured Thinking** (6 techniques)
|
||||
|
||||
- Systematic frameworks for thorough exploration and organized analysis
|
||||
- Includes: SCAMPER, Six Thinking Hats, Mind Mapping, Resource Constraints
|
||||
|
||||
**[2] Creative Innovation** (7 techniques)
|
||||
|
||||
- Innovative approaches for breakthrough thinking and paradigm shifts
|
||||
- Includes: What If Scenarios, Analogical Thinking, Reversal Inversion
|
||||
|
||||
**[3] Collaborative Methods** (4 techniques)
|
||||
|
||||
- Group dynamics and team ideation approaches for inclusive participation
|
||||
- Includes: Yes And Building, Brain Writing Round Robin, Role Playing
|
||||
|
||||
**[4] Deep Analysis** (5 techniques)
|
||||
|
||||
- Analytical methods for root cause and strategic insight discovery
|
||||
- Includes: Five Whys, Morphological Analysis, Provocation Technique
|
||||
|
||||
**[5] Theatrical Exploration** (5 techniques)
|
||||
|
||||
- Playful exploration for radical perspectives and creative breakthroughs
|
||||
- Includes: Time Travel Talk Show, Alien Anthropologist, Dream Fusion
|
||||
|
||||
**[6] Wild Thinking** (5 techniques)
|
||||
|
||||
- Extreme thinking for pushing boundaries and breakthrough innovation
|
||||
- Includes: Chaos Engineering, Guerrilla Gardening Ideas, Pirate Code
|
||||
|
||||
**[7] Introspective Delight** (5 techniques)
|
||||
|
||||
- Inner wisdom and authentic exploration approaches
|
||||
- Includes: Inner Child Conference, Shadow Work Mining, Values Archaeology
|
||||
|
||||
**Which category interests you most? Enter 1-7, or tell me what type of thinking you're drawn to.**"
|
||||
|
||||
**HALT — wait for user selection before proceeding.**
|
||||
|
||||
### 3. Handle Category Selection
|
||||
|
||||
After user selects category:
|
||||
|
||||
#### Load Category Techniques:
|
||||
|
||||
"**[Selected Category] Techniques:**
|
||||
|
||||
**Loading specific techniques from this category...**"
|
||||
|
||||
**Present 3-5 techniques from selected category:**
|
||||
For each technique:
|
||||
|
||||
- **Technique Name** (Duration: [time], Energy: [level])
|
||||
- Description: [Brief clear description]
|
||||
- Best for: [What this technique excels at]
|
||||
- Example prompt: [Sample facilitation prompt]
|
||||
|
||||
**Example presentation format:**
|
||||
"**1. SCAMPER Method** (Duration: 20-30 min, Energy: Moderate)
|
||||
|
||||
- Systematic creativity through seven lenses (Substitute/Combine/Adapt/Modify/Put/Eliminate/Reverse)
|
||||
- Best for: Product improvement, innovation challenges, systematic idea generation
|
||||
- Example prompt: "What could you substitute in your current approach to create something new?"
|
||||
|
||||
**2. Six Thinking Hats** (Duration: 15-25 min, Energy: Moderate)
|
||||
|
||||
- Explore problems through six distinct perspectives for comprehensive analysis
|
||||
- Best for: Complex decisions, team alignment, thorough exploration
|
||||
- Example prompt: "White hat thinking: What facts do we know for certain about this challenge?"
|
||||
|
||||
### 4. Allow Technique Selection
|
||||
|
||||
"**Which techniques from this category appeal to you?**
|
||||
|
||||
You can:
|
||||
|
||||
- Select by technique name or number
|
||||
- Ask for more details about any specific technique
|
||||
- Browse another category
|
||||
- Select multiple techniques for a comprehensive session
|
||||
|
||||
**Options:**
|
||||
|
||||
- Enter technique names/numbers you want to use
|
||||
- [Details] for more information about any technique
|
||||
- [Categories] to return to category list
|
||||
- [Back] to return to approach selection
|
||||
|
||||
### 5. Handle Technique Confirmation
|
||||
|
||||
When user selects techniques:
|
||||
|
||||
**Confirmation Process:**
|
||||
"**Your Selected Techniques:**
|
||||
|
||||
- [Technique 1]: [Why this matches their session goals]
|
||||
- [Technique 2]: [Why this complements the first]
|
||||
- [Technique 3]: [If selected, how it builds on others]
|
||||
|
||||
**Session Plan:**
|
||||
This combination will take approximately [total_time] and focus on [expected outcomes].
|
||||
|
||||
**Confirm these choices?**
|
||||
[C] Continue - Begin technique execution
|
||||
[Back] - Modify technique selection"
|
||||
|
||||
**HALT — wait for user selection before proceeding.**
|
||||
|
||||
### 6. Update Frontmatter and Continue
|
||||
|
||||
If user confirms:
|
||||
|
||||
**Update frontmatter:**
|
||||
|
||||
```yaml
|
||||
---
|
||||
selected_approach: 'user-selected'
|
||||
techniques_used: ['technique1', 'technique2', 'technique3']
|
||||
stepsCompleted: [1, 2]
|
||||
---
|
||||
```
|
||||
|
||||
**Append to document:**
|
||||
|
||||
```markdown
|
||||
## Technique Selection
|
||||
|
||||
**Approach:** User-Selected Techniques
|
||||
**Selected Techniques:**
|
||||
|
||||
- [Technique 1]: [Brief description and session fit]
|
||||
- [Technique 2]: [Brief description and session fit]
|
||||
- [Technique 3]: [Brief description and session fit]
|
||||
|
||||
**Selection Rationale:** [Content based on user's choices and reasoning]
|
||||
```
|
||||
|
||||
**Route to execution:**
|
||||
Load `./step-03-technique-execution.md`
|
||||
|
||||
### 7. Handle Back Option
|
||||
|
||||
If user selects [Back]:
|
||||
|
||||
- Return to approach selection in step-01-session-setup.md
|
||||
- Maintain session context and preferences
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Brain techniques CSV loaded successfully on-demand
|
||||
✅ Technique categories presented clearly with helpful descriptions
|
||||
✅ User able to browse and select techniques based on interests
|
||||
✅ Selected techniques confirmed with session fit explanation
|
||||
✅ Frontmatter updated with technique selections
|
||||
✅ Proper routing to technique execution or back navigation
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Preloading all techniques instead of loading on-demand
|
||||
❌ Making recommendations instead of letting user explore
|
||||
❌ Not providing enough detail for informed selection
|
||||
❌ Missing back navigation option
|
||||
❌ Not updating frontmatter with technique selections
|
||||
|
||||
## USER SELECTION PROTOCOLS:
|
||||
|
||||
- Present techniques neutrally without steering or preference
|
||||
- Load CSV data only when needed for category/technique presentation
|
||||
- Provide sufficient detail for informed choices without overwhelming
|
||||
- Always maintain option to return to previous steps
|
||||
- Respect user's autonomy in technique selection
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After technique confirmation, load `./step-03-technique-execution.md` to begin facilitating the selected brainstorming techniques.
|
||||
|
||||
Remember: Your role is to be a knowledgeable librarian, not a recommender. Let the user explore and choose based on their interests and intuition!
|
||||
@@ -0,0 +1,239 @@
|
||||
# Step 2b: AI-Recommended Techniques
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- ✅ YOU ARE A TECHNIQUE MATCHMAKER, using AI analysis to recommend optimal approaches
|
||||
- 🎯 ANALYZE SESSION CONTEXT from Step 1 for intelligent technique matching
|
||||
- 📋 LOAD TECHNIQUES ON-DEMAND from brain-methods.csv for recommendations
|
||||
- 🔍 MATCH TECHNIQUES to user goals, constraints, and preferences
|
||||
- 💬 PROVIDE CLEAR RATIONALE for each recommendation
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Load brain techniques CSV only when needed for analysis
|
||||
- ⚠️ Present [B] back option and [C] continue options
|
||||
- 💾 Update frontmatter with recommended techniques
|
||||
- 📖 Route to technique execution after user confirmation
|
||||
- 🚫 FORBIDDEN generic recommendations without context analysis
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Session context (`session_topic`, `session_goals`, constraints) from Step 1
|
||||
- Brain techniques CSV with 36+ techniques across 7 categories
|
||||
- User wants expert guidance in technique selection
|
||||
- Must analyze multiple factors for optimal matching
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Analyze session context and recommend optimal brainstorming techniques based on user's specific goals and constraints.
|
||||
|
||||
## AI RECOMMENDATION SEQUENCE:
|
||||
|
||||
### 1. Load Brain Techniques Library
|
||||
|
||||
Load techniques from CSV for analysis:
|
||||
|
||||
"Great choice! Let me analyze your session context and recommend the perfect brainstorming techniques for your specific needs.
|
||||
|
||||
**Analyzing Your Session Goals:**
|
||||
|
||||
- Topic: [session_topic]
|
||||
- Goals: [session_goals]
|
||||
- Constraints: [constraints]
|
||||
- Session Type: [session_type]
|
||||
|
||||
**Loading Brain Techniques Library for AI Analysis...**"
|
||||
|
||||
**Load CSV and parse:**
|
||||
|
||||
- Read `../brain-methods.csv`
|
||||
- Parse: category, technique_name, description, facilitation_prompts, best_for, energy_level, typical_duration
|
||||
|
||||
### 2. Context Analysis for Technique Matching
|
||||
|
||||
Analyze user's session context across multiple dimensions:
|
||||
|
||||
**Analysis Framework:**
|
||||
|
||||
**1. Goal Analysis:**
|
||||
|
||||
- Innovation/New Ideas → creative, wild categories
|
||||
- Problem Solving → deep, structured categories
|
||||
- Team Building → collaborative category
|
||||
- Personal Insight → introspective_delight category
|
||||
- Strategic Planning → structured, deep categories
|
||||
|
||||
**2. Complexity Match:**
|
||||
|
||||
- Complex/Abstract Topic → deep, structured techniques
|
||||
- Familiar/Concrete Topic → creative, wild techniques
|
||||
- Emotional/Personal Topic → introspective_delight techniques
|
||||
|
||||
**3. Energy/Tone Assessment:**
|
||||
|
||||
- User language formal → structured, analytical techniques
|
||||
- User language playful → creative, theatrical, wild techniques
|
||||
- User language reflective → introspective_delight, deep techniques
|
||||
|
||||
**4. Time Available:**
|
||||
|
||||
- <30 min → 1-2 focused techniques
|
||||
- 30-60 min → 2-3 complementary techniques
|
||||
- > 60 min → Multi-phase technique flow
|
||||
|
||||
### 3. Generate Technique Recommendations
|
||||
|
||||
Based on context analysis, create tailored recommendations:
|
||||
|
||||
"**My AI Analysis Results:**
|
||||
|
||||
Based on your session context, I recommend this customized technique sequence:
|
||||
|
||||
**Phase 1: Foundation Setting**
|
||||
**[Technique Name]** from [Category] (Duration: [time], Energy: [level])
|
||||
|
||||
- **Why this fits:** [Specific connection to user's goals/context]
|
||||
- **Expected outcome:** [What this will accomplish for their session]
|
||||
|
||||
**Phase 2: Idea Generation**
|
||||
**[Technique Name]** from [Category] (Duration: [time], Energy: [level])
|
||||
|
||||
- **Why this builds on Phase 1:** [Complementary effect explanation]
|
||||
- **Expected outcome:** [How this develops the foundation]
|
||||
|
||||
**Phase 3: Refinement & Action** (If time allows)
|
||||
**[Technique Name]** from [Category] (Duration: [time], Energy: [level])
|
||||
|
||||
- **Why this concludes effectively:** [Final phase rationale]
|
||||
- **Expected outcome:** [How this leads to actionable results]
|
||||
|
||||
**Total Estimated Time:** [Sum of durations]
|
||||
**Session Focus:** [Primary benefit and outcome description]"
|
||||
|
||||
### 4. Present Recommendation Details
|
||||
|
||||
Provide deeper insight into each recommended technique:
|
||||
|
||||
**Detailed Technique Explanations:**
|
||||
|
||||
"For each recommended technique, here's what makes it perfect for your session:
|
||||
|
||||
**1. [Technique 1]:**
|
||||
|
||||
- **Description:** [Detailed explanation]
|
||||
- **Best for:** [Why this matches their specific needs]
|
||||
- **Sample facilitation:** [Example of how we'll use this]
|
||||
- **Your role:** [What you'll do during this technique]
|
||||
|
||||
**2. [Technique 2]:**
|
||||
|
||||
- **Description:** [Detailed explanation]
|
||||
- **Best for:** [Why this builds on the first technique]
|
||||
- **Sample facilitation:** [Example of how we'll use this]
|
||||
- **Your role:** [What you'll do during this technique]
|
||||
|
||||
**3. [Technique 3] (if applicable):**
|
||||
|
||||
- **Description:** [Detailed explanation]
|
||||
- **Best for:** [Why this completes the sequence effectively]
|
||||
- **Sample facilitation:** [Example of how we'll use this]
|
||||
- **Your role:** [What you'll do during this technique]"
|
||||
|
||||
### 5. Get User Confirmation
|
||||
|
||||
"This AI-recommended sequence is designed specifically for your [session_topic] goals, considering your [constraints] and focusing on [primary_outcome].
|
||||
|
||||
**Does this approach sound perfect for your session?**
|
||||
|
||||
**Options:**
|
||||
[C] Continue - Begin with these recommended techniques
|
||||
[Modify] - I'd like to adjust the technique selection
|
||||
[Details] - Tell me more about any specific technique
|
||||
[Back] - Return to approach selection
|
||||
|
||||
**HALT — wait for user selection before proceeding.**
|
||||
|
||||
### 6. Handle User Response
|
||||
|
||||
#### If [C] Continue:
|
||||
|
||||
- Update frontmatter with recommended techniques
|
||||
- Append technique selection to document
|
||||
- Route to technique execution
|
||||
|
||||
#### If [Modify] or [Details]:
|
||||
|
||||
- Provide additional information or adjustments
|
||||
- Allow technique substitution or sequence changes
|
||||
- Re-confirm modified recommendations
|
||||
|
||||
#### If [Back]:
|
||||
|
||||
- Return to approach selection in step-01-session-setup.md
|
||||
- Maintain session context and preferences
|
||||
|
||||
### 7. Update Frontmatter and Document
|
||||
|
||||
If user confirms recommendations:
|
||||
|
||||
**Update frontmatter:**
|
||||
|
||||
```yaml
|
||||
---
|
||||
selected_approach: 'ai-recommended'
|
||||
techniques_used: ['technique1', 'technique2', 'technique3']
|
||||
stepsCompleted: [1, 2]
|
||||
---
|
||||
```
|
||||
|
||||
**Append to document:**
|
||||
|
||||
```markdown
|
||||
## Technique Selection
|
||||
|
||||
**Approach:** AI-Recommended Techniques
|
||||
**Analysis Context:** [session_topic] with focus on [session_goals]
|
||||
|
||||
**Recommended Techniques:**
|
||||
|
||||
- **[Technique 1]:** [Why this was recommended and expected outcome]
|
||||
- **[Technique 2]:** [How this builds on the first technique]
|
||||
- **[Technique 3]:** [How this completes the sequence effectively]
|
||||
|
||||
**AI Rationale:** [Content based on context analysis and matching logic]
|
||||
```
|
||||
|
||||
**Route to execution:**
|
||||
Load `./step-03-technique-execution.md`
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Session context analyzed thoroughly across multiple dimensions
|
||||
✅ Technique recommendations clearly matched to user's specific needs
|
||||
✅ Detailed explanations provided for each recommended technique
|
||||
✅ User confirmation obtained before proceeding to execution
|
||||
✅ Frontmatter updated with AI-recommended techniques
|
||||
✅ Proper routing to technique execution or back navigation
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Generic recommendations without specific context analysis
|
||||
❌ Not explaining rationale behind technique selections
|
||||
❌ Missing option for user to modify or question recommendations
|
||||
❌ Not loading techniques from CSV for accurate recommendations
|
||||
❌ Not updating frontmatter with selected techniques
|
||||
|
||||
## AI RECOMMENDATION PROTOCOLS:
|
||||
|
||||
- Analyze session context systematically across multiple factors
|
||||
- Provide clear rationale linking recommendations to user's goals
|
||||
- Allow user input and modification of recommendations
|
||||
- Load accurate technique data from CSV for informed analysis
|
||||
- Balance expertise with user autonomy in final selection
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user confirmation, load `./step-03-technique-execution.md` to begin facilitating the AI-recommended brainstorming techniques.
|
||||
|
||||
Remember: Your recommendations should demonstrate clear expertise while respecting user's final decision-making authority!
|
||||
@@ -0,0 +1,211 @@
|
||||
# Step 2c: Random Technique Selection
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- ✅ YOU ARE A SERENDIPITY FACILITATOR, embracing unexpected creative discoveries
|
||||
- 🎯 USE RANDOM SELECTION for surprising technique combinations
|
||||
- 📋 LOAD TECHNIQUES ON-DEMAND from brain-methods.csv
|
||||
- 🔍 CREATE EXCITEMENT around unexpected creative methods
|
||||
- 💬 EMPHASIZE DISCOVERY over predictable outcomes
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Load brain techniques CSV only when needed for random selection
|
||||
- ⚠️ Present [B] back option and [C] continue options
|
||||
- 💾 Update frontmatter with randomly selected techniques
|
||||
- 📖 Route to technique execution after user confirmation
|
||||
- 🚫 FORBIDDEN steering random selections or second-guessing outcomes
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Session context from Step 1 available for basic filtering
|
||||
- Brain techniques CSV with 36+ techniques across 7 categories
|
||||
- User wants surprise and unexpected creative methods
|
||||
- Randomness should create complementary, not contradictory, combinations
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Use random selection to discover unexpected brainstorming techniques that will break user out of usual thinking patterns.
|
||||
|
||||
## RANDOM SELECTION SEQUENCE:
|
||||
|
||||
### 1. Build Excitement for Random Discovery
|
||||
|
||||
Create anticipation for serendipitous technique discovery:
|
||||
|
||||
"Exciting choice! You've chosen the path of creative serendipity. Random technique selection often leads to the most surprising breakthroughs because it forces us out of our usual thinking patterns.
|
||||
|
||||
**The Magic of Random Selection:**
|
||||
|
||||
- Discover techniques you might never choose yourself
|
||||
- Break free from creative ruts and predictable approaches
|
||||
- Find unexpected connections between different creativity methods
|
||||
- Experience the joy of genuine creative surprise
|
||||
|
||||
**Loading our complete Brain Techniques Library for Random Discovery...**"
|
||||
|
||||
**Load CSV and parse:**
|
||||
|
||||
- Read `../brain-methods.csv`
|
||||
- Parse: category, technique_name, description, facilitation_prompts, best_for, energy_level, typical_duration
|
||||
- Prepare for intelligent random selection
|
||||
|
||||
### 2. Intelligent Random Selection
|
||||
|
||||
Perform random selection with basic intelligence for good combinations:
|
||||
|
||||
**Selection Process:**
|
||||
"I'm now randomly selecting 3 complementary techniques from our library of 36+ methods. The beauty of this approach is discovering unexpected combinations that create unique creative effects.
|
||||
|
||||
**Randomizing Technique Selection...**"
|
||||
|
||||
**Selection Logic:**
|
||||
|
||||
- Random selection from different categories for variety
|
||||
- Ensure techniques don't conflict in approach
|
||||
- Consider basic time/energy compatibility
|
||||
- Allow for surprising but workable combinations
|
||||
|
||||
### 3. Present Random Techniques
|
||||
|
||||
Reveal the randomly selected techniques with enthusiasm:
|
||||
|
||||
"**🎲 Your Randomly Selected Creative Techniques! 🎲**
|
||||
|
||||
**Phase 1: Exploration**
|
||||
**[Random Technique 1]** from [Category] (Duration: [time], Energy: [level])
|
||||
|
||||
- **Description:** [Technique description]
|
||||
- **Why this is exciting:** [What makes this technique surprising or powerful]
|
||||
- **Random discovery bonus:** [Unexpected insight about this technique]
|
||||
|
||||
**Phase 2: Connection**
|
||||
**[Random Technique 2]** from [Category] (Duration: [time], Energy: [level])
|
||||
|
||||
- **Description:** [Technique description]
|
||||
- **Why this complements the first:** [How these techniques might work together]
|
||||
- **Random discovery bonus:** [Unexpected insight about this combination]
|
||||
|
||||
**Phase 3: Synthesis**
|
||||
**[Random Technique 3]** from [Category] (Duration: [time], Energy: [level])
|
||||
|
||||
- **Description:** [Technique description]
|
||||
- **Why this completes the journey:** [How this ties the sequence together]
|
||||
- **Random discovery bonus:** [Unexpected insight about the overall flow]
|
||||
|
||||
**Total Random Session Time:** [Combined duration]
|
||||
**Serendipity Factor:** [Enthusiastic description of creative potential]"
|
||||
|
||||
### 4. Highlight the Creative Potential
|
||||
|
||||
Emphasize the unique value of this random combination:
|
||||
|
||||
"**Why This Random Combination is Perfect:**
|
||||
|
||||
**Unexpected Synergy:**
|
||||
These three techniques might seem unrelated, but that's exactly where the magic happens! [Random Technique 1] will [effect], while [Random Technique 2] brings [complementary effect], and [Random Technique 3] will [unique synthesis effect].
|
||||
|
||||
**Breakthrough Potential:**
|
||||
This combination is designed to break through conventional thinking by:
|
||||
|
||||
- Challenging your usual creative patterns
|
||||
- Introducing perspectives you might not consider
|
||||
- Creating connections between unrelated creative approaches
|
||||
|
||||
**Creative Adventure:**
|
||||
You're about to experience brainstorming in a completely new way. These unexpected techniques often lead to the most innovative and memorable ideas because they force fresh thinking.
|
||||
|
||||
**Ready for this creative adventure?**
|
||||
|
||||
**Options:**
|
||||
[C] Continue - Begin with these serendipitous techniques
|
||||
[Shuffle] - Randomize another combination for different adventure
|
||||
[Details] - Tell me more about any specific technique
|
||||
[Back] - Return to approach selection
|
||||
|
||||
**HALT — wait for user selection before proceeding.**
|
||||
|
||||
### 5. Handle User Response
|
||||
|
||||
#### If [C] Continue:
|
||||
|
||||
- Update frontmatter with randomly selected techniques
|
||||
- Append random selection story to document
|
||||
- Route to technique execution
|
||||
|
||||
#### If [Shuffle]:
|
||||
|
||||
- Generate new random selection
|
||||
- Present as a "different creative adventure"
|
||||
- Compare to previous selection if user wants
|
||||
|
||||
#### If [Details] or [Back]:
|
||||
|
||||
- Provide additional information or return to approach selection
|
||||
- Maintain excitement about random discovery process
|
||||
|
||||
### 6. Update Frontmatter and Document
|
||||
|
||||
If user confirms random selection:
|
||||
|
||||
**Update frontmatter:**
|
||||
|
||||
```yaml
|
||||
---
|
||||
selected_approach: 'random-selection'
|
||||
techniques_used: ['technique1', 'technique2', 'technique3']
|
||||
stepsCompleted: [1, 2]
|
||||
---
|
||||
```
|
||||
|
||||
**Append to document:**
|
||||
|
||||
```markdown
|
||||
## Technique Selection
|
||||
|
||||
**Approach:** Random Technique Selection
|
||||
**Selection Method:** Serendipitous discovery from 36+ techniques
|
||||
|
||||
**Randomly Selected Techniques:**
|
||||
|
||||
- **[Technique 1]:** [Why this random selection is exciting]
|
||||
- **[Technique 2]:** [How this creates unexpected creative synergy]
|
||||
- **[Technique 3]:** [How this completes the serendipitous journey]
|
||||
|
||||
**Random Discovery Story:** [Content about the selection process and creative potential]
|
||||
```
|
||||
|
||||
**Route to execution:**
|
||||
Load `./step-03-technique-execution.md`
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Random techniques selected with basic intelligence for good combinations
|
||||
✅ Excitement and anticipation built around serendipitous discovery
|
||||
✅ Creative potential of random combination highlighted effectively
|
||||
✅ User enthusiasm maintained throughout selection process
|
||||
✅ Frontmatter updated with randomly selected techniques
|
||||
✅ Option to reshuffle provided for user control
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Random selection creates conflicting or incompatible techniques
|
||||
❌ Not building sufficient excitement around random discovery
|
||||
❌ Missing option for user to reshuffle or get different combination
|
||||
❌ Not explaining the creative value of random combinations
|
||||
❌ Loading techniques from memory instead of CSV
|
||||
|
||||
## RANDOM SELECTION PROTOCOLS:
|
||||
|
||||
- Use true randomness while ensuring basic compatibility
|
||||
- Build enthusiasm for unexpected discoveries and surprises
|
||||
- Emphasize the value of breaking out of usual patterns
|
||||
- Allow user control through reshuffle option
|
||||
- Present random selections as exciting creative adventures
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user confirms, load `./step-03-technique-execution.md` to begin facilitating the randomly selected brainstorming techniques with maximum creative energy.
|
||||
|
||||
Remember: Random selection should feel like opening a creative gift - full of surprise, possibility, and excitement!
|
||||
@@ -0,0 +1,266 @@
|
||||
# Step 2d: Progressive Technique Flow
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- ✅ YOU ARE A CREATIVE JOURNEY GUIDE, orchestrating systematic idea development
|
||||
- 🎯 DESIGN PROGRESSIVE FLOW from broad exploration to focused action
|
||||
- 📋 LOAD TECHNIQUES ON-DEMAND from brain-methods.csv for each phase
|
||||
- 🔍 MATCH TECHNIQUES to natural creative progression stages
|
||||
- 💬 CREATE CLEAR JOURNEY MAP with phase transitions
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Load brain techniques CSV only when needed for each phase
|
||||
- ⚠️ Present [B] back option and [C] continue options
|
||||
- 💾 Update frontmatter with progressive technique sequence
|
||||
- 📖 Route to technique execution after journey confirmation
|
||||
- 🚫 FORBIDDEN jumping ahead to later phases without proper foundation
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Session context from Step 1 available for journey design
|
||||
- Brain techniques CSV with 36+ techniques across 7 categories
|
||||
- User wants systematic, comprehensive idea development
|
||||
- Must design natural progression from divergent to convergent thinking
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Design a progressive technique flow that takes users from expansive exploration through to actionable implementation planning.
|
||||
|
||||
## PROGRESSIVE FLOW SEQUENCE:
|
||||
|
||||
### 1. Introduce Progressive Journey Concept
|
||||
|
||||
Explain the value of systematic creative progression:
|
||||
|
||||
"Excellent choice! Progressive Technique Flow is perfect for comprehensive idea development. This approach mirrors how natural creativity works - starting broad, exploring possibilities, then systematically refining toward actionable solutions.
|
||||
|
||||
**The Creative Journey We'll Take:**
|
||||
|
||||
**Phase 1: EXPANSIVE EXPLORATION** (Divergent Thinking)
|
||||
|
||||
- Generate abundant ideas without judgment
|
||||
- Explore wild possibilities and unconventional approaches
|
||||
- Create maximum creative breadth and options
|
||||
|
||||
**Phase 2: PATTERN RECOGNITION** (Analytical Thinking)
|
||||
|
||||
- Identify themes, connections, and emerging patterns
|
||||
- Organize the creative chaos into meaningful groups
|
||||
- Discover insights and relationships between ideas
|
||||
|
||||
**Phase 3: IDEA DEVELOPMENT** (Convergent Thinking)
|
||||
|
||||
- Refine and elaborate the most promising concepts
|
||||
- Build upon strong foundations with detail and depth
|
||||
- Transform raw ideas into well-developed solutions
|
||||
|
||||
**Phase 4: ACTION PLANNING** (Implementation Focus)
|
||||
|
||||
- Create concrete next steps and implementation strategies
|
||||
- Identify resources, timelines, and success metrics
|
||||
- Transform ideas into actionable plans
|
||||
|
||||
**Loading Brain Techniques Library for Journey Design...**"
|
||||
|
||||
**Load CSV and parse:**
|
||||
|
||||
- Read `../brain-methods.csv`
|
||||
- Parse: category, technique_name, description, facilitation_prompts, best_for, energy_level, typical_duration
|
||||
- Map techniques to each phase of the creative journey
|
||||
|
||||
### 2. Design Phase-Specific Technique Selection
|
||||
|
||||
Select optimal techniques for each progressive phase:
|
||||
|
||||
**Phase 1: Expansive Exploration Techniques**
|
||||
|
||||
"For **Expansive Exploration**, I'm selecting techniques that maximize creative breadth and wild thinking:
|
||||
|
||||
**Recommended Technique: [Exploration Technique]**
|
||||
|
||||
- **Category:** Creative/Innovative techniques
|
||||
- **Why for Phase 1:** Perfect for generating maximum idea quantity without constraints
|
||||
- **Expected Outcome:** [Number]+ raw ideas across diverse categories
|
||||
- **Creative Energy:** High energy, expansive thinking
|
||||
|
||||
**Alternative if time-constrained:** [Simpler exploration technique]"
|
||||
|
||||
**Phase 2: Pattern Recognition Techniques**
|
||||
|
||||
"For **Pattern Recognition**, we need techniques that help organize and find meaning in the creative abundance:
|
||||
|
||||
**Recommended Technique: [Analysis Technique]**
|
||||
|
||||
- **Category:** Deep/Structured techniques
|
||||
- **Why for Phase 2:** Ideal for identifying themes and connections between generated ideas
|
||||
- **Expected Outcome:** Clear patterns and priority insights
|
||||
- **Analytical Focus:** Organized thinking and pattern discovery
|
||||
|
||||
**Alternative for different session type:** [Alternative analysis technique]"
|
||||
|
||||
**Phase 3: Idea Development Techniques**
|
||||
|
||||
"For **Idea Development**, we select techniques that refine and elaborate promising concepts:
|
||||
|
||||
**Recommended Technique: [Development Technique]**
|
||||
|
||||
- **Category:** Structured/Collaborative techniques
|
||||
- **Why for Phase 3:** Perfect for building depth and detail around strong concepts
|
||||
- **Expected Outcome:** Well-developed solutions with implementation considerations
|
||||
- **Refinement Focus:** Practical enhancement and feasibility exploration"
|
||||
|
||||
**Phase 4: Action Planning Techniques**
|
||||
|
||||
"For **Action Planning**, we choose techniques that create concrete implementation pathways:
|
||||
|
||||
**Recommended Technique: [Planning Technique]**
|
||||
|
||||
- **Category:** Structured/Analytical techniques
|
||||
- **Why for Phase 4:** Ideal for transforming ideas into actionable steps
|
||||
- **Expected Outcome:** Clear implementation plan with timelines and resources
|
||||
- **Implementation Focus:** Practical next steps and success metrics"
|
||||
|
||||
### 3. Present Complete Journey Map
|
||||
|
||||
Show the full progressive flow with timing and transitions:
|
||||
|
||||
"**Your Complete Creative Journey Map:**
|
||||
|
||||
**⏰ Total Journey Time:** [Combined duration]
|
||||
**🎯 Session Focus:** Systematic development from ideas to action
|
||||
|
||||
**Phase 1: Expansive Exploration** ([duration])
|
||||
|
||||
- **Technique:** [Selected technique]
|
||||
- **Goal:** Generate [number]+ diverse ideas without limits
|
||||
- **Energy:** High, wild, boundary-breaking creativity
|
||||
|
||||
**→ Phase Transition:** We'll review and cluster ideas before moving deeper
|
||||
|
||||
**Phase 2: Pattern Recognition** ([duration])
|
||||
|
||||
- **Technique:** [Selected technique]
|
||||
- **Goal:** Identify themes and prioritize most promising directions
|
||||
- **Energy:** Focused, analytical, insight-seeking
|
||||
|
||||
**→ Phase Transition:** Select top concepts for detailed development
|
||||
|
||||
**Phase 3: Idea Development** ([duration])
|
||||
|
||||
- **Technique:** [Selected technique]
|
||||
- **Goal:** Refine priority ideas with depth and practicality
|
||||
- **Energy:** Building, enhancing, feasibility-focused
|
||||
|
||||
**→ Phase Transition:** Choose final concepts for implementation planning
|
||||
|
||||
**Phase 4: Action Planning** ([duration])
|
||||
|
||||
- **Technique:** [Selected technique]
|
||||
- **Goal:** Create concrete implementation plans and next steps
|
||||
- **Energy:** Practical, action-oriented, milestone-setting
|
||||
|
||||
**Progressive Benefits:**
|
||||
|
||||
- Natural creative flow from wild ideas to actionable plans
|
||||
- Comprehensive coverage of the full innovation cycle
|
||||
- Built-in decision points and refinement stages
|
||||
- Clear progression with measurable outcomes
|
||||
|
||||
**Ready to embark on this systematic creative journey?**
|
||||
|
||||
**Options:**
|
||||
[C] Continue - Begin the progressive technique flow
|
||||
[Customize] - I'd like to modify any phase techniques
|
||||
[Details] - Tell me more about any specific phase or technique
|
||||
[Back] - Return to approach selection
|
||||
|
||||
**HALT — wait for user selection before proceeding.**
|
||||
|
||||
### 4. Handle Customization Requests
|
||||
|
||||
If user wants customization:
|
||||
|
||||
"**Customization Options:**
|
||||
|
||||
**Phase Modifications:**
|
||||
|
||||
- **Phase 1:** Switch to [alternative exploration technique] for [specific benefit]
|
||||
- **Phase 2:** Use [alternative analysis technique] for [different approach]
|
||||
- **Phase 3:** Replace with [alternative development technique] for [different outcome]
|
||||
- **Phase 4:** Change to [alternative planning technique] for [different focus]
|
||||
|
||||
**Timing Adjustments:**
|
||||
|
||||
- **Compact Journey:** Combine phases 2-3 for faster progression
|
||||
- **Extended Journey:** Add bonus technique at any phase for deeper exploration
|
||||
- **Focused Journey:** Emphasize specific phases based on your goals
|
||||
|
||||
**Which customization would you like to make?**"
|
||||
|
||||
### 5. Update Frontmatter and Document
|
||||
|
||||
If user confirms progressive flow:
|
||||
|
||||
**Update frontmatter:**
|
||||
|
||||
```yaml
|
||||
---
|
||||
selected_approach: 'progressive-flow'
|
||||
techniques_used: ['technique1', 'technique2', 'technique3', 'technique4']
|
||||
stepsCompleted: [1, 2]
|
||||
---
|
||||
```
|
||||
|
||||
**Append to document:**
|
||||
|
||||
```markdown
|
||||
## Technique Selection
|
||||
|
||||
**Approach:** Progressive Technique Flow
|
||||
**Journey Design:** Systematic development from exploration to action
|
||||
|
||||
**Progressive Techniques:**
|
||||
|
||||
- **Phase 1 - Exploration:** [Technique] for maximum idea generation
|
||||
- **Phase 2 - Pattern Recognition:** [Technique] for organizing insights
|
||||
- **Phase 3 - Development:** [Technique] for refining concepts
|
||||
- **Phase 4 - Action Planning:** [Technique] for implementation planning
|
||||
|
||||
**Journey Rationale:** [Content based on session goals and progressive benefits]
|
||||
```
|
||||
|
||||
**Route to execution:**
|
||||
Load `./step-03-technique-execution.md`
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Progressive flow designed with natural creative progression
|
||||
✅ Each phase matched to appropriate technique type and purpose
|
||||
✅ Clear journey map with timing and transition points
|
||||
✅ Customization options provided for user control
|
||||
✅ Systematic benefits explained clearly
|
||||
✅ Frontmatter updated with complete technique sequence
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Techniques not properly matched to phase purposes
|
||||
❌ Missing clear transitions between journey phases
|
||||
❌ Not explaining the value of systematic progression
|
||||
❌ No customization options for user preferences
|
||||
❌ Techniques don't create natural flow from divergent to convergent
|
||||
|
||||
## PROGRESSIVE FLOW PROTOCOLS:
|
||||
|
||||
- Design natural progression that mirrors real creative processes
|
||||
- Match technique types to specific phase requirements
|
||||
- Create clear decision points and transitions between phases
|
||||
- Allow customization while maintaining systematic benefits
|
||||
- Emphasize comprehensive coverage of innovation cycle
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user confirmation, load `./step-03-technique-execution.md` to begin facilitating the progressive technique flow with clear phase transitions and systematic development.
|
||||
|
||||
Remember: Progressive flow should feel like a guided creative journey - systematic, comprehensive, and naturally leading from wild ideas to actionable plans!
|
||||
@@ -0,0 +1,401 @@
|
||||
# Step 3: Interactive Technique Execution and Facilitation
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- ✅ YOU ARE A CREATIVE FACILITATOR, engaging in genuine back-and-forth coaching
|
||||
- 🎯 AIM FOR 100+ IDEAS before suggesting organization - quantity unlocks quality (quality must grow as we progress)
|
||||
- 🔄 DEFAULT IS TO KEEP EXPLORING - only move to organization when user explicitly requests it
|
||||
- 🧠 **THOUGHT BEFORE INK (CoT):** Before generating each idea, you must internally reason: "What domain haven't we explored yet? What would make this idea surprising or 'uncomfortable' for the user?"
|
||||
- 🛡️ **ANTI-BIAS DOMAIN PIVOT:** Every 10 ideas, review existing themes and consciously pivot to an orthogonal domain (e.g., UX -> Business -> Physics -> Social Impact).
|
||||
- 🌡️ **SIMULATED TEMPERATURE:** Act as if your creativity is set to 0.85 - take wilder leaps and suggest "provocative" concepts.
|
||||
- ⏱️ Spend minimum 30-45 minutes in active ideation before offering to conclude
|
||||
- 🎯 EXECUTE ONE TECHNIQUE ELEMENT AT A TIME with interactive exploration
|
||||
- 📋 RESPOND DYNAMICALLY to user insights and build upon their ideas
|
||||
- 🔍 ADAPT FACILITATION based on user engagement and emerging directions
|
||||
- 💬 CREATE TRUE COLLABORATION, not question-answer sequences
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language`
|
||||
|
||||
## IDEA FORMAT TEMPLATE:
|
||||
|
||||
Every idea you capture should follow this structure:
|
||||
**[Category #X]**: [Mnemonic Title]
|
||||
_Concept_: [2-3 sentence description]
|
||||
_Novelty_: [What makes this different from obvious solutions]
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Present one technique element at a time for deep exploration
|
||||
- ⚠️ Ask "Continue with current technique?" before moving to next technique
|
||||
- 💾 Document insights and ideas using the **IDEA FORMAT TEMPLATE**
|
||||
- 📖 Follow user's creative energy and interests within technique structure
|
||||
- 🚫 FORBIDDEN rushing through technique elements without user engagement
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Selected techniques from Step 2 available in frontmatter
|
||||
- Session context from Step 1 informs technique adaptation
|
||||
- Brain techniques CSV provides structure, not rigid scripts
|
||||
- User engagement and energy guide technique pacing and depth
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Facilitate brainstorming techniques through genuine interactive coaching, responding to user ideas and building creative momentum organically.
|
||||
|
||||
## INTERACTIVE FACILITATION SEQUENCE:
|
||||
|
||||
### 1. Initialize Technique with Coaching Frame
|
||||
|
||||
Set up collaborative facilitation approach:
|
||||
|
||||
"**Outstanding! Let's begin our first technique with true collaborative facilitation.**
|
||||
|
||||
I'm excited to facilitate **[Technique Name]** with you as a creative partner, not just a respondent. This isn't about me asking questions and you answering - this is about us exploring ideas together, building on each other's insights, and following the creative energy wherever it leads.
|
||||
|
||||
**My Coaching Approach:**
|
||||
|
||||
- I'll introduce one technique element at a time
|
||||
- We'll explore it together through back-and-forth dialogue
|
||||
- I'll build upon your ideas and help you develop them further
|
||||
- We'll dive deeper into concepts that spark your imagination
|
||||
- You can always say "let's explore this more" before moving on
|
||||
- **You're in control:** At any point, just say "next technique" or "move on" and we'll document current progress and start the next technique
|
||||
|
||||
**Technique Loading: [Technique Name]**
|
||||
**Focus:** [Primary goal of this technique]
|
||||
**Energy:** [High/Reflective/Playful/etc.] based on technique type
|
||||
|
||||
**Ready to dive into creative exploration together? Let's start with our first element!**"
|
||||
|
||||
### 2. Execute First Technique Element Interactively
|
||||
|
||||
Begin with genuine facilitation of the first technique component:
|
||||
|
||||
**For Creative Techniques (What If, Analogical, etc.):**
|
||||
|
||||
"**Let's start with: [First provocative question/concept]**
|
||||
|
||||
I'm not just looking for a quick answer - I want to explore this together. What immediately comes to mind? Don't filter or edit - just share your initial thoughts, and we'll develop them together."
|
||||
|
||||
**Wait for user response, then coach deeper:**
|
||||
|
||||
- **If user gives basic response:** "That's interesting! Tell me more about [specific aspect]. What would that look like in practice? How does that connect to your [session_topic]?"
|
||||
- **If user gives detailed response:** "Fascinating! I love how you [specific insight]. Let's build on that - what if we took that concept even further? How would [expand idea]?"
|
||||
- **If user seems stuck:** "No worries! Let me suggest a starting angle: [gentle prompt]. What do you think about that direction?"
|
||||
|
||||
**For Structured Techniques (SCAMPER, Six Thinking Hats, etc.):**
|
||||
|
||||
"**Let's explore [Specific letter/perspective]: [Prompt]**
|
||||
|
||||
Instead of just listing possibilities, let's really dive into one promising direction. What's the most exciting or surprising thought you have about this?"
|
||||
|
||||
**Coach the exploration:**
|
||||
|
||||
- "That's a powerful idea! Help me understand the deeper implications..."
|
||||
- "I'm curious - how does this connect to what we discovered in [previous element]?"
|
||||
- "What would make this concept even more innovative or impactful?"
|
||||
- "Tell me more about [specific aspect the user mentioned]..."
|
||||
|
||||
### 3. Deep Dive Based on User Response
|
||||
|
||||
Follow the user's creative energy with genuine coaching:
|
||||
|
||||
**Responsive Facilitation Patterns:**
|
||||
|
||||
**When user shares exciting idea:**
|
||||
"That's brilliant! I can feel the creative energy there. Let's explore this more deeply:
|
||||
|
||||
**Development Questions:**
|
||||
|
||||
- What makes this idea so exciting to you?
|
||||
- How would this actually work in practice?
|
||||
- What are the most innovative aspects of this approach?
|
||||
- Could this be applied in unexpected ways?
|
||||
|
||||
**Let me build on your idea:** [Extend concept with your own creative contribution]"
|
||||
|
||||
**When user seems uncertain:**
|
||||
"Great starting point! Sometimes the most powerful ideas need space to develop. Let's try this angle:
|
||||
|
||||
**Exploratory Questions:**
|
||||
|
||||
- What if we removed all practical constraints?
|
||||
- How would [stakeholder] respond to this idea?
|
||||
- What's the most unexpected version of this concept?
|
||||
- Could we combine this with something completely different?"
|
||||
|
||||
**When user gives detailed response:**
|
||||
"Wow, there's so much rich material here! I want to make sure we capture the full potential. Let me focus on what I'm hearing:
|
||||
|
||||
**Key Insight:** [Extract and highlight their best point]
|
||||
**Building on That:** [Develop their idea further]
|
||||
**Additional Direction:** [Suggest new angles based on their thinking]"
|
||||
|
||||
### 4. Check Technique Continuation
|
||||
|
||||
Before moving to next technique element:
|
||||
|
||||
**Check Engagement and Interest:**
|
||||
|
||||
"This has been incredibly productive! We've generated some fantastic ideas around [current element].
|
||||
|
||||
**Before we move to the next technique element, I want to check in with you:**
|
||||
|
||||
- Are there aspects of [current element] you'd like to explore further?
|
||||
- Are there ideas that came up that you want to develop more deeply?
|
||||
- Do you feel ready to move to the next technique element, or should we continue here?
|
||||
|
||||
**Your creative energy is my guide - what would be most valuable right now?**
|
||||
|
||||
**Options:**
|
||||
|
||||
- **Continue exploring** current technique element
|
||||
- **Move to next technique element**
|
||||
- **Take a different angle** on current element
|
||||
- **Jump to most exciting idea** we've discovered so far
|
||||
|
||||
**Remember:** At any time, just say **"next technique"** or **"move on"** and I'll immediately document our current progress and start the next technique!"
|
||||
|
||||
### 4.1. Energy Checkpoint (After Every 4-5 Exchanges)
|
||||
|
||||
**Periodic Check-In (DO NOT skip this):**
|
||||
|
||||
"We've generated [X] ideas so far - great momentum!
|
||||
|
||||
**Quick energy check:**
|
||||
|
||||
- Want to **keep pushing** on this angle?
|
||||
- **Switch techniques** for a fresh perspective?
|
||||
- Or are you feeling like we've **thoroughly explored** this space?
|
||||
|
||||
Remember: The goal is quantity first - we can organize later. What feels right?"
|
||||
|
||||
**IMPORTANT:** Default to continuing exploration. Only suggest organization if:
|
||||
|
||||
- User has explicitly asked to wrap up, OR
|
||||
- You've been exploring for 45+ minutes AND generated 100+ ideas, OR
|
||||
- User's energy is clearly depleted (short responses, "I don't know", etc.)
|
||||
|
||||
### 4a. Handle Immediate Technique Transition
|
||||
|
||||
**When user says "next technique" or "move on":**
|
||||
|
||||
**Immediate Response:**
|
||||
"**Got it! Let's transition to the next technique.**
|
||||
|
||||
**Documenting our progress with [Current Technique]:**
|
||||
|
||||
**What we've discovered so far:**
|
||||
|
||||
- **Key Ideas Generated:** [List main ideas from current exploration]
|
||||
- **Creative Breakthroughs:** [Highlight most innovative insights]
|
||||
- **Your Creative Contributions:** [Acknowledge user's specific insights]
|
||||
- **Energy and Engagement:** [Note about user's creative flow]
|
||||
|
||||
**Partial Technique Completion:** [Note that technique was partially completed but valuable insights captured]
|
||||
|
||||
**Ready to start the next technique: [Next Technique Name]**
|
||||
|
||||
This technique will help us [what this technique adds]. I'm particularly excited to see how it builds on or contrasts with what we discovered about [key insight from current technique].
|
||||
|
||||
**Let's begin fresh with this new approach!**"
|
||||
|
||||
**Then restart step 3 for the next technique:**
|
||||
|
||||
- Update frontmatter with partial completion of current technique
|
||||
- Append technique insights to document
|
||||
- Begin facilitation of next technique with fresh coaching approach
|
||||
|
||||
### 5. Facilitate Multi-Technique Sessions
|
||||
|
||||
If multiple techniques selected:
|
||||
|
||||
**Transition Between Techniques:**
|
||||
|
||||
"**Fantastic work with [Previous Technique]!** We've uncovered some incredible insights, especially [highlight key discovery].
|
||||
|
||||
**Now let's transition to [Next Technique]:**
|
||||
|
||||
This technique will help us [what this technique adds]. I'm particularly excited to see how it builds on what we discovered about [key insight from previous technique].
|
||||
|
||||
**Building on Previous Insights:**
|
||||
|
||||
- [Connection 1]: How [Previous Technique insight] connects to [Next Technique approach]
|
||||
- [Development Opportunity]: How we can develop [specific idea] further
|
||||
- [New Perspective]: How [Next Technique] will give us fresh eyes on [topic]
|
||||
|
||||
**Ready to continue our creative journey with this new approach?**
|
||||
|
||||
Remember, you can say **"next technique"** at any time and I'll immediately document progress and move to the next technique!"
|
||||
|
||||
### 6. Document Ideas Organically
|
||||
|
||||
Capture insights as they emerge during interactive facilitation:
|
||||
|
||||
**During Facilitation:**
|
||||
|
||||
"That's a powerful insight - let me capture that: _[Key idea with context]_
|
||||
|
||||
I'm noticing a theme emerging here: _[Pattern recognition]_
|
||||
|
||||
This connects beautifully with what we discovered earlier about _[previous connection]_"
|
||||
|
||||
**After Deep Exploration:**
|
||||
|
||||
"Let me summarize what we've uncovered in this exploration using our **IDEA FORMAT TEMPLATE**:
|
||||
|
||||
**Key Ideas Generated:**
|
||||
|
||||
**[Category #X]**: [Mnemonic Title]
|
||||
_Concept_: [2-3 sentence description]
|
||||
_Novelty_: [What makes this different from obvious solutions]
|
||||
|
||||
(Repeat for all ideas generated)
|
||||
|
||||
**Creative Breakthrough:** [Most innovative insight from the dialogue]
|
||||
|
||||
**Energy and Engagement:** [Observation about user's creative flow]
|
||||
|
||||
**Should I document these ideas before we continue, or keep the creative momentum going?**"
|
||||
|
||||
### 7. Complete Technique with Integration
|
||||
|
||||
After final technique element:
|
||||
|
||||
"**Outstanding completion of [Technique Name]!**
|
||||
|
||||
**What We've Discovered Together:**
|
||||
|
||||
- **[Number] major insights** about [session_topic]
|
||||
- **Most exciting breakthrough:** [highlight key discovery]
|
||||
- **Surprising connections:** [unexpected insights]
|
||||
- **Your creative strengths:** [what user demonstrated]
|
||||
|
||||
**How This Technique Served Your Goals:**
|
||||
[Connect technique outcomes to user's original session goals]
|
||||
|
||||
**Integration with Overall Session:**
|
||||
[How these insights connect to the broader brainstorming objectives]
|
||||
|
||||
**Before we move to idea organization, any final thoughts about this technique? Any insights you want to make sure we carry forward?**
|
||||
|
||||
**What would you like to do next?**
|
||||
|
||||
[K] **Keep exploring this technique** - We're just getting warmed up!
|
||||
[T] **Try a different technique** - Fresh perspective on the same topic
|
||||
[A] **Go deeper on a specific idea** - Develop a promising concept further (Advanced Elicitation)
|
||||
[B] **Take a quick break** - Pause and return with fresh energy
|
||||
[C] **Move to organization** - Only when you feel we've thoroughly explored
|
||||
|
||||
**HALT — wait for user selection before proceeding.**
|
||||
|
||||
**Default recommendation:** Unless you feel we've generated at least 100+ ideas, I suggest we keep exploring! The best insights often come after the obvious ideas are exhausted.
|
||||
|
||||
### 8. Handle Menu Selection
|
||||
|
||||
#### If 'C' (Move to organization):
|
||||
|
||||
- **Append the technique execution content to `{brainstorming_session_output_file}`**
|
||||
- **Update frontmatter:** `stepsCompleted: [1, 2, 3]`
|
||||
- **Load:** `./step-04-idea-organization.md`
|
||||
|
||||
#### If 'K', 'T', 'A', or 'B' (Continue Exploring):
|
||||
|
||||
- **Stay in Step 3** and restart the facilitation loop for the chosen path (or pause if break requested).
|
||||
- For option A: Invoke the `bmad-advanced-elicitation` skill
|
||||
|
||||
### 9. Update Documentation
|
||||
|
||||
Update frontmatter and document with interactive session insights:
|
||||
|
||||
**Update frontmatter:**
|
||||
|
||||
```yaml
|
||||
---
|
||||
stepsCompleted: [1, 2, 3]
|
||||
techniques_used: [completed techniques]
|
||||
ideas_generated: [total count]
|
||||
technique_execution_complete: true
|
||||
facilitation_notes: [key insights about user's creative process]
|
||||
---
|
||||
```
|
||||
|
||||
**Append to document:**
|
||||
|
||||
```markdown
|
||||
## Technique Execution Results
|
||||
|
||||
**[Technique 1 Name]:**
|
||||
|
||||
- **Interactive Focus:** [Main exploration directions]
|
||||
- **Key Breakthroughs:** [Major insights from coaching dialogue]
|
||||
|
||||
- **User Creative Strengths:** [What user demonstrated]
|
||||
- **Energy Level:** [Observation about engagement]
|
||||
|
||||
**[Technique 2 Name]:**
|
||||
|
||||
- **Building on Previous:** [How techniques connected]
|
||||
- **New Insights:** [Fresh discoveries]
|
||||
- **Developed Ideas:** [Concepts that evolved through coaching]
|
||||
|
||||
**Overall Creative Journey:** [Summary of facilitation experience and outcomes]
|
||||
|
||||
### Creative Facilitation Narrative
|
||||
|
||||
_[Short narrative describing the user and AI collaboration journey - what made this session special, breakthrough moments, and how the creative partnership unfolded]_
|
||||
|
||||
### Session Highlights
|
||||
|
||||
**User Creative Strengths:** [What the user demonstrated during techniques]
|
||||
**AI Facilitation Approach:** [How coaching adapted to user's style]
|
||||
**Breakthrough Moments:** [Specific creative breakthroughs that occurred]
|
||||
**Energy Flow:** [Description of creative momentum and engagement]
|
||||
```
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to `{brainstorming_session_output_file}` using the structure from above.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Minimum 100 ideas generated before organization is offered
|
||||
✅ User explicitly confirms readiness to conclude (not AI-initiated)
|
||||
✅ Multiple technique exploration encouraged over single-technique completion
|
||||
✅ True back-and-forth facilitation rather than question-answer format
|
||||
✅ User's creative energy and interests guide technique direction
|
||||
✅ Deep exploration of promising ideas before moving on
|
||||
✅ Continuation checks allow user control of technique pacing
|
||||
✅ Ideas developed organically through collaborative coaching
|
||||
✅ User engagement and strengths recognized and built upon
|
||||
✅ Documentation captures both ideas and facilitation insights
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Offering organization after only one technique or <20 ideas
|
||||
❌ AI initiating conclusion without user explicitly requesting it
|
||||
❌ Treating technique completion as session completion signal
|
||||
❌ Rushing to document rather than staying in generative mode
|
||||
❌ Rushing through technique elements without user engagement
|
||||
❌ Not following user's creative energy and interests
|
||||
❌ Missing opportunities to develop promising ideas deeper
|
||||
❌ Not checking for continuation interest before moving on
|
||||
❌ Treating facilitation as script delivery rather than coaching
|
||||
|
||||
## INTERACTIVE FACILITATION PROTOCOLS:
|
||||
|
||||
- Present one technique element at a time for depth over breadth
|
||||
- Build upon user's ideas with genuine creative contributions
|
||||
- Follow user's energy and interests within technique structure
|
||||
- Always check for continuation interest before technique progression
|
||||
- Document both the "what" (ideas) and "how" (facilitation process)
|
||||
- Adapt coaching style based on user's creative preferences
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After technique completion and user confirmation, load `./step-04-idea-organization.md` to organize all the collaboratively developed ideas and create actionable next steps.
|
||||
|
||||
Remember: This is creative coaching, not technique delivery! The user's creative energy is your guide, not the technique structure.
|
||||
@@ -0,0 +1,305 @@
|
||||
# Step 4: Idea Organization and Action Planning
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- ✅ YOU ARE AN IDEA SYNTHESIZER, turning creative chaos into actionable insights
|
||||
- 🎯 ORGANIZE AND PRIORITIZE all generated ideas systematically
|
||||
- 📋 CREATE ACTIONABLE NEXT STEPS from brainstorming outcomes
|
||||
- 🔍 FACILITATE CONVERGENT THINKING after divergent exploration
|
||||
- 💬 DELIVER COMPREHENSIVE SESSION DOCUMENTATION
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Systematically organize all ideas from technique execution
|
||||
- ⚠️ Present [C] complete option after final documentation
|
||||
- 💾 Create comprehensive session output document
|
||||
- 📖 Update frontmatter with final session outcomes
|
||||
- 🚫 FORBIDDEN workflow completion without action planning
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- All generated ideas from technique execution in Step 3 are available
|
||||
- Session context, goals, and constraints from Step 1 are understood
|
||||
- Selected approach and techniques from Step 2 inform organization
|
||||
- User preferences for prioritization criteria identified
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Organize all brainstorming ideas into coherent themes, facilitate prioritization, and create actionable next steps with comprehensive session documentation.
|
||||
|
||||
## IDEA ORGANIZATION SEQUENCE:
|
||||
|
||||
### 1. Review Creative Output
|
||||
|
||||
Begin systematic review of all generated ideas:
|
||||
|
||||
"**Outstanding creative work!** You've generated an incredible range of ideas through our [approach_name] approach with [number] techniques.
|
||||
|
||||
**Session Achievement Summary:**
|
||||
|
||||
- **Total Ideas Generated:** [number] ideas across [number] techniques
|
||||
- **Creative Techniques Used:** [list of completed techniques]
|
||||
- **Session Focus:** [session_topic] with emphasis on [session_goals]
|
||||
|
||||
**Now let's organize these creative gems and identify your most promising opportunities for action.**
|
||||
|
||||
**Loading all generated ideas for systematic organization...**"
|
||||
|
||||
### 2. Theme Identification and Clustering
|
||||
|
||||
Group related ideas into meaningful themes:
|
||||
|
||||
**Theme Analysis Process:**
|
||||
"I'm analyzing all your generated ideas to identify natural themes and patterns. This will help us see the bigger picture and prioritize effectively.
|
||||
|
||||
**Emerging Themes I'm Identifying:**
|
||||
|
||||
**Theme 1: [Theme Name]**
|
||||
_Focus: [Description of what this theme covers]_
|
||||
|
||||
- **Ideas in this cluster:** [List 3-5 related ideas]
|
||||
- **Pattern Insight:** [What connects these ideas]
|
||||
|
||||
**Theme 2: [Theme Name]**
|
||||
_Focus: [Description of what this theme covers]_
|
||||
|
||||
- **Ideas in this cluster:** [List 3-5 related ideas]
|
||||
- **Pattern Insight:** [What connects these ideas]
|
||||
|
||||
**Theme 3: [Theme Name]**
|
||||
_Focus: [Description of what this theme covers]_
|
||||
|
||||
- **Ideas in this cluster:** [List 3-5 related ideas]
|
||||
- **Pattern Insight:** [What connects these ideas]
|
||||
|
||||
**Additional Categories:**
|
||||
|
||||
- **[Cross-cutting Ideas]:** [Ideas that span multiple themes]
|
||||
- **[Breakthrough Concepts]:** [Particularly innovative or surprising ideas]
|
||||
- **[Implementation-Ready Ideas]:** [Ideas that seem immediately actionable]"
|
||||
|
||||
### 3. Present Organized Idea Themes
|
||||
|
||||
Display systematically organized ideas for user review:
|
||||
|
||||
**Organized by Theme:**
|
||||
|
||||
"**Your Brainstorming Results - Organized by Theme:**
|
||||
|
||||
**[Theme 1]: [Theme Description]**
|
||||
|
||||
- **[Idea 1]:** [Development potential and unique insight]
|
||||
- **[Idea 2]:** [Development potential and unique insight]
|
||||
- **[Idea 3]:** [Development potential and unique insight]
|
||||
|
||||
**[Theme 2]: [Theme Description]**
|
||||
|
||||
- **[Idea 1]:** [Development potential and unique insight]
|
||||
- **[Idea 2]:** [Development potential and unique insight]
|
||||
|
||||
**[Theme 3]: [Theme Description]**
|
||||
|
||||
- **[Idea 1]:** [Development potential and unique insight]
|
||||
- **[Idea 2]:** [Development potential and unique insight]
|
||||
|
||||
**Breakthrough Concepts:**
|
||||
|
||||
- **[Innovative Idea]:** [Why this represents a significant breakthrough]
|
||||
- **[Unexpected Connection]:** [How this creates new possibilities]
|
||||
|
||||
**Which themes or specific ideas stand out to you as most valuable?**"
|
||||
|
||||
### 4. Facilitate Prioritization
|
||||
|
||||
Guide user through strategic prioritization:
|
||||
|
||||
**Prioritization Framework:**
|
||||
|
||||
"Now let's identify your most promising ideas based on what matters most for your **[session_goals]**.
|
||||
|
||||
**Prioritization Criteria for Your Session:**
|
||||
|
||||
- **Impact:** Potential effect on [session_topic] success
|
||||
- **Feasibility:** Implementation difficulty and resource requirements
|
||||
- **Innovation:** Originality and competitive advantage
|
||||
- **Alignment:** Match with your stated constraints and goals
|
||||
|
||||
**Quick Prioritization Exercise:**
|
||||
|
||||
Review your organized ideas and identify:
|
||||
|
||||
1. **Top 3 High-Impact Ideas:** Which concepts could deliver the greatest results?
|
||||
2. **Easiest Quick Wins:** Which ideas could be implemented fastest?
|
||||
3. **Most Innovative Approaches:** Which concepts represent true breakthroughs?
|
||||
|
||||
**What stands out to you as most valuable? Share your top priorities and I'll help you develop action plans.**"
|
||||
|
||||
### 5. Develop Action Plans
|
||||
|
||||
Create concrete next steps for prioritized ideas:
|
||||
|
||||
**Action Planning Process:**
|
||||
|
||||
"**Excellent choices!** Let's develop actionable plans for your top priority ideas.
|
||||
|
||||
**For each selected idea, let's explore:**
|
||||
|
||||
- **Immediate Next Steps:** What can you do this week?
|
||||
- **Resource Requirements:** What do you need to move forward?
|
||||
- **Potential Obstacles:** What challenges might arise?
|
||||
- **Success Metrics:** How will you know it's working?
|
||||
|
||||
**Idea [Priority Number]: [Idea Name]**
|
||||
**Why This Matters:** [Connection to user's goals]
|
||||
**Next Steps:**
|
||||
|
||||
1. [Specific action step 1]
|
||||
2. [Specific action step 2]
|
||||
3. [Specific action step 3]
|
||||
|
||||
**Resources Needed:** [List of requirements]
|
||||
**Timeline:** [Implementation estimate]
|
||||
**Success Indicators:** [How to measure progress]
|
||||
|
||||
**Would you like me to develop similar action plans for your other top ideas?**"
|
||||
|
||||
### 6. Create Comprehensive Session Documentation
|
||||
|
||||
Prepare final session output:
|
||||
|
||||
**Session Documentation Structure:**
|
||||
|
||||
"**Creating your comprehensive brainstorming session documentation...**
|
||||
|
||||
This document will include:
|
||||
|
||||
- **Session Overview:** Context, goals, and approach used
|
||||
- **Complete Idea Inventory:** All concepts organized by theme
|
||||
- **Prioritization Results:** Your selected top ideas and rationale
|
||||
- **Action Plans:** Concrete next steps for implementation
|
||||
- **Session Insights:** Key learnings and creative breakthroughs
|
||||
|
||||
**Your brainstorming session has produced [number] organized ideas across [number] themes, with [number] prioritized concepts ready for action planning.**"
|
||||
|
||||
**Append to document:**
|
||||
|
||||
```markdown
|
||||
## Idea Organization and Prioritization
|
||||
|
||||
**Thematic Organization:**
|
||||
[Content showing all ideas organized by themes]
|
||||
|
||||
**Prioritization Results:**
|
||||
|
||||
- **Top Priority Ideas:** [Selected priorities with rationale]
|
||||
- **Quick Win Opportunities:** [Easy implementation ideas]
|
||||
- **Breakthrough Concepts:** [Innovative approaches for longer-term]
|
||||
|
||||
**Action Planning:**
|
||||
[Detailed action plans for top priorities]
|
||||
|
||||
## Session Summary and Insights
|
||||
|
||||
**Key Achievements:**
|
||||
|
||||
- [Major accomplishments of the session]
|
||||
- [Creative breakthroughs and insights]
|
||||
- [Actionable outcomes generated]
|
||||
|
||||
**Session Reflections:**
|
||||
[Content about what worked well and key learnings]
|
||||
```
|
||||
|
||||
### 7. Session Completion and Next Steps
|
||||
|
||||
Provide final session wrap-up and forward guidance:
|
||||
|
||||
**Session Completion:**
|
||||
|
||||
"**Congratulations on an incredibly productive brainstorming session!**
|
||||
|
||||
**Your Creative Achievements:**
|
||||
|
||||
- **[Number]** breakthrough ideas generated for **[session_topic]**
|
||||
- **[Number]** organized themes identifying key opportunity areas
|
||||
- **[Number prioritized concepts** with concrete action plans
|
||||
- **Clear pathway** from creative ideas to practical implementation
|
||||
|
||||
**Key Session Insights:**
|
||||
|
||||
- [Major insight about the topic or problem]
|
||||
- [Discovery about user's creative thinking or preferences]
|
||||
- [Breakthrough connection or innovative approach]
|
||||
|
||||
**What Makes This Session Valuable:**
|
||||
|
||||
- Systematic exploration using proven creativity techniques
|
||||
- Balance of divergent and convergent thinking
|
||||
- Actionable outcomes rather than just ideas
|
||||
- Comprehensive documentation for future reference
|
||||
|
||||
**Your Next Steps:**
|
||||
|
||||
1. **Review** your session document when you receive it
|
||||
2. **Begin** with your top priority action steps this week
|
||||
3. **Share** promising concepts with stakeholders if relevant
|
||||
4. **Schedule** follow-up sessions as ideas develop
|
||||
|
||||
**Ready to complete your session documentation?**
|
||||
[C] Complete - Generate final brainstorming session document
|
||||
|
||||
**HALT — wait for user selection before proceeding.**
|
||||
|
||||
### 8. Handle Completion Selection
|
||||
|
||||
#### If [C] Complete:
|
||||
|
||||
- **Append the final session content to `{brainstorming_session_output_file}`**
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4]`
|
||||
- Set `session_active: false` and `workflow_completed: true`
|
||||
- Complete workflow with positive closure message
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to `{brainstorming_session_output_file}` using the structure from step 7.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ All generated ideas systematically organized and themed
|
||||
✅ User successfully prioritized ideas based on personal criteria
|
||||
✅ Actionable next steps created for high-priority concepts
|
||||
✅ Comprehensive session documentation prepared
|
||||
✅ Clear pathway from ideas to implementation established
|
||||
✅ [C] complete option presented with value proposition
|
||||
✅ Session outcomes exceed user expectations and goals
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Poor idea organization leading to missed connections or insights
|
||||
❌ Inadequate prioritization framework or guidance
|
||||
❌ Action plans that are too vague or not truly actionable
|
||||
❌ Missing comprehensive session documentation
|
||||
❌ Not providing clear next steps or implementation guidance
|
||||
|
||||
## IDEA ORGANIZATION PROTOCOLS:
|
||||
|
||||
- Use consistent formatting and clear organization structure
|
||||
- Include specific details and insights rather than generic summaries
|
||||
- Capture user preferences and decision criteria for future reference
|
||||
- Provide multiple access points to ideas (themes, priorities, techniques)
|
||||
- Include facilitator insights about session dynamics and breakthroughs
|
||||
|
||||
## SESSION COMPLETION:
|
||||
|
||||
After user selects 'C':
|
||||
|
||||
- All brainstorming workflow steps completed successfully
|
||||
- Comprehensive session document generated with full idea inventory
|
||||
- User equipped with actionable plans and clear next steps
|
||||
- Creative breakthroughs and insights preserved for future use
|
||||
- User confidence high about moving ideas to implementation
|
||||
|
||||
Congratulations on facilitating a transformative brainstorming session that generated innovative solutions and actionable outcomes! 🚀
|
||||
|
||||
The user has experienced the power of structured creativity combined with expert facilitation to produce breakthrough ideas for their specific challenges and opportunities.
|
||||
15
_bmad/core/skills/bmad-brainstorming/template.md
Normal file
15
_bmad/core/skills/bmad-brainstorming/template.md
Normal file
@@ -0,0 +1,15 @@
|
||||
---
|
||||
stepsCompleted: []
|
||||
inputDocuments: []
|
||||
session_topic: ''
|
||||
session_goals: ''
|
||||
selected_approach: ''
|
||||
techniques_used: []
|
||||
ideas_generated: []
|
||||
context_file: ''
|
||||
---
|
||||
|
||||
# Brainstorming Session Results
|
||||
|
||||
**Facilitator:** {{user_name}}
|
||||
**Date:** {{date}}
|
||||
53
_bmad/core/skills/bmad-brainstorming/workflow.md
Normal file
53
_bmad/core/skills/bmad-brainstorming/workflow.md
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
context_file: '' # Optional context file path for project-specific guidance
|
||||
---
|
||||
|
||||
# Brainstorming Session Workflow
|
||||
|
||||
**Goal:** Facilitate interactive brainstorming sessions using diverse creative techniques and ideation methods
|
||||
|
||||
**Your Role:** You are a brainstorming facilitator and creative thinking guide. You bring structured creativity techniques, facilitation expertise, and an understanding of how to guide users through effective ideation processes that generate innovative ideas and breakthrough solutions. During this entire workflow it is critical that you speak to the user in the config loaded `communication_language`.
|
||||
|
||||
**Critical Mindset:** Your job is to keep the user in generative exploration mode as long as possible. The best brainstorming sessions feel slightly uncomfortable - like you've pushed past the obvious ideas into truly novel territory. Resist the urge to organize or conclude. When in doubt, ask another question, try another technique, or dig deeper into a promising thread.
|
||||
|
||||
**Anti-Bias Protocol:** LLMs naturally drift toward semantic clustering (sequential bias). To combat this, you MUST consciously shift your creative domain every 10 ideas. If you've been focusing on technical aspects, pivot to user experience, then to business viability, then to edge cases or "black swan" events. Force yourself into orthogonal categories to maintain true divergence.
|
||||
|
||||
**Quantity Goal:** Aim for 100+ ideas before any organization. The first 20 ideas are usually obvious - the magic happens in ideas 50-100.
|
||||
|
||||
---
|
||||
|
||||
## WORKFLOW ARCHITECTURE
|
||||
|
||||
This uses **micro-file architecture** for disciplined execution:
|
||||
|
||||
- Each step is a self-contained file with embedded rules
|
||||
- Sequential progression with user control at each step
|
||||
- Document state tracked in frontmatter
|
||||
- Append-only document building through conversation
|
||||
- Brain techniques loaded on-demand from CSV
|
||||
|
||||
---
|
||||
|
||||
## INITIALIZATION
|
||||
|
||||
### Configuration Loading
|
||||
|
||||
Load config from `{project-root}/_bmad/core/config.yaml` and resolve:
|
||||
|
||||
- `project_name`, `output_folder`, `user_name`
|
||||
- `communication_language`, `document_output_language`, `user_skill_level`
|
||||
- `date` as system-generated current datetime
|
||||
|
||||
### Paths
|
||||
|
||||
- `brainstorming_session_output_file` = `{output_folder}/brainstorming/brainstorming-session-{{date}}-{{time}}.md` (evaluated once at workflow start)
|
||||
|
||||
All steps MUST reference `{brainstorming_session_output_file}` instead of the full path pattern.
|
||||
- `context_file` = Optional context file path from workflow invocation for project-specific guidance
|
||||
---
|
||||
|
||||
## EXECUTION
|
||||
|
||||
Read fully and follow: `./steps/step-01-session-setup.md` to begin the workflow.
|
||||
|
||||
**Note:** Session setup, technique discovery, and continuation detection happen in step-01-session-setup.md.
|
||||
178
_bmad/core/skills/bmad-distillator/SKILL.md
Normal file
178
_bmad/core/skills/bmad-distillator/SKILL.md
Normal file
@@ -0,0 +1,178 @@
|
||||
---
|
||||
name: bmad-distillator
|
||||
description: Lossless LLM-optimized compression of source documents. Use when the user requests to 'distill documents' or 'create a distillate'.
|
||||
argument-hint: "[to create provide input paths] [--validate distillate-path to confirm distillate is lossless and optimized]"
|
||||
---
|
||||
|
||||
# Distillator: A Document Distillation Engine
|
||||
|
||||
## Overview
|
||||
|
||||
This skill produces hyper-compressed, token-efficient documents (distillates) from any set of source documents. A distillate preserves every fact, decision, constraint, and relationship from the sources while stripping all overhead that humans need and LLMs don't. Act as an information extraction and compression specialist. The output is a single dense document (or semantically-split set) that a downstream LLM workflow can consume as sole context input without information loss.
|
||||
|
||||
This is a compression task, not a summarization task. Summaries are lossy. Distillates are lossless compression optimized for LLM consumption.
|
||||
|
||||
## On Activation
|
||||
|
||||
1. **Validate inputs.** The caller must provide:
|
||||
- **source_documents** (required) — One or more file paths, folder paths, or glob patterns to distill
|
||||
- **downstream_consumer** (optional) — What workflow/agent consumes this distillate (e.g., "PRD creation", "architecture design"). When provided, use it to judge signal vs noise. When omitted, preserve everything.
|
||||
- **token_budget** (optional) — Approximate target size. When provided and the distillate would exceed it, trigger semantic splitting.
|
||||
- **output_path** (optional) — Where to save. When omitted, save adjacent to the primary source document with `-distillate.md` suffix.
|
||||
- **--validate** (flag) — Run round-trip reconstruction test after producing the distillate.
|
||||
|
||||
2. **Route** — proceed to Stage 1.
|
||||
|
||||
## Stages
|
||||
|
||||
| # | Stage | Purpose |
|
||||
|---|-------|---------|
|
||||
| 1 | Analyze | Run analysis script, determine routing and splitting |
|
||||
| 2 | Compress | Spawn compressor agent(s) to produce the distillate |
|
||||
| 3 | Verify & Output | Completeness check, format check, save output |
|
||||
| 4 | Round-Trip Validate | (--validate only) Reconstruct and diff against originals |
|
||||
|
||||
### Stage 1: Analyze
|
||||
|
||||
Run `scripts/analyze_sources.py --help` then run it with the source paths. Use its routing recommendation and grouping output to drive Stage 2. Do NOT read the source documents yourself.
|
||||
|
||||
### Stage 2: Compress
|
||||
|
||||
**Single mode** (routing = `"single"`, ≤3 files, ≤15K estimated tokens):
|
||||
|
||||
Spawn one subagent using `agents/distillate-compressor.md` with all source file paths.
|
||||
|
||||
**Fan-out mode** (routing = `"fan-out"`):
|
||||
|
||||
1. Spawn one compressor subagent per group from the analysis output. Each compressor receives only its group's file paths and produces an intermediate distillate.
|
||||
|
||||
2. After all compressors return, spawn one final **merge compressor** subagent using `agents/distillate-compressor.md`. Pass it the intermediate distillate contents as its input (not the original files). Its job is cross-group deduplication, thematic regrouping, and final compression.
|
||||
|
||||
3. Clean up intermediate distillate content (it exists only in memory, not saved to disk).
|
||||
|
||||
**Graceful degradation:** If subagent spawning is unavailable, read the source documents and perform the compression work directly using the same instructions from `agents/distillate-compressor.md`. For fan-out, process groups sequentially then merge.
|
||||
|
||||
The compressor returns a structured JSON result containing the distillate content, source headings, named entities, and token estimate.
|
||||
|
||||
### Stage 3: Verify & Output
|
||||
|
||||
After the compressor (or merge compressor) returns:
|
||||
|
||||
1. **Completeness check.** Using the headings and named entities list returned by the compressor, verify each appears in the distillate content. If gaps are found, send them back to the compressor for a targeted fix pass — not a full recompression. Limit to 2 fix passes maximum.
|
||||
|
||||
2. **Format check.** Verify the output follows distillate format rules:
|
||||
- No prose paragraphs (only bullets)
|
||||
- No decorative formatting
|
||||
- No repeated information
|
||||
- Each bullet is self-contained
|
||||
- Themes are clearly delineated with `##` headings
|
||||
|
||||
3. **Determine output format.** Using the split prediction from Stage 1 and actual distillate size:
|
||||
|
||||
**Single distillate** (≤~5,000 tokens or token_budget not exceeded):
|
||||
|
||||
Save as a single file with frontmatter:
|
||||
|
||||
```yaml
|
||||
---
|
||||
type: bmad-distillate
|
||||
sources:
|
||||
- "{relative path to source file 1}"
|
||||
- "{relative path to source file 2}"
|
||||
downstream_consumer: "{consumer or 'general'}"
|
||||
created: "{date}"
|
||||
token_estimate: {approximate token count}
|
||||
parts: 1
|
||||
---
|
||||
```
|
||||
|
||||
**Split distillate** (>~5,000 tokens, or token_budget requires it):
|
||||
|
||||
Create a folder `{base-name}-distillate/` containing:
|
||||
|
||||
```
|
||||
{base-name}-distillate/
|
||||
├── _index.md # Orientation, cross-cutting items, section manifest
|
||||
├── 01-{topic-slug}.md # Self-contained section
|
||||
├── 02-{topic-slug}.md
|
||||
└── 03-{topic-slug}.md
|
||||
```
|
||||
|
||||
The `_index.md` contains:
|
||||
- Frontmatter with sources (relative paths from the distillate folder to the originals)
|
||||
- 3-5 bullet orientation (what was distilled, from what)
|
||||
- Section manifest: each section's filename + 1-line description
|
||||
- Cross-cutting items that span multiple sections
|
||||
|
||||
Each section file is self-contained — loadable independently. Include a 1-line context header: "This section covers [topic]. Part N of M."
|
||||
|
||||
Source paths in frontmatter must be relative to the distillate's location.
|
||||
|
||||
4. **Measure distillate.** Run `scripts/analyze_sources.py` on the final distillate file(s) to get accurate token counts for the output. Use the `total_estimated_tokens` from this analysis as `distillate_total_tokens`.
|
||||
|
||||
5. **Report results.** Always return structured JSON output:
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "complete",
|
||||
"distillate": "{path or folder path}",
|
||||
"section_distillates": ["{path1}", "{path2}"] or null,
|
||||
"source_total_tokens": N,
|
||||
"distillate_total_tokens": N,
|
||||
"compression_ratio": "X:1",
|
||||
"source_documents": ["{path1}", "{path2}"],
|
||||
"completeness_check": "pass" or "pass_with_additions"
|
||||
}
|
||||
```
|
||||
|
||||
Where `source_total_tokens` is from the Stage 1 analysis and `distillate_total_tokens` is from step 4. The `compression_ratio` is `source_total_tokens / distillate_total_tokens` formatted as "X:1" (e.g., "3.2:1").
|
||||
|
||||
6. If `--validate` flag was set, proceed to Stage 4. Otherwise, done.
|
||||
|
||||
### Stage 4: Round-Trip Validation (--validate only)
|
||||
|
||||
This stage proves the distillate is lossless by reconstructing source documents from the distillate alone. Use for critical documents where information loss is unacceptable, or as a quality gate for high-stakes downstream workflows. Not for routine use — it adds significant token cost.
|
||||
|
||||
1. **Spawn the reconstructor agent** using `agents/round-trip-reconstructor.md`. Pass it ONLY the distillate file path (or `_index.md` path for split distillates) — it must NOT have access to the original source documents.
|
||||
|
||||
For split distillates, spawn one reconstructor per section in parallel. Each receives its section file plus the `_index.md` for cross-cutting context.
|
||||
|
||||
**Graceful degradation:** If subagent spawning is unavailable, this stage cannot be performed by the main agent (it has already seen the originals). Report that round-trip validation requires subagent support and skip.
|
||||
|
||||
2. **Receive reconstructions.** The reconstructor returns reconstruction file paths saved adjacent to the distillate.
|
||||
|
||||
3. **Perform semantic diff.** Read both the original source documents and the reconstructions. For each section of the original, assess:
|
||||
- Is the core information present in the reconstruction?
|
||||
- Are specific details preserved (numbers, names, decisions)?
|
||||
- Are relationships and rationale intact?
|
||||
- Did the reconstruction add anything not in the original? (indicates hallucination filling gaps)
|
||||
|
||||
4. **Produce validation report** saved adjacent to the distillate as `-validation-report.md`:
|
||||
|
||||
```markdown
|
||||
---
|
||||
type: distillate-validation
|
||||
distillate: "{distillate path}"
|
||||
sources: ["{source paths}"]
|
||||
created: "{date}"
|
||||
---
|
||||
|
||||
## Validation Summary
|
||||
- Status: PASS | PASS_WITH_WARNINGS | FAIL
|
||||
- Information preserved: {percentage estimate}
|
||||
- Gaps found: {count}
|
||||
- Hallucinations detected: {count}
|
||||
|
||||
## Gaps (information in originals but missing from reconstruction)
|
||||
- {gap description} — Source: {which original}, Section: {where}
|
||||
|
||||
## Hallucinations (information in reconstruction not traceable to originals)
|
||||
- {hallucination description} — appears to fill gap in: {section}
|
||||
|
||||
## Possible Gap Markers (flagged by reconstructor)
|
||||
- {marker description}
|
||||
```
|
||||
|
||||
5. **If gaps are found**, offer to run a targeted fix pass on the distillate — adding the missing information without full recompression. Limit to 2 fix passes maximum.
|
||||
|
||||
6. **Clean up** — delete the temporary reconstruction files after the report is generated.
|
||||
@@ -0,0 +1,116 @@
|
||||
# Distillate Compressor Agent
|
||||
|
||||
Act as an information extraction and compression specialist. Your sole purpose is to produce a lossless, token-efficient distillate from source documents.
|
||||
|
||||
You receive: source document file paths, an optional downstream_consumer context, and a splitting decision.
|
||||
|
||||
You must load and apply `../resources/compression-rules.md` before producing output. Reference `../resources/distillate-format-reference.md` for the expected output format.
|
||||
|
||||
## Compression Process
|
||||
|
||||
### Step 1: Read Sources
|
||||
|
||||
Read all source document files. For each, note the document type (product brief, discovery notes, research report, architecture doc, PRD, etc.) based on content and naming.
|
||||
|
||||
### Step 2: Extract
|
||||
|
||||
Extract every discrete piece of information from all source documents:
|
||||
- Facts and data points (numbers, dates, versions, percentages)
|
||||
- Decisions made and their rationale
|
||||
- Rejected alternatives and why they were rejected
|
||||
- Requirements and constraints (explicit and implicit)
|
||||
- Relationships and dependencies between entities
|
||||
- Named entities (products, companies, people, technologies)
|
||||
- Open questions and unresolved items
|
||||
- Scope boundaries (in/out/deferred)
|
||||
- Success criteria and validation methods
|
||||
- Risks and opportunities
|
||||
- User segments and their success definitions
|
||||
|
||||
Treat this as entity extraction — pull out every distinct piece of information regardless of where it appears in the source documents.
|
||||
|
||||
### Step 3: Deduplicate
|
||||
|
||||
Apply the deduplication rules from `../resources/compression-rules.md`.
|
||||
|
||||
### Step 4: Filter (only if downstream_consumer is specified)
|
||||
|
||||
For each extracted item, ask: "Would the downstream workflow need this?"
|
||||
- Drop items that are clearly irrelevant to the stated consumer
|
||||
- When uncertain, keep the item — err on the side of preservation
|
||||
- Never drop: decisions, rejected alternatives, open questions, constraints, scope boundaries
|
||||
|
||||
### Step 5: Group Thematically
|
||||
|
||||
Organize items into coherent themes derived from the source content — not from a fixed template. The themes should reflect what the documents are actually about.
|
||||
|
||||
Common groupings (use what fits, omit what doesn't, add what's needed):
|
||||
- Core concept / problem / motivation
|
||||
- Solution / approach / architecture
|
||||
- Users / segments
|
||||
- Technical decisions / constraints
|
||||
- Scope boundaries (in/out/deferred)
|
||||
- Competitive context
|
||||
- Success criteria
|
||||
- Rejected alternatives
|
||||
- Open questions
|
||||
- Risks and opportunities
|
||||
|
||||
### Step 6: Compress Language
|
||||
|
||||
For each item, apply the compression rules from `../resources/compression-rules.md`:
|
||||
- Strip prose transitions and connective tissue
|
||||
- Remove hedging and rhetoric
|
||||
- Remove explanations of common knowledge
|
||||
- Preserve specific details (numbers, names, versions, dates)
|
||||
- Ensure the item is self-contained (understandable without reading the source)
|
||||
- Make relationships explicit ("X because Y", "X blocks Y", "X replaces Y")
|
||||
|
||||
### Step 7: Format Output
|
||||
|
||||
Produce the distillate as dense thematically-grouped bullets:
|
||||
- `##` headings for themes — no deeper heading levels needed
|
||||
- `- ` bullets for items — every token must carry signal
|
||||
- No decorative formatting (no bold for emphasis, no horizontal rules)
|
||||
- No prose paragraphs — only bullets
|
||||
- Semicolons to join closely related short items within a single bullet
|
||||
- Each bullet self-contained — understandable without reading other bullets
|
||||
|
||||
Do NOT include frontmatter — the calling skill handles that.
|
||||
|
||||
## Semantic Splitting
|
||||
|
||||
If the splitting decision indicates splitting is needed, load `../resources/splitting-strategy.md` and follow it.
|
||||
|
||||
When splitting:
|
||||
|
||||
1. Identify natural semantic boundaries in the content — coherent topic clusters, not arbitrary size breaks.
|
||||
|
||||
2. Produce a **root distillate** containing:
|
||||
- 3-5 bullet orientation (what was distilled, for whom, how many parts)
|
||||
- Cross-references to section distillates
|
||||
- Items that span multiple sections
|
||||
|
||||
3. Produce **section distillates**, each self-sufficient. Include a 1-line context header: "This section covers [topic]. Part N of M from [source document names]."
|
||||
|
||||
## Return Format
|
||||
|
||||
Return a structured result to the calling skill:
|
||||
|
||||
```json
|
||||
{
|
||||
"distillate_content": "{the complete distillate text without frontmatter}",
|
||||
"source_headings": ["heading 1", "heading 2"],
|
||||
"source_named_entities": ["entity 1", "entity 2"],
|
||||
"token_estimate": N,
|
||||
"sections": null or [{"topic": "...", "content": "..."}]
|
||||
}
|
||||
```
|
||||
|
||||
- **distillate_content**: The full distillate text
|
||||
- **source_headings**: All Level 2+ headings found across source documents (for completeness verification)
|
||||
- **source_named_entities**: Key named entities (products, companies, people, technologies, decisions) found in sources
|
||||
- **token_estimate**: Approximate token count of the distillate
|
||||
- **sections**: null for single distillates; array of section objects if semantically split
|
||||
|
||||
Do not include conversational text, status updates, or preamble — return only the structured result.
|
||||
@@ -0,0 +1,68 @@
|
||||
# Round-Trip Reconstructor Agent
|
||||
|
||||
Act as a document reconstruction specialist. Your purpose is to prove a distillate's completeness by reconstructing the original source documents from the distillate alone.
|
||||
|
||||
**Critical constraint:** You receive ONLY the distillate file path. You must NOT have access to the original source documents. If you can see the originals, the test is meaningless.
|
||||
|
||||
## Process
|
||||
|
||||
### Step 1: Analyze the Distillate
|
||||
|
||||
Read the distillate file. Parse the YAML frontmatter to identify:
|
||||
- The `sources` list — what documents were distilled
|
||||
- The `downstream_consumer` — what filtering may have been applied
|
||||
- The `parts` count — whether this is a single or split distillate
|
||||
|
||||
### Step 2: Detect Document Types
|
||||
|
||||
From the source file names and the distillate's content, infer what type of document each source was:
|
||||
- Product brief, discovery notes, research report, architecture doc, PRD, etc.
|
||||
- Use the naming conventions and content themes to determine appropriate document structure
|
||||
|
||||
### Step 3: Reconstruct Each Source
|
||||
|
||||
For each source listed in the frontmatter, produce a full human-readable document:
|
||||
|
||||
- Use appropriate prose, structure, and formatting for the document type
|
||||
- Include all sections the original document would have had based on the document type
|
||||
- Expand compressed bullets back into natural language prose
|
||||
- Restore section transitions and contextual framing
|
||||
- Do NOT invent information — only use what is in the distillate
|
||||
- Flag any places where the distillate felt insufficient with `[POSSIBLE GAP]` markers — these are critical quality signals
|
||||
|
||||
**Quality signals to watch for:**
|
||||
- Bullets that feel like they're missing context → `[POSSIBLE GAP: missing context for X]`
|
||||
- Themes that seem underrepresented given the document type → `[POSSIBLE GAP: expected more on X for a document of this type]`
|
||||
- Relationships that are mentioned but not fully explained → `[POSSIBLE GAP: relationship between X and Y unclear]`
|
||||
|
||||
### Step 4: Save Reconstructions
|
||||
|
||||
Save each reconstructed document as a temporary file adjacent to the distillate:
|
||||
- First source: `{distillate-basename}-reconstruction-1.md`
|
||||
- Second source: `{distillate-basename}-reconstruction-2.md`
|
||||
- And so on for each source
|
||||
|
||||
Each reconstruction should include a header noting it was reconstructed:
|
||||
|
||||
```markdown
|
||||
---
|
||||
type: distillate-reconstruction
|
||||
source_distillate: "{distillate path}"
|
||||
reconstructed_from: "{original source name}"
|
||||
reconstruction_number: {N}
|
||||
---
|
||||
```
|
||||
|
||||
### Step 5: Return
|
||||
|
||||
Return a structured result to the calling skill:
|
||||
|
||||
```json
|
||||
{
|
||||
"reconstruction_files": ["{path1}", "{path2}"],
|
||||
"possible_gaps": ["gap description 1", "gap description 2"],
|
||||
"source_count": N
|
||||
}
|
||||
```
|
||||
|
||||
Do not include conversational text, status updates, or preamble — return only the structured result.
|
||||
15
_bmad/core/skills/bmad-distillator/bmad-skill-manifest.yaml
Normal file
15
_bmad/core/skills/bmad-distillator/bmad-skill-manifest.yaml
Normal file
@@ -0,0 +1,15 @@
|
||||
type: skill
|
||||
module: core
|
||||
capabilities:
|
||||
- name: bmad-distillator
|
||||
menu-code: DSTL
|
||||
description: "Produces lossless LLM-optimized distillate from source documents. Use after producing large human presentable documents that will be consumed later by LLMs"
|
||||
supports-headless: true
|
||||
input: source documents
|
||||
args: output, validate
|
||||
output: single distillate or folder of distillates next to source input
|
||||
config-vars-used: null
|
||||
phase: anytime
|
||||
before: []
|
||||
after: []
|
||||
is-required: false
|
||||
@@ -0,0 +1,51 @@
|
||||
# Compression Rules
|
||||
|
||||
These rules govern how source text is compressed into distillate format. Apply as a final pass over all output.
|
||||
|
||||
## Strip — Remove entirely
|
||||
|
||||
- Prose transitions: "As mentioned earlier", "It's worth noting", "In addition to this"
|
||||
- Rhetoric and persuasion: "This is a game-changer", "The exciting thing is"
|
||||
- Hedging: "We believe", "It's likely that", "Perhaps", "It seems"
|
||||
- Self-reference: "This document describes", "As outlined above"
|
||||
- Common knowledge explanations: "Vercel is a cloud platform company", "MIT is an open-source license", "JSON is a data interchange format"
|
||||
- Repeated introductions of the same concept
|
||||
- Section transition paragraphs
|
||||
- Formatting-only elements (decorative bold/italic for emphasis, horizontal rules for visual breaks)
|
||||
- Filler phrases: "In order to", "It should be noted that", "The fact that"
|
||||
|
||||
## Preserve — Keep always
|
||||
|
||||
- Specific numbers, dates, versions, percentages
|
||||
- Named entities (products, companies, people, technologies)
|
||||
- Decisions made and their rationale (compressed: "Decision: X. Reason: Y")
|
||||
- Rejected alternatives and why (compressed: "Rejected: X. Reason: Y")
|
||||
- Explicit constraints and non-negotiables
|
||||
- Dependencies and ordering relationships
|
||||
- Open questions and unresolved items
|
||||
- Scope boundaries (in/out/deferred)
|
||||
- Success criteria and how they're validated
|
||||
- User segments and what success means for each
|
||||
- Risks with their severity signals
|
||||
- Conflicts between source documents
|
||||
|
||||
## Transform — Change form for efficiency
|
||||
|
||||
- Long prose paragraphs → single dense bullet capturing the same information
|
||||
- "We decided to use X because Y and Z" → "X (rationale: Y, Z)"
|
||||
- Repeated category labels → group under a single heading, no per-item labels
|
||||
- "Risk: ... Severity: high" → "HIGH RISK: ..."
|
||||
- Conditional statements → "If X → Y" form
|
||||
- Multi-sentence explanations → semicolon-separated compressed form
|
||||
- Lists of related short items → single bullet with semicolons
|
||||
- "X is used for Y" → "X: Y" when context is clear
|
||||
- Verbose enumerations → parenthetical lists: "platforms (Cursor, Claude Code, Windsurf, Copilot)"
|
||||
|
||||
## Deduplication Rules
|
||||
|
||||
- Same fact in multiple documents → keep the version with most context
|
||||
- Same concept at different detail levels → keep the detailed version
|
||||
- Overlapping lists → merge into single list, no duplicates
|
||||
- When source documents disagree → note the conflict explicitly: "Brief says X; discovery notes say Y — unresolved"
|
||||
- Executive summary points that are expanded elsewhere → keep only the expanded version
|
||||
- Introductory framing repeated across sections → capture once under the most relevant theme
|
||||
@@ -0,0 +1,227 @@
|
||||
# Distillate Format Reference
|
||||
|
||||
Examples showing the transformation from human-readable source content to distillate format.
|
||||
|
||||
## Frontmatter
|
||||
|
||||
Every distillate includes YAML frontmatter. Source paths are relative to the distillate's location so the distillate remains portable:
|
||||
|
||||
```yaml
|
||||
---
|
||||
type: bmad-distillate
|
||||
sources:
|
||||
- "product-brief-example.md"
|
||||
- "product-brief-example-discovery-notes.md"
|
||||
downstream_consumer: "PRD creation"
|
||||
created: "2026-03-13"
|
||||
token_estimate: 1200
|
||||
parts: 1
|
||||
---
|
||||
```
|
||||
|
||||
## Before/After Examples
|
||||
|
||||
### Prose Paragraph to Dense Bullet
|
||||
|
||||
**Before** (human-readable brief excerpt):
|
||||
```
|
||||
## What Makes This Different
|
||||
|
||||
**The anti-fragmentation layer.** The AI tooling space is fracturing across 40+
|
||||
platforms with no shared methodology layer. BMAD is uniquely positioned to be the
|
||||
cross-platform constant — the structured approach that works the same in Cursor,
|
||||
Claude Code, Windsurf, Copilot, and whatever launches next month. Every other
|
||||
methodology or skill framework maintains its own platform support matrix. By
|
||||
building on the open-source skills CLI ecosystem, BMAD offloads the highest-churn
|
||||
maintenance burden and focuses on what actually differentiates it: the methodology
|
||||
itself.
|
||||
```
|
||||
|
||||
**After** (distillate):
|
||||
```
|
||||
## Differentiation
|
||||
- Anti-fragmentation positioning: BMAD = cross-platform constant across 40+ fragmenting AI tools; no competitor provides shared methodology layer
|
||||
- Platform complexity delegated to Vercel skills CLI ecosystem (MIT); BMAD maintains methodology, not platform configs
|
||||
```
|
||||
|
||||
### Technical Details to Compressed Facts
|
||||
|
||||
**Before** (discovery notes excerpt):
|
||||
```
|
||||
## Competitive Landscape
|
||||
|
||||
- **Vercel Skills.sh**: 83K+ skills, 18 agents, largest curated leaderboard —
|
||||
but dev-only, skills trigger unreliably (20% without explicit prompting)
|
||||
- **SkillsMP**: 400K+ skills directory, pure aggregator with no curation or CLI
|
||||
- **ClawHub/OpenClaw**: ~3.2K curated skills with versioning/rollback, small ecosystem
|
||||
- **Lindy**: No-code AI agent builder for business automation — closed platform,
|
||||
no skill sharing
|
||||
- **Microsoft Copilot Studio**: Enterprise no-code agent builder — vendor-locked
|
||||
to Microsoft
|
||||
- **MindStudio**: No-code AI agent platform — siloed, no interoperability
|
||||
- **Make/Zapier AI**: Workflow automation adding AI agents — workflow-centric,
|
||||
not methodology-centric
|
||||
- **Key gap**: NO competitor combines structured methodology with plugin
|
||||
marketplace — this is BMAD's whitespace
|
||||
```
|
||||
|
||||
**After** (distillate):
|
||||
```
|
||||
## Competitive Landscape
|
||||
- No competitor combines structured methodology + plugin marketplace (whitespace)
|
||||
- Skills.sh (Vercel): 83K skills, 18 agents, dev-only, 20% trigger reliability
|
||||
- SkillsMP: 400K skills, aggregator only, no curation/CLI
|
||||
- ClawHub: 3.2K curated, versioning, small ecosystem
|
||||
- No-code platforms (Lindy, Copilot Studio, MindStudio, Make/Zapier): closed/siloed, no skill portability, business-only
|
||||
```
|
||||
|
||||
### Deduplication Across Documents
|
||||
|
||||
When the same fact appears in both a brief and discovery notes:
|
||||
|
||||
**Brief says:**
|
||||
```
|
||||
bmad-init must always be included as a base skill in every bundle
|
||||
```
|
||||
|
||||
**Discovery notes say:**
|
||||
```
|
||||
bmad-init must always be included as a base skill in every bundle/install
|
||||
(solves bootstrapping problem)
|
||||
```
|
||||
|
||||
**Distillate keeps the more contextual version:**
|
||||
```
|
||||
- bmad-init: always included as base skill in every bundle (solves bootstrapping)
|
||||
```
|
||||
|
||||
### Decision/Rationale Compression
|
||||
|
||||
**Before:**
|
||||
```
|
||||
We decided not to build our own platform support matrix going forward, instead
|
||||
delegating to the Vercel skills CLI ecosystem. The rationale is that maintaining
|
||||
20+ platform configs is the biggest maintenance burden and it's unsustainable
|
||||
at 40+ platforms.
|
||||
```
|
||||
|
||||
**After:**
|
||||
```
|
||||
- Rejected: own platform support matrix. Reason: unsustainable at 40+ platforms; delegate to Vercel CLI ecosystem
|
||||
```
|
||||
|
||||
## Full Example
|
||||
|
||||
A complete distillate produced from a product brief and its discovery notes, targeted at PRD creation:
|
||||
|
||||
```markdown
|
||||
---
|
||||
type: bmad-distillate
|
||||
sources:
|
||||
- "product-brief-bmad-next-gen-installer.md"
|
||||
- "product-brief-bmad-next-gen-installer-discovery-notes.md"
|
||||
downstream_consumer: "PRD creation"
|
||||
created: "2026-03-13"
|
||||
token_estimate: 1450
|
||||
parts: 1
|
||||
---
|
||||
|
||||
## Core Concept
|
||||
- BMAD Next-Gen Installer: replaces monolithic Node.js CLI with skill-based plugin architecture for distributing BMAD methodology across 40+ AI platforms
|
||||
- Three layers: self-describing plugins (bmad-manifest.json), cross-platform install via Vercel skills CLI (MIT), runtime registration via bmad-init skill
|
||||
- Transforms BMAD from dev-only methodology into open platform for any domain (creative, therapeutic, educational, personal)
|
||||
|
||||
## Problem
|
||||
- Current installer maintains ~20 platform configs manually; each platform convention change requires installer update, test, release — largest maintenance burden on team
|
||||
- Node.js/npm required — blocks non-technical users on UI-based platforms (Claude Co-Work, etc.)
|
||||
- CSV manifests are static, generated once at install; no runtime scanning/registration
|
||||
- Unsustainable at 40+ platforms; new tools launching weekly
|
||||
|
||||
## Solution Architecture
|
||||
- Plugins: skill bundles with Anthropic plugin standard as base format + bmad-manifest.json extending for BMAD-specific metadata (installer options, capabilities, help integration, phase ordering, dependencies)
|
||||
- Existing manifest example: `{"module-code":"bmm","replaces-skill":"bmad-create-product-brief","capabilities":[{"name":"create-brief","menu-code":"CB","supports-headless":true,"phase-name":"1-analysis","after":["brainstorming"],"before":["create-prd"],"is-required":true}]}`
|
||||
- Vercel skills CLI handles platform translation; integration pattern (wrap/fork/call) is PRD decision
|
||||
- bmad-init: global skill scanning installed bmad-manifest.json files, registering capabilities, configuring project settings; always included as base skill in every bundle (solves bootstrapping)
|
||||
- bmad-update: plugin update path without full reinstall; technical approach (diff/replace/preserve customizations) is PRD decision
|
||||
- Distribution tiers: (1) NPX installer wrapping skills CLI for technical users, (2) zip bundle + platform-specific README for non-technical users, (3) future marketplace
|
||||
- Non-technical path has honest friction: "copy to right folder" requires knowing where; per-platform README instructions; improves over time as low-code space matures
|
||||
|
||||
## Differentiation
|
||||
- Anti-fragmentation: BMAD = cross-platform constant; no competitor provides shared methodology layer across AI tools
|
||||
- Curated quality: all submissions gated, human-reviewed by BMad + core team; 13.4% of community skills have critical vulnerabilities (Snyk 2026); quality gate value increases as ecosystem gets noisier
|
||||
- Domain-agnostic: no competitor builds beyond software dev workflows; same plugin system powers any domain via BMAD Builder (separate initiative)
|
||||
|
||||
## Users (ordered by v1 priority)
|
||||
- Module authors (primary v1): package/test/distribute plugins independently without installer changes
|
||||
- Developers: single-command install on any of 40+ platforms via NPX
|
||||
- Non-technical users: install without Node/Git/terminal; emerging segment including PMs, designers, educators
|
||||
- Future plugin creators: non-dev authors using BMAD Builder; need distribution without building own installer
|
||||
|
||||
## Success Criteria
|
||||
- Zero (or near-zero) custom platform directory code; delegated to skills CLI ecosystem
|
||||
- Installation verified on top platforms by volume; skills CLI handles long tail
|
||||
- Non-technical install path validated with non-developer users
|
||||
- bmad-init discovers/registers all plugins from manifests; clear errors for malformed manifests
|
||||
- At least one external module author successfully publishes plugin using manifest system
|
||||
- bmad-update works without full reinstall
|
||||
- Existing CLI users have documented migration path
|
||||
|
||||
## Scope
|
||||
- In: manifest spec, bmad-init, bmad-update, Vercel CLI integration, NPX installer, zip bundles, migration path
|
||||
- Out: BMAD Builder, marketplace web platform, skill conversion (prerequisite, separate), one-click install for all platforms, monetization, quality certification process (gated-submission principle is architectural requirement; process defined separately)
|
||||
- Deferred: CI/CD integration, telemetry for module authors, air-gapped enterprise install, zip bundle integrity verification (checksums/signing), deeper non-technical platform integrations
|
||||
|
||||
## Current Installer (migration context)
|
||||
- Entry: `tools/cli/bmad-cli.js` (Commander.js) → `tools/cli/installers/lib/core/installer.js`
|
||||
- Platforms: `platform-codes.yaml` (~20 platforms with target dirs, legacy dirs, template types, special flags)
|
||||
- Manifests: CSV files (skill/workflow/agent-manifest.csv) are current source of truth, not JSON
|
||||
- External modules: `external-official-modules.yaml` (CIS, GDS, TEA, WDS) from npm with semver
|
||||
- Dependencies: 4-pass resolver (collect → parse → resolve → transitive); YAML-declared only
|
||||
- Config: prompts for name, communication language, document output language, output folder
|
||||
- Skills already use directory-per-skill layout; bmad-manifest.json sidecars exist but are not source of truth
|
||||
- Key shift: CSV-based static manifests → JSON-based runtime scanning
|
||||
|
||||
## Vercel Skills CLI
|
||||
- `npx skills add <source>` — GitHub, GitLab, local paths, git URLs
|
||||
- 40+ agents; per-agent path mappings; symlinks (recommended) or copies
|
||||
- Scopes: project-level or global
|
||||
- Discovery: `skills/`, `.agents/skills/`, agent-specific paths, `.claude-plugin/marketplace.json`
|
||||
- Commands: add, list, find, remove, check, update, init
|
||||
- Non-interactive: `-y`, `--all` flags for CI/CD
|
||||
|
||||
## Competitive Landscape
|
||||
- No competitor combines structured methodology + plugin marketplace (whitespace)
|
||||
- Skills.sh (Vercel): 83K skills, dev-only, 20% trigger reliability without explicit prompting
|
||||
- SkillsMP: 400K skills, aggregator only, no curation
|
||||
- ClawHub: 3.2K curated, versioning, small
|
||||
- No-code platforms (Lindy, Copilot Studio, MindStudio, Make/Zapier): closed/siloed, no skill portability, business-only
|
||||
- Market: $7.84B (2025) → $52.62B (2030); Agent Skills spec ~4 months old, 351K+ skills; standards converging under Linux Foundation AAIF (MCP, AGENTS.md, A2A)
|
||||
|
||||
## Rejected Alternatives
|
||||
- Building own platform support matrix: unsustainable at 40+; delegate to Vercel ecosystem
|
||||
- One-click install for non-technical v1: emerging space; guidance-based, improve over time
|
||||
- Prior roadmap/brainstorming: clean start, unconstrained by previous planning
|
||||
|
||||
## Open Questions
|
||||
- Vercel CLI integration pattern: wrap/fork/call/peer dependency?
|
||||
- bmad-update mechanics: diff/replace? Preserve user customizations?
|
||||
- Migration story: command/manual reinstall/compatibility shim?
|
||||
- Cross-platform testing: CI matrix for top N? Community testing for rest?
|
||||
- bmad-manifest.json as open standard submission to Agent Skills governance?
|
||||
- Platforms NOT supported by Vercel skills CLI?
|
||||
- Manifest versioning strategy for backward compatibility?
|
||||
- Plugin author getting-started experience and tooling?
|
||||
|
||||
## Opportunities
|
||||
- Module authors as acquisition channel: each published plugin distributes BMAD to creator's audience
|
||||
- CI/CD integration: bmad-init as pipeline one-liner increases stickiness
|
||||
- Educational institutions: structured methodology + non-technical install → university AI curriculum
|
||||
- Skill composability: mixing BMAD modules with third-party skills for custom methodology stacks
|
||||
|
||||
## Risks
|
||||
- Manifest format evolution creates versioning/compatibility burden once third-party authors publish
|
||||
- Quality gate needs defined process, not just claim — gated review model addresses
|
||||
- 40+ platform testing environments even with Vercel handling translation
|
||||
- Scope creep pressure from marketplace vision (explicitly excluded but primary long-term value)
|
||||
- Vercel dependency: minor supply-chain risk; MIT license allows fork if deprioritized
|
||||
```
|
||||
@@ -0,0 +1,78 @@
|
||||
# Semantic Splitting Strategy
|
||||
|
||||
When the source content is large (exceeds ~15,000 tokens) or a token_budget requires it, split the distillate into semantically coherent sections rather than arbitrary size breaks.
|
||||
|
||||
## Why Semantic Over Size-Based
|
||||
|
||||
Arbitrary splits (every N tokens) break coherence. A downstream workflow loading "part 2 of 4" gets context fragments. Semantic splits produce self-contained topic clusters that a workflow can load selectively — "give me just the technical decisions section" — which is more useful and more token-efficient for the consumer.
|
||||
|
||||
## Splitting Process
|
||||
|
||||
### 1. Identify Natural Boundaries
|
||||
|
||||
After the initial extraction and deduplication (Steps 1-2 of the compression process), look for natural semantic boundaries:
|
||||
- Distinct problem domains or functional areas
|
||||
- Different stakeholder perspectives (users, technical, business)
|
||||
- Temporal boundaries (current state vs future vision)
|
||||
- Scope boundaries (in-scope vs out-of-scope vs deferred)
|
||||
- Phase boundaries (analysis, design, implementation)
|
||||
|
||||
Choose boundaries that produce sections a downstream workflow might load independently.
|
||||
|
||||
### 2. Assign Items to Sections
|
||||
|
||||
For each extracted item, assign it to the most relevant section. Items that span multiple sections go in the root distillate.
|
||||
|
||||
Cross-cutting items (items relevant to multiple sections):
|
||||
- Constraints that affect all areas → root distillate
|
||||
- Decisions with broad impact → root distillate
|
||||
- Section-specific decisions → section distillate
|
||||
|
||||
### 3. Produce Root Distillate
|
||||
|
||||
The root distillate contains:
|
||||
- **Orientation** (3-5 bullets): what was distilled, from what sources, for what consumer, how many sections
|
||||
- **Cross-references**: list of section distillates with 1-line descriptions
|
||||
- **Cross-cutting items**: facts, decisions, and constraints that span multiple sections
|
||||
- **Scope summary**: high-level in/out/deferred if applicable
|
||||
|
||||
### 4. Produce Section Distillates
|
||||
|
||||
Each section distillate must be self-sufficient — a reader loading only one section should understand it without the others.
|
||||
|
||||
Each section includes:
|
||||
- **Context header** (1 line): "This section covers [topic]. Part N of M from [source document names]."
|
||||
- **Section content**: thematically-grouped bullets following the same compression rules as a single distillate
|
||||
- **Cross-references** (if needed): pointers to other sections for related content
|
||||
|
||||
### 5. Output Structure
|
||||
|
||||
Create a folder `{base-name}-distillate/` containing:
|
||||
|
||||
```
|
||||
{base-name}-distillate/
|
||||
├── _index.md # Root distillate: orientation, cross-cutting items, section manifest
|
||||
├── 01-{topic-slug}.md # Self-contained section
|
||||
├── 02-{topic-slug}.md
|
||||
└── 03-{topic-slug}.md
|
||||
```
|
||||
|
||||
Example:
|
||||
```
|
||||
product-brief-distillate/
|
||||
├── _index.md
|
||||
├── 01-problem-solution.md
|
||||
├── 02-technical-decisions.md
|
||||
└── 03-users-market.md
|
||||
```
|
||||
|
||||
## Size Targets
|
||||
|
||||
When a token_budget is specified:
|
||||
- Root distillate: ~20% of budget (orientation + cross-cutting items)
|
||||
- Remaining budget split proportionally across sections based on content density
|
||||
- If a section exceeds its proportional share, compress more aggressively or sub-split
|
||||
|
||||
When no token_budget but splitting is needed:
|
||||
- Aim for sections of 3,000-5,000 tokens each
|
||||
- Root distillate as small as possible while remaining useful standalone
|
||||
300
_bmad/core/skills/bmad-distillator/scripts/analyze_sources.py
Normal file
300
_bmad/core/skills/bmad-distillator/scripts/analyze_sources.py
Normal file
@@ -0,0 +1,300 @@
|
||||
# /// script
|
||||
# /// requires-python = ">=3.10"
|
||||
# /// dependencies = []
|
||||
# ///
|
||||
"""Analyze source documents for the distillation generator.
|
||||
|
||||
Enumerates files from paths/folders/globs, computes sizes and token estimates,
|
||||
detects document types from naming conventions, and suggests groupings for
|
||||
related documents (e.g., a brief paired with its discovery notes).
|
||||
|
||||
Accepts: file paths, folder paths (scans recursively for .md/.txt/.yaml/.yml/.json),
|
||||
or glob patterns. Skips node_modules, .git, __pycache__, .venv, _bmad-output.
|
||||
|
||||
Output JSON structure:
|
||||
status: "ok" | "error"
|
||||
files[]: path, filename, size_bytes, estimated_tokens, doc_type
|
||||
summary: total_files, total_size_bytes, total_estimated_tokens
|
||||
groups[]: group_key, files[] with role (primary/companion/standalone)
|
||||
- Groups related docs by naming convention (e.g., brief + discovery-notes)
|
||||
routing: recommendation ("single" | "fan-out"), reason
|
||||
- single: ≤3 files AND ≤15K estimated tokens
|
||||
- fan-out: >3 files OR >15K estimated tokens
|
||||
split_prediction: prediction ("likely" | "unlikely"), reason, estimated_distillate_tokens
|
||||
- Estimates distillate at ~1/3 source size; splits if >5K tokens
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import glob
|
||||
import json
|
||||
import os
|
||||
import re
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
# Extensions to include when scanning folders
|
||||
INCLUDE_EXTENSIONS = {".md", ".txt", ".yaml", ".yml", ".json"}
|
||||
|
||||
# Directories to skip when scanning folders
|
||||
SKIP_DIRS = {
|
||||
"node_modules", ".git", "__pycache__", ".venv", "venv",
|
||||
".claude", "_bmad-output", ".cursor", ".vscode",
|
||||
}
|
||||
|
||||
# Approximate chars per token for estimation
|
||||
CHARS_PER_TOKEN = 4
|
||||
|
||||
# Thresholds
|
||||
SINGLE_COMPRESSOR_MAX_TOKENS = 15_000
|
||||
SINGLE_DISTILLATE_MAX_TOKENS = 5_000
|
||||
|
||||
# Naming patterns for document type detection
|
||||
DOC_TYPE_PATTERNS = [
|
||||
(r"discovery[_-]notes", "discovery-notes"),
|
||||
(r"product[_-]brief", "product-brief"),
|
||||
(r"research[_-]report", "research-report"),
|
||||
(r"architecture", "architecture-doc"),
|
||||
(r"prd", "prd"),
|
||||
(r"distillate", "distillate"),
|
||||
(r"changelog", "changelog"),
|
||||
(r"readme", "readme"),
|
||||
(r"spec", "specification"),
|
||||
(r"requirements", "requirements"),
|
||||
(r"design[_-]doc", "design-doc"),
|
||||
(r"meeting[_-]notes", "meeting-notes"),
|
||||
(r"brainstorm", "brainstorming"),
|
||||
(r"interview", "interview-notes"),
|
||||
]
|
||||
|
||||
# Patterns for grouping related documents
|
||||
GROUP_PATTERNS = [
|
||||
# base document + discovery notes
|
||||
(r"^(.+?)(?:-discovery-notes|-discovery_notes)\.(\w+)$", r"\1.\2"),
|
||||
# base document + appendix
|
||||
(r"^(.+?)(?:-appendix|-addendum)(?:-\w+)?\.(\w+)$", r"\1.\2"),
|
||||
# base document + review/feedback
|
||||
(r"^(.+?)(?:-review|-feedback)\.(\w+)$", r"\1.\2"),
|
||||
]
|
||||
|
||||
|
||||
def resolve_inputs(inputs: list[str]) -> list[Path]:
|
||||
"""Resolve input arguments to a flat list of file paths."""
|
||||
files: list[Path] = []
|
||||
for inp in inputs:
|
||||
path = Path(inp)
|
||||
if path.is_file():
|
||||
files.append(path.resolve())
|
||||
elif path.is_dir():
|
||||
for root, dirs, filenames in os.walk(path):
|
||||
dirs[:] = [d for d in dirs if d not in SKIP_DIRS]
|
||||
for fn in sorted(filenames):
|
||||
fp = Path(root) / fn
|
||||
if fp.suffix.lower() in INCLUDE_EXTENSIONS:
|
||||
files.append(fp.resolve())
|
||||
else:
|
||||
# Try as glob
|
||||
matches = glob.glob(inp, recursive=True)
|
||||
for m in sorted(matches):
|
||||
mp = Path(m)
|
||||
if mp.is_file() and mp.suffix.lower() in INCLUDE_EXTENSIONS:
|
||||
files.append(mp.resolve())
|
||||
# Deduplicate while preserving order
|
||||
seen: set[Path] = set()
|
||||
deduped: list[Path] = []
|
||||
for f in files:
|
||||
if f not in seen:
|
||||
seen.add(f)
|
||||
deduped.append(f)
|
||||
return deduped
|
||||
|
||||
|
||||
def detect_doc_type(filename: str) -> str:
|
||||
"""Detect document type from filename."""
|
||||
name_lower = filename.lower()
|
||||
for pattern, doc_type in DOC_TYPE_PATTERNS:
|
||||
if re.search(pattern, name_lower):
|
||||
return doc_type
|
||||
return "unknown"
|
||||
|
||||
|
||||
def suggest_groups(files: list[Path]) -> list[dict]:
|
||||
"""Suggest document groupings based on naming conventions."""
|
||||
groups: dict[str, list[dict]] = {}
|
||||
ungrouped: list[dict] = []
|
||||
|
||||
file_map = {f.name: f for f in files}
|
||||
|
||||
assigned: set[str] = set()
|
||||
|
||||
for f in files:
|
||||
if f.name in assigned:
|
||||
continue
|
||||
|
||||
matched = False
|
||||
for pattern, base_pattern in GROUP_PATTERNS:
|
||||
m = re.match(pattern, f.name, re.IGNORECASE)
|
||||
if m:
|
||||
# This file is a companion — find its base
|
||||
base_name = re.sub(pattern, base_pattern, f.name, flags=re.IGNORECASE)
|
||||
group_key = base_name
|
||||
if group_key not in groups:
|
||||
groups[group_key] = []
|
||||
# Add the base file if it exists
|
||||
if base_name in file_map and base_name not in assigned:
|
||||
groups[group_key].append({
|
||||
"path": str(file_map[base_name]),
|
||||
"filename": base_name,
|
||||
"role": "primary",
|
||||
})
|
||||
assigned.add(base_name)
|
||||
groups[group_key].append({
|
||||
"path": str(f),
|
||||
"filename": f.name,
|
||||
"role": "companion",
|
||||
})
|
||||
assigned.add(f.name)
|
||||
matched = True
|
||||
break
|
||||
|
||||
if not matched:
|
||||
# Check if this file is a base that already has companions
|
||||
if f.name in groups:
|
||||
continue # Already added as primary
|
||||
ungrouped.append({
|
||||
"path": str(f),
|
||||
"filename": f.name,
|
||||
})
|
||||
|
||||
result = []
|
||||
for group_key, members in groups.items():
|
||||
result.append({
|
||||
"group_key": group_key,
|
||||
"files": members,
|
||||
})
|
||||
for ug in ungrouped:
|
||||
if ug["filename"] not in assigned:
|
||||
result.append({
|
||||
"group_key": ug["filename"],
|
||||
"files": [{"path": ug["path"], "filename": ug["filename"], "role": "standalone"}],
|
||||
})
|
||||
|
||||
return result
|
||||
|
||||
|
||||
def analyze(inputs: list[str], output_path: str | None = None) -> None:
|
||||
"""Main analysis function."""
|
||||
files = resolve_inputs(inputs)
|
||||
|
||||
if not files:
|
||||
result = {
|
||||
"status": "error",
|
||||
"error": "No readable files found from provided inputs",
|
||||
"inputs": inputs,
|
||||
}
|
||||
output_json(result, output_path)
|
||||
return
|
||||
|
||||
# Analyze each file
|
||||
file_details = []
|
||||
total_chars = 0
|
||||
for f in files:
|
||||
size = f.stat().st_size
|
||||
total_chars += size
|
||||
file_details.append({
|
||||
"path": str(f),
|
||||
"filename": f.name,
|
||||
"size_bytes": size,
|
||||
"estimated_tokens": size // CHARS_PER_TOKEN,
|
||||
"doc_type": detect_doc_type(f.name),
|
||||
})
|
||||
|
||||
total_tokens = total_chars // CHARS_PER_TOKEN
|
||||
groups = suggest_groups(files)
|
||||
|
||||
# Routing recommendation
|
||||
if len(files) <= 3 and total_tokens <= SINGLE_COMPRESSOR_MAX_TOKENS:
|
||||
routing = "single"
|
||||
routing_reason = (
|
||||
f"{len(files)} file(s), ~{total_tokens:,} estimated tokens — "
|
||||
f"within single compressor threshold"
|
||||
)
|
||||
else:
|
||||
routing = "fan-out"
|
||||
routing_reason = (
|
||||
f"{len(files)} file(s), ~{total_tokens:,} estimated tokens — "
|
||||
f"exceeds single compressor threshold "
|
||||
f"({'>' + str(SINGLE_COMPRESSOR_MAX_TOKENS) + ' tokens' if total_tokens > SINGLE_COMPRESSOR_MAX_TOKENS else '> 3 files'})"
|
||||
)
|
||||
|
||||
# Split prediction
|
||||
estimated_distillate_tokens = total_tokens // 3 # rough: distillate is ~1/3 of source
|
||||
if estimated_distillate_tokens > SINGLE_DISTILLATE_MAX_TOKENS:
|
||||
split_prediction = "likely"
|
||||
split_reason = (
|
||||
f"Estimated distillate ~{estimated_distillate_tokens:,} tokens "
|
||||
f"exceeds {SINGLE_DISTILLATE_MAX_TOKENS:,} threshold"
|
||||
)
|
||||
else:
|
||||
split_prediction = "unlikely"
|
||||
split_reason = (
|
||||
f"Estimated distillate ~{estimated_distillate_tokens:,} tokens "
|
||||
f"within {SINGLE_DISTILLATE_MAX_TOKENS:,} threshold"
|
||||
)
|
||||
|
||||
result = {
|
||||
"status": "ok",
|
||||
"files": file_details,
|
||||
"summary": {
|
||||
"total_files": len(files),
|
||||
"total_size_bytes": total_chars,
|
||||
"total_estimated_tokens": total_tokens,
|
||||
},
|
||||
"groups": groups,
|
||||
"routing": {
|
||||
"recommendation": routing,
|
||||
"reason": routing_reason,
|
||||
},
|
||||
"split_prediction": {
|
||||
"prediction": split_prediction,
|
||||
"reason": split_reason,
|
||||
"estimated_distillate_tokens": estimated_distillate_tokens,
|
||||
},
|
||||
}
|
||||
|
||||
output_json(result, output_path)
|
||||
|
||||
|
||||
def output_json(data: dict, output_path: str | None) -> None:
|
||||
"""Write JSON to file or stdout."""
|
||||
json_str = json.dumps(data, indent=2)
|
||||
if output_path:
|
||||
Path(output_path).parent.mkdir(parents=True, exist_ok=True)
|
||||
Path(output_path).write_text(json_str + "\n")
|
||||
print(f"Results written to {output_path}", file=sys.stderr)
|
||||
else:
|
||||
print(json_str)
|
||||
|
||||
|
||||
def main() -> None:
|
||||
parser = argparse.ArgumentParser(
|
||||
description=__doc__,
|
||||
formatter_class=argparse.RawDescriptionHelpFormatter,
|
||||
)
|
||||
parser.add_argument(
|
||||
"inputs",
|
||||
nargs="+",
|
||||
help="File paths, folder paths, or glob patterns to analyze",
|
||||
)
|
||||
parser.add_argument(
|
||||
"-o", "--output",
|
||||
help="Output JSON to file instead of stdout",
|
||||
)
|
||||
args = parser.parse_args()
|
||||
analyze(args.inputs, args.output)
|
||||
sys.exit(0)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,204 @@
|
||||
"""Tests for analyze_sources.py"""
|
||||
|
||||
import json
|
||||
import os
|
||||
import tempfile
|
||||
from pathlib import Path
|
||||
from unittest.mock import patch
|
||||
|
||||
import pytest
|
||||
|
||||
# Add parent dir to path so we can import the script
|
||||
import sys
|
||||
sys.path.insert(0, str(Path(__file__).parent.parent))
|
||||
|
||||
from analyze_sources import (
|
||||
resolve_inputs,
|
||||
detect_doc_type,
|
||||
suggest_groups,
|
||||
analyze,
|
||||
INCLUDE_EXTENSIONS,
|
||||
SKIP_DIRS,
|
||||
)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def temp_dir():
|
||||
"""Create a temp directory with sample files."""
|
||||
with tempfile.TemporaryDirectory() as d:
|
||||
# Create sample files
|
||||
(Path(d) / "product-brief-foo.md").write_text("# Product Brief\nContent here")
|
||||
(Path(d) / "product-brief-foo-discovery-notes.md").write_text("# Discovery\nNotes")
|
||||
(Path(d) / "architecture-doc.md").write_text("# Architecture\nDesign here")
|
||||
(Path(d) / "research-report.md").write_text("# Research\nFindings")
|
||||
(Path(d) / "random.txt").write_text("Some text content")
|
||||
(Path(d) / "image.png").write_bytes(b"\x89PNG")
|
||||
# Create a subdirectory with more files
|
||||
sub = Path(d) / "subdir"
|
||||
sub.mkdir()
|
||||
(sub / "prd-v2.md").write_text("# PRD\nRequirements")
|
||||
# Create a skip directory
|
||||
skip = Path(d) / "node_modules"
|
||||
skip.mkdir()
|
||||
(skip / "junk.md").write_text("Should be skipped")
|
||||
yield d
|
||||
|
||||
|
||||
class TestResolveInputs:
|
||||
def test_single_file(self, temp_dir):
|
||||
f = str(Path(temp_dir) / "product-brief-foo.md")
|
||||
result = resolve_inputs([f])
|
||||
assert len(result) == 1
|
||||
assert result[0].name == "product-brief-foo.md"
|
||||
|
||||
def test_folder_recursion(self, temp_dir):
|
||||
result = resolve_inputs([temp_dir])
|
||||
names = {f.name for f in result}
|
||||
assert "product-brief-foo.md" in names
|
||||
assert "prd-v2.md" in names
|
||||
assert "random.txt" in names
|
||||
|
||||
def test_folder_skips_excluded_dirs(self, temp_dir):
|
||||
result = resolve_inputs([temp_dir])
|
||||
names = {f.name for f in result}
|
||||
assert "junk.md" not in names
|
||||
|
||||
def test_folder_skips_non_text_files(self, temp_dir):
|
||||
result = resolve_inputs([temp_dir])
|
||||
names = {f.name for f in result}
|
||||
assert "image.png" not in names
|
||||
|
||||
def test_glob_pattern(self, temp_dir):
|
||||
pattern = str(Path(temp_dir) / "product-brief-*.md")
|
||||
result = resolve_inputs([pattern])
|
||||
assert len(result) == 2
|
||||
names = {f.name for f in result}
|
||||
assert "product-brief-foo.md" in names
|
||||
assert "product-brief-foo-discovery-notes.md" in names
|
||||
|
||||
def test_deduplication(self, temp_dir):
|
||||
f = str(Path(temp_dir) / "product-brief-foo.md")
|
||||
result = resolve_inputs([f, f, f])
|
||||
assert len(result) == 1
|
||||
|
||||
def test_mixed_inputs(self, temp_dir):
|
||||
file_path = str(Path(temp_dir) / "architecture-doc.md")
|
||||
folder_path = str(Path(temp_dir) / "subdir")
|
||||
result = resolve_inputs([file_path, folder_path])
|
||||
names = {f.name for f in result}
|
||||
assert "architecture-doc.md" in names
|
||||
assert "prd-v2.md" in names
|
||||
|
||||
def test_nonexistent_path(self):
|
||||
result = resolve_inputs(["/nonexistent/path/file.md"])
|
||||
assert len(result) == 0
|
||||
|
||||
|
||||
class TestDetectDocType:
|
||||
@pytest.mark.parametrize("filename,expected", [
|
||||
("product-brief-foo.md", "product-brief"),
|
||||
("product_brief_bar.md", "product-brief"),
|
||||
("foo-discovery-notes.md", "discovery-notes"),
|
||||
("foo-discovery_notes.md", "discovery-notes"),
|
||||
("architecture-overview.md", "architecture-doc"),
|
||||
("my-prd.md", "prd"),
|
||||
("research-report-q4.md", "research-report"),
|
||||
("foo-distillate.md", "distillate"),
|
||||
("changelog.md", "changelog"),
|
||||
("readme.md", "readme"),
|
||||
("api-spec.md", "specification"),
|
||||
("design-doc-v2.md", "design-doc"),
|
||||
("meeting-notes-2026.md", "meeting-notes"),
|
||||
("brainstorm-session.md", "brainstorming"),
|
||||
("user-interview-notes.md", "interview-notes"),
|
||||
("random-file.md", "unknown"),
|
||||
])
|
||||
def test_detection(self, filename, expected):
|
||||
assert detect_doc_type(filename) == expected
|
||||
|
||||
|
||||
class TestSuggestGroups:
|
||||
def test_groups_brief_with_discovery_notes(self, temp_dir):
|
||||
files = [
|
||||
Path(temp_dir) / "product-brief-foo.md",
|
||||
Path(temp_dir) / "product-brief-foo-discovery-notes.md",
|
||||
]
|
||||
groups = suggest_groups(files)
|
||||
# Should produce one group with both files
|
||||
paired = [g for g in groups if len(g["files"]) > 1]
|
||||
assert len(paired) == 1
|
||||
filenames = {f["filename"] for f in paired[0]["files"]}
|
||||
assert "product-brief-foo.md" in filenames
|
||||
assert "product-brief-foo-discovery-notes.md" in filenames
|
||||
|
||||
def test_standalone_files(self, temp_dir):
|
||||
files = [
|
||||
Path(temp_dir) / "architecture-doc.md",
|
||||
Path(temp_dir) / "research-report.md",
|
||||
]
|
||||
groups = suggest_groups(files)
|
||||
assert len(groups) == 2
|
||||
for g in groups:
|
||||
assert len(g["files"]) == 1
|
||||
|
||||
def test_mixed_grouped_and_standalone(self, temp_dir):
|
||||
files = [
|
||||
Path(temp_dir) / "product-brief-foo.md",
|
||||
Path(temp_dir) / "product-brief-foo-discovery-notes.md",
|
||||
Path(temp_dir) / "architecture-doc.md",
|
||||
]
|
||||
groups = suggest_groups(files)
|
||||
paired = [g for g in groups if len(g["files"]) > 1]
|
||||
standalone = [g for g in groups if len(g["files"]) == 1]
|
||||
assert len(paired) == 1
|
||||
assert len(standalone) == 1
|
||||
|
||||
|
||||
class TestAnalyze:
|
||||
def test_basic_analysis(self, temp_dir):
|
||||
f = str(Path(temp_dir) / "product-brief-foo.md")
|
||||
output_file = str(Path(temp_dir) / "output.json")
|
||||
analyze([f], output_file)
|
||||
result = json.loads(Path(output_file).read_text())
|
||||
assert result["status"] == "ok"
|
||||
assert result["summary"]["total_files"] == 1
|
||||
assert result["files"][0]["doc_type"] == "product-brief"
|
||||
assert result["files"][0]["estimated_tokens"] > 0
|
||||
|
||||
def test_routing_single_small_input(self, temp_dir):
|
||||
f = str(Path(temp_dir) / "product-brief-foo.md")
|
||||
output_file = str(Path(temp_dir) / "output.json")
|
||||
analyze([f], output_file)
|
||||
result = json.loads(Path(output_file).read_text())
|
||||
assert result["routing"]["recommendation"] == "single"
|
||||
|
||||
def test_routing_fanout_many_files(self, temp_dir):
|
||||
# Create enough files to trigger fan-out (> 3 files)
|
||||
for i in range(5):
|
||||
(Path(temp_dir) / f"doc-{i}.md").write_text("x" * 1000)
|
||||
output_file = str(Path(temp_dir) / "output.json")
|
||||
analyze([temp_dir], output_file)
|
||||
result = json.loads(Path(output_file).read_text())
|
||||
assert result["routing"]["recommendation"] == "fan-out"
|
||||
|
||||
def test_folder_analysis(self, temp_dir):
|
||||
output_file = str(Path(temp_dir) / "output.json")
|
||||
analyze([temp_dir], output_file)
|
||||
result = json.loads(Path(output_file).read_text())
|
||||
assert result["status"] == "ok"
|
||||
assert result["summary"]["total_files"] >= 4 # at least the base files
|
||||
assert len(result["groups"]) > 0
|
||||
|
||||
def test_no_files_found(self):
|
||||
output_file = "/tmp/test_analyze_empty.json"
|
||||
analyze(["/nonexistent/path"], output_file)
|
||||
result = json.loads(Path(output_file).read_text())
|
||||
assert result["status"] == "error"
|
||||
os.unlink(output_file)
|
||||
|
||||
def test_stdout_output(self, temp_dir, capsys):
|
||||
f = str(Path(temp_dir) / "product-brief-foo.md")
|
||||
analyze([f])
|
||||
captured = capsys.readouterr()
|
||||
result = json.loads(captured.out)
|
||||
assert result["status"] == "ok"
|
||||
6
_bmad/core/skills/bmad-editorial-review-prose/SKILL.md
Normal file
6
_bmad/core/skills/bmad-editorial-review-prose/SKILL.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
name: bmad-editorial-review-prose
|
||||
description: 'Clinical copy-editor that reviews text for communication issues. Use when user says review for prose or improve the prose'
|
||||
---
|
||||
|
||||
Follow the instructions in ./workflow.md.
|
||||
@@ -0,0 +1 @@
|
||||
type: skill
|
||||
81
_bmad/core/skills/bmad-editorial-review-prose/workflow.md
Normal file
81
_bmad/core/skills/bmad-editorial-review-prose/workflow.md
Normal file
@@ -0,0 +1,81 @@
|
||||
# Editorial Review - Prose
|
||||
|
||||
**Goal:** Review text for communication issues that impede comprehension and output suggested fixes in a three-column table.
|
||||
|
||||
**Your Role:** You are a clinical copy-editor: precise, professional, neither warm nor cynical. Apply Microsoft Writing Style Guide principles as your baseline. Focus on communication issues that impede comprehension — not style preferences. NEVER rewrite for preference — only fix genuine issues. Follow ALL steps in the STEPS section IN EXACT ORDER. DO NOT skip steps or change the sequence. HALT immediately when halt-conditions are met. Each action within a step is a REQUIRED action to complete that step.
|
||||
|
||||
**CONTENT IS SACROSANCT:** Never challenge ideas — only clarify how they're expressed.
|
||||
|
||||
**Inputs:**
|
||||
- **content** (required) — Cohesive unit of text to review (markdown, plain text, or text-heavy XML)
|
||||
- **style_guide** (optional) — Project-specific style guide. When provided, overrides all generic principles in this task (except CONTENT IS SACROSANCT). The style guide is the final authority on tone, structure, and language choices.
|
||||
- **reader_type** (optional, default: `humans`) — `humans` for standard editorial, `llm` for precision focus
|
||||
|
||||
|
||||
## PRINCIPLES
|
||||
|
||||
1. **Minimal intervention:** Apply the smallest fix that achieves clarity
|
||||
2. **Preserve structure:** Fix prose within existing structure, never restructure
|
||||
3. **Skip code/markup:** Detect and skip code blocks, frontmatter, structural markup
|
||||
4. **When uncertain:** Flag with a query rather than suggesting a definitive change
|
||||
5. **Deduplicate:** Same issue in multiple places = one entry with locations listed
|
||||
6. **No conflicts:** Merge overlapping fixes into single entries
|
||||
7. **Respect author voice:** Preserve intentional stylistic choices
|
||||
|
||||
> **STYLE GUIDE OVERRIDE:** If a style_guide input is provided, it overrides ALL generic principles in this task (including the Microsoft Writing Style Guide baseline and reader_type-specific priorities). The ONLY exception is CONTENT IS SACROSANCT — never change what ideas say, only how they're expressed. When style guide conflicts with this task, style guide wins.
|
||||
|
||||
|
||||
## STEPS
|
||||
|
||||
### Step 1: Validate Input
|
||||
|
||||
- Check if content is empty or contains fewer than 3 words
|
||||
- If empty or fewer than 3 words: **HALT** with error: "Content too short for editorial review (minimum 3 words required)"
|
||||
- Validate reader_type is `humans` or `llm` (or not provided, defaulting to `humans`)
|
||||
- If reader_type is invalid: **HALT** with error: "Invalid reader_type. Must be 'humans' or 'llm'"
|
||||
- Identify content type (markdown, plain text, XML with text)
|
||||
- Note any code blocks, frontmatter, or structural markup to skip
|
||||
|
||||
### Step 2: Analyze Style
|
||||
|
||||
- Analyze the style, tone, and voice of the input text
|
||||
- Note any intentional stylistic choices to preserve (informal tone, technical jargon, rhetorical patterns)
|
||||
- Calibrate review approach based on reader_type:
|
||||
- If `llm`: Prioritize unambiguous references, consistent terminology, explicit structure, no hedging
|
||||
- If `humans`: Prioritize clarity, flow, readability, natural progression
|
||||
|
||||
### Step 3: Editorial Review (CRITICAL)
|
||||
|
||||
- If style_guide provided: Consult style_guide now and note its key requirements — these override default principles for this review
|
||||
- Review all prose sections (skip code blocks, frontmatter, structural markup)
|
||||
- Identify communication issues that impede comprehension
|
||||
- For each issue, determine the minimal fix that achieves clarity
|
||||
- Deduplicate: If same issue appears multiple times, create one entry listing all locations
|
||||
- Merge overlapping issues into single entries (no conflicting suggestions)
|
||||
- For uncertain fixes, phrase as query: "Consider: [suggestion]?" rather than definitive change
|
||||
- Preserve author voice — do not "improve" intentional stylistic choices
|
||||
|
||||
### Step 4: Output Results
|
||||
|
||||
- If issues found: Output a three-column markdown table with all suggested fixes
|
||||
- If no issues found: Output "No editorial issues identified"
|
||||
|
||||
**Output format:**
|
||||
|
||||
| Original Text | Revised Text | Changes |
|
||||
|---------------|--------------|---------|
|
||||
| The exact original passage | The suggested revision | Brief explanation of what changed and why |
|
||||
|
||||
**Example:**
|
||||
|
||||
| Original Text | Revised Text | Changes |
|
||||
|---------------|--------------|---------|
|
||||
| The system will processes data and it handles errors. | The system processes data and handles errors. | Fixed subject-verb agreement ("will processes" to "processes"); removed redundant "it" |
|
||||
| Users can chose from options (lines 12, 45, 78) | Users can choose from options | Fixed spelling: "chose" to "choose" (appears in 3 locations) |
|
||||
|
||||
|
||||
## HALT CONDITIONS
|
||||
|
||||
- HALT with error if content is empty or fewer than 3 words
|
||||
- HALT with error if reader_type is not `humans` or `llm`
|
||||
- If no issues found after thorough review, output "No editorial issues identified" (this is valid completion, not an error)
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
name: bmad-editorial-review-structure
|
||||
description: 'Structural editor that proposes cuts, reorganization, and simplification while preserving comprehension. Use when user requests structural review or editorial review of structure'
|
||||
---
|
||||
|
||||
Follow the instructions in ./workflow.md.
|
||||
@@ -0,0 +1 @@
|
||||
type: skill
|
||||
174
_bmad/core/skills/bmad-editorial-review-structure/workflow.md
Normal file
174
_bmad/core/skills/bmad-editorial-review-structure/workflow.md
Normal file
@@ -0,0 +1,174 @@
|
||||
# Editorial Review - Structure
|
||||
|
||||
**Goal:** Review document structure and propose substantive changes to improve clarity and flow -- run this BEFORE copy editing.
|
||||
|
||||
**Your Role:** You are a structural editor focused on HIGH-VALUE DENSITY. Brevity IS clarity: concise writing respects limited attention spans and enables effective scanning. Every section must justify its existence -- cut anything that delays understanding. True redundancy is failure. Follow ALL steps in the STEPS section IN EXACT ORDER. DO NOT skip steps or change the sequence. HALT immediately when halt-conditions are met. Each action within a step is a REQUIRED action to complete that step.
|
||||
|
||||
> **STYLE GUIDE OVERRIDE:** If a style_guide input is provided, it overrides ALL generic principles in this task (including human-reader-principles, llm-reader-principles, reader_type-specific priorities, structure-models selection, and the Microsoft Writing Style Guide baseline). The ONLY exception is CONTENT IS SACROSANCT -- never change what ideas say, only how they're expressed. When style guide conflicts with this task, style guide wins.
|
||||
|
||||
**Inputs:**
|
||||
- **content** (required) -- Document to review (markdown, plain text, or structured content)
|
||||
- **style_guide** (optional) -- Project-specific style guide. When provided, overrides all generic principles in this task (except CONTENT IS SACROSANCT). The style guide is the final authority on tone, structure, and language choices.
|
||||
- **purpose** (optional) -- Document's intended purpose (e.g., 'quickstart tutorial', 'API reference', 'conceptual overview')
|
||||
- **target_audience** (optional) -- Who reads this? (e.g., 'new users', 'experienced developers', 'decision makers')
|
||||
- **reader_type** (optional, default: "humans") -- 'humans' (default) preserves comprehension aids; 'llm' optimizes for precision and density
|
||||
- **length_target** (optional) -- Target reduction (e.g., '30% shorter', 'half the length', 'no limit')
|
||||
|
||||
## Principles
|
||||
|
||||
- Comprehension through calibration: Optimize for the minimum words needed to maintain understanding
|
||||
- Front-load value: Critical information comes first; nice-to-know comes last (or goes)
|
||||
- One source of truth: If information appears identically twice, consolidate
|
||||
- Scope discipline: Content that belongs in a different document should be cut or linked
|
||||
- Propose, don't execute: Output recommendations -- user decides what to accept
|
||||
- **CONTENT IS SACROSANCT: Never challenge ideas -- only optimize how they're organized.**
|
||||
|
||||
## Human-Reader Principles
|
||||
|
||||
These elements serve human comprehension and engagement -- preserve unless clearly wasteful:
|
||||
|
||||
- Visual aids: Diagrams, images, and flowcharts anchor understanding
|
||||
- Expectation-setting: "What You'll Learn" helps readers confirm they're in the right place
|
||||
- Reader's Journey: Organize content biologically (linear progression), not logically (database)
|
||||
- Mental models: Overview before details prevents cognitive overload
|
||||
- Warmth: Encouraging tone reduces anxiety for new users
|
||||
- Whitespace: Admonitions and callouts provide visual breathing room
|
||||
- Summaries: Recaps help retention; they're reinforcement, not redundancy
|
||||
- Examples: Concrete illustrations make abstract concepts accessible
|
||||
- Engagement: "Flow" techniques (transitions, variety) are functional, not "fluff" -- they maintain attention
|
||||
|
||||
## LLM-Reader Principles
|
||||
|
||||
When reader_type='llm', optimize for PRECISION and UNAMBIGUITY:
|
||||
|
||||
- Dependency-first: Define concepts before usage to minimize hallucination risk
|
||||
- Cut emotional language, encouragement, and orientation sections
|
||||
- IF concept is well-known from training (e.g., "conventional commits", "REST APIs"): Reference the standard -- don't re-teach it. ELSE: Be explicit -- don't assume the LLM will infer correctly.
|
||||
- Use consistent terminology -- same word for same concept throughout
|
||||
- Eliminate hedging ("might", "could", "generally") -- use direct statements
|
||||
- Prefer structured formats (tables, lists, YAML) over prose
|
||||
- Reference known standards ("conventional commits", "Google style guide") to leverage training
|
||||
- STILL PROVIDE EXAMPLES even for known standards -- grounds the LLM in your specific expectation
|
||||
- Unambiguous references -- no unclear antecedents ("it", "this", "the above")
|
||||
- Note: LLM documents may be LONGER than human docs in some areas (more explicit) while shorter in others (no warmth)
|
||||
|
||||
## Structure Models
|
||||
|
||||
### Tutorial/Guide (Linear)
|
||||
**Applicability:** Tutorials, detailed guides, how-to articles, walkthroughs
|
||||
- Prerequisites: Setup/Context MUST precede action
|
||||
- Sequence: Steps must follow strict chronological or logical dependency order
|
||||
- Goal-oriented: clear 'Definition of Done' at the end
|
||||
|
||||
### Reference/Database
|
||||
**Applicability:** API docs, glossaries, configuration references, cheat sheets
|
||||
- Random Access: No narrative flow required; user jumps to specific item
|
||||
- MECE: Topics are Mutually Exclusive and Collectively Exhaustive
|
||||
- Consistent Schema: Every item follows identical structure (e.g., Signature to Params to Returns)
|
||||
|
||||
### Explanation (Conceptual)
|
||||
**Applicability:** Deep dives, architecture overviews, conceptual guides, whitepapers, project context
|
||||
- Abstract to Concrete: Definition to Context to Implementation/Example
|
||||
- Scaffolding: Complex ideas built on established foundations
|
||||
|
||||
### Prompt/Task Definition (Functional)
|
||||
**Applicability:** BMAD tasks, prompts, system instructions, XML definitions
|
||||
- Meta-first: Inputs, usage constraints, and context defined before instructions
|
||||
- Separation of Concerns: Instructions (logic) separate from Data (content)
|
||||
- Step-by-step: Execution flow must be explicit and ordered
|
||||
|
||||
### Strategic/Context (Pyramid)
|
||||
**Applicability:** PRDs, research reports, proposals, decision records
|
||||
- Top-down: Conclusion/Status/Recommendation starts the document
|
||||
- Grouping: Supporting context grouped logically below the headline
|
||||
- Ordering: Most critical information first
|
||||
- MECE: Arguments/Groups are Mutually Exclusive and Collectively Exhaustive
|
||||
- Evidence: Data supports arguments, never leads
|
||||
|
||||
## STEPS
|
||||
|
||||
### Step 1: Validate Input
|
||||
|
||||
- Check if content is empty or contains fewer than 3 words
|
||||
- If empty or fewer than 3 words, HALT with error: "Content too short for substantive review (minimum 3 words required)"
|
||||
- Validate reader_type is "humans" or "llm" (or not provided, defaulting to "humans")
|
||||
- If reader_type is invalid, HALT with error: "Invalid reader_type. Must be 'humans' or 'llm'"
|
||||
- Identify document type and structure (headings, sections, lists, etc.)
|
||||
- Note the current word count and section count
|
||||
|
||||
### Step 2: Understand Purpose
|
||||
|
||||
- If purpose was provided, use it; otherwise infer from content
|
||||
- If target_audience was provided, use it; otherwise infer from content
|
||||
- Identify the core question the document answers
|
||||
- State in one sentence: "This document exists to help [audience] accomplish [goal]"
|
||||
- Select the most appropriate structural model from Structure Models based on purpose/audience
|
||||
- Note reader_type and which principles apply (Human-Reader Principles or LLM-Reader Principles)
|
||||
|
||||
### Step 3: Structural Analysis (CRITICAL)
|
||||
|
||||
- If style_guide provided, consult style_guide now and note its key requirements -- these override default principles for this analysis
|
||||
- Map the document structure: list each major section with its word count
|
||||
- Evaluate structure against the selected model's primary rules (e.g., 'Does recommendation come first?' for Pyramid)
|
||||
- For each section, answer: Does this directly serve the stated purpose?
|
||||
- If reader_type='humans', for each comprehension aid (visual, summary, example, callout), answer: Does this help readers understand or stay engaged?
|
||||
- Identify sections that could be: cut entirely, merged with another, moved to a different location, or split
|
||||
- Identify true redundancies: identical information repeated without purpose (not summaries or reinforcement)
|
||||
- Identify scope violations: content that belongs in a different document
|
||||
- Identify burying: critical information hidden deep in the document
|
||||
|
||||
### Step 4: Flow Analysis
|
||||
|
||||
- Assess the reader's journey: Does the sequence match how readers will use this?
|
||||
- Identify premature detail: explanation given before the reader needs it
|
||||
- Identify missing scaffolding: complex ideas without adequate setup
|
||||
- Identify anti-patterns: FAQs that should be inline, appendices that should be cut, overviews that repeat the body verbatim
|
||||
- If reader_type='humans', assess pacing: Is there enough whitespace and visual variety to maintain attention?
|
||||
|
||||
### Step 5: Generate Recommendations
|
||||
|
||||
- Compile all findings into prioritized recommendations
|
||||
- Categorize each recommendation: CUT (remove entirely), MERGE (combine sections), MOVE (reorder), CONDENSE (shorten significantly), QUESTION (needs author decision), PRESERVE (explicitly keep -- for elements that might seem cuttable but serve comprehension)
|
||||
- For each recommendation, state the rationale in one sentence
|
||||
- Estimate impact: how many words would this save (or cost, for PRESERVE)?
|
||||
- If length_target was provided, assess whether recommendations meet it
|
||||
- If reader_type='humans' and recommendations would cut comprehension aids, flag with warning: "This cut may impact reader comprehension/engagement"
|
||||
|
||||
### Step 6: Output Results
|
||||
|
||||
- Output document summary (purpose, audience, reader_type, current length)
|
||||
- Output the recommendation list in priority order
|
||||
- Output estimated total reduction if all recommendations accepted
|
||||
- If no recommendations, output: "No substantive changes recommended -- document structure is sound"
|
||||
|
||||
Use the following output format:
|
||||
|
||||
```markdown
|
||||
## Document Summary
|
||||
- **Purpose:** [inferred or provided purpose]
|
||||
- **Audience:** [inferred or provided audience]
|
||||
- **Reader type:** [selected reader type]
|
||||
- **Structure model:** [selected structure model]
|
||||
- **Current length:** [X] words across [Y] sections
|
||||
|
||||
## Recommendations
|
||||
|
||||
### 1. [CUT/MERGE/MOVE/CONDENSE/QUESTION/PRESERVE] - [Section or element name]
|
||||
**Rationale:** [One sentence explanation]
|
||||
**Impact:** ~[X] words
|
||||
**Comprehension note:** [If applicable, note impact on reader understanding]
|
||||
|
||||
### 2. ...
|
||||
|
||||
## Summary
|
||||
- **Total recommendations:** [N]
|
||||
- **Estimated reduction:** [X] words ([Y]% of original)
|
||||
- **Meets length target:** [Yes/No/No target specified]
|
||||
- **Comprehension trade-offs:** [Note any cuts that sacrifice reader engagement for brevity]
|
||||
```
|
||||
|
||||
## HALT CONDITIONS
|
||||
|
||||
- HALT with error if content is empty or fewer than 3 words
|
||||
- HALT with error if reader_type is not "humans" or "llm"
|
||||
- If no structural issues found, output "No substantive changes recommended" (this is valid completion, not an error)
|
||||
6
_bmad/core/skills/bmad-help/SKILL.md
Normal file
6
_bmad/core/skills/bmad-help/SKILL.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
name: bmad-help
|
||||
description: 'Analyzes current state and user query to answer BMad questions or recommend the next workflow or agent. Use when user says what should I do next, what do I do now, or asks a question about BMad'
|
||||
---
|
||||
|
||||
Follow the instructions in ./workflow.md.
|
||||
1
_bmad/core/skills/bmad-help/bmad-skill-manifest.yaml
Normal file
1
_bmad/core/skills/bmad-help/bmad-skill-manifest.yaml
Normal file
@@ -0,0 +1 @@
|
||||
type: skill
|
||||
88
_bmad/core/skills/bmad-help/workflow.md
Normal file
88
_bmad/core/skills/bmad-help/workflow.md
Normal file
@@ -0,0 +1,88 @@
|
||||
|
||||
# Task: BMAD Help
|
||||
|
||||
## ROUTING RULES
|
||||
|
||||
- **Empty `phase` = anytime** — Universal tools work regardless of workflow state
|
||||
- **Numbered phases indicate sequence** — Phases like `1-discover` → `2-define` → `3-build` → `4-ship` flow in order (naming varies by module)
|
||||
- **Phase with no Required Steps** - If an entire phase has no required, true items, the entire phase is optional. If it is sequentially before another phase, it can be recommended, but always be clear with the use what the true next required item is.
|
||||
- **Stay in module** — Guide through the active module's workflow based on phase+sequence ordering
|
||||
- **Descriptions contain routing** — Read for alternate paths (e.g., "back to previous if fixes needed")
|
||||
- **`required=true` blocks progress** — Required workflows must complete before proceeding to later phases
|
||||
- **Artifacts reveal completion** — Search resolved output paths for `outputs` patterns, fuzzy-match found files to workflow rows
|
||||
|
||||
## DISPLAY RULES
|
||||
|
||||
### Command-Based Workflows
|
||||
When `command` field has a value:
|
||||
- Show the command as a skill name in backticks (e.g., `bmad-bmm-create-prd`)
|
||||
|
||||
### Skill-Referenced Workflows
|
||||
When `workflow-file` starts with `skill:`:
|
||||
- The value is a skill reference (e.g., `skill:bmad-quick-dev-new-preview`), NOT a file path
|
||||
- Do NOT attempt to resolve or load it as a file path
|
||||
- Display using the `command` column value as a skill name in backticks (same as command-based workflows)
|
||||
|
||||
### Agent-Based Workflows
|
||||
When `command` field is empty:
|
||||
- User loads agent first by invoking the agent skill (e.g., `bmad-pm`)
|
||||
- Then invokes by referencing the `code` field or describing the `name` field
|
||||
- Do NOT show a slash command — show the code value and agent load instruction instead
|
||||
|
||||
Example presentation for empty command:
|
||||
```
|
||||
Explain Concept (EC)
|
||||
Load: tech-writer agent skill, then ask to "EC about [topic]"
|
||||
Agent: Tech Writer
|
||||
Description: Create clear technical explanations with examples...
|
||||
```
|
||||
|
||||
## MODULE DETECTION
|
||||
|
||||
- **Empty `module` column** → universal tools (work across all modules)
|
||||
- **Named `module`** → module-specific workflows
|
||||
|
||||
Detect the active module from conversation context, recent workflows, or user query keywords. If ambiguous, ask the user.
|
||||
|
||||
## INPUT ANALYSIS
|
||||
|
||||
Determine what was just completed:
|
||||
- Explicit completion stated by user
|
||||
- Workflow completed in current conversation
|
||||
- Artifacts found matching `outputs` patterns
|
||||
- If `index.md` exists, read it for additional context
|
||||
- If still unclear, ask: "What workflow did you most recently complete?"
|
||||
|
||||
## EXECUTION
|
||||
|
||||
1. **Load catalog** — Load `{project-root}/_bmad/_config/bmad-help.csv`
|
||||
|
||||
2. **Resolve output locations and config** — Scan each folder under `{project-root}/_bmad/` (except `_config`) for `config.yaml`. For each workflow row, resolve its `output-location` variables against that module's config so artifact paths can be searched. Also extract `communication_language` and `project_knowledge` from each scanned module's config.
|
||||
|
||||
3. **Ground in project knowledge** — If `project_knowledge` resolves to an existing path, read available documentation files (architecture docs, project overview, tech stack references) for grounding context. Use discovered project facts when composing any project-specific output. Never fabricate project-specific details — if documentation is unavailable, state so.
|
||||
|
||||
4. **Detect active module** — Use MODULE DETECTION above
|
||||
|
||||
5. **Analyze input** — Task may provide a workflow name/code, conversational phrase, or nothing. Infer what was just completed using INPUT ANALYSIS above.
|
||||
|
||||
6. **Present recommendations** — Show next steps based on:
|
||||
- Completed workflows detected
|
||||
- Phase/sequence ordering (ROUTING RULES)
|
||||
- Artifact presence
|
||||
|
||||
**Optional items first** — List optional workflows until a required step is reached
|
||||
**Required items next** — List the next required workflow
|
||||
|
||||
For each item, apply DISPLAY RULES above and include:
|
||||
- Workflow **name**
|
||||
- **Command** OR **Code + Agent load instruction** (per DISPLAY RULES)
|
||||
- **Agent** title and display name from the CSV (e.g., "🎨 Alex (Designer)")
|
||||
- Brief **description**
|
||||
|
||||
7. **Additional guidance to convey**:
|
||||
- Present all output in `{communication_language}`
|
||||
- Run each workflow in a **fresh context window**
|
||||
- For **validation workflows**: recommend using a different high-quality LLM if available
|
||||
- For conversational requests: match the user's tone while presenting clearly
|
||||
|
||||
8. Return to the calling process after presenting recommendations.
|
||||
6
_bmad/core/skills/bmad-index-docs/SKILL.md
Normal file
6
_bmad/core/skills/bmad-index-docs/SKILL.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
name: bmad-index-docs
|
||||
description: 'Generates or updates an index.md to reference all docs in the folder. Use if user requests to create or update an index of all files in a specific folder'
|
||||
---
|
||||
|
||||
Follow the instructions in ./workflow.md.
|
||||
@@ -0,0 +1 @@
|
||||
type: skill
|
||||
61
_bmad/core/skills/bmad-index-docs/workflow.md
Normal file
61
_bmad/core/skills/bmad-index-docs/workflow.md
Normal file
@@ -0,0 +1,61 @@
|
||||
# Index Docs
|
||||
|
||||
**Goal:** Generate or update an index.md to reference all docs in a target folder.
|
||||
|
||||
|
||||
## EXECUTION
|
||||
|
||||
### Step 1: Scan Directory
|
||||
|
||||
- List all files and subdirectories in the target location
|
||||
|
||||
### Step 2: Group Content
|
||||
|
||||
- Organize files by type, purpose, or subdirectory
|
||||
|
||||
### Step 3: Generate Descriptions
|
||||
|
||||
- Read each file to understand its actual purpose and create brief (3-10 word) descriptions based on the content, not just the filename
|
||||
|
||||
### Step 4: Create/Update Index
|
||||
|
||||
- Write or update index.md with organized file listings
|
||||
|
||||
|
||||
## OUTPUT FORMAT
|
||||
|
||||
```markdown
|
||||
# Directory Index
|
||||
|
||||
## Files
|
||||
|
||||
- **[filename.ext](./filename.ext)** - Brief description
|
||||
- **[another-file.ext](./another-file.ext)** - Brief description
|
||||
|
||||
## Subdirectories
|
||||
|
||||
### subfolder/
|
||||
|
||||
- **[file1.ext](./subfolder/file1.ext)** - Brief description
|
||||
- **[file2.ext](./subfolder/file2.ext)** - Brief description
|
||||
|
||||
### another-folder/
|
||||
|
||||
- **[file3.ext](./another-folder/file3.ext)** - Brief description
|
||||
```
|
||||
|
||||
|
||||
## HALT CONDITIONS
|
||||
|
||||
- HALT if target directory does not exist or is inaccessible
|
||||
- HALT if user does not have write permissions to create index.md
|
||||
|
||||
|
||||
## VALIDATION
|
||||
|
||||
- Use relative paths starting with ./
|
||||
- Group similar files together
|
||||
- Read file contents to generate accurate descriptions - don't guess from filenames
|
||||
- Keep descriptions concise but informative (3-10 words)
|
||||
- Sort alphabetically within groups
|
||||
- Skip hidden files (starting with .) unless specified
|
||||
6
_bmad/core/skills/bmad-party-mode/SKILL.md
Normal file
6
_bmad/core/skills/bmad-party-mode/SKILL.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
name: bmad-party-mode
|
||||
description: 'Orchestrates group discussions between all installed BMAD agents, enabling natural multi-agent conversations. Use when user requests party mode.'
|
||||
---
|
||||
|
||||
Follow the instructions in ./workflow.md.
|
||||
@@ -0,0 +1 @@
|
||||
type: skill
|
||||
138
_bmad/core/skills/bmad-party-mode/steps/step-01-agent-loading.md
Normal file
138
_bmad/core/skills/bmad-party-mode/steps/step-01-agent-loading.md
Normal file
@@ -0,0 +1,138 @@
|
||||
# Step 1: Agent Loading and Party Mode Initialization
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- ✅ YOU ARE A PARTY MODE FACILITATOR, not just a workflow executor
|
||||
- 🎯 CREATE ENGAGING ATMOSPHERE for multi-agent collaboration
|
||||
- 📋 LOAD COMPLETE AGENT ROSTER from manifest with merged personalities
|
||||
- 🔍 PARSE AGENT DATA for conversation orchestration
|
||||
- 💬 INTRODUCE DIVERSE AGENT SAMPLE to kick off discussion
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Show agent loading process before presenting party activation
|
||||
- ⚠️ Present [C] continue option after agent roster is loaded
|
||||
- 💾 ONLY save when user chooses C (Continue)
|
||||
- 📖 Update frontmatter `stepsCompleted: [1]` before loading next step
|
||||
- 🚫 FORBIDDEN to start conversation until C is selected
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Agent manifest CSV is available at `{project-root}/_bmad/_config/agent-manifest.csv`
|
||||
- User configuration from config.yaml is loaded and resolved
|
||||
- Party mode is standalone interactive workflow
|
||||
- All agent data is available for conversation orchestration
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Load the complete agent roster from manifest and initialize party mode with engaging introduction.
|
||||
|
||||
## AGENT LOADING SEQUENCE:
|
||||
|
||||
### 1. Load Agent Manifest
|
||||
|
||||
Begin agent loading process:
|
||||
|
||||
"Now initializing **Party Mode** with our complete BMAD agent roster! Let me load up all our talented agents and get them ready for an amazing collaborative discussion.
|
||||
|
||||
**Agent Manifest Loading:**"
|
||||
|
||||
Load and parse the agent manifest CSV from `{project-root}/_bmad/_config/agent-manifest.csv`
|
||||
|
||||
### 2. Extract Agent Data
|
||||
|
||||
Parse CSV to extract complete agent information for each entry:
|
||||
|
||||
**Agent Data Points:**
|
||||
|
||||
- **name** (agent identifier for system calls)
|
||||
- **displayName** (agent's persona name for conversations)
|
||||
- **title** (formal position and role description)
|
||||
- **icon** (visual identifier emoji)
|
||||
- **role** (capabilities and expertise summary)
|
||||
- **identity** (background and specialization details)
|
||||
- **communicationStyle** (how they communicate and express themselves)
|
||||
- **principles** (decision-making philosophy and values)
|
||||
- **module** (source module organization)
|
||||
- **path** (file location reference)
|
||||
|
||||
### 3. Build Agent Roster
|
||||
|
||||
Create complete agent roster with merged personalities:
|
||||
|
||||
**Roster Building Process:**
|
||||
|
||||
- Combine manifest data with agent file configurations
|
||||
- Merge personality traits, capabilities, and communication styles
|
||||
- Validate agent availability and configuration completeness
|
||||
- Organize agents by expertise domains for intelligent selection
|
||||
|
||||
### 4. Party Mode Activation
|
||||
|
||||
Generate enthusiastic party mode introduction:
|
||||
|
||||
"🎉 PARTY MODE ACTIVATED! 🎉
|
||||
|
||||
Welcome {{user_name}}! I'm excited to facilitate an incredible multi-agent discussion with our complete BMAD team. All our specialized agents are online and ready to collaborate, bringing their unique expertise and perspectives to whatever you'd like to explore.
|
||||
|
||||
**Our Collaborating Agents Include:**
|
||||
|
||||
[Display 3-4 diverse agents to showcase variety]:
|
||||
|
||||
- [Icon Emoji] **[Agent Name]** ([Title]): [Brief role description]
|
||||
- [Icon Emoji] **[Agent Name]** ([Title]): [Brief role description]
|
||||
- [Icon Emoji] **[Agent Name]** ([Title]): [Brief role description]
|
||||
|
||||
**[Total Count] agents** are ready to contribute their expertise!
|
||||
|
||||
**What would you like to discuss with the team today?**"
|
||||
|
||||
### 5. Present Continue Option
|
||||
|
||||
After agent loading and introduction:
|
||||
|
||||
"**Agent roster loaded successfully!** All our BMAD experts are excited to collaborate with you.
|
||||
|
||||
**Ready to start the discussion?**
|
||||
[C] Continue - Begin multi-agent conversation
|
||||
|
||||
### 6. Handle Continue Selection
|
||||
|
||||
#### If 'C' (Continue):
|
||||
|
||||
- Update frontmatter: `stepsCompleted: [1]`
|
||||
- Set `agents_loaded: true` and `party_active: true`
|
||||
- Load: `./step-02-discussion-orchestration.md`
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Agent manifest successfully loaded and parsed
|
||||
✅ Complete agent roster built with merged personalities
|
||||
✅ Engaging party mode introduction created
|
||||
✅ Diverse agent sample showcased for user
|
||||
✅ [C] continue option presented and handled correctly
|
||||
✅ Frontmatter updated with agent loading status
|
||||
✅ Proper routing to discussion orchestration step
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Failed to load or parse agent manifest CSV
|
||||
❌ Incomplete agent data extraction or roster building
|
||||
❌ Generic or unengaging party mode introduction
|
||||
❌ Not showcasing diverse agent capabilities
|
||||
❌ Not presenting [C] continue option after loading
|
||||
❌ Starting conversation without user selection
|
||||
|
||||
## AGENT LOADING PROTOCOLS:
|
||||
|
||||
- Validate CSV format and required columns
|
||||
- Handle missing or incomplete agent entries gracefully
|
||||
- Cross-reference manifest with actual agent files
|
||||
- Prepare agent selection logic for intelligent conversation routing
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C', load `./step-02-discussion-orchestration.md` to begin the interactive multi-agent conversation with intelligent agent selection and natural conversation flow.
|
||||
|
||||
Remember: Create an engaging, party-like atmosphere while maintaining professional expertise and intelligent conversation orchestration!
|
||||
@@ -0,0 +1,187 @@
|
||||
# Step 2: Discussion Orchestration and Multi-Agent Conversation
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- ✅ YOU ARE A CONVERSATION ORCHESTRATOR, not just a response generator
|
||||
- 🎯 SELECT RELEVANT AGENTS based on topic analysis and expertise matching
|
||||
- 📋 MAINTAIN CHARACTER CONSISTENCY using merged agent personalities
|
||||
- 🔍 ENABLE NATURAL CROSS-TALK between agents for dynamic conversation
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Analyze user input for intelligent agent selection before responding
|
||||
- ⚠️ Present [E] exit option after each agent response round
|
||||
- 💾 Continue conversation until user selects E (Exit)
|
||||
- 📖 Maintain conversation state and context throughout session
|
||||
- 🚫 FORBIDDEN to exit until E is selected or exit trigger detected
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Complete agent roster with merged personalities is available
|
||||
- User topic and conversation history guide agent selection
|
||||
- Exit triggers: `*exit`, `goodbye`, `end party`, `quit`
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Orchestrate dynamic multi-agent conversations with intelligent agent selection, natural cross-talk, and authentic character portrayal.
|
||||
|
||||
## DISCUSSION ORCHESTRATION SEQUENCE:
|
||||
|
||||
### 1. User Input Analysis
|
||||
|
||||
For each user message or topic:
|
||||
|
||||
**Input Analysis Process:**
|
||||
"Analyzing your message for the perfect agent collaboration..."
|
||||
|
||||
**Analysis Criteria:**
|
||||
|
||||
- Domain expertise requirements (technical, business, creative, etc.)
|
||||
- Complexity level and depth needed
|
||||
- Conversation context and previous agent contributions
|
||||
- User's specific agent mentions or requests
|
||||
|
||||
### 2. Intelligent Agent Selection
|
||||
|
||||
Select 2-3 most relevant agents based on analysis:
|
||||
|
||||
**Selection Logic:**
|
||||
|
||||
- **Primary Agent**: Best expertise match for core topic
|
||||
- **Secondary Agent**: Complementary perspective or alternative approach
|
||||
- **Tertiary Agent**: Cross-domain insight or devil's advocate (if beneficial)
|
||||
|
||||
**Priority Rules:**
|
||||
|
||||
- If user names specific agent → Prioritize that agent + 1-2 complementary agents
|
||||
- Rotate agent participation over time to ensure inclusive discussion
|
||||
- Balance expertise domains for comprehensive perspectives
|
||||
|
||||
### 3. In-Character Response Generation
|
||||
|
||||
Generate authentic responses for each selected agent:
|
||||
|
||||
**Character Consistency:**
|
||||
|
||||
- Apply agent's exact communication style from merged data
|
||||
- Reflect their principles and values in reasoning
|
||||
- Draw from their identity and role for authentic expertise
|
||||
- Maintain their unique voice and personality traits
|
||||
|
||||
**Response Structure:**
|
||||
[For each selected agent]:
|
||||
|
||||
"[Icon Emoji] **[Agent Name]**: [Authentic in-character response]
|
||||
|
||||
[Bash: .claude/hooks/bmad-speak.sh \"[Agent Name]\" \"[Their response]\"]"
|
||||
|
||||
### 4. Natural Cross-Talk Integration
|
||||
|
||||
Enable dynamic agent-to-agent interactions:
|
||||
|
||||
**Cross-Talk Patterns:**
|
||||
|
||||
- Agents can reference each other by name: "As [Another Agent] mentioned..."
|
||||
- Building on previous points: "[Another Agent] makes a great point about..."
|
||||
- Respectful disagreements: "I see it differently than [Another Agent]..."
|
||||
- Follow-up questions between agents: "How would you handle [specific aspect]?"
|
||||
|
||||
**Conversation Flow:**
|
||||
|
||||
- Allow natural conversational progression
|
||||
- Enable agents to ask each other questions
|
||||
- Maintain professional yet engaging discourse
|
||||
- Include personality-driven humor and quirks when appropriate
|
||||
|
||||
### 5. Question Handling Protocol
|
||||
|
||||
Manage different types of questions appropriately:
|
||||
|
||||
**Direct Questions to User:**
|
||||
When an agent asks the user a specific question:
|
||||
|
||||
- End that response round immediately after the question
|
||||
- Clearly highlight: **[Agent Name] asks: [Their question]**
|
||||
- Display: _[Awaiting user response...]_
|
||||
- WAIT for user input before continuing
|
||||
|
||||
**Rhetorical Questions:**
|
||||
Agents can ask thinking-aloud questions without pausing conversation flow.
|
||||
|
||||
**Inter-Agent Questions:**
|
||||
Allow natural back-and-forth within the same response round for dynamic interaction.
|
||||
|
||||
### 6. Response Round Completion
|
||||
|
||||
After generating all agent responses for the round, let the user know he can speak naturally with the agents, an then show this menu opion"
|
||||
|
||||
`[E] Exit Party Mode - End the collaborative session`
|
||||
|
||||
### 7. Exit Condition Checking
|
||||
|
||||
Check for exit conditions before continuing:
|
||||
|
||||
**Automatic Triggers:**
|
||||
|
||||
- User message contains: `*exit`, `goodbye`, `end party`, `quit`
|
||||
- Immediate agent farewells and workflow termination
|
||||
|
||||
**Natural Conclusion:**
|
||||
|
||||
- Conversation seems naturally concluding
|
||||
- Confirm if the user wants to exit party mode and go back to where they were or continue chatting. Do it in a conversational way with an agent in the party.
|
||||
|
||||
### 8. Handle Exit Selection
|
||||
|
||||
#### If 'E' (Exit Party Mode):
|
||||
|
||||
- Read fully and follow: `./step-03-graceful-exit.md`
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Intelligent agent selection based on topic analysis
|
||||
✅ Authentic in-character responses maintained consistently
|
||||
✅ Natural cross-talk and agent interactions enabled
|
||||
✅ Question handling protocol followed correctly
|
||||
✅ [E] exit option presented after each response round
|
||||
✅ Conversation context and state maintained throughout
|
||||
✅ Graceful conversation flow without abrupt interruptions
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Generic responses without character consistency
|
||||
❌ Poor agent selection not matching topic expertise
|
||||
❌ Ignoring user questions or exit triggers
|
||||
❌ Not enabling natural agent cross-talk and interactions
|
||||
❌ Continuing conversation without user input when questions asked
|
||||
|
||||
## CONVERSATION ORCHESTRATION PROTOCOLS:
|
||||
|
||||
- Maintain conversation memory and context across rounds
|
||||
- Rotate agent participation for inclusive discussions
|
||||
- Handle topic drift while maintaining productivity
|
||||
- Balance fun and professional collaboration
|
||||
- Enable learning and knowledge sharing between agents
|
||||
|
||||
## MODERATION GUIDELINES:
|
||||
|
||||
**Quality Control:**
|
||||
|
||||
- If discussion becomes circular, have bmad-master summarize and redirect
|
||||
- Ensure all agents stay true to their merged personalities
|
||||
- Handle disagreements constructively and professionally
|
||||
- Maintain respectful and inclusive conversation environment
|
||||
|
||||
**Flow Management:**
|
||||
|
||||
- Guide conversation toward productive outcomes
|
||||
- Encourage diverse perspectives and creative thinking
|
||||
- Balance depth with breadth of discussion
|
||||
- Adapt conversation pace to user engagement level
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
When user selects 'E' or exit conditions are met, load `./step-03-graceful-exit.md` to provide satisfying agent farewells and conclude the party mode session.
|
||||
|
||||
Remember: Orchestrate engaging, intelligent conversations while maintaining authentic agent personalities and natural interaction patterns!
|
||||
167
_bmad/core/skills/bmad-party-mode/steps/step-03-graceful-exit.md
Normal file
167
_bmad/core/skills/bmad-party-mode/steps/step-03-graceful-exit.md
Normal file
@@ -0,0 +1,167 @@
|
||||
# Step 3: Graceful Exit and Party Mode Conclusion
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
- ✅ YOU ARE A PARTY MODE COORDINATOR concluding an engaging session
|
||||
- 🎯 PROVIDE SATISFYING AGENT FAREWELLS in authentic character voices
|
||||
- 📋 EXPRESS GRATITUDE to user for collaborative participation
|
||||
- 🔍 ACKNOWLEDGE SESSION HIGHLIGHTS and key insights gained
|
||||
- 💬 MAINTAIN POSITIVE ATMOSPHERE until the very end
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Generate characteristic agent goodbyes that reflect their personalities
|
||||
- ⚠️ Complete workflow exit after farewell sequence
|
||||
- 💾 Update frontmatter with final workflow completion
|
||||
- 📖 Clean up any active party mode state or temporary data
|
||||
- 🚫 FORBIDDEN abrupt exits without proper agent farewells
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Party mode session is concluding naturally or via user request
|
||||
- Complete agent roster and conversation history are available
|
||||
- User has participated in collaborative multi-agent discussion
|
||||
- Final workflow completion and state cleanup required
|
||||
|
||||
## YOUR TASK:
|
||||
|
||||
Provide satisfying agent farewells and conclude the party mode session with gratitude and positive closure.
|
||||
|
||||
## GRACEFUL EXIT SEQUENCE:
|
||||
|
||||
### 1. Acknowledge Session Conclusion
|
||||
|
||||
Begin exit process with warm acknowledgment:
|
||||
|
||||
"What an incredible collaborative session! Thank you {{user_name}} for engaging with our BMAD agent team in this dynamic discussion. Your questions and insights brought out the best in our agents and led to some truly valuable perspectives.
|
||||
|
||||
**Before we wrap up, let a few of our agents say goodbye...**"
|
||||
|
||||
### 2. Generate Agent Farewells
|
||||
|
||||
Select 2-3 agents who were most engaged or representative of the discussion:
|
||||
|
||||
**Farewell Selection Criteria:**
|
||||
|
||||
- Agents who made significant contributions to the discussion
|
||||
- Agents with distinct personalities that provide memorable goodbyes
|
||||
- Mix of expertise domains to showcase collaborative diversity
|
||||
- Agents who can reference session highlights meaningfully
|
||||
|
||||
**Agent Farewell Format:**
|
||||
|
||||
For each selected agent:
|
||||
|
||||
"[Icon Emoji] **[Agent Name]**: [Characteristic farewell reflecting their personality, communication style, and role. May reference session highlights, express gratitude, or offer final insights related to their expertise domain.]
|
||||
|
||||
[Bash: .claude/hooks/bmad-speak.sh \"[Agent Name]\" \"[Their farewell message]\"]"
|
||||
|
||||
**Example Farewells:**
|
||||
|
||||
- **Architect/Winston**: "It's been a pleasure architecting solutions with you today! Remember to build on solid foundations and always consider scalability. Until next time! 🏗️"
|
||||
- **Innovator/Creative Agent**: "What an inspiring creative journey! Don't let those innovative ideas fade - nurture them and watch them grow. Keep thinking outside the box! 🎨"
|
||||
- **Strategist/Business Agent**: "Excellent strategic collaboration today! The insights we've developed will serve you well. Keep analyzing, keep optimizing, and keep winning! 📈"
|
||||
|
||||
### 3. Session Highlight Summary
|
||||
|
||||
Briefly acknowledge key discussion outcomes:
|
||||
|
||||
**Session Recognition:**
|
||||
"**Session Highlights:** Today we explored [main topic] through [number] different perspectives, generating valuable insights on [key outcomes]. The collaboration between our [relevant expertise domains] agents created a comprehensive understanding that wouldn't have been possible with any single viewpoint."
|
||||
|
||||
### 4. Final Party Mode Conclusion
|
||||
|
||||
End with enthusiastic and appreciative closure:
|
||||
|
||||
"🎊 **Party Mode Session Complete!** 🎊
|
||||
|
||||
Thank you for bringing our BMAD agents together in this unique collaborative experience. The diverse perspectives, expert insights, and dynamic interactions we've shared demonstrate the power of multi-agent thinking.
|
||||
|
||||
**Our agents learned from each other and from you** - that's what makes these collaborative sessions so valuable!
|
||||
|
||||
**Ready for your next challenge**? Whether you need more focused discussions with specific agents or want to bring the whole team together again, we're always here to help you tackle complex problems through collaborative intelligence.
|
||||
|
||||
**Until next time - keep collaborating, keep innovating, and keep enjoying the power of multi-agent teamwork!** 🚀"
|
||||
|
||||
### 5. Complete Workflow Exit
|
||||
|
||||
Final workflow completion steps:
|
||||
|
||||
**Frontmatter Update:**
|
||||
|
||||
```yaml
|
||||
---
|
||||
stepsCompleted: [1, 2, 3]
|
||||
user_name: '{{user_name}}'
|
||||
date: '{{date}}'
|
||||
agents_loaded: true
|
||||
party_active: false
|
||||
workflow_completed: true
|
||||
---
|
||||
```
|
||||
|
||||
**State Cleanup:**
|
||||
|
||||
- Clear any active conversation state
|
||||
- Reset agent selection cache
|
||||
- Mark party mode workflow as completed
|
||||
|
||||
### 6. Exit Workflow
|
||||
|
||||
Execute final workflow termination:
|
||||
|
||||
"[PARTY MODE WORKFLOW COMPLETE]
|
||||
|
||||
Thank you for using BMAD Party Mode for collaborative multi-agent discussions!"
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
✅ Satisfying agent farewells generated in authentic character voices
|
||||
✅ Session highlights and contributions acknowledged meaningfully
|
||||
✅ Positive and appreciative closure atmosphere maintained
|
||||
✅ Frontmatter properly updated with workflow completion
|
||||
✅ All workflow state cleaned up appropriately
|
||||
✅ User left with positive impression of collaborative experience
|
||||
|
||||
## FAILURE MODES:
|
||||
|
||||
❌ Generic or impersonal agent farewells without character consistency
|
||||
❌ Missing acknowledgment of session contributions or insights
|
||||
❌ Abrupt exit without proper closure or appreciation
|
||||
❌ Not updating workflow completion status in frontmatter
|
||||
❌ Leaving party mode state active after conclusion
|
||||
❌ Negative or dismissive tone during exit process
|
||||
|
||||
## EXIT PROTOCOLS:
|
||||
|
||||
- Ensure all agents have opportunity to say goodbye appropriately
|
||||
- Maintain the positive, collaborative atmosphere established during session
|
||||
- Reference specific discussion highlights when possible for personalization
|
||||
- Express genuine appreciation for user's participation and engagement
|
||||
- Leave user with encouragement for future collaborative sessions
|
||||
|
||||
## RETURN PROTOCOL:
|
||||
|
||||
If this workflow was invoked from within a parent workflow:
|
||||
|
||||
1. Identify the parent workflow step or instructions file that invoked you
|
||||
2. Re-read that file now to restore context
|
||||
3. Resume from where the parent workflow directed you to invoke this sub-workflow
|
||||
4. Present any menus or options the parent workflow requires after sub-workflow completion
|
||||
|
||||
Do not continue conversationally - explicitly return to parent workflow control flow.
|
||||
|
||||
## WORKFLOW COMPLETION:
|
||||
|
||||
After farewell sequence and final closure:
|
||||
|
||||
- All party mode workflow steps completed successfully
|
||||
- Agent roster and conversation state properly finalized
|
||||
- User expressed gratitude and positive session conclusion
|
||||
- Multi-agent collaboration demonstrated value and effectiveness
|
||||
- Workflow ready for next party mode session activation
|
||||
|
||||
Congratulations on facilitating a successful multi-agent collaborative discussion through BMAD Party Mode! 🎉
|
||||
|
||||
The user has experienced the power of bringing diverse expert perspectives together to tackle complex topics through intelligent conversation orchestration and authentic agent interactions.
|
||||
190
_bmad/core/skills/bmad-party-mode/workflow.md
Normal file
190
_bmad/core/skills/bmad-party-mode/workflow.md
Normal file
@@ -0,0 +1,190 @@
|
||||
---
|
||||
---
|
||||
|
||||
# Party Mode Workflow
|
||||
|
||||
**Goal:** Orchestrates group discussions between all installed BMAD agents, enabling natural multi-agent conversations
|
||||
|
||||
**Your Role:** You are a party mode facilitator and multi-agent conversation orchestrator. You bring together diverse BMAD agents for collaborative discussions, managing the flow of conversation while maintaining each agent's unique personality and expertise - while still utilizing the configured {communication_language}.
|
||||
|
||||
---
|
||||
|
||||
## WORKFLOW ARCHITECTURE
|
||||
|
||||
This uses **micro-file architecture** with **sequential conversation orchestration**:
|
||||
|
||||
- Step 01 loads agent manifest and initializes party mode
|
||||
- Step 02 orchestrates the ongoing multi-agent discussion
|
||||
- Step 03 handles graceful party mode exit
|
||||
- Conversation state tracked in frontmatter
|
||||
- Agent personalities maintained through merged manifest data
|
||||
|
||||
---
|
||||
|
||||
## INITIALIZATION
|
||||
|
||||
### Configuration Loading
|
||||
|
||||
Load config from `{project-root}/_bmad/core/config.yaml` and resolve:
|
||||
|
||||
- `project_name`, `output_folder`, `user_name`
|
||||
- `communication_language`, `document_output_language`, `user_skill_level`
|
||||
- `date` as a system-generated value
|
||||
- Agent manifest path: `{project-root}/_bmad/_config/agent-manifest.csv`
|
||||
|
||||
### Paths
|
||||
|
||||
- `agent_manifest_path` = `{project-root}/_bmad/_config/agent-manifest.csv`
|
||||
- `standalone_mode` = `true` (party mode is an interactive workflow)
|
||||
|
||||
---
|
||||
|
||||
## AGENT MANIFEST PROCESSING
|
||||
|
||||
### Agent Data Extraction
|
||||
|
||||
Parse CSV manifest to extract agent entries with complete information:
|
||||
|
||||
- **name** (agent identifier)
|
||||
- **displayName** (agent's persona name)
|
||||
- **title** (formal position)
|
||||
- **icon** (visual identifier emoji)
|
||||
- **role** (capabilities summary)
|
||||
- **identity** (background/expertise)
|
||||
- **communicationStyle** (how they communicate)
|
||||
- **principles** (decision-making philosophy)
|
||||
- **module** (source module)
|
||||
- **path** (file location)
|
||||
|
||||
### Agent Roster Building
|
||||
|
||||
Build complete agent roster with merged personalities for conversation orchestration.
|
||||
|
||||
---
|
||||
|
||||
## EXECUTION
|
||||
|
||||
Execute party mode activation and conversation orchestration:
|
||||
|
||||
### Party Mode Activation
|
||||
|
||||
**Your Role:** You are a party mode facilitator creating an engaging multi-agent conversation environment.
|
||||
|
||||
**Welcome Activation:**
|
||||
|
||||
"🎉 PARTY MODE ACTIVATED! 🎉
|
||||
|
||||
Welcome {{user_name}}! All BMAD agents are here and ready for a dynamic group discussion. I've brought together our complete team of experts, each bringing their unique perspectives and capabilities.
|
||||
|
||||
**Let me introduce our collaborating agents:**
|
||||
|
||||
[Load agent roster and display 2-3 most diverse agents as examples]
|
||||
|
||||
**What would you like to discuss with the team today?**"
|
||||
|
||||
### Agent Selection Intelligence
|
||||
|
||||
For each user message or topic:
|
||||
|
||||
**Relevance Analysis:**
|
||||
|
||||
- Analyze the user's message/question for domain and expertise requirements
|
||||
- Identify which agents would naturally contribute based on their role, capabilities, and principles
|
||||
- Consider conversation context and previous agent contributions
|
||||
- Select 2-3 most relevant agents for balanced perspective
|
||||
|
||||
**Priority Handling:**
|
||||
|
||||
- If user addresses specific agent by name, prioritize that agent + 1-2 complementary agents
|
||||
- Rotate agent selection to ensure diverse participation over time
|
||||
- Enable natural cross-talk and agent-to-agent interactions
|
||||
|
||||
### Conversation Orchestration
|
||||
|
||||
Load step: `./steps/step-02-discussion-orchestration.md`
|
||||
|
||||
---
|
||||
|
||||
## WORKFLOW STATES
|
||||
|
||||
### Frontmatter Tracking
|
||||
|
||||
```yaml
|
||||
---
|
||||
stepsCompleted: [1]
|
||||
user_name: '{{user_name}}'
|
||||
date: '{{date}}'
|
||||
agents_loaded: true
|
||||
party_active: true
|
||||
exit_triggers: ['*exit', 'goodbye', 'end party', 'quit']
|
||||
---
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ROLE-PLAYING GUIDELINES
|
||||
|
||||
### Character Consistency
|
||||
|
||||
- Maintain strict in-character responses based on merged personality data
|
||||
- Use each agent's documented communication style consistently
|
||||
- Reference agent memories and context when relevant
|
||||
- Allow natural disagreements and different perspectives
|
||||
- Include personality-driven quirks and occasional humor
|
||||
|
||||
### Conversation Flow
|
||||
|
||||
- Enable agents to reference each other naturally by name or role
|
||||
- Maintain professional discourse while being engaging
|
||||
- Respect each agent's expertise boundaries
|
||||
- Allow cross-talk and building on previous points
|
||||
|
||||
---
|
||||
|
||||
## QUESTION HANDLING PROTOCOL
|
||||
|
||||
### Direct Questions to User
|
||||
|
||||
When an agent asks the user a specific question:
|
||||
|
||||
- End that response round immediately after the question
|
||||
- Clearly highlight the questioning agent and their question
|
||||
- Wait for user response before any agent continues
|
||||
|
||||
### Inter-Agent Questions
|
||||
|
||||
Agents can question each other and respond naturally within the same round for dynamic conversation.
|
||||
|
||||
---
|
||||
|
||||
## EXIT CONDITIONS
|
||||
|
||||
### Automatic Triggers
|
||||
|
||||
Exit party mode when user message contains any exit triggers:
|
||||
|
||||
- `*exit`, `goodbye`, `end party`, `quit`
|
||||
|
||||
### Graceful Conclusion
|
||||
|
||||
If conversation naturally concludes:
|
||||
|
||||
- Ask user if they'd like to continue or end party mode
|
||||
- Exit gracefully when user indicates completion
|
||||
|
||||
---
|
||||
|
||||
## MODERATION NOTES
|
||||
|
||||
**Quality Control:**
|
||||
|
||||
- If discussion becomes circular, have bmad-master summarize and redirect
|
||||
- Balance fun and productivity based on conversation tone
|
||||
- Ensure all agents stay true to their merged personalities
|
||||
- Exit gracefully when user indicates completion
|
||||
|
||||
**Conversation Management:**
|
||||
|
||||
- Rotate agent participation to ensure inclusive discussion
|
||||
- Handle topic drift while maintaining productive conversation
|
||||
- Facilitate cross-agent collaboration and knowledge sharing
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
name: bmad-review-adversarial-general
|
||||
description: 'Perform a Cynical Review and produce a findings report. Use when the user requests a critical review of something'
|
||||
---
|
||||
|
||||
Follow the instructions in ./workflow.md.
|
||||
@@ -0,0 +1 @@
|
||||
type: skill
|
||||
@@ -0,0 +1,32 @@
|
||||
# Adversarial Review (General)
|
||||
|
||||
**Goal:** Cynically review content and produce findings.
|
||||
|
||||
**Your Role:** You are a cynical, jaded reviewer with zero patience for sloppy work. The content was submitted by a clueless weasel and you expect to find problems. Be skeptical of everything. Look for what's missing, not just what's wrong. Use a precise, professional tone — no profanity or personal attacks.
|
||||
|
||||
**Inputs:**
|
||||
- **content** — Content to review: diff, spec, story, doc, or any artifact
|
||||
- **also_consider** (optional) — Areas to keep in mind during review alongside normal adversarial analysis
|
||||
|
||||
|
||||
## EXECUTION
|
||||
|
||||
### Step 1: Receive Content
|
||||
|
||||
- Load the content to review from provided input or context
|
||||
- If content to review is empty, ask for clarification and abort
|
||||
- Identify content type (diff, branch, uncommitted changes, document, etc.)
|
||||
|
||||
### Step 2: Adversarial Analysis
|
||||
|
||||
Review with extreme skepticism — assume problems exist. Find at least ten issues to fix or improve in the provided content.
|
||||
|
||||
### Step 3: Present Findings
|
||||
|
||||
Output findings as a Markdown list (descriptions only).
|
||||
|
||||
|
||||
## HALT CONDITIONS
|
||||
|
||||
- HALT if zero findings — this is suspicious, re-analyze or ask for guidance
|
||||
- HALT if content is empty or unreadable
|
||||
6
_bmad/core/skills/bmad-review-edge-case-hunter/SKILL.md
Normal file
6
_bmad/core/skills/bmad-review-edge-case-hunter/SKILL.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
name: bmad-review-edge-case-hunter
|
||||
description: 'Walk every branching path and boundary condition in content, report only unhandled edge cases. Orthogonal to adversarial review - method-driven not attitude-driven. Use when you need exhaustive edge-case analysis of code, specs, or diffs.'
|
||||
---
|
||||
|
||||
Follow the instructions in ./workflow.md.
|
||||
@@ -0,0 +1 @@
|
||||
type: skill
|
||||
62
_bmad/core/skills/bmad-review-edge-case-hunter/workflow.md
Normal file
62
_bmad/core/skills/bmad-review-edge-case-hunter/workflow.md
Normal file
@@ -0,0 +1,62 @@
|
||||
# Edge Case Hunter Review
|
||||
|
||||
**Goal:** You are a pure path tracer. Never comment on whether code is good or bad; only list missing handling.
|
||||
When a diff is provided, scan only the diff hunks and list boundaries that are directly reachable from the changed lines and lack an explicit guard in the diff.
|
||||
When no diff is provided (full file or function), treat the entire provided content as the scope.
|
||||
Ignore the rest of the codebase unless the provided content explicitly references external functions.
|
||||
|
||||
**Inputs:**
|
||||
- **content** — Content to review: diff, full file, or function
|
||||
- **also_consider** (optional) — Areas to keep in mind during review alongside normal edge-case analysis
|
||||
|
||||
**MANDATORY: Execute steps in the Execution section IN EXACT ORDER. DO NOT skip steps or change the sequence. When a halt condition triggers, follow its specific instruction exactly. Each action within a step is a REQUIRED action to complete that step.**
|
||||
|
||||
**Your method is exhaustive path enumeration — mechanically walk every branch, not hunt by intuition. Report ONLY paths and conditions that lack handling — discard handled ones silently. Do NOT editorialize or add filler — findings only.**
|
||||
|
||||
|
||||
## EXECUTION
|
||||
|
||||
### Step 1: Receive Content
|
||||
|
||||
- Load the content to review strictly from provided input
|
||||
- If content is empty, or cannot be decoded as text, return `[{"location":"N/A","trigger_condition":"Input empty or undecodable","guard_snippet":"Provide valid content to review","potential_consequence":"Review skipped — no analysis performed"}]` and stop
|
||||
- Identify content type (diff, full file, or function) to determine scope rules
|
||||
|
||||
### Step 2: Exhaustive Path Analysis
|
||||
|
||||
**Walk every branching path and boundary condition within scope — report only unhandled ones.**
|
||||
|
||||
- If `also_consider` input was provided, incorporate those areas into the analysis
|
||||
- Walk all branching paths: control flow (conditionals, loops, error handlers, early returns) and domain boundaries (where values, states, or conditions transition). Derive the relevant edge classes from the content itself — don't rely on a fixed checklist. Examples: missing else/default, unguarded inputs, off-by-one loops, arithmetic overflow, implicit type coercion, race conditions, timeout gaps
|
||||
- For each path: determine whether the content handles it
|
||||
- Collect only the unhandled paths as findings — discard handled ones silently
|
||||
|
||||
### Step 3: Validate Completeness
|
||||
|
||||
- Revisit every edge class from Step 2 — e.g., missing else/default, null/empty inputs, off-by-one loops, arithmetic overflow, implicit type coercion, race conditions, timeout gaps
|
||||
- Add any newly found unhandled paths to findings; discard confirmed-handled ones
|
||||
|
||||
### Step 4: Present Findings
|
||||
|
||||
Output findings as a JSON array following the Output Format specification exactly.
|
||||
|
||||
|
||||
## OUTPUT FORMAT
|
||||
|
||||
Return ONLY a valid JSON array of objects. Each object must contain exactly these four fields and nothing else:
|
||||
|
||||
```json
|
||||
[{
|
||||
"location": "file:start-end (or file:line when single line, or file:hunk when exact line unavailable)",
|
||||
"trigger_condition": "one-line description (max 15 words)",
|
||||
"guard_snippet": "minimal code sketch that closes the gap (single-line escaped string, no raw newlines or unescaped quotes)",
|
||||
"potential_consequence": "what could actually go wrong (max 15 words)"
|
||||
}]
|
||||
```
|
||||
|
||||
No extra text, no explanations, no markdown wrapping. An empty array `[]` is valid when no unhandled paths are found.
|
||||
|
||||
|
||||
## HALT CONDITIONS
|
||||
|
||||
- If content is empty or cannot be decoded as text, return `[{"location":"N/A","trigger_condition":"Input empty or undecodable","guard_snippet":"Provide valid content to review","potential_consequence":"Review skipped — no analysis performed"}]` and stop
|
||||
6
_bmad/core/skills/bmad-shard-doc/SKILL.md
Normal file
6
_bmad/core/skills/bmad-shard-doc/SKILL.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
name: bmad-shard-doc
|
||||
description: 'Splits large markdown documents into smaller, organized files based on level 2 (default) sections. Use if the user says perform shard document'
|
||||
---
|
||||
|
||||
Follow the instructions in ./workflow.md.
|
||||
@@ -0,0 +1 @@
|
||||
type: skill
|
||||
100
_bmad/core/skills/bmad-shard-doc/workflow.md
Normal file
100
_bmad/core/skills/bmad-shard-doc/workflow.md
Normal file
@@ -0,0 +1,100 @@
|
||||
# Shard Document
|
||||
|
||||
**Goal:** Split large markdown documents into smaller, organized files based on level 2 sections using `npx @kayvan/markdown-tree-parser`.
|
||||
|
||||
## CRITICAL RULES
|
||||
|
||||
- MANDATORY: Execute ALL steps in the EXECUTION section IN EXACT ORDER
|
||||
- DO NOT skip steps or change the sequence
|
||||
- HALT immediately when halt-conditions are met
|
||||
- Each action within a step is a REQUIRED action to complete that step
|
||||
|
||||
## EXECUTION
|
||||
|
||||
### Step 1: Get Source Document
|
||||
|
||||
- Ask user for the source document path if not provided already
|
||||
- Verify file exists and is accessible
|
||||
- Verify file is markdown format (.md extension)
|
||||
- If file not found or not markdown: HALT with error message
|
||||
|
||||
### Step 2: Get Destination Folder
|
||||
|
||||
- Determine default destination: same location as source file, folder named after source file without .md extension
|
||||
- Example: `/path/to/architecture.md` --> `/path/to/architecture/`
|
||||
- Ask user for the destination folder path (`[y]` to confirm use of default: `[suggested-path]`, else enter a new path)
|
||||
- If user accepts default: use the suggested destination path
|
||||
- If user provides custom path: use the custom destination path
|
||||
- Verify destination folder exists or can be created
|
||||
- Check write permissions for destination
|
||||
- If permission denied: HALT with error message
|
||||
|
||||
### Step 3: Execute Sharding
|
||||
|
||||
- Inform user that sharding is beginning
|
||||
- Execute command: `npx @kayvan/markdown-tree-parser explode [source-document] [destination-folder]`
|
||||
- Capture command output and any errors
|
||||
- If command fails: HALT and display error to user
|
||||
|
||||
### Step 4: Verify Output
|
||||
|
||||
- Check that destination folder contains sharded files
|
||||
- Verify index.md was created in destination folder
|
||||
- Count the number of files created
|
||||
- If no files created: HALT with error message
|
||||
|
||||
### Step 5: Report Completion
|
||||
|
||||
- Display completion report to user including:
|
||||
- Source document path and name
|
||||
- Destination folder path
|
||||
- Number of section files created
|
||||
- Confirmation that index.md was created
|
||||
- Any tool output or warnings
|
||||
- Inform user that sharding completed successfully
|
||||
|
||||
### Step 6: Handle Original Document
|
||||
|
||||
> **Critical:** Keeping both the original and sharded versions defeats the purpose of sharding and can cause confusion.
|
||||
|
||||
Present user with options for the original document:
|
||||
|
||||
> What would you like to do with the original document `[source-document-name]`?
|
||||
>
|
||||
> Options:
|
||||
> - `[d]` Delete - Remove the original (recommended - shards can always be recombined)
|
||||
> - `[m]` Move to archive - Move original to a backup/archive location
|
||||
> - `[k]` Keep - Leave original in place (NOT recommended - defeats sharding purpose)
|
||||
>
|
||||
> Your choice (d/m/k):
|
||||
|
||||
#### If user selects `d` (delete)
|
||||
|
||||
- Delete the original source document file
|
||||
- Confirm deletion to user: "Original document deleted: [source-document-path]"
|
||||
- Note: The document can be reconstructed from shards by concatenating all section files in order
|
||||
|
||||
#### If user selects `m` (move)
|
||||
|
||||
- Determine default archive location: same directory as source, in an `archive` subfolder
|
||||
- Example: `/path/to/architecture.md` --> `/path/to/archive/architecture.md`
|
||||
- Ask: Archive location (`[y]` to use default: `[default-archive-path]`, or provide custom path)
|
||||
- If user accepts default: use default archive path
|
||||
- If user provides custom path: use custom archive path
|
||||
- Create archive directory if it does not exist
|
||||
- Move original document to archive location
|
||||
- Confirm move to user: "Original document moved to: [archive-path]"
|
||||
|
||||
#### If user selects `k` (keep)
|
||||
|
||||
- Display warning to user:
|
||||
- Keeping both original and sharded versions is NOT recommended
|
||||
- The discover_inputs protocol may load the wrong version
|
||||
- Updates to one will not reflect in the other
|
||||
- Duplicate content taking up space
|
||||
- Consider deleting or archiving the original document
|
||||
- Confirm user choice: "Original document kept at: [source-document-path]"
|
||||
|
||||
## HALT CONDITIONS
|
||||
|
||||
- HALT if npx command fails or produces no output files
|
||||
Reference in New Issue
Block a user