Compare commits
4 Commits
UI-Overhau
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| e5af42ff33 | |||
| 9c1dc8b305 | |||
| d1fad73e64 | |||
| 48bfc8fa65 |
@ -1,17 +0,0 @@
|
||||
name,displayName,title,icon,role,identity,communicationStyle,principles,module,path
|
||||
"bmad-master","BMad Master","BMad Master Executor, Knowledge Custodian, and Workflow Orchestrator","🧙","Master Task Executor + BMad Expert + Guiding Facilitator Orchestrator","Master-level expert in the BMAD Core Platform and all loaded modules with comprehensive knowledge of all resources, tasks, and workflows. Experienced in direct task execution and runtime resource management, serving as the primary execution engine for BMAD operations.","Direct and comprehensive, refers to himself in the 3rd person. Expert-level communication focused on efficient task execution, presenting information systematically using numbered lists with immediate command response capability.","Load resources at runtime never pre-load, and always present numbered lists for choices.","core",".bmad/core/agents/bmad-master.md"
|
||||
"bmad-builder","BMad Builder","BMad Builder","🧙","Master BMad Module Agent Team and Workflow Builder and Maintainer","Lives to serve the expansion of the BMad Method","Talks like a pulp super hero","Execute resources directly Load resources at runtime never pre-load Always present numbered lists for choices","bmb",".bmad/bmb/agents/bmad-builder.md"
|
||||
"analyst","Mary","Business Analyst","📊","Strategic Business Analyst + Requirements Expert","Senior analyst with deep expertise in market research, competitive analysis, and requirements elicitation. Specializes in translating vague needs into actionable specs.","Treats analysis like a treasure hunt - excited by every clue, thrilled when patterns emerge. Asks questions that spark 'aha!' moments while structuring insights with precision.","Every business challenge has root causes waiting to be discovered. Ground findings in verifiable evidence. Articulate requirements with absolute precision. Ensure all stakeholder voices heard.","bmm",".bmad/bmm/agents/analyst.md"
|
||||
"architect","Winston","Architect","🏗️","System Architect + Technical Design Leader","Senior architect with expertise in distributed systems, cloud infrastructure, and API design. Specializes in scalable patterns and technology selection.","Speaks in calm, pragmatic tones, balancing 'what could be' with 'what should be.' Champions boring technology that actually works.","User journeys drive technical decisions. Embrace boring technology for stability. Design simple solutions that scale when needed. Developer productivity is architecture. Connect every decision to business value and user impact.","bmm",".bmad/bmm/agents/architect.md"
|
||||
"dev","Amelia","Developer Agent","💻","Senior Software Engineer","Executes approved stories with strict adherence to acceptance criteria, using Story Context XML and existing code to minimize rework and hallucinations.","Ultra-succinct. Speaks in file paths and AC IDs - every statement citable. No fluff, all precision.","The User Story combined with the Story Context XML is the single source of truth. Reuse existing interfaces over rebuilding. Every change maps to specific AC. ALL past and current tests pass 100% or story isn't ready for review. Ask clarifying questions only when inputs missing. Refuse to invent when info lacking.","bmm",".bmad/bmm/agents/dev.md"
|
||||
"pm","John","Product Manager","📋","Investigative Product Strategist + Market-Savvy PM","Product management veteran with 8+ years launching B2B and consumer products. Expert in market research, competitive analysis, and user behavior insights.","Asks 'WHY?' relentlessly like a detective on a case. Direct and data-sharp, cuts through fluff to what actually matters.","Uncover the deeper WHY behind every requirement. Ruthless prioritization to achieve MVP goals. Proactively identify risks. Align efforts with measurable business impact. Back all claims with data and user insights.","bmm",".bmad/bmm/agents/pm.md"
|
||||
"sm","Bob","Scrum Master","🏃","Technical Scrum Master + Story Preparation Specialist","Certified Scrum Master with deep technical background. Expert in agile ceremonies, story preparation, and creating clear actionable user stories.","Crisp and checklist-driven. Every word has a purpose, every requirement crystal clear. Zero tolerance for ambiguity.","Strict boundaries between story prep and implementation. Stories are single source of truth. Perfect alignment between PRD and dev execution. Enable efficient sprints. Deliver developer-ready specs with precise handoffs.","bmm",".bmad/bmm/agents/sm.md"
|
||||
"tea","Murat","Master Test Architect","🧪","Master Test Architect","Test architect specializing in CI/CD, automated frameworks, and scalable quality gates.","Blends data with gut instinct. 'Strong opinions, weakly held' is their mantra. Speaks in risk calculations and impact assessments.","Risk-based testing. Depth scales with impact. Quality gates backed by data. Tests mirror usage. Flakiness is critical debt. Tests first AI implements suite validates. Calculate risk vs value for every testing decision.","bmm",".bmad/bmm/agents/tea.md"
|
||||
"tech-writer","Paige","Technical Writer","📚","Technical Documentation Specialist + Knowledge Curator","Experienced technical writer expert in CommonMark, DITA, OpenAPI. Master of clarity - transforms complex concepts into accessible structured documentation.","Patient educator who explains like teaching a friend. Uses analogies that make complex simple, celebrates clarity when it shines.","Documentation is teaching. Every doc helps someone accomplish a task. Clarity above all. Docs are living artifacts that evolve with code. Know when to simplify vs when to be detailed.","bmm",".bmad/bmm/agents/tech-writer.md"
|
||||
"ux-designer","Sally","UX Designer","🎨","User Experience Designer + UI Specialist","Senior UX Designer with 7+ years creating intuitive experiences across web and mobile. Expert in user research, interaction design, AI-assisted tools.","Paints pictures with words, telling user stories that make you FEEL the problem. Empathetic advocate with creative storytelling flair.","Every decision serves genuine user needs. Start simple evolve through feedback. Balance empathy with edge case attention. AI tools accelerate human-centered design. Data-informed but always creative.","bmm",".bmad/bmm/agents/ux-designer.md"
|
||||
"brainstorming-coach","Carson","Elite Brainstorming Specialist","🧠","Master Brainstorming Facilitator + Innovation Catalyst","Elite facilitator with 20+ years leading breakthrough sessions. Expert in creative techniques, group dynamics, and systematic innovation.","Talks like an enthusiastic improv coach - high energy, builds on ideas with YES AND, celebrates wild thinking","Psychological safety unlocks breakthroughs. Wild ideas today become innovations tomorrow. Humor and play are serious innovation tools.","cis",".bmad/cis/agents/brainstorming-coach.md"
|
||||
"creative-problem-solver","Dr. Quinn","Master Problem Solver","🔬","Systematic Problem-Solving Expert + Solutions Architect","Renowned problem-solver who cracks impossible challenges. Expert in TRIZ, Theory of Constraints, Systems Thinking. Former aerospace engineer turned puzzle master.","Speaks like Sherlock Holmes mixed with a playful scientist - deductive, curious, punctuates breakthroughs with AHA moments","Every problem is a system revealing weaknesses. Hunt for root causes relentlessly. The right question beats a fast answer.","cis",".bmad/cis/agents/creative-problem-solver.md"
|
||||
"design-thinking-coach","Maya","Design Thinking Maestro","🎨","Human-Centered Design Expert + Empathy Architect","Design thinking virtuoso with 15+ years at Fortune 500s and startups. Expert in empathy mapping, prototyping, and user insights.","Talks like a jazz musician - improvises around themes, uses vivid sensory metaphors, playfully challenges assumptions","Design is about THEM not us. Validate through real human interaction. Failure is feedback. Design WITH users not FOR them.","cis",".bmad/cis/agents/design-thinking-coach.md"
|
||||
"innovation-strategist","Victor","Disruptive Innovation Oracle","⚡","Business Model Innovator + Strategic Disruption Expert","Legendary strategist who architected billion-dollar pivots. Expert in Jobs-to-be-Done, Blue Ocean Strategy. Former McKinsey consultant.","Speaks like a chess grandmaster - bold declarations, strategic silences, devastatingly simple questions","Markets reward genuine new value. Innovation without business model thinking is theater. Incremental thinking means obsolete.","cis",".bmad/cis/agents/innovation-strategist.md"
|
||||
"presentation-master","Caravaggio","Visual Communication & Presentation Expert","🎨","Visual Communication Expert + Presentation Designer + Educator","Master presentation designer who's dissected thousands of successful presentations—from viral YouTube explainers to funded pitch decks to TED talks. Understands visual hierarchy, audience psychology, and information design. Knows when to be bold and casual, when to be polished and professional. Expert in Excalidraw's frame-based presentation capabilities and visual storytelling across all contexts.","Energetic creative director with sarcastic wit and experimental flair. Talks like you're in the editing room together—dramatic reveals, visual metaphors, "what if we tried THIS?!" energy. Treats every project like a creative challenge, celebrates bold choices, roasts bad design decisions with humor.","- Know your audience - pitch decks ≠ YouTube thumbnails ≠ conference talks - Visual hierarchy drives attention - design the eye's journey deliberately - Clarity over cleverness - unless cleverness serves the message - Every frame needs a job - inform, persuade, transition, or cut it - Test the 3-second rule - can they grasp the core idea that fast? - White space builds focus - cramming kills comprehension - Consistency signals professionalism - establish and maintain visual language - Story structure applies everywhere - hook, build tension, deliver payoff","cis",".bmad/cis/agents/presentation-master.md"
|
||||
"storyteller","Sophia","Master Storyteller","📖","Expert Storytelling Guide + Narrative Strategist","Master storyteller with 50+ years across journalism, screenwriting, and brand narratives. Expert in emotional psychology and audience engagement.","Speaks like a bard weaving an epic tale - flowery, whimsical, every sentence enraptures and draws you deeper","Powerful narratives leverage timeless human truths. Find the authentic story. Make the abstract concrete through vivid details.","cis",".bmad/cis/agents/storyteller.md"
|
||||
|
@ -1,352 +0,0 @@
|
||||
type,name,module,path,hash
|
||||
"csv","agent-manifest","_cfg","bmad/_cfg/agent-manifest.csv","c8ea1b716b8f2e2ee9a9e41f35271f3131f481a7b221e5b7b3e19c30a6363ed0"
|
||||
"csv","task-manifest","_cfg","bmad/_cfg/task-manifest.csv","7fccf1cdffa6d592342f9edd9e13c042fffea2dbcbb79b043fbd69a7e610c875"
|
||||
"csv","workflow-manifest","_cfg","bmad/_cfg/workflow-manifest.csv","5c7b03394ba7c6e9d549a12e554dfaf26c7f13d0441a0093d174b0ece8dacf9d"
|
||||
"yaml","manifest","_cfg","bmad/_cfg/manifest.yaml","6af878d8a4afa7e598b850a310758902304351eecf752a1504335b655ce63805"
|
||||
"csv","communication-presets","bmb","bmad/bmb/workflows/create-agent/communication-presets.csv","1d40b718418c672b19700516f03479dce199fb3646ff26250536e42113a91224"
|
||||
"js","installer","bmb","bmad/bmb/workflows/create-module/installer-templates/installer.js","309ecdf2cebbb213a9139e5b7780d0d42bd60f665c497691773f84202e6667a7"
|
||||
"md","agent-compilation","bmb","bmad/bmb/docs/agent-compilation.md","c9381fc09c183183016657fd6403ca0c96516aa89820296ba159d17d26a4d629"
|
||||
"md","agent-menu-patterns","bmb","bmad/bmb/docs/agent-menu-patterns.md","e754f2c5bd31083eed2d4a28dbe3550c1a354a70e06a9a04d08c59e982e420a8"
|
||||
"md","agent-validation-checklist","bmb","bmad/bmb/workflows/create-agent/agent-validation-checklist.md","7b1172ac27735a8adcd02448692b652bd6d089fdab3ea667b5bec7c724f240e9"
|
||||
"md","bmad-builder","bmb","bmad/bmb/agents/bmad-builder.md","d9079f11e5bc78846e42f8f88570f74cbfea3657e31c03472fa09d6fcf948c9d"
|
||||
"md","brainstorm-context","bmb","bmad/bmb/workflows/create-agent/brainstorm-context.md","576d7a02935ef4e34bdc6476527b658d954bb490b8d09b09ef7e0cf58712d96f"
|
||||
"md","brainstorm-context","bmb","bmad/bmb/workflows/create-module/brainstorm-context.md","62b902177d2cb56df2d6a12e5ec5c7d75ec94770ce22ac72c96691a876ed2e6a"
|
||||
"md","brainstorm-context","bmb","bmad/bmb/workflows/create-workflow/brainstorm-context.md","f246ec343e338068b37fee8c93aa6d2fe1d4857addba6db3fe6ad80a2a2950e8"
|
||||
"md","breakthroughs","bmb","bmad/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/breakthroughs.md","f7eaba2c3f5f721d84bb9dc560f50840e79daeee026a139fe74aecccb5fd20c7"
|
||||
"md","checklist","bmb","bmad/bmb/workflows/audit-workflow/checklist.md","2e9fc9abe6dfbe5906cb20c9c1ef9d222070bf558db0da68b6fcde3969102ee6"
|
||||
"md","checklist","bmb","bmad/bmb/workflows/convert-legacy/checklist.md","40ae7527e72b13a02672a8cf98b224ac6e8b6563fc91285b627869bcc3484fb7"
|
||||
"md","checklist","bmb","bmad/bmb/workflows/create-module/checklist.md","6ca49bfca71e603c80d5ff84e6c330bf95f1ecee642840fdddaa2b6f98bba1a3"
|
||||
"md","checklist","bmb","bmad/bmb/workflows/create-workflow/checklist.md","5177e91bedcb515fa09f3a2bad36c2579d0201ac502a1262ba64f515daca41df"
|
||||
"md","checklist","bmb","bmad/bmb/workflows/create-workflow/workflow-template/checklist.md","a950c68c71cd54b5a3ef4c8d68ad8ec40d5d1fa057f7c95e697e975807ae600b"
|
||||
"md","checklist","bmb","bmad/bmb/workflows/edit-module/checklist.md","a30511053672ff986786543022b186487aec9ed09485c515b0d03a1f968c00df"
|
||||
"md","checklist","bmb","bmad/bmb/workflows/edit-workflow/checklist.md","9677c087ddfb40765e611de23a5a009afe51c347683dfe5f7d9fd33712ac4795"
|
||||
"md","checklist","bmb","bmad/bmb/workflows/module-brief/checklist.md","4710f9c7e48a1cb29b225d43955bf313271dc7f9bb471bfecb1a8edf5f57a10a"
|
||||
"md","expert-agent-architecture","bmb","bmad/bmb/docs/expert-agent-architecture.md","79f02c8ddd86318ab62c0900b5c398a64e5e68b684e0349e35a2d2c262b7f659"
|
||||
"md","index","bmb","bmad/bmb/docs/index.md","c9d5170e93a53af426d6f95f43c506780ac39b0fcbe725adb84a2e7c3f3fd989"
|
||||
"md","instructions","bmb","bmad/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/instructions.md","2875b03e1f6bde4e6af943fb869cae427047d3b1780815f0a88bb72427f9d644"
|
||||
"md","instructions","bmb","bmad/bmb/workflows/audit-workflow/instructions.md","bcc6bb5061061615f4682e3f00be5bc41ba4cd701bfdc31b2709fc743dec60b7"
|
||||
"md","instructions","bmb","bmad/bmb/workflows/convert-legacy/instructions.md","6be0e83abff42583b88527d885d8253a7ed9863cae23d93d276167196fc77fd3"
|
||||
"md","instructions","bmb","bmad/bmb/workflows/create-agent/instructions.md","41a81ce78f379a44853a8e0087125a108161df04e9ea1e95d497bf0e8d1791db"
|
||||
"md","instructions","bmb","bmad/bmb/workflows/create-module/instructions.md","640113b47f8b62e40583f39d127a83e0960d297dd9058ffdd7029dd741f19d8b"
|
||||
"md","instructions","bmb","bmad/bmb/workflows/create-workflow/instructions.md","0c2195b6bb6bc830f16c60b50d3996fa6d53f7900ba0b196398ea91736183b1b"
|
||||
"md","instructions","bmb","bmad/bmb/workflows/create-workflow/workflow-template/instructions.md","40757b8b91e4d0f130695f71d2c445038dbc305b531b637efd2c5f2c70b9e3fe"
|
||||
"md","instructions","bmb","bmad/bmb/workflows/edit-agent/instructions.md","a5324245966d01cb1d85c6a6b47a43414422b4c0d6b5c5c9bfa8423a97743605"
|
||||
"md","instructions","bmb","bmad/bmb/workflows/edit-module/instructions.md","1dfece3903ddfec71f8802cc17ecde4a66b5131dce223b898a769f05092eb39d"
|
||||
"md","instructions","bmb","bmad/bmb/workflows/edit-workflow/instructions.md","55cbdd9c105efbe611aa9a869febb36064e7b3ab95e1fb59b42005646374e756"
|
||||
"md","instructions","bmb","bmad/bmb/workflows/module-brief/instructions.md","a1386d90d1d347c4bad17b628f3c201e1a61d162ffe8468bba89ef377996ce8c"
|
||||
"md","memories","bmb","bmad/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/memories.md","4b5a835195284352544641a2bfd66a98dd51f714cc0059e034842f9d07d32aa6"
|
||||
"md","module-agent-architecture","bmb","bmad/bmb/docs/module-agent-architecture.md","e86f409887acd68cc67c56705e702a3c252aedc5f0b05a9c481e090657196e74"
|
||||
"md","module-structure","bmb","bmad/bmb/workflows/create-module/module-structure.md","032bd574cf5a6c86ad967ec7f827a337ffe4ec68f0fa180d18863e275bd1b1e8"
|
||||
"md","mood-patterns","bmb","bmad/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/mood-patterns.md","40d9ca8c95efc1b121421df018e0d5f58010a32e250e60bb6f1c8f59530cff8d"
|
||||
"md","readme","bmb","bmad/bmb/reference/readme.md","fd0dcb1c9acd089b6855dcfc89a74c9c27e4b1637d3c2c2e8db4cde2fb1140eb"
|
||||
"md","README","bmb","bmad/bmb/README.md","aa2beac1fb84267cbaa6d7eb541da824c34177a17cd227f11b189ab3a1e06d33"
|
||||
"md","README","bmb","bmad/bmb/reference/agents/expert-examples/journal-keeper/README.md","4d8fb27d4e0993d9a60d21a19c92806bc1cb10488b4c203d688b8b636b01782b"
|
||||
"md","README","bmb","bmad/bmb/reference/agents/module-examples/README.md","3237dc5ad3580ad93fac5503773b8e25042f14ab4d4375ddffdf79377dff0509"
|
||||
"md","README","bmb","bmad/bmb/reference/agents/simple-examples/README.md","645ad486a3cf20b6e57d60255571c890a57af59522b42e675a553ba8cdc38b2b"
|
||||
"md","README","bmb","bmad/bmb/workflows/convert-legacy/README.md","a5fa14007024d5ee9c2d793bd0d50874b662a2ea501dbcf017dfaf80e8384965"
|
||||
"md","README","bmb","bmad/bmb/workflows/create-module/README.md","bd510d67395896d198eef7bf607141853be2ceb3b0a5670389fb77c7e56088ef"
|
||||
"md","README","bmb","bmad/bmb/workflows/create-workflow/README.md","a30aed2d7956f7d7a0c5e0a1edd151b86512e0d3e814f37aa137a53743cadcfd"
|
||||
"md","README","bmb","bmad/bmb/workflows/edit-agent/README.md","60df7797724dcdeb09d73129bc09c6ea8f2916074753c1a0a0eec72b8116a82a"
|
||||
"md","README","bmb","bmad/bmb/workflows/edit-module/README.md","f95914b31f5118eba63e737f1198b08bb7ab4f8dbb8dfdc06ac2e85d9acd4f90"
|
||||
"md","README","bmb","bmad/bmb/workflows/edit-workflow/README.md","2db00015c03a3ed7df4ff609ac27a179885145e4c8190862eea70d8b894ee9be"
|
||||
"md","README","bmb","bmad/bmb/workflows/module-brief/README.md","3b6456ebaff447a2312d1274b50bad538da6a8e7c73c2e7e4d5b7f6092852219"
|
||||
"md","simple-agent-architecture","bmb","bmad/bmb/docs/simple-agent-architecture.md","56eac057796d459346f478a59774d0266e343a8cf87464670a45c50644938e1c"
|
||||
"md","template","bmb","bmad/bmb/workflows/audit-workflow/template.md","98e65880cac3ffb123e513abd48710e57e461418dd79a07d6b712505ed3ddb0e"
|
||||
"md","template","bmb","bmad/bmb/workflows/create-workflow/workflow-template/template.md","c98f65a122035b456f1cbb2df6ecaf06aa442746d93a29d1d0ed2fc9274a43ee"
|
||||
"md","template","bmb","bmad/bmb/workflows/module-brief/template.md","7d1ad5ec40b06510fcbb0a3da8ea32aefa493e5b04c3a2bba90ce5685b894275"
|
||||
"md","understanding-agent-types","bmb","bmad/bmb/docs/understanding-agent-types.md","17cd17d09295dd9064d46ae9beebf4943976c146d4cbf93a903da14063153d08"
|
||||
"md","workflow-creation-guide","bmb","bmad/bmb/workflows/create-workflow/workflow-creation-guide.md","26fe479fba9af99ca65933b383353e4b23825a85483b51278dab0cc0ae4ebf3e"
|
||||
"yaml","bmad-builder.agent","bmb","bmad/bmb/agents/bmad-builder.agent.yaml",""
|
||||
"yaml","commit-poet.agent","bmb","bmad/bmb/reference/agents/simple-examples/commit-poet.agent.yaml","a57745f92808bba5788795c981c77c56a6b703baa25ccef0e3326280af4105a9"
|
||||
"yaml","config","bmb","bmad/bmb/config.yaml","80882cd418e52aa321c4013bd0bb3af773a6fcf000b56ac035303e069ad0139b"
|
||||
"yaml","install-config","bmb","bmad/bmb/workflows/create-module/installer-templates/install-config.yaml","484448c87b55725f2cb5eb8661c4706b7d43ddbb94bbfe98abaab591bcef32d0"
|
||||
"yaml","journal-keeper.agent","bmb","bmad/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml","37b02124fa3ade0516ad25c7657aa031dbda0374cec89a0df6761c9a94f4590b"
|
||||
"yaml","security-engineer.agent","bmb","bmad/bmb/reference/agents/module-examples/security-engineer.agent.yaml","09f792da53437c3434dd10bfe1b6cf5c8d58b226e0624dedbf78419131d0114a"
|
||||
"yaml","trend-analyst.agent","bmb","bmad/bmb/reference/agents/module-examples/trend-analyst.agent.yaml","421a5d2829540add32151c0cc0efd7373dbe39bec156bb2d1f1e7fb8ba0609e0"
|
||||
"yaml","workflow","bmb","bmad/bmb/workflows/audit-workflow/workflow.yaml","12dbdf2b847380b7fa6a7903571344cc739d65b16fd6bae6c4367e2d67042030"
|
||||
"yaml","workflow","bmb","bmad/bmb/workflows/convert-legacy/workflow.yaml","10a6ac62bf809d700dd2029784a9138e8eeef7dc2141845fffd681e98e1307ce"
|
||||
"yaml","workflow","bmb","bmad/bmb/workflows/create-agent/workflow.yaml","2e04222edb659a71ee752372df0b6493d68cffa378bb8b8a9a26e1318c1be903"
|
||||
"yaml","workflow","bmb","bmad/bmb/workflows/create-module/workflow.yaml","728d652409d4fdf72c7c7f4312f87a71144939e6c4d0b88d8acd3a2c4723508f"
|
||||
"yaml","workflow","bmb","bmad/bmb/workflows/create-workflow/workflow-template/workflow.yaml","a6067898980e4652865e4cf7d4a4abd273de3573b5b299001e6d4e52919406ed"
|
||||
"yaml","workflow","bmb","bmad/bmb/workflows/create-workflow/workflow.yaml","6c66b60f1c71d95fb892a699a98558bbfdf6ce56951af45fed77c5b781f35025"
|
||||
"yaml","workflow","bmb","bmad/bmb/workflows/edit-agent/workflow.yaml","f4ff147e1d660e950fcecfdc9e8e27cee1e059e89879fd32364ead32a9715fce"
|
||||
"yaml","workflow","bmb","bmad/bmb/workflows/edit-module/workflow.yaml","25ee3994fad9845ae7d3f8979ab0e08548f4f5473a04bf2fd9704bf42793dc1f"
|
||||
"yaml","workflow","bmb","bmad/bmb/workflows/edit-workflow/workflow.yaml","996f51e3fca2fdf45e10e502e3f2079519cbdf16261c9c62d46cb0412161894d"
|
||||
"yaml","workflow","bmb","bmad/bmb/workflows/module-brief/workflow.yaml","1a178ab87b8f602a5a27262ee2276fe16ea0f132c888524d774dde0dd6ba4b9f"
|
||||
"csv","default-party","bmm","bmad/bmm/teams/default-party.csv","5cac772c6ca7510b511c90f3e5c135cd42dc0ab567a6ded3c3cfb4fb032f2f6e"
|
||||
"csv","documentation-requirements","bmm","bmad/bmm/workflows/document-project/documentation-requirements.csv","d1253b99e88250f2130516b56027ed706e643bfec3d99316727a4c6ec65c6c1d"
|
||||
"csv","domain-complexity","bmm","bmad/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv","ed4d30e9fd87db2d628fb66cac7a302823ef6ebb3a8da53b9265326f10a54e11"
|
||||
"csv","pattern-categories","bmm","bmad/bmm/workflows/3-solutioning/architecture/pattern-categories.csv","d9a275931bfed32a65106ce374f2bf8e48ecc9327102a08f53b25818a8c78c04"
|
||||
"csv","project-types","bmm","bmad/bmm/workflows/2-plan-workflows/prd/project-types.csv","7a01d336e940fb7a59ff450064fd1194cdedda316370d939264a0a0adcc0aca3"
|
||||
"csv","tea-index","bmm","bmad/bmm/testarch/tea-index.csv","23b0e383d06e039a77bb1611b168a2bb5323ed044619a592ac64e36911066c83"
|
||||
"excalidraw","workflow-method-greenfield","bmm","bmad/bmm/docs/images/workflow-method-greenfield.excalidraw","5bbcdb2e97b56f844447c82c210975f1aa5ce7e82ec268390a64a75e5d5a48ed"
|
||||
"json","excalidraw-library","bmm","bmad/bmm/workflows/diagrams/_shared/excalidraw-library.json","8e5079f4e79ff17f4781358423f2126a1f14ab48bbdee18fd28943865722030c"
|
||||
"json","project-scan-report-schema","bmm","bmad/bmm/workflows/document-project/templates/project-scan-report-schema.json","53255f15a10cab801a1d75b4318cdb0095eed08c51b3323b7e6c236ae6b399b7"
|
||||
"md","agents-guide","bmm","bmad/bmm/docs/agents-guide.md","c70830b78fa3986d89400bbbc6b60dae1ff2ff0e55e3416f6a2794079ead870e"
|
||||
"md","analyst","bmm","bmad/bmm/agents/analyst.md","d7e80877912751c1726fee19a977fbfaf1d245846dae4c0f18119bbc96f1bb90"
|
||||
"md","architect","bmm","bmad/bmm/agents/architect.md","c54743457c1b8a06878c9c66ba4312f8eff340d3ec199293ce008a7c5d0760f9"
|
||||
"md","architecture-template","bmm","bmad/bmm/workflows/3-solutioning/architecture/architecture-template.md","a4908c181b04483c589ece1eb09a39f835b8a0dcb871cb624897531c371f5166"
|
||||
"md","atdd-checklist-template","bmm","bmad/bmm/workflows/testarch/atdd/atdd-checklist-template.md","9944d7b488669bbc6e9ef537566eb2744e2541dad30a9b2d9d4ae4762f66b337"
|
||||
"md","backlog_template","bmm","bmad/bmm/workflows/4-implementation/code-review/backlog_template.md","84b1381c05012999ff9a8b036b11c8aa2f926db4d840d256b56d2fa5c11f4ef7"
|
||||
"md","brownfield-guide","bmm","bmad/bmm/docs/brownfield-guide.md","8cc867f2a347579ca2d4f3965bb16b85924fabc65fe68fa213d8583a990aacd6"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/1-analysis/product-brief/checklist.md","d801d792e3cf6f4b3e4c5f264d39a18b2992a197bc347e6d0389cc7b6c5905de"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/1-analysis/research/checklist.md","eca09a6e7fc21316b11c022395b729dd56a615cbe483932ba65e1c11be9d95ed"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/2-plan-workflows/create-ux-design/checklist.md","1aa5bc2ad9409fab750ce55475a69ec47b7cdb5f4eac93b628bb5d9d3ea9dacb"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/2-plan-workflows/prd/checklist.md","9c3f0452b3b520ac2e975bf8b3e0325f07c40ff45d20f79aad610e489167770e"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/2-plan-workflows/tech-spec/checklist.md","905a709418504f88775c37e46d89164f064fb4fefc199dab55e568ef67bde06b"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/3-solutioning/architecture/checklist.md","625df65f77ceaf7193cdac0e7bc0ffda39bf6b18f698859b10c50c2588a5dc56"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/3-solutioning/implementation-readiness/checklist.md","6024d4064ad1010a9bbdbaa830c01adba27c1aba6bf0153d88eee460427af799"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/4-implementation/code-review/checklist.md","549f958bfe0b28f33ed3dac7b76ea8f266630b3e67f4bda2d4ae85be518d3c89"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/4-implementation/correct-course/checklist.md","c02bdd4bf4b1f8ea8f7c7babaa485d95f7837818e74cef07486a20b31671f6f5"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/4-implementation/create-story/checklist.md","e3a636b15f010fc0c337e35c2a9427d4a0b9746f7f2ac5dda0b2f309f469f5d1"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/4-implementation/dev-story/checklist.md","77cecc9d45050de194300c841e7d8a11f6376e2fbe0a5aac33bb2953b1026014"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/4-implementation/epic-tech-context/checklist.md","630a0c5b75ea848a74532f8756f01ec12d4f93705a3f61fcde28bc42cdcb3cf3"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/4-implementation/sprint-planning/checklist.md","80b10aedcf88ab1641b8e5f99c9a400c8fd9014f13ca65befc5c83992e367dd7"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/4-implementation/story-context/checklist.md","29f17f8b5c0c4ded3f9ca7020b5a950ef05ae3c62c3fadc34fc41b0c129e13ca"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/diagrams/create-dataflow/checklist.md","f420aaf346833dfda5454ffec9f90a680e903453bcc4d3e277d089e6781fec55"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/diagrams/create-diagram/checklist.md","6357350a6e2237c1b819edd8fc847e376192bf802000cb1a4337c9584fc91a18"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/diagrams/create-flowchart/checklist.md","45aaf882b8e9a1042683406ae2cfc0b23d3d39bd1dac3ddb0778d5b7165f7047"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/diagrams/create-wireframe/checklist.md","588f9354bf366c173aa261cf5a8b3a87c878ea72fd2c0f8088c4b3289e984641"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/document-project/checklist.md","2f1edb9e5e0b003f518b333ae842f344ff94d4dda7df07ba7f30c5b066013a68"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/testarch/atdd/checklist.md","c4fa594d949dd8f1f818c11054b28643b458ab05ed90cf65f118deb1f4818e9f"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/testarch/automate/checklist.md","bf1ae220c15c9f263967d1606658b19adcd37d57aef2b0faa30d34f01e5b0d22"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/testarch/ci/checklist.md","c40143aaf0e34c264a2f737e14a50ec85d861bda78235cf01a3c63413d996dc8"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/testarch/framework/checklist.md","16cc3aee710abb60fb85d2e92f0010b280e66b38fac963c0955fb36e7417103a"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/testarch/nfr-assess/checklist.md","044416df40402db39eb660509eedadafc292c16edc247cf93812f2a325ee032c"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/testarch/test-design/checklist.md","1a7e5e975d5a2bd3afd81e743e5ee3a2aa72571fce250caac24a6643808394eb"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/testarch/test-review/checklist.md","0626c675114c23019e20e4ae2330a64baba43ad11774ff268c027b3c584a0891"
|
||||
"md","checklist","bmm","bmad/bmm/workflows/testarch/trace/checklist.md","a4468ae2afa9cf676310ec1351bb34317d5390e4a02ded9684cc15a62f2fd4fd"
|
||||
"md","checklist-deep-prompt","bmm","bmad/bmm/workflows/1-analysis/research/checklist-deep-prompt.md","5caaa34bd252cf26e50f75d25b6cff8cfaf2f56615f1141cd75225e7d8e9b00a"
|
||||
"md","checklist-technical","bmm","bmad/bmm/workflows/1-analysis/research/checklist-technical.md","aab903438d953c3b3f5a9b1090346452077db4e3cda3ce5af3a564b52b4487fc"
|
||||
"md","ci-burn-in","bmm","bmad/bmm/testarch/knowledge/ci-burn-in.md","de0092c37ea5c24b40a1aff90c5560bbe0c6cc31702de55d4ea58c56a2e109af"
|
||||
"md","component-tdd","bmm","bmad/bmm/testarch/knowledge/component-tdd.md","88bd1f9ca1d5bcd1552828845fe80b86ff3acdf071bac574eda744caf7120ef8"
|
||||
"md","contract-testing","bmm","bmad/bmm/testarch/knowledge/contract-testing.md","d8f662c286b2ea4772213541c43aebef006ab6b46e8737ebdc4a414621895599"
|
||||
"md","data-factories","bmm","bmad/bmm/testarch/knowledge/data-factories.md","d7428fe7675da02b6f5c4c03213fc5e542063f61ab033efb47c1c5669b835d88"
|
||||
"md","deep-dive-instructions","bmm","bmad/bmm/workflows/document-project/workflows/deep-dive-instructions.md","a567fc43c918ca3f77440e75ce2ac7779740550ad848cade130cca1837115c1e"
|
||||
"md","deep-dive-template","bmm","bmad/bmm/workflows/document-project/templates/deep-dive-template.md","6198aa731d87d6a318b5b8d180fc29b9aa53ff0966e02391c17333818e94ffe9"
|
||||
"md","dev","bmm","bmad/bmm/agents/dev.md","419c598db6f7d4672b81f1e70d2d76182857968c04ed98175e98ddbf90c134d4"
|
||||
"md","documentation-standards","bmm","bmad/bmm/workflows/techdoc/documentation-standards.md","fc26d4daff6b5a73eb7964eacba6a4f5cf8f9810a8c41b6949c4023a4176d853"
|
||||
"md","email-auth","bmm","bmad/bmm/testarch/knowledge/email-auth.md","43f4cc3138a905a91f4a69f358be6664a790b192811b4dfc238188e826f6b41b"
|
||||
"md","enterprise-agentic-development","bmm","bmad/bmm/docs/enterprise-agentic-development.md","260b02514513338ec6712810abd1646ac4416cafce87db0ff6ddde6f824d8fd7"
|
||||
"md","epics-template","bmm","bmad/bmm/workflows/2-plan-workflows/tech-spec/epics-template.md","2eb396607543da58e6accdf0617773d9db059632ef8cb069ec745b790274704c"
|
||||
"md","epics-template","bmm","bmad/bmm/workflows/3-solutioning/create-epics-and-stories/epics-template.md","9adb82dfce092b40756578c15eddab540c5c987abd7fcc323f3d76b2999eb115"
|
||||
"md","error-handling","bmm","bmad/bmm/testarch/knowledge/error-handling.md","8a314eafb31e78020e2709d88aaf4445160cbefb3aba788b62d1701557eb81c1"
|
||||
"md","faq","bmm","bmad/bmm/docs/faq.md","ae791150e73625c79a93f07e9385f45b7c2026676071a0e7de6bc4ebebb317cf"
|
||||
"md","feature-flags","bmm","bmad/bmm/testarch/knowledge/feature-flags.md","f6db7e8de2b63ce40a1ceb120a4055fbc2c29454ad8fca5db4e8c065d98f6f49"
|
||||
"md","fixture-architecture","bmm","bmad/bmm/testarch/knowledge/fixture-architecture.md","a3b6c1bcaf5e925068f3806a3d2179ac11dde7149e404bc4bb5602afb7392501"
|
||||
"md","full-scan-instructions","bmm","bmad/bmm/workflows/document-project/workflows/full-scan-instructions.md","6c6e0d77b33f41757eed8ebf436d4def69cd6ce412395b047bf5909f66d876aa"
|
||||
"md","glossary","bmm","bmad/bmm/docs/glossary.md","f194e68adad2458d6bdd41f4b4fab95c241790cf243807748f4ca3f35cef6676"
|
||||
"md","index-template","bmm","bmad/bmm/workflows/document-project/templates/index-template.md","42c8a14f53088e4fda82f26a3fe41dc8a89d4bcb7a9659dd696136378b64ee90"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/1-analysis/brainstorm-project/instructions.md","bedd2e74055a9b9d6516221f4788286b313353fc636d3bc43ec147c3e27eba72"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/1-analysis/domain-research/instructions.md","12068fa7f84b41ab922a1b4e8e9b2ef8bcb922501d2470a3221b457dd5d05384"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/1-analysis/product-brief/instructions.md","d68bc5aaf6acc38d185c8cb888bb4f4ca3fb53b05f73895c37f4dcfc5452f9ee"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/2-plan-workflows/create-ux-design/instructions.md","40d5e921c28c3cd83ec8d7e699fc72d182e8611851033057bab29f304dd604c4"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/2-plan-workflows/prd/instructions.md","cf7f00a321b830768be65d37747d0ed4d35bab8a314c0865375a1dc386f58e0e"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/2-plan-workflows/tech-spec/instructions.md","d8f46330cb32c052549abb2bd0c5034fd15b97622ba66c82b8119fa70a91af04"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/3-solutioning/architecture/instructions.md","a5d71dc77c15138ac208c1b20bc525b299fef188fc0cba232a38b936caa9fa7b"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/3-solutioning/create-epics-and-stories/instructions.md","e46c893a0a6ae1976564fe41825320ed1d0df916e5a503155258c4cd5f4a9004"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/3-solutioning/implementation-readiness/instructions.md","d000a383dffcd6606a4984fa332cc6294d784f1db841739161c0cde030613c49"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/4-implementation/code-review/instructions.md","608b47fd427649324ece2a5e687d40a99705b06d757f4ba5db5c261985482e41"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/4-implementation/correct-course/instructions.md","36bdc26a75adcba6aba508f3384512502d6640f96926742666e026f1eb380666"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/4-implementation/create-story/instructions.md","38179e6b27b944e54bab9d69a12c0945893d70653899b13a5dc33adcc8129dce"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/4-implementation/dev-story/instructions.md","b3126a4f11f089601297276da36ad3d5e3777973500032e37cb1754b202a3ae4"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/4-implementation/epic-tech-context/instructions.md","9269596a5626c328963f5362a564f698dbfed7c6a9ef4e4f58d19621b1a664ca"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/4-implementation/retrospective/instructions.md","affe11f9528d7ed244a5def0209097826686ef39626c8219c23f5174b0e657cb"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/4-implementation/sprint-planning/instructions.md","0456996ca4dc38e832d64b72650c4f6f1048c0ce6e8d996a5a0ec16bc9a589f5"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/4-implementation/story-context/instructions.md","d7a522e129bd0575f6ffbd19f23bf4fba619a7ce4d007a4c81007b3925dd4389"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/4-implementation/story-done/instructions.md","52163e1df2e75f1d34cad513b386ac73bada53784e827cca28d0ea9f05dc8ec4"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/4-implementation/story-ready/instructions.md","21e20a6ba037962b8cf6d818f1f35bf0303232c406e469b2f2e60e9ca3a01a3d"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/diagrams/create-dataflow/instructions.md","d07ed411e68fce925af5e59800e718406a783f8b94dadaa42425f3a33f460637"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/diagrams/create-diagram/instructions.md","231d3ce0f0fe0f8af9010acebf2720eb858a45ea34cd1e7ec8385878bcd5e27f"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/diagrams/create-flowchart/instructions.md","36e8b3327dd6c97270f11de6f3bea346c17dd1b0e25fef65245fe166b00a2543"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/diagrams/create-wireframe/instructions.md","60309b71a73d1bee9804aaf63228c917066b8da64b929b32813b1d0411a8b8b2"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/document-project/instructions.md","c67bd666382131bead7d4ace1ac6f0c9acd2d1d1b2a82314b4b90bda3a15eeb4"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/testarch/atdd/instructions.md","dcd052e78a069e9548d66ba679ed5db66e94b8ef5b3a02696837b77a641abcad"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/testarch/automate/instructions.md","8e6cb0167b14b345946bb7e46ab2fb02a9ff2faab9c3de34848e2d4586626960"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/testarch/ci/instructions.md","abdf97208c19d0cb76f9e5387613a730e56ddd90eb87523a8c8f1b03f20647a3"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/testarch/framework/instructions.md","936b9770dca2c65b38bc33e2e85ccf61e0b5722fc046eeae159a3efcbc361e30"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/testarch/nfr-assess/instructions.md","7de16907253721c8baae2612be35325c6fa543765377783763a09739fa71f072"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/testarch/test-design/instructions.md","effd3832628d45caecdb7cef43e0cdc8b8b928418b752feaa9f30398b7a4c0f7"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/testarch/test-review/instructions.md","ab2f7adfd106652014a1573e2557cfd4c9d0f7017258d68abf8b1470ab82720e"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/testarch/trace/instructions.md","fe499a09c4bebbff0a0bce763ced2c36bee5c36b268a4abb4e964a309ff2fa20"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/workflow-status/init/instructions.md","37988b39d3813d1da879d4348c9606c3cd9f1a9f02cfa56a03b3a5cad344c4a6"
|
||||
"md","instructions","bmm","bmad/bmm/workflows/workflow-status/instructions.md","567a9ea03b3a6625194fb5a3901d8eb96dd203d0e59de4bfcdc2dcab8dd97231"
|
||||
"md","instructions-deep-prompt","bmm","bmad/bmm/workflows/1-analysis/research/instructions-deep-prompt.md","3312f8b35fe8e1a2ed4a6d3500be237fcee2f935d20ad5b2ae4e6c5bfed19ba6"
|
||||
"md","instructions-generate-stories","bmm","bmad/bmm/workflows/2-plan-workflows/tech-spec/instructions-generate-stories.md","30c313a4525001bde80a4786791953017c366abd5b5effa5b61f7686fc3d1043"
|
||||
"md","instructions-market","bmm","bmad/bmm/workflows/1-analysis/research/instructions-market.md","ff67aa72126a60ab718da7acc12de40b58b313e9cfd519ad0ab657b025cc53ac"
|
||||
"md","instructions-router","bmm","bmad/bmm/workflows/1-analysis/research/instructions-router.md","90644e9c1f1d48c0b50fec35ddfaab3c0f1eb14c0c5e5b0562bf9fa0f3e761e2"
|
||||
"md","instructions-technical","bmm","bmad/bmm/workflows/1-analysis/research/instructions-technical.md","4140a69386d0b11b4732ae6610a8ee5ed86bf788ef622a851c3141cf2c9af410"
|
||||
"md","network-first","bmm","bmad/bmm/testarch/knowledge/network-first.md","2920e58e145626f5505bcb75e263dbd0e6ac79a8c4c2ec138f5329e06a6ac014"
|
||||
"md","nfr-criteria","bmm","bmad/bmm/testarch/knowledge/nfr-criteria.md","e63cee4a0193e4858c8f70ff33a497a1b97d13a69da66f60ed5c9a9853025aa1"
|
||||
"md","nfr-report-template","bmm","bmad/bmm/workflows/testarch/nfr-assess/nfr-report-template.md","b1d8fcbdfc9715a285a58cb161242dea7d311171c09a2caab118ad8ace62b80c"
|
||||
"md","party-mode","bmm","bmad/bmm/docs/party-mode.md","7acadc96c7235695a88cba42b5642e1ee3a7f96eb2264862f629e1d4280b9761"
|
||||
"md","playwright-config","bmm","bmad/bmm/testarch/knowledge/playwright-config.md","42516511104a7131775f4446196cf9e5dd3295ba3272d5a5030660b1dffaa69f"
|
||||
"md","pm","bmm","bmad/bmm/agents/pm.md","f37c60e29e8c12c3144b0539bafada607c956763a56a8ff96ee25c98d588a357"
|
||||
"md","prd-template","bmm","bmad/bmm/workflows/2-plan-workflows/prd/prd-template.md","456f63362fe44789593e65749244dbf8e0089562c5f6032c500f3b014e0d5bdc"
|
||||
"md","probability-impact","bmm","bmad/bmm/testarch/knowledge/probability-impact.md","446dba0caa1eb162734514f35366f8c38ed3666528b0b5e16c7f03fd3c537d0f"
|
||||
"md","project-context","bmm","bmad/bmm/workflows/1-analysis/brainstorm-project/project-context.md","0f1888da4bfc4f24c4de9477bd3ccb2a6fb7aa83c516dfdc1f98fbd08846d4ba"
|
||||
"md","project-overview-template","bmm","bmad/bmm/workflows/document-project/templates/project-overview-template.md","a7c7325b75a5a678dca391b9b69b1e3409cfbe6da95e70443ed3ace164e287b2"
|
||||
"md","quick-spec-flow","bmm","bmad/bmm/docs/quick-spec-flow.md","215d508d27ea94e0091fc32f8dce22fadf990b3b9d8b397e2c393436934f85af"
|
||||
"md","quick-start","bmm","bmad/bmm/docs/quick-start.md","d3d327c8743136c11c24bde16297bf4cb44953629c1f4a931dc3ef3fb12765e4"
|
||||
"md","README","bmm","bmad/bmm/README.md","ad4e6d0c002e3a5fef1b695bda79e245fe5a43345375c699165b32d6fc511457"
|
||||
"md","README","bmm","bmad/bmm/docs/README.md","431c50b8acf7142eb6e167618538ece6bcda8bcd5d7b681a302cf866335e916e"
|
||||
"md","risk-governance","bmm","bmad/bmm/testarch/knowledge/risk-governance.md","2fa2bc3979c4f6d4e1dec09facb2d446f2a4fbc80107b11fc41cbef2b8d65d68"
|
||||
"md","scale-adaptive-system","bmm","bmad/bmm/docs/scale-adaptive-system.md","eb91f9859066f6f1214ac2e02178bc9c766cb96828380e730c79aee361582d8d"
|
||||
"md","selective-testing","bmm","bmad/bmm/testarch/knowledge/selective-testing.md","c14c8e1bcc309dbb86a60f65bc921abf5a855c18a753e0c0654a108eb3eb1f1c"
|
||||
"md","selector-resilience","bmm","bmad/bmm/testarch/knowledge/selector-resilience.md","a55c25a340f1cd10811802665754a3f4eab0c82868fea61fea9cc61aa47ac179"
|
||||
"md","sm","bmm","bmad/bmm/agents/sm.md","42fb37e9d1fb5174581db4d33c8037fa5995a7ca9dfc5ca737bc0994c99c2dd4"
|
||||
"md","source-tree-template","bmm","bmad/bmm/workflows/document-project/templates/source-tree-template.md","109bc335ebb22f932b37c24cdc777a351264191825444a4d147c9b82a1e2ad7a"
|
||||
"md","tea","bmm","bmad/bmm/agents/tea.md","90fbe1b2c51c2191cfcc75835e569a230a91f604bacd291d10ba3a6254e2aaf0"
|
||||
"md","tech-spec-template","bmm","bmad/bmm/workflows/2-plan-workflows/tech-spec/tech-spec-template.md","2b07373b7b23f71849f107b8fd4356fef71ba5ad88d7f333f05547da1d3be313"
|
||||
"md","tech-writer","bmm","bmad/bmm/agents/tech-writer.md","6825923d37347acd470211bd38086c40b3f99c81952df6f890399b6e089613e4"
|
||||
"md","template","bmm","bmad/bmm/workflows/1-analysis/domain-research/template.md","5606843f77007d886cc7ecf1fcfddd1f6dfa3be599239c67eff1d8e40585b083"
|
||||
"md","template","bmm","bmad/bmm/workflows/1-analysis/product-brief/template.md","96f89df7a4dabac6400de0f1d1abe1f2d4713b76fe9433f31c8a885e20d5a5b4"
|
||||
"md","template","bmm","bmad/bmm/workflows/3-solutioning/implementation-readiness/template.md","d8e5fdd62adf9836f7f6cccd487df9b260b392da2e45d2c849ecc667b9869427"
|
||||
"md","template","bmm","bmad/bmm/workflows/4-implementation/create-story/template.md","83c5d21312c0f2060888a2a8ba8332b60f7e5ebeb9b24c9ee59ba96114afb9c9"
|
||||
"md","template","bmm","bmad/bmm/workflows/4-implementation/epic-tech-context/template.md","b5c5d0686453b7c9880d5b45727023f2f6f8d6e491b47267efa8f968f20074e3"
|
||||
"md","template-deep-prompt","bmm","bmad/bmm/workflows/1-analysis/research/template-deep-prompt.md","2e65c7d6c56e0fa3c994e9eb8e6685409d84bc3e4d198ea462fa78e06c1c0932"
|
||||
"md","template-market","bmm","bmad/bmm/workflows/1-analysis/research/template-market.md","e5e59774f57b2f9b56cb817c298c02965b92c7d00affbca442366638cd74d9ca"
|
||||
"md","template-technical","bmm","bmad/bmm/workflows/1-analysis/research/template-technical.md","78caa56ba6eb6922925e5aab4ed4a8245fe744b63c245be29a0612135851f4ca"
|
||||
"md","test-architecture","bmm","bmad/bmm/docs/test-architecture.md","231473caba99b56d3e4bddde858405246786ffb44bff102bdd09e9f9b2f0da8d"
|
||||
"md","test-design-template","bmm","bmad/bmm/workflows/testarch/test-design/test-design-template.md","0902ec300d59458bcfc2df24da2622b607b557f26e6d407e093b7c7dbc515ba5"
|
||||
"md","test-healing-patterns","bmm","bmad/bmm/testarch/knowledge/test-healing-patterns.md","b44f7db1ebb1c20ca4ef02d12cae95f692876aee02689605d4b15fe728d28fdf"
|
||||
"md","test-levels-framework","bmm","bmad/bmm/testarch/knowledge/test-levels-framework.md","80bbac7959a47a2e7e7de82613296f906954d571d2d64ece13381c1a0b480237"
|
||||
"md","test-priorities-matrix","bmm","bmad/bmm/testarch/knowledge/test-priorities-matrix.md","321c3b708cc19892884be0166afa2a7197028e5474acaf7bc65c17ac861964a5"
|
||||
"md","test-quality","bmm","bmad/bmm/testarch/knowledge/test-quality.md","97b6db474df0ec7a98a15fd2ae49671bb8e0ddf22963f3c4c47917bb75c05b90"
|
||||
"md","test-review-template","bmm","bmad/bmm/workflows/testarch/test-review/test-review-template.md","3e68a73c48eebf2e0b5bb329a2af9e80554ef443f8cd16652e8343788f249072"
|
||||
"md","timing-debugging","bmm","bmad/bmm/testarch/knowledge/timing-debugging.md","c4c87539bbd3fd961369bb1d7066135d18c6aad7ecd70256ab5ec3b26a8777d9"
|
||||
"md","trace-template","bmm","bmad/bmm/workflows/testarch/trace/trace-template.md","5453a8e4f61b294a1fc0ba42aec83223ae1bcd5c33d7ae0de6de992e3ee42b43"
|
||||
"md","user-story-template","bmm","bmad/bmm/workflows/2-plan-workflows/tech-spec/user-story-template.md","4b179d52088745060991e7cfd853da7d6ce5ac0aa051118c9cecea8d59bdaf87"
|
||||
"md","ux-design-template","bmm","bmad/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md","f9b8ae0fe08c6a23c63815ddd8ed43183c796f266ffe408f3426af1f13b956db"
|
||||
"md","ux-designer","bmm","bmad/bmm/agents/ux-designer.md","8dd16e05e3bfe47dae80d7ae2a0caa7070fb0f0dedb506af70170c8ea0b63c11"
|
||||
"md","visual-debugging","bmm","bmad/bmm/testarch/knowledge/visual-debugging.md","072a3d30ba6d22d5e628fc26a08f6e03f8b696e49d5a4445f37749ce5cd4a8a9"
|
||||
"md","workflow-architecture-reference","bmm","bmad/bmm/docs/workflow-architecture-reference.md","36efd4e3d74d1739455e896e62b7711bf4179c572f1eef7a7fae7f2385adcc6d"
|
||||
"md","workflow-document-project-reference","bmm","bmad/bmm/docs/workflow-document-project-reference.md","ae07462c68758985b4f84183d0921453c08e23fe38b0fa1a67d5e3a9f23f4c50"
|
||||
"md","workflows-analysis","bmm","bmad/bmm/docs/workflows-analysis.md","4dd00c829adcf881ecb96e083f754a4ce109159cfdaff8a5a856590ba33f1d74"
|
||||
"md","workflows-implementation","bmm","bmad/bmm/docs/workflows-implementation.md","4b80c0afded7e643692990dcf2283b4b4250377b5f87516a86d4972de483c4b0"
|
||||
"md","workflows-planning","bmm","bmad/bmm/docs/workflows-planning.md","3daeb274ad2564f8b1d109f78204b146a004c9edce6e7844ffa30da5a7e98066"
|
||||
"md","workflows-solutioning","bmm","bmad/bmm/docs/workflows-solutioning.md","933a8d9da5e4378506d8539e1b74bb505149eeecdd8be9f4e8ccc98a282d0e4c"
|
||||
"svg","workflow-method-greenfield","bmm","bmad/bmm/docs/images/workflow-method-greenfield.svg","fb20cc12c35e6b93bb2b8f9e95b4f1891d4c080f39c38c047180433dfd51ed46"
|
||||
"xml","context-template","bmm","bmad/bmm/workflows/4-implementation/story-context/context-template.xml","582374f4d216ba60f1179745b319bbc2becc2ac92d7d8a19ac3273381a5c2549"
|
||||
"yaml","analyst.agent","bmm","bmad/bmm/agents/analyst.agent.yaml",""
|
||||
"yaml","architect.agent","bmm","bmad/bmm/agents/architect.agent.yaml",""
|
||||
"yaml","architecture-patterns","bmm","bmad/bmm/workflows/3-solutioning/architecture/architecture-patterns.yaml","00b9878fd753b756eec16a9f416b4975945d6439e1343673540da4bccb0b83f5"
|
||||
"yaml","config","bmm","bmad/bmm/config.yaml","a2fd4a76571f7b02a31f848a269b779efabfff80b322c96a7dfbfa8cc56b4089"
|
||||
"yaml","decision-catalog","bmm","bmad/bmm/workflows/3-solutioning/architecture/decision-catalog.yaml","f7fc2ed6ec6c4bd78ec808ad70d24751b53b4835e0aad1088057371f545d3c82"
|
||||
"yaml","deep-dive","bmm","bmad/bmm/workflows/document-project/workflows/deep-dive.yaml","c401fb8d94ca96f3bb0ccc1146269e1bfa4ce4eadab52bd63c7fcff6c2f26216"
|
||||
"yaml","dev.agent","bmm","bmad/bmm/agents/dev.agent.yaml",""
|
||||
"yaml","enterprise-brownfield","bmm","bmad/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml","26b8700277c1f1ac278cc292dbcdd8bc96850c68810d2f51d197437560a30c92"
|
||||
"yaml","enterprise-greenfield","bmm","bmad/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml","ab16f64719de6252ba84dfbb39aea2529a22ee5fa68e5faa67d4b8bbeaf7c371"
|
||||
"yaml","excalidraw-templates","bmm","bmad/bmm/workflows/diagrams/_shared/excalidraw-templates.yaml","ca6e4ae85b5ab16df184ce1ddfdf83b20f9540db112ebf195cb793017f014a70"
|
||||
"yaml","full-scan","bmm","bmad/bmm/workflows/document-project/workflows/full-scan.yaml","3d2e620b58902ab63e2d83304180ecd22ba5ab07183b3afb47261343647bde6f"
|
||||
"yaml","github-actions-template","bmm","bmad/bmm/workflows/testarch/ci/github-actions-template.yaml","28c0de7c96481c5a7719596c85dd0ce8b5dc450d360aeaa7ebf6294dcf4bea4c"
|
||||
"yaml","gitlab-ci-template","bmm","bmad/bmm/workflows/testarch/ci/gitlab-ci-template.yaml","bc83b9240ad255c6c2a99bf863b9e519f736c99aeb4b1e341b07620d54581fdc"
|
||||
"yaml","injections","bmm","bmad/bmm/workflows/1-analysis/research/claude-code/injections.yaml","dd6dd6e722bf661c3c51d25cc97a1e8ca9c21d517ec0372e469364ba2cf1fa8b"
|
||||
"yaml","method-brownfield","bmm","bmad/bmm/workflows/workflow-status/paths/method-brownfield.yaml","ccfa4631f8759ba7540df10a03ca44ecf02996da97430106abfcc418d1af87a5"
|
||||
"yaml","method-greenfield","bmm","bmad/bmm/workflows/workflow-status/paths/method-greenfield.yaml","1a6fb41f79e51fa0bbd247c283f44780248ef2c207750d2c9b45e8f86531f080"
|
||||
"yaml","pm.agent","bmm","bmad/bmm/agents/pm.agent.yaml",""
|
||||
"yaml","project-levels","bmm","bmad/bmm/workflows/workflow-status/project-levels.yaml","414b9aefff3cfe864e8c14b55595abfe3157fd20d9ee11bb349a2b8c8e8b5449"
|
||||
"yaml","quick-flow-brownfield","bmm","bmad/bmm/workflows/workflow-status/paths/quick-flow-brownfield.yaml","0d8837a07efaefe06b29c1e58fee982fafe6bbb40c096699bd64faed8e56ebf8"
|
||||
"yaml","quick-flow-greenfield","bmm","bmad/bmm/workflows/workflow-status/paths/quick-flow-greenfield.yaml","c6eae1a3ef86e87bd48a285b11989809526498dc15386fa949279f2e77b011d5"
|
||||
"yaml","sm.agent","bmm","bmad/bmm/agents/sm.agent.yaml",""
|
||||
"yaml","sprint-status-template","bmm","bmad/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml","1b9f6bc7955c9caedfc14e0bbfa01e3f4fd5f720a91142fb6e9027431f965a48"
|
||||
"yaml","tea.agent","bmm","bmad/bmm/agents/tea.agent.yaml",""
|
||||
"yaml","team-fullstack","bmm","bmad/bmm/teams/team-fullstack.yaml","3bc35195392607b6298c36a7f1f7cb94a8ac0b0e6febe61f745009a924caee7c"
|
||||
"yaml","tech-writer.agent","bmm","bmad/bmm/agents/tech-writer.agent.yaml",""
|
||||
"yaml","ux-designer.agent","bmm","bmad/bmm/agents/ux-designer.agent.yaml",""
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/1-analysis/brainstorm-project/workflow.yaml","38d859ea65db2cc2eebb0dbf1679711dad92710d8da2c2d9753b852055abd970"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/1-analysis/domain-research/workflow.yaml","919fb482ff0d94e836445f0321baea2426c30207eb01c899aa977e8bcc7fcac7"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/1-analysis/product-brief/workflow.yaml","4dbd4969985af241fea608811af4391bfcfd824d49e0c41ee46aa630116681d9"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/1-analysis/research/workflow.yaml","3489d4989ad781f67909269e76b439122246d667d771cbb64988e4624ee2572a"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.yaml","e640ee7ccdb60a3a49b58faff1c99ad3ddcacb8580b059285918d403addcc9cd"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/2-plan-workflows/prd/workflow.yaml","a6b8d830f1bddb5823ef00f23f3ca4d6a143bbc090168925c0e0de48e2da4204"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml","3971c1c6e6ebca536e4667f226387ac9068c6e7f5ee9417445774bfc2481aa20"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/3-solutioning/architecture/workflow.yaml","f0b5f401122a2e899c653cea525b177ceb3291a44d2375b0cd95b9f57af23e6a"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.yaml","a54f6db30334418438d5ecc23fffeeae7e3bf5f83694ef8c1fc980e23d855e4c"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/3-solutioning/implementation-readiness/workflow.yaml","e2867da72a2769247c6b1588b76701b36e49b263e26c2949a660829792ac40e2"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/4-implementation/code-review/workflow.yaml","f933eb1f31c8acf143e6e2c10ae7b828cd095b101d1dfa27a20678878a914bbc"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml","53bc0f2bc058cabf28febb603fd9be5d1171f6c8db14715ab65e7a0798bde696"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/4-implementation/create-story/workflow.yaml","11c3eaa0a9d8e20d6943bb6f61386ca62b83627b93c67f880b210bcc52cf381f"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml","540c72d6b499413c898bdc4186001a123079cc098a2fa48a6b6adbf72d9f59a4"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml","33004b358aec14166877a1ae29c032b3a571c8534edd5cd167b25533d2d0e81d"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml","f9ccda4e0e7728797ce021f5ae40e5d5632450453471d932a8b7577c600f9434"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml","da7d8d4ff8427c866b094821a50e6d6a7c75bf9a51da613499616cee0b4d1a3c"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/4-implementation/story-context/workflow.yaml","3e1337755cd33126d8bf85de32fb9d0a4f2725dec44965f770c34a163430827b"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/4-implementation/story-done/workflow.yaml","c55568088bbbc6d4c3c3c19a2428d670bbdd87166ad100a0bd983bda9914e33c"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/4-implementation/story-ready/workflow.yaml","a4a322305f77a73bc265af81d124129f13457f0aceda535adda86efc3d538bcb"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/diagrams/create-dataflow/workflow.yaml","58e9c6b6c99e68d166ec3491ae3299d9f662480da39b5f21afa5bf7ccc82d7ad"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/diagrams/create-diagram/workflow.yaml","4ae7bb7fe57d40ef357ff74732ac672e2094691ae5f4a67515bf37c504604c4a"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/diagrams/create-flowchart/workflow.yaml","fde7e2dc8920839f0ad7012520fcbabf4fda004c38de546d891a987a29694e57"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/diagrams/create-wireframe/workflow.yaml","511a7d17d13c5cbc57a1d2c3f73d1a79b2952aa40242f3c6d1117901bb5c495b"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/document-project/workflow.yaml","219333bb489c0aa0b2538a4801a381502a9f581839889262f6ef102ea4d54be7"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/testarch/atdd/workflow.yaml","e0c095c8844f0a92f961e3570d5887b8a7be39a6a2e8c7c449f13eb9cf3e0fb9"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/testarch/automate/workflow.yaml","b7b3d6552f8d3e2a0d9243fca27e30ad5103e38798fadd02b6b376b3f0532aac"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/testarch/ci/workflow.yaml","d8d59916c937fef9ee5e2c454cfa0cda33e58d21b211d562a05681587b8fdde0"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/testarch/framework/workflow.yaml","2774679175fed88d0ef21be44418a26a82a5b9d1aa08c906373a638e7877d523"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml","dad49221c4dcb4e1fbcc118b5caae13c63a050412e402ff65b6971cfab281fe3"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/testarch/test-design/workflow.yaml","494d12c966022969c74caeb336e80bb0fce05f0bb4f83581ab7111e9f6f0596d"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/testarch/test-review/workflow.yaml","c5e272f9969b704aa56b83a22f727fa2188490d7f6e347bc65966e0513eefa96"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/testarch/trace/workflow.yaml","841eec77aba6490ba5672ac2c01ce570c38011e94574d870e8ba15bba78509f4"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/workflow-status/init/workflow.yaml","3f54117211a421790df59c6c0a15d6ba6be33a001489d013870f939aaa649436"
|
||||
"yaml","workflow","bmm","bmad/bmm/workflows/workflow-status/workflow.yaml","6a1ad67ec954660fd8e7433b55ab3b75e768f7efa33aad36cf98cdbc2ef6575b"
|
||||
"yaml","workflow-status-template","bmm","bmad/bmm/workflows/workflow-status/workflow-status-template.yaml","0ec9c95f1690b7b7786ffb4ab10663c93b775647ad58e283805092e1e830a0d9"
|
||||
"csv","default-party","cis","bmad/cis/teams/default-party.csv","352ab9a0809da706759e265da66f91884b80a6270fe85ff7f7fe8cbba61fa3a2"
|
||||
"csv","design-methods","cis","bmad/cis/workflows/design-thinking/design-methods.csv","6735e9777620398e35b7b8ccb21e9263d9164241c3b9973eb76f5112fb3a8fc9"
|
||||
"csv","innovation-frameworks","cis","bmad/cis/workflows/innovation-strategy/innovation-frameworks.csv","9a14473b1d667467172d8d161e91829c174e476a030a983f12ec6af249c4e42f"
|
||||
"csv","solving-methods","cis","bmad/cis/workflows/problem-solving/solving-methods.csv","aa15c3a862523f20c199600d8d4d0a23fce1001010d7efc29a71abe537d42995"
|
||||
"csv","story-types","cis","bmad/cis/workflows/storytelling/story-types.csv","ec5a3c713617bf7e2cf7db439303dd8f3363daa2f6db20a350c82260ade88bdb"
|
||||
"md","brainstorming-coach","cis","bmad/cis/agents/brainstorming-coach.md","593e8f91ce0e20343af49fffb99e650ff828c390446b879e3da019d5ee4138b5"
|
||||
"md","creative-problem-solver","cis","bmad/cis/agents/creative-problem-solver.md","6c71da0e7ab6dfda6ec7fbfe137352fafff50000a11ea76d52af3388956df355"
|
||||
"md","design-thinking-coach","cis","bmad/cis/agents/design-thinking-coach.md","c99c06777bc00ff21668f50420a17fa7d42e2037696a45b4cfa6fadf29a722c1"
|
||||
"md","innovation-strategist","cis","bmad/cis/agents/innovation-strategist.md","c807b2983fdf9419c61064c72c7f4c71fe64578224c6390821a83b9de64f06b2"
|
||||
"md","instructions","cis","bmad/cis/workflows/design-thinking/instructions.md","66bbb5592905fbc0c53672fe3a080c29974cf90b5773ac36f482be283b143806"
|
||||
"md","instructions","cis","bmad/cis/workflows/innovation-strategy/instructions.md","45640898f0f8462a70b0148c80dbd7b3b74a0f1ae467838b06e9193dcd517914"
|
||||
"md","instructions","cis","bmad/cis/workflows/problem-solving/instructions.md","41350fd95944081d62b33b9cc228be5813fea94144ea380e95ef15456663e7ac"
|
||||
"md","instructions","cis","bmad/cis/workflows/storytelling/instructions.md","8723399bd0ae47a7325c975aac93d65e681cb3a5e0a88df12dd8aed969ee2f46"
|
||||
"md","presentation-master","cis","bmad/cis/agents/presentation-master.md","37cd10067965d56ffbae7c43c177abc2b9cb812a04c53ed0686d7a3451684054"
|
||||
"md","README","cis","bmad/cis/README.md","aa493c5bc9b1f5db0c46e8ece9c5d9d10b5d1d4d0d3ea0c102b002df62d4eac8"
|
||||
"md","README","cis","bmad/cis/agents/README.md","304fac869ca6a76660df270bb92af6394f3c98e8fd3ec36c9ea69c3e65f3f965"
|
||||
"md","README","cis","bmad/cis/workflows/README.md","013f3bf86267a29506aebc3c58826316381295476030d0a6a29f4cc90c91174e"
|
||||
"md","README","cis","bmad/cis/workflows/design-thinking/README.md","0a38f88352dc4674f6e1f55a67ffebf403bf329c874a21a49ce7834c08f91f62"
|
||||
"md","README","cis","bmad/cis/workflows/innovation-strategy/README.md","820a9e734fadf2cfac94d499cec2e4b41a54d054c0d2f6b9819da319beee4fb9"
|
||||
"md","README","cis","bmad/cis/workflows/problem-solving/README.md","a5e75b9899751d7aabffcf65785f10d4d2e0455f8c7c541e8a143e3babceca8b"
|
||||
"md","README","cis","bmad/cis/workflows/storytelling/README.md","1bad4223dce51cb5a7ab8c116467f78037a4583d3a840210ee2f160ad15b71ee"
|
||||
"md","storyteller","cis","bmad/cis/agents/storyteller.md","2e4d6be860c5c35c26d5e8aa0115cc5a2c7c418e8c21a889d97ea5bbcf98f4f0"
|
||||
"md","template","cis","bmad/cis/workflows/design-thinking/template.md","7834c387ac0412c841b49a9fcdd8043f5ce053e5cb26993548cf4d31b561f6f0"
|
||||
"md","template","cis","bmad/cis/workflows/innovation-strategy/template.md","e59bd789df87130bde034586d3e68bf1847c074f63d839945e0c29b1d0c85c82"
|
||||
"md","template","cis","bmad/cis/workflows/problem-solving/template.md","6c9efd7ac7b10010bd9911db16c2fbdca01fb0c306d871fa6381eef700b45608"
|
||||
"md","template","cis","bmad/cis/workflows/storytelling/template.md","461981aa772ef2df238070cbec90fc40995df2a71a8c22225b90c91afed57452"
|
||||
"yaml","brainstorming-coach.agent","cis","bmad/cis/agents/brainstorming-coach.agent.yaml",""
|
||||
"yaml","config","cis","bmad/cis/config.yaml","3d4485a5e5c2e52b428c0d9d93874d4b221ed55354eb8b1bfb162a9fb5c1a555"
|
||||
"yaml","creative-problem-solver.agent","cis","bmad/cis/agents/creative-problem-solver.agent.yaml",""
|
||||
"yaml","creative-squad","cis","bmad/cis/teams/creative-squad.yaml","25407cf0ebdf5b10884cd03c86068e04715ef270ada93a3b64cb9907b62c71cf"
|
||||
"yaml","design-thinking-coach.agent","cis","bmad/cis/agents/design-thinking-coach.agent.yaml",""
|
||||
"yaml","innovation-strategist.agent","cis","bmad/cis/agents/innovation-strategist.agent.yaml",""
|
||||
"yaml","presentation-master.agent","cis","bmad/cis/agents/presentation-master.agent.yaml",""
|
||||
"yaml","storyteller.agent","cis","bmad/cis/agents/storyteller.agent.yaml",""
|
||||
"yaml","workflow","cis","bmad/cis/workflows/design-thinking/workflow.yaml","7c479a604858c0b0de222085fa2fa36e5005c6300c518a834f52aa14d2fcc60e"
|
||||
"yaml","workflow","cis","bmad/cis/workflows/innovation-strategy/workflow.yaml","27a18c616d89601c6578113d77cc911e4d7e8a175f953c2a02e07df404a73dae"
|
||||
"yaml","workflow","cis","bmad/cis/workflows/problem-solving/workflow.yaml","119a49f40b6cca16b5e2738bdb7cae211d950e249ccd9c42c6bebaf1a4166516"
|
||||
"yaml","workflow","cis","bmad/cis/workflows/storytelling/workflow.yaml","22b7d33b6625fc601992b7a9b690e232f834c1aa4a1039a511c302b999ea4b80"
|
||||
"csv","adv-elicit-methods","core","bmad/core/tasks/adv-elicit-methods.csv","b4e925870f902862899f12934e617c3b4fe002d1b652c99922b30fa93482533b"
|
||||
"csv","advanced-elicitation-methods","core","bmad/core/tasks/advanced-elicitation-methods.csv","a8fe633e66471b69224ec2ee67c6bb2480c33c6fa9d416f672e3a5620ec5f33b"
|
||||
"csv","brain-methods","core","bmad/core/workflows/brainstorming/brain-methods.csv","ecffe2f0ba263aac872b2d2c95a3f7b1556da2a980aa0edd3764ffb2f11889f3"
|
||||
"md","bmad-master","core","bmad/core/agents/bmad-master.md","684b7872611e5979fbe420e0c96e9910355e181b49aed0317d872381e154e299"
|
||||
"md","excalidraw-helpers","core","bmad/core/resources/excalidraw/excalidraw-helpers.md","37f18fa0bd15f85a33e7526a2cbfe1d5a9404f8bcb8febc79b782361ef790de4"
|
||||
"md","instructions","core","bmad/core/workflows/brainstorming/instructions.md","fb4757564c03e1624e74f6ee344b286db3c2f7db23d2a8007152d807304cd3a6"
|
||||
"md","instructions","core","bmad/core/workflows/party-mode/instructions.md","768a835653fea54cbf4f7136e19f968add5ccf4b1dbce5636c5268d74b1b7181"
|
||||
"md","library-loader","core","bmad/core/resources/excalidraw/library-loader.md","7c9637a8467718035257bcc7a8733c31d59dc7396b48b60200913731a17cb666"
|
||||
"md","README","core","bmad/core/resources/excalidraw/README.md","a188224350e2400410eb52b7d7a36b1ee39d2ea13be1b58b231845f6bc37f21b"
|
||||
"md","README","core","bmad/core/workflows/brainstorming/README.md","57564ec8cb336945da8b7cab536076c437ff6c61a628664964058c76f4cd1360"
|
||||
"md","template","core","bmad/core/workflows/brainstorming/template.md","f2fe173a1a4bb1fba514652b314e83f7d78c68d09fb68071f9c2e61ee9f61576"
|
||||
"md","validate-json-instructions","core","bmad/core/resources/excalidraw/validate-json-instructions.md","0970bac93d52b4ee591a11998a02d5682e914649a40725d623489c77f7a1e449"
|
||||
"xml","advanced-elicitation","core","bmad/core/tasks/advanced-elicitation.xml","afb4020a20d26c92a694b77523426915b6e9665afb80ef5f76aded7f1d626ba6"
|
||||
"xml","bmad-web-orchestrator.agent","core","bmad/core/agents/bmad-web-orchestrator.agent.xml","2c2c3145d2c54ef40e1aa58519ae652fc2f63cb80b3e5236d40019e177853e0e"
|
||||
"xml","index-docs","core","bmad/core/tasks/index-docs.xml","c6a9d79628fd1246ef29e296438b238d21c68f50eadb16219ac9d6200cf03628"
|
||||
"xml","shard-doc","core","bmad/core/tools/shard-doc.xml","a0ddae908e440be3f3f40a96f7b288bcbf9fa3f8dc45d22814a957e807d2bedc"
|
||||
"xml","validate-workflow","core","bmad/core/tasks/validate-workflow.xml","63580411c759ee317e58da8bda6ceba27dbf9d3742f39c5c705afcd27361a9ee"
|
||||
"xml","workflow","core","bmad/core/tasks/workflow.xml","dcf69e99ec2996b85da1de9fac3715ae5428270d07817c40f04ae880fcc233fc"
|
||||
"yaml","bmad-master.agent","core","bmad/core/agents/bmad-master.agent.yaml",""
|
||||
"yaml","config","core","bmad/core/config.yaml","ebc9ab3bea31740ec2d367b6fa7916e7ea55a13e5db3c07029dce541a7b78153"
|
||||
"yaml","workflow","core","bmad/core/workflows/brainstorming/workflow.yaml","93b452218ce086c72b95685fd6d007a0f5c5ebece1d5ae4e1e9498623f53a424"
|
||||
"yaml","workflow","core","bmad/core/workflows/party-mode/workflow.yaml","1dcab5dc1d3396a16206775f2ee47f1ccb73a230c223c89de23ea1790ceaa3b7"
|
||||
|
@ -1,6 +0,0 @@
|
||||
ide: claude-code
|
||||
configured_date: '2025-11-25T04:20:40.623Z'
|
||||
last_updated: '2025-11-25T04:20:40.623Z'
|
||||
configuration:
|
||||
subagentChoices: null
|
||||
installLocation: null
|
||||
@ -1,12 +0,0 @@
|
||||
installation:
|
||||
version: 6.0.0-alpha.12
|
||||
installDate: '2025-11-25T04:20:40.589Z'
|
||||
lastUpdated: '2025-11-25T04:20:40.589Z'
|
||||
modules:
|
||||
- core
|
||||
- bmb
|
||||
- bmm
|
||||
- cis
|
||||
ides:
|
||||
- claude-code
|
||||
- cursor
|
||||
@ -1,5 +0,0 @@
|
||||
name,displayName,description,module,path,standalone
|
||||
"advanced-elicitation","Advanced Elicitation","When called from workflow","core",".bmad/core/tasks/advanced-elicitation.xml","true"
|
||||
"index-docs","Index Docs","Generates or updates an index.md of all documents in the specified directory","core",".bmad/core/tasks/index-docs.xml","true"
|
||||
"validate-workflow","Validate Workflow Output","Run a checklist against a document with thorough analysis and produce a validation report","core",".bmad/core/tasks/validate-workflow.xml","false"
|
||||
"workflow","Execute Workflow","Execute given workflow by loading its configuration, following instructions, and producing output","core",".bmad/core/tasks/workflow.xml","false"
|
||||
|
@ -1,2 +0,0 @@
|
||||
name,displayName,description,module,path,standalone
|
||||
"shard-doc","Shard Document","Splits large markdown documents into smaller, organized files based on level 2 (default) sections","core",".bmad/core/tools/shard-doc.xml","true"
|
||||
|
@ -1,51 +0,0 @@
|
||||
name,description,module,path,standalone
|
||||
"brainstorming","Facilitate interactive brainstorming sessions using diverse creative techniques. This workflow facilitates interactive brainstorming sessions using diverse creative techniques. The session is highly interactive, with the AI acting as a facilitator to guide the user through various ideation methods to generate and refine creative solutions.","core",".bmad/core/workflows/brainstorming/workflow.yaml","true"
|
||||
"party-mode","Orchestrates group discussions between all installed BMAD agents, enabling natural multi-agent conversations","core",".bmad/core/workflows/party-mode/workflow.yaml","true"
|
||||
"audit-workflow","Comprehensive workflow quality audit - validates structure, config standards, variable usage, bloat detection, and web_bundle completeness. Performs deep analysis of workflow.yaml, instructions.md, template.md, and web_bundle configuration against BMAD v6 standards.","bmb",".bmad/bmb/workflows/audit-workflow/workflow.yaml","true"
|
||||
"convert-legacy","Converts legacy BMAD v4 or similar items (agents, workflows, modules) to BMad Core compliant format with proper structure and conventions","bmb",".bmad/bmb/workflows/convert-legacy/workflow.yaml","true"
|
||||
"create-agent","Interactive workflow to build BMAD Core compliant agents (YAML source compiled to .md during install) with optional brainstorming, persona development, and command structure","bmb",".bmad/bmb/workflows/create-agent/workflow.yaml","true"
|
||||
"create-module","Interactive workflow to build complete BMAD modules with agents, workflows, tasks, and installation infrastructure","bmb",".bmad/bmb/workflows/create-module/workflow.yaml","true"
|
||||
"create-workflow","Interactive workflow builder that guides creation of new BMAD workflows with proper structure and validation for optimal human-AI collaboration. Includes optional brainstorming phase for workflow ideas and design.","bmb",".bmad/bmb/workflows/create-workflow/workflow.yaml","true"
|
||||
"edit-agent","Edit existing BMAD agents while following all best practices and conventions","bmb",".bmad/bmb/workflows/edit-agent/workflow.yaml","true"
|
||||
"edit-module","Edit existing BMAD modules (structure, agents, workflows, documentation) while following all best practices","bmb",".bmad/bmb/workflows/edit-module/workflow.yaml","true"
|
||||
"edit-workflow","Edit existing BMAD workflows while following all best practices and conventions","bmb",".bmad/bmb/workflows/edit-workflow/workflow.yaml","true"
|
||||
"module-brief","Create a comprehensive Module Brief that serves as the blueprint for building new BMAD modules using strategic analysis and creative vision","bmb",".bmad/bmb/workflows/module-brief/workflow.yaml","true"
|
||||
"brainstorm-project","Facilitate project brainstorming sessions by orchestrating the CIS brainstorming workflow with project-specific context and guidance.","bmm",".bmad/bmm/workflows/1-analysis/brainstorm-project/workflow.yaml","true"
|
||||
"domain-research","Collaborative exploration of domain-specific requirements, regulations, and patterns for complex projects","bmm",".bmad/bmm/workflows/1-analysis/domain-research/workflow.yaml","true"
|
||||
"product-brief","Interactive product brief creation workflow that guides users through defining their product vision with multiple input sources and conversational collaboration","bmm",".bmad/bmm/workflows/1-analysis/product-brief/workflow.yaml","true"
|
||||
"research","Adaptive research workflow supporting multiple research types: market research, deep research prompt generation, technical/architecture evaluation, competitive intelligence, user research, and domain analysis","bmm",".bmad/bmm/workflows/1-analysis/research/workflow.yaml","true"
|
||||
"create-ux-design","Collaborative UX design facilitation workflow that creates exceptional user experiences through visual exploration and informed decision-making. Unlike template-driven approaches, this workflow facilitates discovery, generates visual options, and collaboratively designs the UX with the user at every step.","bmm",".bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.yaml","true"
|
||||
"prd","Unified PRD workflow for BMad Method and Enterprise Method tracks. Produces strategic PRD and tactical epic breakdown. Hands off to architecture workflow for technical design. Note: Quick Flow track uses tech-spec workflow.","bmm",".bmad/bmm/workflows/2-plan-workflows/prd/workflow.yaml","true"
|
||||
"tech-spec","Technical specification workflow for quick-flow projects. Creates focused tech spec and generates epic + stories (1 story for simple changes, 2-5 stories for features). Tech-spec only - no PRD needed.","bmm",".bmad/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml","true"
|
||||
"architecture","Collaborative architectural decision facilitation for AI-agent consistency. Replaces template-driven architecture with intelligent, adaptive conversation that produces a decision-focused architecture document optimized for preventing agent conflicts.","bmm",".bmad/bmm/workflows/3-solutioning/architecture/workflow.yaml","true"
|
||||
"create-epics-and-stories","Transform PRD requirements into bite-sized stories organized into deliverable functional epics. This workflow takes a Product Requirements Document (PRD) and breaks it down into epics and user stories that can be easily assigned to development teams. It ensures that all functional requirements are captured in a structured format, making it easier for teams to understand and implement the necessary features.","bmm",".bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.yaml","true"
|
||||
"implementation-readiness","Validate that PRD, UX Design, Architecture, Epics and Stories are complete and aligned before Phase 4 implementation. Ensures all artifacts cover the MVP requirements with no gaps or contradictions.","bmm",".bmad/bmm/workflows/3-solutioning/implementation-readiness/workflow.yaml","true"
|
||||
"code-review","Perform a Senior Developer code review on a completed story flagged Ready for Review, leveraging story-context, epic tech-spec, repo docs, MCP servers for latest best-practices, and web search as fallback. Appends structured review notes to the story.","bmm",".bmad/bmm/workflows/4-implementation/code-review/workflow.yaml","true"
|
||||
"correct-course","Navigate significant changes during sprint execution by analyzing impact, proposing solutions, and routing for implementation","bmm",".bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml","true"
|
||||
"create-story","Create the next user story markdown from epics/PRD and architecture, using a standard template and saving to the stories folder","bmm",".bmad/bmm/workflows/4-implementation/create-story/workflow.yaml","true"
|
||||
"dev-story","Execute a story by implementing tasks/subtasks, writing tests, validating, and updating the story file per acceptance criteria","bmm",".bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml","true"
|
||||
"epic-tech-context","Generate a comprehensive Technical Specification from PRD and Architecture with acceptance criteria and traceability mapping","bmm",".bmad/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml","true"
|
||||
"retrospective","Run after epic completion to review overall success, extract lessons learned, and explore if new information emerged that might impact the next epic","bmm",".bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml","true"
|
||||
"sprint-planning","Generate and manage the sprint status tracking file for Phase 4 implementation, extracting all epics and stories from epic files and tracking their status through the development lifecycle","bmm",".bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml","true"
|
||||
"story-context","Assemble a dynamic Story Context XML by pulling latest documentation and existing code/library artifacts relevant to a drafted story","bmm",".bmad/bmm/workflows/4-implementation/story-context/workflow.yaml","true"
|
||||
"story-done","Marks a story as done (DoD complete) and moves it from its current status → DONE in the status file. Advances the story queue. Simple status-update workflow with no searching required.","bmm",".bmad/bmm/workflows/4-implementation/story-done/workflow.yaml","true"
|
||||
"story-ready","Marks a drafted story as ready for development and moves it from TODO → IN PROGRESS in the status file. Simple status-update workflow with no searching required.","bmm",".bmad/bmm/workflows/4-implementation/story-ready/workflow.yaml","true"
|
||||
"create-excalidraw-dataflow","Create data flow diagrams (DFD) in Excalidraw format","bmm",".bmad/bmm/workflows/diagrams/create-dataflow/workflow.yaml","true"
|
||||
"create-excalidraw-diagram","Create system architecture diagrams, ERDs, UML diagrams, or general technical diagrams in Excalidraw format","bmm",".bmad/bmm/workflows/diagrams/create-diagram/workflow.yaml","true"
|
||||
"create-excalidraw-flowchart","Create a flowchart visualization in Excalidraw format for processes, pipelines, or logic flows","bmm",".bmad/bmm/workflows/diagrams/create-flowchart/workflow.yaml","true"
|
||||
"create-excalidraw-wireframe","Create website or app wireframes in Excalidraw format","bmm",".bmad/bmm/workflows/diagrams/create-wireframe/workflow.yaml","true"
|
||||
"document-project","Analyzes and documents brownfield projects by scanning codebase, architecture, and patterns to create comprehensive reference documentation for AI-assisted development","bmm",".bmad/bmm/workflows/document-project/workflow.yaml","true"
|
||||
"testarch-atdd","Generate failing acceptance tests before implementation using TDD red-green-refactor cycle","bmm",".bmad/bmm/workflows/testarch/atdd/workflow.yaml","false"
|
||||
"testarch-automate","Expand test automation coverage after implementation or analyze existing codebase to generate comprehensive test suite","bmm",".bmad/bmm/workflows/testarch/automate/workflow.yaml","false"
|
||||
"testarch-ci","Scaffold CI/CD quality pipeline with test execution, burn-in loops, and artifact collection","bmm",".bmad/bmm/workflows/testarch/ci/workflow.yaml","false"
|
||||
"testarch-framework","Initialize production-ready test framework architecture (Playwright or Cypress) with fixtures, helpers, and configuration","bmm",".bmad/bmm/workflows/testarch/framework/workflow.yaml","false"
|
||||
"testarch-nfr","Assess non-functional requirements (performance, security, reliability, maintainability) before release with evidence-based validation","bmm",".bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml","false"
|
||||
"testarch-test-design","Dual-mode workflow: (1) System-level testability review in Solutioning phase, or (2) Epic-level test planning in Implementation phase. Auto-detects mode based on project phase.","bmm",".bmad/bmm/workflows/testarch/test-design/workflow.yaml","false"
|
||||
"testarch-test-review","Review test quality using comprehensive knowledge base and best practices validation","bmm",".bmad/bmm/workflows/testarch/test-review/workflow.yaml","false"
|
||||
"testarch-trace","Generate requirements-to-tests traceability matrix, analyze coverage, and make quality gate decision (PASS/CONCERNS/FAIL/WAIVED)","bmm",".bmad/bmm/workflows/testarch/trace/workflow.yaml","false"
|
||||
"workflow-init","Initialize a new BMM project by determining level, type, and creating workflow path","bmm",".bmad/bmm/workflows/workflow-status/init/workflow.yaml","true"
|
||||
"workflow-status","Lightweight status checker - answers ""what should I do now?"" for any agent. Reads YAML status file for workflow tracking. Use workflow-init for new projects.","bmm",".bmad/bmm/workflows/workflow-status/workflow.yaml","true"
|
||||
"design-thinking","Guide human-centered design processes using empathy-driven methodologies. This workflow walks through the design thinking phases - Empathize, Define, Ideate, Prototype, and Test - to create solutions deeply rooted in user needs.","cis",".bmad/cis/workflows/design-thinking/workflow.yaml","true"
|
||||
"innovation-strategy","Identify disruption opportunities and architect business model innovation. This workflow guides strategic analysis of markets, competitive dynamics, and business model innovation to uncover sustainable competitive advantages and breakthrough opportunities.","cis",".bmad/cis/workflows/innovation-strategy/workflow.yaml","true"
|
||||
"problem-solving","Apply systematic problem-solving methodologies to crack complex challenges. This workflow guides through problem diagnosis, root cause analysis, creative solution generation, evaluation, and implementation planning using proven frameworks.","cis",".bmad/cis/workflows/problem-solving/workflow.yaml","true"
|
||||
"storytelling","Craft compelling narratives using proven story frameworks and techniques. This workflow guides users through structured narrative development, applying appropriate story frameworks to create emotionally resonant and engaging stories for any purpose.","cis",".bmad/cis/workflows/storytelling/workflow.yaml","true"
|
||||
|
@ -1,194 +0,0 @@
|
||||
# BMB - BMad Builder Module
|
||||
|
||||
Specialized tools and workflows for creating, customizing, and extending BMad components including agents, workflows, and complete modules.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Module Structure](#module-structure)
|
||||
- [Core Workflows](#core-workflows)
|
||||
- [Agent Types](#agent-types)
|
||||
- [Quick Start](#quick-start)
|
||||
- [Best Practices](#best-practices)
|
||||
|
||||
## Module Structure
|
||||
|
||||
### 🤖 Agents
|
||||
|
||||
**BMad Builder** - Master builder agent orchestrating all creation workflows with deep knowledge of BMad architecture and conventions.
|
||||
|
||||
### 📋 Workflows
|
||||
|
||||
Comprehensive suite for building and maintaining BMad components.
|
||||
|
||||
## Core Workflows
|
||||
|
||||
### Creation Workflows
|
||||
|
||||
**[create-agent](./workflows/create-agent/README.md)** - Build BMad agents
|
||||
|
||||
- Interactive persona development
|
||||
- Command structure design
|
||||
- YAML source compilation to .md
|
||||
|
||||
**[create-workflow](./workflows/create-workflow/README.md)** - Design workflows
|
||||
|
||||
- Structured multi-step processes
|
||||
- Configuration validation
|
||||
- Web bundle support
|
||||
|
||||
**[create-module](./workflows/create-module/README.md)** - Build complete modules
|
||||
|
||||
- Full module infrastructure
|
||||
- Agent and workflow integration
|
||||
- Installation automation
|
||||
|
||||
**[module-brief](./workflows/module-brief/README.md)** - Strategic planning
|
||||
|
||||
- Module blueprint creation
|
||||
- Vision and architecture
|
||||
- Comprehensive analysis
|
||||
|
||||
### Editing Workflows
|
||||
|
||||
**[edit-agent](./workflows/edit-agent/README.md)** - Modify existing agents
|
||||
|
||||
- Persona refinement
|
||||
- Command updates
|
||||
- Best practice compliance
|
||||
|
||||
**[edit-workflow](./workflows/edit-workflow/README.md)** - Update workflows
|
||||
|
||||
- Structure maintenance
|
||||
- Configuration updates
|
||||
- Documentation sync
|
||||
|
||||
**[edit-module](./workflows/edit-module/README.md)** - Module enhancement
|
||||
|
||||
- Component modifications
|
||||
- Dependency management
|
||||
- Version control
|
||||
|
||||
### Maintenance Workflows
|
||||
|
||||
**[convert-legacy](./workflows/convert-legacy/README.md)** - Migration tool
|
||||
|
||||
- v4 to v6 conversion
|
||||
- Structure compliance
|
||||
- Convention updates
|
||||
|
||||
**[audit-workflow](./workflows/audit-workflow/README.md)** - Quality validation
|
||||
|
||||
- Structure verification
|
||||
- Config standards check
|
||||
- Bloat detection
|
||||
- Web bundle completeness
|
||||
|
||||
**[redoc](./workflows/redoc/README.md)** - Auto-documentation
|
||||
|
||||
- Reverse-tree approach
|
||||
- Technical writer quality
|
||||
- Convention compliance
|
||||
|
||||
## Agent Types
|
||||
|
||||
BMB creates three agent architectures:
|
||||
|
||||
### Full Module Agent
|
||||
|
||||
- Complete persona and role definition
|
||||
- Command structure with fuzzy matching
|
||||
- Workflow integration
|
||||
- Module-specific capabilities
|
||||
|
||||
### Hybrid Agent
|
||||
|
||||
- Shared core capabilities
|
||||
- Module-specific extensions
|
||||
- Cross-module compatibility
|
||||
|
||||
### Standalone Agent
|
||||
|
||||
- Independent operation
|
||||
- Minimal dependencies
|
||||
- Specialized single purpose
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. **Load BMad Builder agent** in your IDE
|
||||
2. **Choose creation type:**
|
||||
```
|
||||
*create-agent # New agent
|
||||
*create-workflow # New workflow
|
||||
*create-module # Complete module
|
||||
```
|
||||
3. **Follow interactive prompts**
|
||||
|
||||
### Example: Creating an Agent
|
||||
|
||||
```
|
||||
User: I need a code review agent
|
||||
Builder: *create-agent
|
||||
|
||||
[Interactive session begins]
|
||||
- Brainstorming phase (optional)
|
||||
- Persona development
|
||||
- Command structure
|
||||
- Integration points
|
||||
```
|
||||
|
||||
## Use Cases
|
||||
|
||||
### Custom Development Teams
|
||||
|
||||
Build specialized agents for:
|
||||
|
||||
- Domain expertise (legal, medical, finance)
|
||||
- Company processes
|
||||
- Tool integrations
|
||||
- Automation tasks
|
||||
|
||||
### Workflow Extensions
|
||||
|
||||
Create workflows for:
|
||||
|
||||
- Compliance requirements
|
||||
- Quality gates
|
||||
- Deployment pipelines
|
||||
- Custom methodologies
|
||||
|
||||
### Complete Solutions
|
||||
|
||||
Package modules for:
|
||||
|
||||
- Industry verticals
|
||||
- Technology stacks
|
||||
- Business processes
|
||||
- Educational frameworks
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Study existing patterns** - Review BMM/CIS implementations
|
||||
2. **Follow conventions** - Use established structures
|
||||
3. **Document thoroughly** - Clear instructions essential
|
||||
4. **Test iteratively** - Validate during creation
|
||||
5. **Consider reusability** - Build modular components
|
||||
|
||||
## Integration
|
||||
|
||||
BMB components integrate with:
|
||||
|
||||
- **BMad Core** - Framework foundation
|
||||
- **BMM** - Extend development capabilities
|
||||
- **CIS** - Leverage creative workflows
|
||||
- **Custom Modules** - Your domain solutions
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- **[Agent Creation Guide](./workflows/create-agent/README.md)** - Detailed instructions
|
||||
- **[Module Structure](./workflows/create-module/module-structure.md)** - Architecture patterns
|
||||
- **[BMM Module](../bmm/README.md)** - Reference implementation
|
||||
- **[Core Framework](../../core/README.md)** - Foundation concepts
|
||||
|
||||
---
|
||||
|
||||
BMB empowers you to extend BMad Method for your specific needs while maintaining framework consistency and power.
|
||||
@ -1,16 +0,0 @@
|
||||
# BMB Module Configuration
|
||||
# Generated by BMAD installer
|
||||
# Version: 6.0.0-alpha.12
|
||||
# Date: 2025-11-25T04:20:40.579Z
|
||||
|
||||
custom_agent_location: '{project-root}/.bmad/agents'
|
||||
custom_workflow_location: '{project-root}/.bmad/workflows'
|
||||
custom_module_location: '{project-root}/.bmad'
|
||||
|
||||
# Core Configuration Values
|
||||
bmad_folder: .bmad
|
||||
user_name: Nicholai
|
||||
communication_language: English
|
||||
document_output_language: English
|
||||
output_folder: '{project-root}/docs/artifacts'
|
||||
install_user_docs: true
|
||||
@ -1,340 +0,0 @@
|
||||
# Agent Compilation: YAML to XML
|
||||
|
||||
What the compiler auto-injects. **DO NOT duplicate these in your YAML.**
|
||||
|
||||
## Compilation Pipeline
|
||||
|
||||
```
|
||||
agent.yaml → Handlebars processing → XML generation → frontmatter.md
|
||||
```
|
||||
|
||||
Source: `tools/cli/lib/agent/compiler.js`
|
||||
|
||||
## File Naming Convention
|
||||
|
||||
**CRITICAL:** Agent filenames must be ROLE-BASED, not persona-based.
|
||||
|
||||
**Why:** Users can customize the agent's persona name via `customize.yaml` config. The filename provides stable identity.
|
||||
|
||||
**Correct:**
|
||||
|
||||
```
|
||||
presentation-master.agent.yaml ← Role/function
|
||||
tech-writer.agent.yaml ← Role/function
|
||||
code-reviewer.agent.yaml ← Role/function
|
||||
```
|
||||
|
||||
**Incorrect:**
|
||||
|
||||
```
|
||||
caravaggio.agent.yaml ← Persona name (users might rename to "Pablo")
|
||||
paige.agent.yaml ← Persona name (users might rename to "Sarah")
|
||||
rex.agent.yaml ← Persona name (users might rename to "Max")
|
||||
```
|
||||
|
||||
**Pattern:**
|
||||
|
||||
- Filename: `{role-or-function}.agent.yaml` (kebab-case)
|
||||
- Metadata ID: `.bmad/{module}/agents/{role-or-function}.md`
|
||||
- Persona Name: User-customizable in metadata or customize.yaml
|
||||
|
||||
**Example:**
|
||||
|
||||
```yaml
|
||||
# File: presentation-master.agent.yaml
|
||||
agent:
|
||||
metadata:
|
||||
id: '.bmad/cis/agents/presentation-master.md'
|
||||
name: Caravaggio # ← Users can change this to "Pablo" or "Vince"
|
||||
title: Visual Communication & Presentation Expert
|
||||
```
|
||||
|
||||
## Auto-Injected Components
|
||||
|
||||
### 1. Frontmatter
|
||||
|
||||
**Injected automatically:**
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: '{agent name from filename}'
|
||||
description: '{title from metadata}'
|
||||
---
|
||||
You must fully embody this agent's persona...
|
||||
```
|
||||
|
||||
**DO NOT add** frontmatter to your YAML source.
|
||||
|
||||
### 2. Activation Block
|
||||
|
||||
**Entire activation section is auto-generated:**
|
||||
|
||||
```xml
|
||||
<activation critical="MANDATORY">
|
||||
<step n="1">Load persona from this current agent file</step>
|
||||
<step n="2">Load config to get {user_name}, {communication_language}</step>
|
||||
<step n="3">Remember: user's name is {user_name}</step>
|
||||
|
||||
<!-- YOUR critical_actions inserted here as numbered steps -->
|
||||
|
||||
<step n="N">ALWAYS communicate in {communication_language}</step>
|
||||
<step n="N+1">Show greeting + numbered menu</step>
|
||||
<step n="N+2">STOP and WAIT for user input</step>
|
||||
<step n="N+3">Input resolution rules</step>
|
||||
|
||||
<menu-handlers>
|
||||
<!-- Only handlers used in YOUR menu are included -->
|
||||
</menu-handlers>
|
||||
|
||||
<rules>
|
||||
<!-- Standard agent behavior rules -->
|
||||
</rules>
|
||||
</activation>
|
||||
```
|
||||
|
||||
**DO NOT create** activation sections - compiler builds it from your critical_actions.
|
||||
|
||||
### 3. Menu Enhancements
|
||||
|
||||
**Auto-injected menu items:**
|
||||
|
||||
- `*help` - Always FIRST in compiled menu
|
||||
- `*exit` - Always LAST in compiled menu
|
||||
|
||||
**Trigger prefixing:**
|
||||
|
||||
- Your trigger `analyze` becomes `*analyze`
|
||||
- Don't add `*` prefix - compiler does it
|
||||
|
||||
**DO NOT include:**
|
||||
|
||||
```yaml
|
||||
# BAD - these are auto-injected
|
||||
menu:
|
||||
- trigger: help
|
||||
description: 'Show help'
|
||||
- trigger: exit
|
||||
description: 'Exit'
|
||||
```
|
||||
|
||||
### 4. Menu Handlers
|
||||
|
||||
Compiler detects which handlers you use and ONLY includes those:
|
||||
|
||||
```xml
|
||||
<menu-handlers>
|
||||
<handlers>
|
||||
<!-- Only if you use action="#id" or action="text" -->
|
||||
<handler type="action">...</handler>
|
||||
|
||||
<!-- Only if you use workflow="path" -->
|
||||
<handler type="workflow">...</handler>
|
||||
|
||||
<!-- Only if you use exec="path" -->
|
||||
<handler type="exec">...</handler>
|
||||
|
||||
<!-- Only if you use tmpl="path" -->
|
||||
<handler type="tmpl">...</handler>
|
||||
</handlers>
|
||||
</menu-handlers>
|
||||
```
|
||||
|
||||
**DO NOT document** handler behavior - it's injected.
|
||||
|
||||
### 5. Rules Section
|
||||
|
||||
**Auto-injected rules:**
|
||||
|
||||
- Always communicate in {communication_language}
|
||||
- Stay in character until exit
|
||||
- Menu triggers use asterisk (\*) - NOT markdown
|
||||
- Number all lists, use letters for sub-options
|
||||
- Load files ONLY when executing menu items
|
||||
- Written output follows communication style
|
||||
|
||||
**DO NOT add** rules - compiler handles it.
|
||||
|
||||
## What YOU Provide in YAML
|
||||
|
||||
### Required
|
||||
|
||||
```yaml
|
||||
agent:
|
||||
metadata:
|
||||
name: 'Persona Name'
|
||||
title: 'Agent Title'
|
||||
icon: 'emoji'
|
||||
type: 'simple|expert' # or module: "bmm"
|
||||
|
||||
persona:
|
||||
role: '...'
|
||||
identity: '...'
|
||||
communication_style: '...'
|
||||
principles: [...]
|
||||
|
||||
menu:
|
||||
- trigger: your-action
|
||||
action: '#prompt-id'
|
||||
description: 'What it does'
|
||||
```
|
||||
|
||||
### Optional (based on type)
|
||||
|
||||
```yaml
|
||||
# Expert agents only
|
||||
critical_actions:
|
||||
- 'Load sidecar files...'
|
||||
- 'Restrict access...'
|
||||
|
||||
# Simple/Expert with embedded logic
|
||||
prompts:
|
||||
- id: prompt-id
|
||||
content: '...'
|
||||
|
||||
# Simple/Expert with customization
|
||||
install_config:
|
||||
questions: [...]
|
||||
```
|
||||
|
||||
## Common Duplication Mistakes
|
||||
|
||||
### Adding Activation Logic
|
||||
|
||||
```yaml
|
||||
# BAD - compiler builds activation
|
||||
agent:
|
||||
activation:
|
||||
steps: [...]
|
||||
```
|
||||
|
||||
### Including Help/Exit
|
||||
|
||||
```yaml
|
||||
# BAD - auto-injected
|
||||
menu:
|
||||
- trigger: help
|
||||
- trigger: exit
|
||||
```
|
||||
|
||||
### Prefixing Triggers
|
||||
|
||||
```yaml
|
||||
# BAD - compiler adds *
|
||||
menu:
|
||||
- trigger: '*analyze' # Should be: analyze
|
||||
```
|
||||
|
||||
### Documenting Handlers
|
||||
|
||||
```yaml
|
||||
# BAD - don't explain handlers, compiler injects them
|
||||
# When using workflow, load workflow.xml...
|
||||
```
|
||||
|
||||
### Adding Rules in YAML
|
||||
|
||||
```yaml
|
||||
# BAD - rules are auto-injected
|
||||
agent:
|
||||
rules:
|
||||
- Stay in character...
|
||||
```
|
||||
|
||||
## Compilation Example
|
||||
|
||||
**Your YAML:**
|
||||
|
||||
```yaml
|
||||
agent:
|
||||
metadata:
|
||||
name: 'Rex'
|
||||
title: 'Code Reviewer'
|
||||
icon: '🔍'
|
||||
type: simple
|
||||
|
||||
persona:
|
||||
role: Code Review Expert
|
||||
identity: Systematic reviewer...
|
||||
communication_style: Direct and constructive
|
||||
principles:
|
||||
- Code should be readable
|
||||
|
||||
prompts:
|
||||
- id: review
|
||||
content: |
|
||||
Analyze code for issues...
|
||||
|
||||
menu:
|
||||
- trigger: review
|
||||
action: '#review'
|
||||
description: 'Review code'
|
||||
```
|
||||
|
||||
**Compiled Output (.md):**
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: 'rex'
|
||||
description: 'Code Reviewer'
|
||||
---
|
||||
|
||||
You must fully embody...
|
||||
|
||||
\`\`\`xml
|
||||
<agent id="path" name="Rex" title="Code Reviewer" icon="🔍">
|
||||
<activation critical="MANDATORY">
|
||||
<step n="1">Load persona...</step>
|
||||
<step n="2">Load config...</step>
|
||||
<step n="3">Remember user...</step>
|
||||
<step n="4">Communicate in language...</step>
|
||||
<step n="5">Show greeting + menu...</step>
|
||||
<step n="6">STOP and WAIT...</step>
|
||||
<step n="7">Input resolution...</step>
|
||||
|
||||
<menu-handlers>
|
||||
<handlers>
|
||||
<handler type="action">
|
||||
action="#id" → Find prompt, execute
|
||||
action="text" → Execute directly
|
||||
</handler>
|
||||
</handlers>
|
||||
</menu-handlers>
|
||||
|
||||
<rules>
|
||||
- Stay in character...
|
||||
- Number lists...
|
||||
- Load files when executing...
|
||||
</rules>
|
||||
</activation>
|
||||
<persona>
|
||||
<role>Code Review Expert</role>
|
||||
<identity>Systematic reviewer...</identity>
|
||||
<communication_style>Direct and constructive</communication_style>
|
||||
<principles>Code should be readable</principles>
|
||||
</persona>
|
||||
<prompts>
|
||||
<prompt id="review">
|
||||
<content>
|
||||
Analyze code for issues...
|
||||
</content>
|
||||
</prompt>
|
||||
</prompts>
|
||||
<menu>
|
||||
<item cmd="*help">Show numbered menu</item>
|
||||
<item cmd="*review" action="#review">Review code</item>
|
||||
<item cmd="*exit">Exit with confirmation</item>
|
||||
</menu>
|
||||
</agent>
|
||||
\`\`\`
|
||||
```
|
||||
|
||||
## Key Takeaways
|
||||
|
||||
1. **Compiler handles boilerplate** - Focus on persona and logic
|
||||
2. **Critical_actions become activation steps** - Just list your agent-specific needs
|
||||
3. **Menu items are enhanced** - Help/exit added, triggers prefixed
|
||||
4. **Handlers auto-detected** - Only what you use is included
|
||||
5. **Rules standardized** - Consistent behavior across agents
|
||||
|
||||
**Your job:** Define persona, prompts, menu actions
|
||||
**Compiler's job:** Activation, handlers, rules, help/exit, prefixes
|
||||
@ -1,524 +0,0 @@
|
||||
# BMAD Agent Menu Patterns
|
||||
|
||||
Design patterns for agent menus in YAML source files.
|
||||
|
||||
## Menu Structure
|
||||
|
||||
Agents define menus in YAML, with triggers auto-prefixed with `*` during compilation:
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: action-name
|
||||
[handler]: [value]
|
||||
description: 'What this command does'
|
||||
```
|
||||
|
||||
**Note:** `*help` and `*exit` are auto-injected by the compiler - DO NOT include them.
|
||||
|
||||
## Handler Types
|
||||
|
||||
### 1. Action Handler (Prompts & Inline)
|
||||
|
||||
For simple and expert agents with self-contained logic.
|
||||
|
||||
**Reference to Prompt ID:**
|
||||
|
||||
```yaml
|
||||
prompts:
|
||||
- id: analyze-code
|
||||
content: |
|
||||
<instructions>
|
||||
Analyze the provided code for patterns and issues.
|
||||
</instructions>
|
||||
|
||||
<process>
|
||||
1. Identify code structure
|
||||
2. Check for anti-patterns
|
||||
3. Suggest improvements
|
||||
</process>
|
||||
|
||||
menu:
|
||||
- trigger: analyze
|
||||
action: '#analyze-code'
|
||||
description: 'Analyze code patterns'
|
||||
```
|
||||
|
||||
**Inline Instruction:**
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: quick-check
|
||||
action: 'Perform a quick syntax validation on the current file'
|
||||
description: 'Quick syntax check'
|
||||
```
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- Simple/Expert agents with self-contained operations
|
||||
- `#id` for complex, multi-step prompts
|
||||
- Inline text for simple, one-line instructions
|
||||
|
||||
### 2. Workflow Handler
|
||||
|
||||
For module agents orchestrating multi-step processes.
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: create-prd
|
||||
workflow: '{project-root}/.bmad/bmm/workflows/prd/workflow.yaml'
|
||||
description: 'Create Product Requirements Document'
|
||||
|
||||
- trigger: brainstorm
|
||||
workflow: '{project-root}/.bmad/core/workflows/brainstorming/workflow.yaml'
|
||||
description: 'Guided brainstorming session'
|
||||
|
||||
# Placeholder for unimplemented workflows
|
||||
- trigger: future-feature
|
||||
workflow: 'todo'
|
||||
description: 'Coming soon'
|
||||
```
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- Module agents with workflow integration
|
||||
- Multi-step document generation
|
||||
- Complex interactive processes
|
||||
- Use "todo" for planned but unimplemented features
|
||||
|
||||
### 3. Exec Handler
|
||||
|
||||
For executing tasks directly.
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: validate
|
||||
exec: '{project-root}/.bmad/core/tasks/validate-workflow.xml'
|
||||
description: 'Validate document structure'
|
||||
|
||||
- trigger: advanced-elicitation
|
||||
exec: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
|
||||
description: 'Advanced elicitation techniques'
|
||||
```
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- Single-operation tasks
|
||||
- Core system operations
|
||||
- Utility functions
|
||||
|
||||
### 4. Template Handler
|
||||
|
||||
For document generation with templates.
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: create-brief
|
||||
exec: '{project-root}/.bmad/core/tasks/create-doc.xml'
|
||||
tmpl: '{project-root}/.bmad/bmm/templates/brief.md'
|
||||
description: 'Create project brief'
|
||||
```
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- Template-based document creation
|
||||
- Combine `exec` with `tmpl` path
|
||||
- Structured output generation
|
||||
|
||||
### 5. Data Handler
|
||||
|
||||
Universal attribute for supplementary information.
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: team-standup
|
||||
exec: '{project-root}/.bmad/bmm/tasks/standup.xml'
|
||||
data: '{project-root}/.bmad/_cfg/agent-manifest.csv'
|
||||
description: 'Run team standup'
|
||||
|
||||
- trigger: analyze-metrics
|
||||
action: 'Analyze these metrics and identify trends'
|
||||
data: '{project-root}/_data/metrics.json'
|
||||
description: 'Analyze performance metrics'
|
||||
```
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- Add to ANY handler type
|
||||
- Reference data files (CSV, JSON, YAML)
|
||||
- Provide context for operations
|
||||
|
||||
## Platform-Specific Menus
|
||||
|
||||
Control visibility based on deployment target:
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: git-flow
|
||||
exec: '{project-root}/.bmad/bmm/tasks/git-flow.xml'
|
||||
description: 'Git workflow operations'
|
||||
ide-only: true # Only in IDE environments
|
||||
|
||||
- trigger: advanced-elicitation
|
||||
exec: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
|
||||
description: 'Advanced elicitation'
|
||||
web-only: true # Only in web bundles
|
||||
```
|
||||
|
||||
## Trigger Naming Conventions
|
||||
|
||||
### Action-Based (Recommended)
|
||||
|
||||
```yaml
|
||||
# Creation
|
||||
- trigger: create-prd
|
||||
- trigger: build-module
|
||||
- trigger: generate-report
|
||||
|
||||
# Analysis
|
||||
- trigger: analyze-requirements
|
||||
- trigger: review-code
|
||||
- trigger: validate-architecture
|
||||
|
||||
# Operations
|
||||
- trigger: update-status
|
||||
- trigger: sync-data
|
||||
- trigger: deploy-changes
|
||||
```
|
||||
|
||||
### Domain-Based
|
||||
|
||||
```yaml
|
||||
# Development
|
||||
- trigger: brainstorm
|
||||
- trigger: architect
|
||||
- trigger: refactor
|
||||
|
||||
# Project Management
|
||||
- trigger: sprint-plan
|
||||
- trigger: retrospective
|
||||
- trigger: standup
|
||||
```
|
||||
|
||||
### Bad Patterns
|
||||
|
||||
```yaml
|
||||
# TOO VAGUE
|
||||
- trigger: do
|
||||
- trigger: run
|
||||
- trigger: process
|
||||
|
||||
# TOO LONG
|
||||
- trigger: create-comprehensive-product-requirements-document
|
||||
|
||||
# NO VERB
|
||||
- trigger: prd
|
||||
- trigger: config
|
||||
```
|
||||
|
||||
## Menu Organization
|
||||
|
||||
### Recommended Order
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
# Note: *help auto-injected first by compiler
|
||||
|
||||
# 1. Primary workflows (main value)
|
||||
- trigger: workflow-init
|
||||
workflow: '...'
|
||||
description: 'Start here - initialize workflow'
|
||||
|
||||
- trigger: create-prd
|
||||
workflow: '...'
|
||||
description: 'Create PRD'
|
||||
|
||||
# 2. Secondary operations
|
||||
- trigger: validate
|
||||
exec: '...'
|
||||
description: 'Validate document'
|
||||
|
||||
# 3. Utilities
|
||||
- trigger: party-mode
|
||||
workflow: '...'
|
||||
description: 'Multi-agent discussion'
|
||||
|
||||
# Note: *exit auto-injected last by compiler
|
||||
```
|
||||
|
||||
### Grouping by Phase
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
# Analysis Phase
|
||||
- trigger: brainstorm
|
||||
workflow: '{project-root}/.bmad/bmm/workflows/1-analysis/brainstorm/workflow.yaml'
|
||||
description: 'Brainstorm ideas'
|
||||
|
||||
- trigger: research
|
||||
workflow: '{project-root}/.bmad/bmm/workflows/1-analysis/research/workflow.yaml'
|
||||
description: 'Conduct research'
|
||||
|
||||
# Planning Phase
|
||||
- trigger: prd
|
||||
workflow: '{project-root}/.bmad/bmm/workflows/2-planning/prd/workflow.yaml'
|
||||
description: 'Create PRD'
|
||||
|
||||
- trigger: architecture
|
||||
workflow: '{project-root}/.bmad/bmm/workflows/2-planning/architecture/workflow.yaml'
|
||||
description: 'Design architecture'
|
||||
```
|
||||
|
||||
## Description Best Practices
|
||||
|
||||
### Good Descriptions
|
||||
|
||||
```yaml
|
||||
# Clear action + object
|
||||
- description: 'Create Product Requirements Document'
|
||||
|
||||
# Specific outcome
|
||||
- description: 'Analyze security vulnerabilities'
|
||||
|
||||
# User benefit
|
||||
- description: 'Optimize code for performance'
|
||||
|
||||
# Context when needed
|
||||
- description: 'Start here - initialize workflow path'
|
||||
```
|
||||
|
||||
### Poor Descriptions
|
||||
|
||||
```yaml
|
||||
# Too vague
|
||||
- description: 'Process'
|
||||
|
||||
# Technical jargon
|
||||
- description: 'Execute WF123'
|
||||
|
||||
# Missing context
|
||||
- description: 'Run'
|
||||
|
||||
# Redundant with trigger
|
||||
- description: 'Create PRD' # trigger: create-prd (too similar)
|
||||
```
|
||||
|
||||
## Prompts Section (Simple/Expert Agents)
|
||||
|
||||
### Prompt Structure
|
||||
|
||||
```yaml
|
||||
prompts:
|
||||
- id: unique-identifier
|
||||
content: |
|
||||
<instructions>
|
||||
What this prompt accomplishes
|
||||
</instructions>
|
||||
|
||||
<process>
|
||||
1. First step
|
||||
{{#if custom_option}}
|
||||
2. Conditional step
|
||||
{{/if}}
|
||||
3. Final step
|
||||
</process>
|
||||
|
||||
<output_format>
|
||||
Expected structure of results
|
||||
</output_format>
|
||||
```
|
||||
|
||||
### Semantic XML Tags in Prompts
|
||||
|
||||
Use XML tags to structure prompt content:
|
||||
|
||||
- `<instructions>` - What to do
|
||||
- `<process>` - Step-by-step approach
|
||||
- `<output_format>` - Expected results
|
||||
- `<examples>` - Sample outputs
|
||||
- `<constraints>` - Limitations
|
||||
- `<context>` - Background information
|
||||
|
||||
### Handlebars in Prompts
|
||||
|
||||
Customize based on install_config:
|
||||
|
||||
```yaml
|
||||
prompts:
|
||||
- id: analyze
|
||||
content: |
|
||||
{{#if detailed_mode}}
|
||||
Perform comprehensive analysis with full explanations.
|
||||
{{/if}}
|
||||
{{#unless detailed_mode}}
|
||||
Quick analysis focusing on key points.
|
||||
{{/unless}}
|
||||
|
||||
Address {{user_name}} in {{communication_style}} tone.
|
||||
```
|
||||
|
||||
## Path Variables
|
||||
|
||||
### Always Use Variables
|
||||
|
||||
```yaml
|
||||
# GOOD - Portable paths
|
||||
workflow: "{project-root}/.bmad/bmm/workflows/prd/workflow.yaml"
|
||||
exec: "{project-root}/.bmad/core/tasks/validate.xml"
|
||||
data: "{project-root}/_data/metrics.csv"
|
||||
|
||||
# BAD - Hardcoded paths
|
||||
workflow: "/Users/john/project/.bmad/bmm/workflows/prd/workflow.yaml"
|
||||
exec: "../../../core/tasks/validate.xml"
|
||||
```
|
||||
|
||||
### Available Variables
|
||||
|
||||
- `{project-root}` - Project root directory
|
||||
- `.bmad` - BMAD installation folder
|
||||
- `{agent-folder}` - Agent installation directory (Expert agents)
|
||||
- `{output_folder}` - Document output location
|
||||
- `{user_name}` - User's name from config
|
||||
- `{communication_language}` - Language preference
|
||||
|
||||
## Complete Examples
|
||||
|
||||
### Simple Agent Menu
|
||||
|
||||
```yaml
|
||||
prompts:
|
||||
- id: format-code
|
||||
content: |
|
||||
<instructions>
|
||||
Format the provided code according to style guidelines.
|
||||
</instructions>
|
||||
|
||||
Apply:
|
||||
- Consistent indentation
|
||||
- Proper spacing
|
||||
- Clear naming conventions
|
||||
|
||||
menu:
|
||||
- trigger: format
|
||||
action: '#format-code'
|
||||
description: 'Format code to style guidelines'
|
||||
|
||||
- trigger: lint
|
||||
action: 'Check code for common issues and anti-patterns'
|
||||
description: 'Lint code for issues'
|
||||
|
||||
- trigger: suggest
|
||||
action: 'Suggest improvements for code readability'
|
||||
description: 'Suggest improvements'
|
||||
```
|
||||
|
||||
### Expert Agent Menu
|
||||
|
||||
```yaml
|
||||
critical_actions:
|
||||
- 'Load {agent-folder}/memories.md'
|
||||
- 'Follow {agent-folder}/instructions.md'
|
||||
- 'ONLY access {agent-folder}/'
|
||||
|
||||
prompts:
|
||||
- id: reflect
|
||||
content: |
|
||||
Guide {{user_name}} through reflection on recent entries.
|
||||
Reference patterns from memories.md naturally.
|
||||
|
||||
menu:
|
||||
- trigger: write
|
||||
action: '#reflect'
|
||||
description: 'Write journal entry'
|
||||
|
||||
- trigger: save
|
||||
action: 'Update {agent-folder}/memories.md with session insights'
|
||||
description: "Save today's session"
|
||||
|
||||
- trigger: patterns
|
||||
action: 'Analyze recent entries for recurring themes'
|
||||
description: 'View patterns'
|
||||
```
|
||||
|
||||
### Module Agent Menu
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: workflow-init
|
||||
workflow: '{project-root}/.bmad/bmm/workflows/workflow-status/init/workflow.yaml'
|
||||
description: 'Initialize workflow path (START HERE)'
|
||||
|
||||
- trigger: brainstorm
|
||||
workflow: '{project-root}/.bmad/bmm/workflows/1-analysis/brainstorm/workflow.yaml'
|
||||
description: 'Guided brainstorming'
|
||||
|
||||
- trigger: prd
|
||||
workflow: '{project-root}/.bmad/bmm/workflows/2-planning/prd/workflow.yaml'
|
||||
description: 'Create PRD'
|
||||
|
||||
- trigger: architecture
|
||||
workflow: '{project-root}/.bmad/bmm/workflows/2-planning/architecture/workflow.yaml'
|
||||
description: 'Design architecture'
|
||||
|
||||
- trigger: party-mode
|
||||
workflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.yaml'
|
||||
description: 'Multi-agent discussion'
|
||||
```
|
||||
|
||||
## Validation Checklist
|
||||
|
||||
- [ ] No duplicate triggers
|
||||
- [ ] Triggers don't start with `*` (auto-added)
|
||||
- [ ] Every item has a description
|
||||
- [ ] Paths use variables, not hardcoded
|
||||
- [ ] `#id` references exist in prompts section
|
||||
- [ ] Workflow paths resolve or are "todo"
|
||||
- [ ] No `*help` or `*exit` (auto-injected)
|
||||
- [ ] Descriptions are clear and action-oriented
|
||||
- [ ] Platform-specific flags used correctly (ide-only, web-only)
|
||||
|
||||
## Common Mistakes
|
||||
|
||||
### Duplicate Triggers
|
||||
|
||||
```yaml
|
||||
# BAD - compiler will fail
|
||||
- trigger: analyze
|
||||
action: '#first'
|
||||
description: 'First analysis'
|
||||
|
||||
- trigger: analyze
|
||||
action: '#second'
|
||||
description: 'Second analysis'
|
||||
```
|
||||
|
||||
### Including Auto-Injected Items
|
||||
|
||||
```yaml
|
||||
# BAD - these are auto-injected
|
||||
menu:
|
||||
- trigger: help
|
||||
description: 'Show help'
|
||||
|
||||
- trigger: exit
|
||||
description: 'Exit agent'
|
||||
```
|
||||
|
||||
### Missing Prompt Reference
|
||||
|
||||
```yaml
|
||||
# BAD - prompt id doesn't exist
|
||||
menu:
|
||||
- trigger: analyze
|
||||
action: '#nonexistent-prompt'
|
||||
description: 'Analysis'
|
||||
```
|
||||
|
||||
### Hardcoded Paths
|
||||
|
||||
```yaml
|
||||
# BAD - not portable
|
||||
menu:
|
||||
- trigger: run
|
||||
workflow: '/absolute/path/to/workflow.yaml'
|
||||
description: 'Run workflow'
|
||||
```
|
||||
@ -1,364 +0,0 @@
|
||||
# Expert Agent Architecture
|
||||
|
||||
Domain-specific agents with persistent memory, sidecar files, and restricted access patterns.
|
||||
|
||||
## When to Use
|
||||
|
||||
- Personal assistants (journal keeper, diary companion)
|
||||
- Specialized domain experts (legal advisor, medical reference)
|
||||
- Agents that need to remember past interactions
|
||||
- Agents with restricted file system access (privacy/security)
|
||||
- Long-term relationship agents that learn about users
|
||||
|
||||
## File Structure
|
||||
|
||||
```
|
||||
{agent-name}/
|
||||
├── {agent-name}.agent.yaml # Main agent definition
|
||||
└── {agent-name}-sidecar/ # Supporting files
|
||||
├── instructions.md # Private directives
|
||||
├── memories.md # Persistent memory
|
||||
├── knowledge/ # Domain-specific resources
|
||||
│ └── README.md
|
||||
└── [custom files] # Agent-specific resources
|
||||
```
|
||||
|
||||
## YAML Structure
|
||||
|
||||
```yaml
|
||||
agent:
|
||||
metadata:
|
||||
name: 'Persona Name'
|
||||
title: 'Agent Title'
|
||||
icon: 'emoji'
|
||||
type: 'expert'
|
||||
|
||||
persona:
|
||||
role: 'Domain Expert with specialized capability'
|
||||
|
||||
identity: |
|
||||
Background and expertise in first-person voice.
|
||||
{{#if user_preference}}
|
||||
Customization based on install_config.
|
||||
{{/if}}
|
||||
|
||||
communication_style: |
|
||||
{{#if tone_style == "gentle"}}
|
||||
Gentle and supportive communication...
|
||||
{{/if}}
|
||||
{{#if tone_style == "direct"}}
|
||||
Direct and efficient communication...
|
||||
{{/if}}
|
||||
I reference past conversations naturally.
|
||||
|
||||
principles:
|
||||
- Core belief about the domain
|
||||
- How I handle user information
|
||||
- My approach to memory and learning
|
||||
|
||||
critical_actions:
|
||||
- 'Load COMPLETE file {agent-folder}/{agent-name}-sidecar/memories.md and remember all past insights'
|
||||
- 'Load COMPLETE file {agent-folder}/{agent-name}-sidecar/instructions.md and follow ALL protocols'
|
||||
- 'ONLY read/write files in {agent-folder}/{agent-name}-sidecar/ - this is our private space'
|
||||
- 'Address user as {{greeting_name}}'
|
||||
- 'Track patterns, themes, and important moments'
|
||||
- 'Reference past interactions naturally to show continuity'
|
||||
|
||||
prompts:
|
||||
- id: main-function
|
||||
content: |
|
||||
<instructions>
|
||||
Guide user through the primary function.
|
||||
{{#if tone_style == "gentle"}}
|
||||
Use gentle, supportive approach.
|
||||
{{/if}}
|
||||
</instructions>
|
||||
|
||||
<process>
|
||||
1. Understand context
|
||||
2. Provide guidance
|
||||
3. Record insights
|
||||
</process>
|
||||
|
||||
- id: memory-recall
|
||||
content: |
|
||||
<instructions>
|
||||
Access and share relevant memories.
|
||||
</instructions>
|
||||
|
||||
Reference stored information naturally.
|
||||
|
||||
menu:
|
||||
- trigger: action1
|
||||
action: '#main-function'
|
||||
description: 'Primary agent function'
|
||||
|
||||
- trigger: remember
|
||||
action: 'Update {agent-folder}/{agent-name}-sidecar/memories.md with session insights'
|
||||
description: 'Save what we discussed today'
|
||||
|
||||
- trigger: patterns
|
||||
action: '#memory-recall'
|
||||
description: 'Recall patterns from past interactions'
|
||||
|
||||
- trigger: insight
|
||||
action: 'Document breakthrough in {agent-folder}/{agent-name}-sidecar/breakthroughs.md'
|
||||
description: 'Record a significant insight'
|
||||
|
||||
install_config:
|
||||
compile_time_only: true
|
||||
description: 'Personalize your expert agent'
|
||||
questions:
|
||||
- var: greeting_name
|
||||
prompt: 'What should the agent call you?'
|
||||
type: text
|
||||
default: 'friend'
|
||||
|
||||
- var: tone_style
|
||||
prompt: 'Preferred communication tone?'
|
||||
type: choice
|
||||
options:
|
||||
- label: 'Gentle - Supportive and nurturing'
|
||||
value: 'gentle'
|
||||
- label: 'Direct - Clear and efficient'
|
||||
value: 'direct'
|
||||
default: 'gentle'
|
||||
|
||||
- var: user_preference
|
||||
prompt: 'Enable personalized features?'
|
||||
type: boolean
|
||||
default: true
|
||||
```
|
||||
|
||||
## Key Components
|
||||
|
||||
### Sidecar Files (CRITICAL)
|
||||
|
||||
Expert agents use companion files for persistence and domain knowledge:
|
||||
|
||||
**memories.md** - Persistent user context
|
||||
|
||||
```markdown
|
||||
# Agent Memory Bank
|
||||
|
||||
## User Preferences
|
||||
|
||||
<!-- Learned from interactions -->
|
||||
|
||||
## Session History
|
||||
|
||||
<!-- Important moments and insights -->
|
||||
|
||||
## Personal Notes
|
||||
|
||||
<!-- Agent observations -->
|
||||
```
|
||||
|
||||
**instructions.md** - Private directives
|
||||
|
||||
```markdown
|
||||
# Agent Private Instructions
|
||||
|
||||
## Core Directives
|
||||
|
||||
- Maintain character consistency
|
||||
- Domain boundaries: {specific domain}
|
||||
- Access restrictions: Only sidecar folder
|
||||
|
||||
## Special Rules
|
||||
|
||||
<!-- Agent-specific protocols -->
|
||||
```
|
||||
|
||||
**knowledge/** - Domain resources
|
||||
|
||||
```markdown
|
||||
# Agent Knowledge Base
|
||||
|
||||
Add domain-specific documentation here.
|
||||
```
|
||||
|
||||
### Critical Actions
|
||||
|
||||
**MANDATORY for expert agents** - These load sidecar files at activation:
|
||||
|
||||
```yaml
|
||||
critical_actions:
|
||||
- 'Load COMPLETE file {agent-folder}/{sidecar}/memories.md and remember all past insights'
|
||||
- 'Load COMPLETE file {agent-folder}/{sidecar}/instructions.md and follow ALL protocols'
|
||||
- 'ONLY read/write files in {agent-folder}/{sidecar}/ - this is our private space'
|
||||
```
|
||||
|
||||
**Key patterns:**
|
||||
|
||||
- **COMPLETE file loading** - Forces full file read, not partial
|
||||
- **Domain restrictions** - Limits file access for privacy/security
|
||||
- **Memory integration** - Past context becomes part of current session
|
||||
- **Protocol adherence** - Ensures consistent behavior
|
||||
|
||||
### {agent-folder} Variable
|
||||
|
||||
Special variable resolved during installation:
|
||||
|
||||
- Points to the agent's installation directory
|
||||
- Used to reference sidecar files
|
||||
- Example: `.bmad/custom/agents/journal-keeper/`
|
||||
|
||||
## What Gets Injected at Compile Time
|
||||
|
||||
Same as simple agents, PLUS:
|
||||
|
||||
1. **Critical actions become numbered activation steps**
|
||||
|
||||
```xml
|
||||
<step n="4">Load COMPLETE file {agent-folder}/memories.md...</step>
|
||||
<step n="5">Load COMPLETE file {agent-folder}/instructions.md...</step>
|
||||
<step n="6">ONLY read/write files in {agent-folder}/...</step>
|
||||
```
|
||||
|
||||
2. **Sidecar files copied during installation**
|
||||
- Entire sidecar folder structure preserved
|
||||
- Relative paths maintained
|
||||
- Files ready for agent use
|
||||
|
||||
## Reference Example
|
||||
|
||||
See: `src/modules/bmb/reference/agents/expert-examples/journal-keeper/`
|
||||
|
||||
Features demonstrated:
|
||||
|
||||
- Complete sidecar structure (memories, instructions, breakthroughs)
|
||||
- Critical actions for loading persistent context
|
||||
- Domain restrictions for privacy
|
||||
- Pattern recognition and memory recall
|
||||
- Handlebars-based personalization
|
||||
- Menu actions that update sidecar files
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
# Copy entire folder to your project
|
||||
cp -r /path/to/journal-keeper/ .bmad/custom/agents/
|
||||
|
||||
# Install with personalization
|
||||
bmad agent-install
|
||||
```
|
||||
|
||||
The installer:
|
||||
|
||||
1. Detects expert agent (folder with .agent.yaml)
|
||||
2. Prompts for personalization
|
||||
3. Compiles agent YAML to XML-in-markdown
|
||||
4. **Copies sidecar files to installation target**
|
||||
5. Creates IDE slash commands
|
||||
6. Saves source for reinstallation
|
||||
|
||||
## Memory Patterns
|
||||
|
||||
### Accumulative Memory
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: save
|
||||
action: "Update {agent-folder}/sidecar/memories.md with today's session insights"
|
||||
description: 'Save session to memory'
|
||||
```
|
||||
|
||||
### Reference Memory
|
||||
|
||||
```yaml
|
||||
prompts:
|
||||
- id: recall
|
||||
content: |
|
||||
<instructions>
|
||||
Reference memories.md naturally:
|
||||
"Last week you mentioned..." or "I notice a pattern..."
|
||||
</instructions>
|
||||
```
|
||||
|
||||
### Structured Insights
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: insight
|
||||
action: 'Document in {agent-folder}/sidecar/breakthroughs.md with date, context, significance'
|
||||
description: 'Record meaningful insight'
|
||||
```
|
||||
|
||||
## Domain Restriction Patterns
|
||||
|
||||
### Single Folder Access
|
||||
|
||||
```yaml
|
||||
critical_actions:
|
||||
- 'ONLY read/write files in {agent-folder}/sidecar/ - NO OTHER FOLDERS'
|
||||
```
|
||||
|
||||
### User Space Access
|
||||
|
||||
```yaml
|
||||
critical_actions:
|
||||
- 'ONLY access files in {user-folder}/journals/ - private space'
|
||||
```
|
||||
|
||||
### Read-Only Access
|
||||
|
||||
```yaml
|
||||
critical_actions:
|
||||
- 'Load knowledge from {agent-folder}/knowledge/ but NEVER modify'
|
||||
- 'Write ONLY to {agent-folder}/sessions/'
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Load sidecar files in critical_actions** - Must be explicit and MANDATORY
|
||||
2. **Enforce domain restrictions** - Clear boundaries prevent scope creep
|
||||
3. **Use {agent-folder} paths** - Portable across installations
|
||||
4. **Design for memory growth** - Structure sidecar files for accumulation
|
||||
5. **Reference past naturally** - Don't dump memory, weave it into conversation
|
||||
6. **Separate concerns** - Memories, instructions, knowledge in distinct files
|
||||
7. **Include privacy features** - Users trust expert agents with personal data
|
||||
|
||||
## Common Patterns
|
||||
|
||||
### Session Continuity
|
||||
|
||||
```yaml
|
||||
communication_style: |
|
||||
I reference past conversations naturally:
|
||||
"Last time we discussed..." or "I've noticed over the weeks..."
|
||||
```
|
||||
|
||||
### Pattern Recognition
|
||||
|
||||
```yaml
|
||||
critical_actions:
|
||||
- 'Track mood patterns, recurring themes, and breakthrough moments'
|
||||
- 'Cross-reference current session with historical patterns'
|
||||
```
|
||||
|
||||
### Adaptive Responses
|
||||
|
||||
```yaml
|
||||
identity: |
|
||||
I learn your preferences and adapt my approach over time.
|
||||
{{#if track_preferences}}
|
||||
I maintain notes about what works best for you.
|
||||
{{/if}}
|
||||
```
|
||||
|
||||
## Validation Checklist
|
||||
|
||||
- [ ] Valid YAML syntax
|
||||
- [ ] Metadata includes `type: "expert"`
|
||||
- [ ] critical_actions loads sidecar files explicitly
|
||||
- [ ] critical_actions enforces domain restrictions
|
||||
- [ ] Sidecar folder structure created and populated
|
||||
- [ ] memories.md has clear section structure
|
||||
- [ ] instructions.md contains core directives
|
||||
- [ ] Menu actions reference {agent-folder} correctly
|
||||
- [ ] File paths use {agent-folder} variable
|
||||
- [ ] Install config personalizes sidecar references
|
||||
- [ ] Agent folder named consistently: `{agent-name}/`
|
||||
- [ ] YAML file named: `{agent-name}.agent.yaml`
|
||||
- [ ] Sidecar folder named: `{agent-name}-sidecar/`
|
||||
@ -1,55 +0,0 @@
|
||||
# BMB Module Documentation
|
||||
|
||||
Reference documentation for building BMAD agents and workflows.
|
||||
|
||||
## Agent Architecture
|
||||
|
||||
Comprehensive guides for each agent type (choose based on use case):
|
||||
|
||||
- [Understanding Agent Types](./understanding-agent-types.md) - **START HERE** - Architecture vs capability, "The Same Agent, Three Ways"
|
||||
- [Simple Agent Architecture](./simple-agent-architecture.md) - Self-contained, optimized, personality-driven
|
||||
- [Expert Agent Architecture](./expert-agent-architecture.md) - Memory, sidecar files, domain restrictions
|
||||
- [Module Agent Architecture](./module-agent-architecture.md) - Workflow integration, professional tools
|
||||
|
||||
## Agent Design Patterns
|
||||
|
||||
- [Agent Menu Patterns](./agent-menu-patterns.md) - Menu handlers, triggers, prompts, organization
|
||||
- [Agent Compilation](./agent-compilation.md) - What compiler auto-injects (AVOID DUPLICATION)
|
||||
|
||||
## Reference Examples
|
||||
|
||||
Production-ready examples in `/src/modules/bmb/reference/agents/`:
|
||||
|
||||
**Simple Agents** (`simple-examples/`)
|
||||
|
||||
- `commit-poet.agent.yaml` - Commit message artisan with style customization
|
||||
|
||||
**Expert Agents** (`expert-examples/`)
|
||||
|
||||
- `journal-keeper/` - Personal journal companion with memory and pattern recognition
|
||||
|
||||
**Module Agents** (`module-examples/`)
|
||||
|
||||
- `security-engineer.agent.yaml` - BMM security specialist with threat modeling
|
||||
- `trend-analyst.agent.yaml` - CIS trend intelligence expert
|
||||
|
||||
## Installation Guide
|
||||
|
||||
For installing standalone simple and expert agents, see:
|
||||
|
||||
- [Custom Agent Installation](/docs/custom-agent-installation.md)
|
||||
|
||||
## Key Concepts
|
||||
|
||||
### YAML to XML Compilation
|
||||
|
||||
Agents are authored in YAML with Handlebars templating. The compiler auto-injects:
|
||||
|
||||
1. **Frontmatter** - Name and description from metadata
|
||||
2. **Activation Block** - Steps, menu handlers, rules (YOU don't write this)
|
||||
3. **Menu Enhancement** - `*help` and `*exit` commands added automatically
|
||||
4. **Trigger Prefixing** - Your triggers auto-prefixed with `*`
|
||||
|
||||
**Critical:** See [Agent Compilation](./agent-compilation.md) to avoid duplicating auto-injected content.
|
||||
|
||||
Source: `tools/cli/lib/agent/compiler.js`
|
||||
@ -1,367 +0,0 @@
|
||||
# Module Agent Architecture
|
||||
|
||||
Full integration agents with workflow orchestration, module-specific paths, and professional tooling.
|
||||
|
||||
## When to Use
|
||||
|
||||
- Professional development workflows (business analysis, architecture design)
|
||||
- Team-oriented tools (project management, sprint planning)
|
||||
- Agents that orchestrate multiple workflows
|
||||
- Module-specific functionality (BMM, BMB, CIS, custom modules)
|
||||
- Agents with complex multi-step operations
|
||||
|
||||
## File Location
|
||||
|
||||
```
|
||||
src/modules/{module-code}/agents/{agent-name}.agent.yaml
|
||||
```
|
||||
|
||||
Compiles to:
|
||||
|
||||
```
|
||||
.bmad/{module-code}/agents/{agent-name}.md
|
||||
```
|
||||
|
||||
## YAML Structure
|
||||
|
||||
```yaml
|
||||
agent:
|
||||
metadata:
|
||||
id: '.bmad/{module-code}/agents/{agent-name}.md'
|
||||
name: 'Persona Name'
|
||||
title: 'Professional Title'
|
||||
icon: 'emoji'
|
||||
module: '{module-code}'
|
||||
|
||||
persona:
|
||||
role: 'Primary expertise and function'
|
||||
identity: 'Background, experience, specializations'
|
||||
communication_style: 'Interaction approach, tone, methodology'
|
||||
principles: 'Core beliefs and methodology'
|
||||
|
||||
menu:
|
||||
- trigger: workflow-action
|
||||
workflow: '{project-root}/.bmad/{module-code}/workflows/{workflow-name}/workflow.yaml'
|
||||
description: 'Execute module workflow'
|
||||
|
||||
- trigger: another-workflow
|
||||
workflow: '{project-root}/.bmad/core/workflows/{workflow-name}/workflow.yaml'
|
||||
description: 'Execute core workflow'
|
||||
|
||||
- trigger: task-action
|
||||
exec: '{project-root}/.bmad/{module-code}/tasks/{task-name}.xml'
|
||||
description: 'Execute module task'
|
||||
|
||||
- trigger: cross-module
|
||||
workflow: '{project-root}/.bmad/other-module/workflows/{workflow-name}/workflow.yaml'
|
||||
description: 'Execute workflow from another module'
|
||||
|
||||
- trigger: with-template
|
||||
exec: '{project-root}/.bmad/core/tasks/create-doc.xml'
|
||||
tmpl: '{project-root}/.bmad/{module-code}/templates/{template-name}.md'
|
||||
description: 'Create document from template'
|
||||
|
||||
- trigger: with-data
|
||||
exec: '{project-root}/.bmad/{module-code}/tasks/{task-name}.xml'
|
||||
data: '{project-root}/.bmad/_cfg/agent-manifest.csv'
|
||||
description: 'Execute task with data file'
|
||||
```
|
||||
|
||||
## Key Components
|
||||
|
||||
### Metadata
|
||||
|
||||
- **id**: Path with `.bmad` variable (resolved at install time)
|
||||
- **name**: Agent persona name
|
||||
- **title**: Professional role
|
||||
- **icon**: Single emoji
|
||||
- **module**: Module code (bmm, bmb, cis, custom)
|
||||
|
||||
### Persona (Professional Voice)
|
||||
|
||||
Module agents typically use **professional** communication styles:
|
||||
|
||||
```yaml
|
||||
persona:
|
||||
role: Strategic Business Analyst + Requirements Expert
|
||||
|
||||
identity: Senior analyst with deep expertise in market research, competitive analysis, and requirements elicitation. Specializes in translating vague needs into actionable specs.
|
||||
|
||||
communication_style: Systematic and probing. Connects dots others miss. Structures findings hierarchically. Uses precise unambiguous language. Ensures all stakeholder voices heard.
|
||||
|
||||
principles: Every business challenge has root causes waiting to be discovered. Ground findings in verifiable evidence. Articulate requirements with absolute precision.
|
||||
```
|
||||
|
||||
**Note:** Module agents usually don't use Handlebars templating since they're not user-customized - they're professional tools with fixed personalities.
|
||||
|
||||
### Menu Handlers
|
||||
|
||||
#### Workflow Handler (Most Common)
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: create-prd
|
||||
workflow: '{project-root}/.bmad/bmm/workflows/prd/workflow.yaml'
|
||||
description: 'Create Product Requirements Document'
|
||||
```
|
||||
|
||||
Invokes BMAD workflow engine to execute multi-step processes.
|
||||
|
||||
#### Task/Exec Handler
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: validate
|
||||
exec: '{project-root}/.bmad/core/tasks/validate-workflow.xml'
|
||||
description: 'Validate document structure'
|
||||
```
|
||||
|
||||
Executes single-operation tasks.
|
||||
|
||||
#### Template Handler
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: create-brief
|
||||
exec: '{project-root}/.bmad/core/tasks/create-doc.xml'
|
||||
tmpl: '{project-root}/.bmad/bmm/templates/brief.md'
|
||||
description: 'Create project brief from template'
|
||||
```
|
||||
|
||||
Combines task execution with template file.
|
||||
|
||||
#### Data Handler
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: team-standup
|
||||
exec: '{project-root}/.bmad/bmm/tasks/standup.xml'
|
||||
data: '{project-root}/.bmad/_cfg/agent-manifest.csv'
|
||||
description: 'Run team standup with agent roster'
|
||||
```
|
||||
|
||||
Provides data file to task.
|
||||
|
||||
#### Placeholder Handler
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: future-feature
|
||||
workflow: 'todo'
|
||||
description: 'Feature planned but not yet implemented'
|
||||
```
|
||||
|
||||
Marks unimplemented features - compiler handles gracefully.
|
||||
|
||||
### Platform-Specific Menu Items
|
||||
|
||||
Control visibility based on platform:
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: advanced-elicitation
|
||||
exec: '{project-root}/.bmad/core/tasks/advanced-elicitation.xml'
|
||||
description: 'Advanced elicitation techniques'
|
||||
web-only: true # Only shows in web bundle
|
||||
|
||||
- trigger: git-operations
|
||||
exec: '{project-root}/.bmad/bmm/tasks/git-flow.xml'
|
||||
description: 'Git workflow operations'
|
||||
ide-only: true # Only shows in IDE environments
|
||||
```
|
||||
|
||||
## Variable System
|
||||
|
||||
### Core Variables
|
||||
|
||||
- `{project-root}` - Root directory of installed project
|
||||
- `.bmad` - BMAD installation folder (usually `.bmad`)
|
||||
- `{user_name}` - User's name from module config
|
||||
- `{communication_language}` - Language preference
|
||||
- `{output_folder}` - Document output directory
|
||||
|
||||
### Path Construction
|
||||
|
||||
**Always use variables, never hardcoded paths:**
|
||||
|
||||
```yaml
|
||||
# GOOD
|
||||
workflow: "{project-root}/.bmad/bmm/workflows/prd/workflow.yaml"
|
||||
|
||||
# BAD
|
||||
workflow: "/Users/john/project/.bmad/bmm/workflows/prd/workflow.yaml"
|
||||
|
||||
# BAD
|
||||
workflow: "../../../bmm/workflows/prd/workflow.yaml"
|
||||
```
|
||||
|
||||
## What Gets Injected at Compile Time
|
||||
|
||||
Module agents use the same injection process as simple agents:
|
||||
|
||||
1. **Frontmatter** with name and description
|
||||
2. **Activation block** with standard steps
|
||||
3. **Menu handlers** based on usage (workflow, exec, tmpl, data)
|
||||
4. **Rules section** for consistent behavior
|
||||
5. **Auto-injected** *help and *exit commands
|
||||
|
||||
**Key difference:** Module agents load **module-specific config** instead of core config:
|
||||
|
||||
```xml
|
||||
<step n="2">Load and read {project-root}/.bmad/{module}/config.yaml...</step>
|
||||
```
|
||||
|
||||
## Reference Examples
|
||||
|
||||
See: `src/modules/bmm/agents/`
|
||||
|
||||
**analyst.agent.yaml** - Business Analyst
|
||||
|
||||
- Workflow orchestration for analysis phase
|
||||
- Multiple workflow integrations
|
||||
- Cross-module workflow access (core/workflows/party-mode)
|
||||
|
||||
**architect.agent.yaml** - System Architect
|
||||
|
||||
- Technical workflow management
|
||||
- Architecture decision workflows
|
||||
|
||||
**pm.agent.yaml** - Product Manager
|
||||
|
||||
- Planning and coordination workflows
|
||||
- Sprint management integration
|
||||
|
||||
## Module Configuration
|
||||
|
||||
Each module has `config.yaml` providing:
|
||||
|
||||
```yaml
|
||||
# src/modules/{module}/config.yaml
|
||||
user_name: 'User Name'
|
||||
communication_language: 'English'
|
||||
output_folder: '{project-root}/docs'
|
||||
custom_settings: 'module-specific values'
|
||||
```
|
||||
|
||||
Agents load this at activation for consistent behavior.
|
||||
|
||||
## Workflow Integration Patterns
|
||||
|
||||
### Sequential Workflow Execution
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: init
|
||||
workflow: '{project-root}/.bmad/bmm/workflows/workflow-init/workflow.yaml'
|
||||
description: 'Initialize workflow path (START HERE)'
|
||||
|
||||
- trigger: status
|
||||
workflow: '{project-root}/.bmad/bmm/workflows/workflow-status/workflow.yaml'
|
||||
description: 'Check current workflow status'
|
||||
|
||||
- trigger: next-step
|
||||
workflow: '{project-root}/.bmad/bmm/workflows/next-step/workflow.yaml'
|
||||
description: 'Execute next workflow in sequence'
|
||||
```
|
||||
|
||||
### Phase-Based Organization
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
# Phase 1: Analysis
|
||||
- trigger: brainstorm
|
||||
workflow: '{project-root}/.bmad/bmm/workflows/1-analysis/brainstorm/workflow.yaml'
|
||||
description: 'Guided brainstorming session'
|
||||
|
||||
- trigger: research
|
||||
workflow: '{project-root}/.bmad/bmm/workflows/1-analysis/research/workflow.yaml'
|
||||
description: 'Market and technical research'
|
||||
|
||||
# Phase 2: Planning
|
||||
- trigger: prd
|
||||
workflow: '{project-root}/.bmad/bmm/workflows/2-planning/prd/workflow.yaml'
|
||||
description: 'Create PRD'
|
||||
|
||||
- trigger: architecture
|
||||
workflow: '{project-root}/.bmad/bmm/workflows/2-planning/architecture/workflow.yaml'
|
||||
description: 'Design architecture'
|
||||
```
|
||||
|
||||
### Cross-Module Access
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: party-mode
|
||||
workflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.yaml'
|
||||
description: 'Bring all agents together'
|
||||
|
||||
- trigger: brainstorm
|
||||
workflow: '{project-root}/.bmad/cis/workflows/brainstorming/workflow.yaml'
|
||||
description: 'Use CIS brainstorming techniques'
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Use .bmad paths** - Portable across installations
|
||||
2. **Organize workflows by phase** - Clear progression for users
|
||||
3. **Include workflow-status** - Help users track progress
|
||||
4. **Reference module config** - Consistent behavior
|
||||
5. **No Handlebars templating** - Module agents are fixed personalities
|
||||
6. **Professional personas** - Match module purpose
|
||||
7. **Clear trigger names** - Self-documenting commands
|
||||
8. **Group related workflows** - Logical menu organization
|
||||
|
||||
## Common Patterns
|
||||
|
||||
### Entry Point Agent
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: start
|
||||
workflow: '{project-root}/.bmad/{module}/workflows/init/workflow.yaml'
|
||||
description: 'Start new project (BEGIN HERE)'
|
||||
```
|
||||
|
||||
### Status Tracking
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: status
|
||||
workflow: '{project-root}/.bmad/{module}/workflows/status/workflow.yaml'
|
||||
description: 'Check workflow progress'
|
||||
```
|
||||
|
||||
### Team Coordination
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: party
|
||||
workflow: '{project-root}/.bmad/core/workflows/party-mode/workflow.yaml'
|
||||
description: 'Multi-agent discussion'
|
||||
```
|
||||
|
||||
## Module Agent vs Simple/Expert
|
||||
|
||||
| Aspect | Module Agent | Simple/Expert Agent |
|
||||
| ------------- | -------------------------------- | ------------------------------- |
|
||||
| Location | `.bmad/{module}/agents/` | `.bmad/custom/agents/` |
|
||||
| Persona | Fixed, professional | Customizable via install_config |
|
||||
| Handlebars | No templating | Yes, extensive |
|
||||
| Menu actions | Workflows, tasks, templates | Prompts, inline actions |
|
||||
| Configuration | Module config.yaml | Core config or none |
|
||||
| Purpose | Professional tooling | Personal utilities |
|
||||
|
||||
## Validation Checklist
|
||||
|
||||
- [ ] Valid YAML syntax
|
||||
- [ ] Metadata includes `module: "{module-code}"`
|
||||
- [ ] id uses `.bmad/{module}/agents/{name}.md`
|
||||
- [ ] All workflow paths use `{project-root}/.bmad/` prefix
|
||||
- [ ] No hardcoded paths
|
||||
- [ ] No duplicate triggers
|
||||
- [ ] Each menu item has description
|
||||
- [ ] Triggers don't start with `*` (auto-added)
|
||||
- [ ] Professional persona appropriate for module
|
||||
- [ ] Workflow paths resolve to actual workflows (or "todo")
|
||||
- [ ] File named `{agent-name}.agent.yaml`
|
||||
- [ ] Located in `src/modules/{module}/agents/`
|
||||
@ -1,288 +0,0 @@
|
||||
# Simple Agent Architecture
|
||||
|
||||
Self-contained agents with prompts, menus, and optional install-time customization.
|
||||
|
||||
## When to Use
|
||||
|
||||
- Single-purpose utilities (commit message generator, code formatter)
|
||||
- Self-contained logic with no external dependencies
|
||||
- Agents that benefit from user customization (style, tone, preferences)
|
||||
- Quick-to-build standalone helpers
|
||||
|
||||
## YAML Structure
|
||||
|
||||
```yaml
|
||||
agent:
|
||||
metadata:
|
||||
id: .bmad/agents/{agent-name}/{agent-name}.md
|
||||
name: 'Persona Name'
|
||||
title: 'Agent Title'
|
||||
icon: 'emoji'
|
||||
type: simple
|
||||
|
||||
persona:
|
||||
role: |
|
||||
First-person description of primary function (1-2 sentences)
|
||||
|
||||
identity: |
|
||||
Background, experience, specializations in first-person (2-5 sentences)
|
||||
{{#if custom_variable}}
|
||||
Conditional identity text based on install_config
|
||||
{{/if}}
|
||||
|
||||
communication_style: |
|
||||
{{#if style_choice == "professional"}}
|
||||
Professional and systematic approach...
|
||||
{{/if}}
|
||||
{{#if style_choice == "casual"}}
|
||||
Friendly and approachable tone...
|
||||
{{/if}}
|
||||
|
||||
principles:
|
||||
- Core belief or methodology
|
||||
- Another guiding principle
|
||||
- Values that shape decisions
|
||||
|
||||
prompts:
|
||||
- id: main-action
|
||||
content: |
|
||||
<instructions>
|
||||
What this prompt does
|
||||
</instructions>
|
||||
|
||||
<process>
|
||||
1. Step one
|
||||
{{#if detailed_mode}}
|
||||
2. Additional detailed step
|
||||
{{/if}}
|
||||
3. Final step
|
||||
</process>
|
||||
|
||||
- id: another-action
|
||||
content: |
|
||||
Another reusable prompt template
|
||||
|
||||
menu:
|
||||
- trigger: action1
|
||||
action: '#main-action'
|
||||
description: 'Execute the main action'
|
||||
|
||||
- trigger: action2
|
||||
action: '#another-action'
|
||||
description: 'Execute another action'
|
||||
|
||||
- trigger: inline
|
||||
action: 'Direct inline instruction text'
|
||||
description: 'Execute inline action'
|
||||
|
||||
install_config:
|
||||
compile_time_only: true
|
||||
description: 'Personalize your agent'
|
||||
questions:
|
||||
- var: style_choice
|
||||
prompt: 'Preferred communication style?'
|
||||
type: choice
|
||||
options:
|
||||
- label: 'Professional'
|
||||
value: 'professional'
|
||||
- label: 'Casual'
|
||||
value: 'casual'
|
||||
default: 'professional'
|
||||
|
||||
- var: detailed_mode
|
||||
prompt: 'Enable detailed explanations?'
|
||||
type: boolean
|
||||
default: true
|
||||
|
||||
- var: custom_variable
|
||||
prompt: 'Your custom text'
|
||||
type: text
|
||||
default: ''
|
||||
```
|
||||
|
||||
## Key Components
|
||||
|
||||
### Metadata
|
||||
|
||||
- **id**: Final compiled path (`.bmad/agents/{name}/{name}.md` for standalone)
|
||||
- **name**: Agent's persona name displayed to users
|
||||
- **title**: Professional role/function
|
||||
- **icon**: Single emoji for visual identification
|
||||
- **type**: `simple` - identifies agent category
|
||||
|
||||
### Persona (First-Person Voice)
|
||||
|
||||
- **role**: Primary expertise in 1-2 sentences
|
||||
- **identity**: Background and specializations (2-5 sentences)
|
||||
- **communication_style**: HOW the agent interacts, including conditional variations
|
||||
- **principles**: Array of core beliefs (start with action verbs)
|
||||
|
||||
### Prompts with IDs
|
||||
|
||||
Reusable prompt templates referenced by `#id`:
|
||||
|
||||
```yaml
|
||||
prompts:
|
||||
- id: analyze-code
|
||||
content: |
|
||||
<instructions>
|
||||
Analyze the provided code for patterns
|
||||
</instructions>
|
||||
```
|
||||
|
||||
Menu items reference these:
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: analyze
|
||||
action: '#analyze-code'
|
||||
description: 'Analyze code patterns'
|
||||
```
|
||||
|
||||
### Menu Actions
|
||||
|
||||
Two forms of action handlers:
|
||||
|
||||
1. **Prompt Reference**: `action: "#prompt-id"` - Executes prompt content
|
||||
2. **Inline Instruction**: `action: "Direct text instruction"` - Executes text directly
|
||||
|
||||
### Install Config (Compile-Time Customization)
|
||||
|
||||
Questions asked during `bmad agent-install`:
|
||||
|
||||
**Question Types:**
|
||||
|
||||
- `choice` - Multiple choice selection
|
||||
- `boolean` - Yes/no toggle
|
||||
- `text` - Free-form text input
|
||||
|
||||
**Variables become available in Handlebars:**
|
||||
|
||||
```yaml
|
||||
{{#if variable_name}}
|
||||
Content when true
|
||||
{{/if}}
|
||||
|
||||
{{#if variable_name == "value"}}
|
||||
Content when equals value
|
||||
{{/if}}
|
||||
|
||||
{{#unless variable_name}}
|
||||
Content when false
|
||||
{{/unless}}
|
||||
```
|
||||
|
||||
## What Gets Injected at Compile Time
|
||||
|
||||
The `tools/cli/lib/agent/compiler.js` automatically adds:
|
||||
|
||||
1. **YAML Frontmatter**
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: 'agent name'
|
||||
description: 'Agent Title'
|
||||
---
|
||||
```
|
||||
|
||||
2. **Activation Block**
|
||||
- Load persona step
|
||||
- Load core config for {user_name}, {communication_language}
|
||||
- Agent-specific critical_actions as numbered steps
|
||||
- Menu display and input handling
|
||||
- Menu handlers (action/workflow/exec/tmpl) based on usage
|
||||
- Rules section
|
||||
|
||||
3. **Auto-Injected Menu Items**
|
||||
- `*help` always first
|
||||
- `*exit` always last
|
||||
|
||||
4. **Trigger Prefixing**
|
||||
- Triggers without `*` get it added automatically
|
||||
|
||||
## Reference Example
|
||||
|
||||
See: `src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml`
|
||||
|
||||
Features demonstrated:
|
||||
|
||||
- Handlebars conditionals for style variations
|
||||
- Multiple prompt templates with semantic XML tags
|
||||
- Install config with choice, boolean, and text questions
|
||||
- Menu items using both `#id` references and inline actions
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
# Copy to your project
|
||||
cp /path/to/commit-poet.agent.yaml .bmad/custom/agents/
|
||||
|
||||
# Install with personalization
|
||||
bmad agent-install
|
||||
# or: npx bmad agent-install
|
||||
```
|
||||
|
||||
The installer:
|
||||
|
||||
1. Prompts for personalization (name, preferences)
|
||||
2. Processes Handlebars templates with your answers
|
||||
3. Compiles YAML to XML-in-markdown
|
||||
4. Creates IDE slash commands
|
||||
5. Saves source for reinstallation
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Use first-person voice** in all persona elements
|
||||
2. **Keep prompts focused** - one clear purpose per prompt
|
||||
3. **Leverage Handlebars** for user customization without code changes
|
||||
4. **Provide sensible defaults** in install_config
|
||||
5. **Use semantic XML tags** in prompt content for clarity
|
||||
6. **Test all conditional paths** before distribution
|
||||
|
||||
## Common Patterns
|
||||
|
||||
### Style Variants
|
||||
|
||||
```yaml
|
||||
communication_style: |
|
||||
{{#if enthusiasm == "high"}}
|
||||
Enthusiastic and energetic approach!
|
||||
{{/if}}
|
||||
{{#if enthusiasm == "moderate"}}
|
||||
Balanced and professional demeanor.
|
||||
{{/if}}
|
||||
```
|
||||
|
||||
### Feature Toggles
|
||||
|
||||
```yaml
|
||||
prompts:
|
||||
- id: main-action
|
||||
content: |
|
||||
{{#if advanced_mode}}
|
||||
Include advanced analysis steps...
|
||||
{{/if}}
|
||||
{{#unless advanced_mode}}
|
||||
Basic analysis only...
|
||||
{{/unless}}
|
||||
```
|
||||
|
||||
### User Personalization
|
||||
|
||||
```yaml
|
||||
identity: |
|
||||
{{#if custom_name}}
|
||||
Known as {{custom_name}} to you.
|
||||
{{/if}}
|
||||
```
|
||||
|
||||
## Validation Checklist
|
||||
|
||||
- [ ] Valid YAML syntax
|
||||
- [ ] All metadata fields present (id, name, title, icon, type)
|
||||
- [ ] Persona complete (role, identity, communication_style, principles)
|
||||
- [ ] Prompts have unique IDs
|
||||
- [ ] Menu triggers don't start with `*` (auto-added)
|
||||
- [ ] Install config questions have defaults
|
||||
- [ ] Handlebars syntax is correct
|
||||
- [ ] File named `{agent-name}.agent.yaml`
|
||||
@ -1,184 +0,0 @@
|
||||
# Understanding Agent Types: Architecture, Not Capability
|
||||
|
||||
**CRITICAL DISTINCTION:** Agent types define **architecture and integration**, NOT capability limits.
|
||||
|
||||
ALL agent types can:
|
||||
|
||||
- ✓ Write to {output_folder}, {project-root}, or anywhere on system
|
||||
- ✓ Update artifacts and files
|
||||
- ✓ Execute bash commands
|
||||
- ✓ Use core variables (.bmad, {output_folder}, etc.)
|
||||
- ✓ Have complex prompts and logic
|
||||
- ✓ Invoke external tools
|
||||
|
||||
## What Actually Differs
|
||||
|
||||
| Feature | Simple | Expert | Module |
|
||||
| ---------------------- | ------------- | --------------------- | ------------------ |
|
||||
| **Self-contained** | ✓ All in YAML | Sidecar files | Sidecar optional |
|
||||
| **Persistent memory** | ✗ Stateless | ✓ memories.md | ✓ If needed |
|
||||
| **Knowledge base** | ✗ | ✓ sidecar/knowledge/ | Module/shared |
|
||||
| **Domain restriction** | ✗ System-wide | ✓ Sidecar only | Optional |
|
||||
| **Personal workflows** | ✗ | ✓ Sidecar workflows\* | ✗ |
|
||||
| **Module workflows** | ✗ | ✗ | ✓ Shared workflows |
|
||||
| **Team integration** | Solo utility | Personal assistant | Team member |
|
||||
|
||||
\*Expert agents CAN have personal workflows in sidecar if critical_actions loads workflow engine
|
||||
|
||||
## The Same Agent, Three Ways
|
||||
|
||||
**Scenario:** Code Generator Agent
|
||||
|
||||
### As Simple Agent (Architecture: Self-contained)
|
||||
|
||||
```yaml
|
||||
agent:
|
||||
metadata:
|
||||
name: CodeGen
|
||||
type: simple
|
||||
|
||||
prompts:
|
||||
- id: generate
|
||||
content: |
|
||||
Ask user for spec details. Generate code.
|
||||
Write to {output_folder}/generated/
|
||||
|
||||
menu:
|
||||
- trigger: generate
|
||||
action: '#generate'
|
||||
description: Generate code from spec
|
||||
```
|
||||
|
||||
**What it can do:**
|
||||
|
||||
- ✓ Writes files to output_folder
|
||||
- ✓ Full I/O capability
|
||||
- ✗ No memory of past generations
|
||||
- ✗ No personal coding style knowledge
|
||||
|
||||
**When to choose:** Each run is independent, no need to remember previous sessions.
|
||||
|
||||
### As Expert Agent (Architecture: Personal sidecar)
|
||||
|
||||
```yaml
|
||||
agent:
|
||||
metadata:
|
||||
name: CodeGen
|
||||
type: expert
|
||||
|
||||
critical_actions:
|
||||
- Load my coding standards from sidecar/knowledge/
|
||||
- Load memories from sidecar/memories.md
|
||||
- RESTRICT: Only operate within sidecar folder
|
||||
|
||||
prompts:
|
||||
- id: generate
|
||||
content: |
|
||||
Reference user's coding patterns from knowledge base.
|
||||
Remember past generations from memories.
|
||||
Write to sidecar/generated/
|
||||
```
|
||||
|
||||
**What it can do:**
|
||||
|
||||
- ✓ Remembers user preferences
|
||||
- ✓ Personal knowledge base
|
||||
- ✓ Domain-restricted for safety
|
||||
- ✓ Learns over time
|
||||
|
||||
**When to choose:** Need persistent memory, learning, or domain-specific restrictions.
|
||||
|
||||
### As Module Agent (Architecture: Team integration)
|
||||
|
||||
```yaml
|
||||
agent:
|
||||
metadata:
|
||||
name: CodeGen
|
||||
module: bmm
|
||||
|
||||
menu:
|
||||
- trigger: implement-story
|
||||
workflow: '.bmad/bmm/workflows/dev-story/workflow.yaml'
|
||||
description: Implement user story
|
||||
|
||||
- trigger: refactor
|
||||
workflow: '.bmad/bmm/workflows/refactor/workflow.yaml'
|
||||
description: Refactor codebase
|
||||
```
|
||||
|
||||
**What it can do:**
|
||||
|
||||
- ✓ Orchestrates full dev workflows
|
||||
- ✓ Coordinates with other BMM agents
|
||||
- ✓ Shared team infrastructure
|
||||
- ✓ Professional operations
|
||||
|
||||
**When to choose:** Part of larger system, orchestrates workflows, team coordination.
|
||||
|
||||
## Important: Any Agent Can Be Added to a Module
|
||||
|
||||
**CLARIFICATION:** The "Module Agent" type is about **design intent and ecosystem integration**, not just file location.
|
||||
|
||||
### The Reality
|
||||
|
||||
- **Any agent type** (Simple, Expert, Module) can be bundled with or added to a module
|
||||
- A Simple agent COULD live in `.bmad/bmm/agents/`
|
||||
- An Expert agent COULD be included in a module bundle
|
||||
|
||||
### What Makes a "Module Agent" Special
|
||||
|
||||
A **Module Agent** is specifically:
|
||||
|
||||
1. **Designed FOR** a particular module ecosystem (BMM, CIS, BMB, etc.)
|
||||
2. **Uses or contributes** that module's workflows
|
||||
3. **Included by default** in that module's bundle
|
||||
4. **Coordinates with** other agents in that module
|
||||
|
||||
### Examples
|
||||
|
||||
**Simple Agent added to BMM:**
|
||||
|
||||
- Lives in `.bmad/bmm/agents/formatter.agent.yaml`
|
||||
- Bundled with BMM for convenience
|
||||
- But still stateless, self-contained
|
||||
- NOT a "Module Agent" - just a Simple agent in a module
|
||||
|
||||
**Module Agent in BMM:**
|
||||
|
||||
- Lives in `.bmad/bmm/agents/tech-writer.agent.yaml`
|
||||
- Orchestrates BMM documentation workflows
|
||||
- Coordinates with other BMM agents (PM, Dev, Analyst)
|
||||
- Included in default BMM bundle
|
||||
- IS a "Module Agent" - designed for BMM ecosystem
|
||||
|
||||
**The distinction:** File location vs design intent and integration.
|
||||
|
||||
## Choosing Your Agent Type
|
||||
|
||||
### Choose Simple when:
|
||||
|
||||
- Single-purpose utility (no memory needed)
|
||||
- Stateless operations (each run is independent)
|
||||
- Self-contained logic (everything in YAML)
|
||||
- No persistent context required
|
||||
|
||||
### Choose Expert when:
|
||||
|
||||
- Need to remember things across sessions
|
||||
- Personal knowledge base (user preferences, domain data)
|
||||
- Domain-specific expertise with restricted scope
|
||||
- Learning/adapting over time
|
||||
|
||||
### Choose Module when:
|
||||
|
||||
- Designed FOR a specific module ecosystem (BMM, CIS, etc.)
|
||||
- Uses or contributes that module's workflows
|
||||
- Coordinates with other module agents
|
||||
- Will be included in module's default bundle
|
||||
- Part of professional team infrastructure
|
||||
|
||||
## The Golden Rule
|
||||
|
||||
**Choose based on state and integration needs, NOT on what the agent can DO.**
|
||||
|
||||
All three types are equally powerful. The difference is how they manage state, where they store data, and how they integrate with your system.
|
||||
@ -1,242 +0,0 @@
|
||||
# Expert Agent Reference: Personal Journal Keeper (Whisper)
|
||||
|
||||
This folder contains a complete reference implementation of a **BMAD Expert Agent** - an agent with persistent memory and domain-specific resources via a sidecar folder.
|
||||
|
||||
## Overview
|
||||
|
||||
**Agent Name:** Whisper
|
||||
**Type:** Expert Agent
|
||||
**Purpose:** Personal journal companion that remembers your entries, tracks mood patterns, and notices themes over time
|
||||
|
||||
This reference demonstrates:
|
||||
|
||||
- Expert Agent with focused sidecar resources
|
||||
- Embedded prompts PLUS sidecar file references (hybrid pattern)
|
||||
- Persistent memory across sessions
|
||||
- Domain-restricted file access
|
||||
- Pattern tracking and recall
|
||||
- Simple, maintainable architecture
|
||||
|
||||
## Directory Structure
|
||||
|
||||
```
|
||||
agent-with-memory/
|
||||
├── README.md # This file
|
||||
├── journal-keeper.agent.yaml # Main agent definition
|
||||
└── journal-keeper-sidecar/ # Agent's private workspace
|
||||
├── instructions.md # Core directives
|
||||
├── memories.md # Persistent session memory
|
||||
├── mood-patterns.md # Emotional tracking data
|
||||
├── breakthroughs.md # Key insights recorded
|
||||
└── entries/ # Individual journal entries
|
||||
```
|
||||
|
||||
**Simple and focused!** Just 4 core files + a folder for entries.
|
||||
|
||||
## Key Architecture Patterns
|
||||
|
||||
### 1. Hybrid Command Pattern
|
||||
|
||||
Expert Agents can use BOTH:
|
||||
|
||||
- **Embedded prompts** via `action: "#prompt-id"` (like Simple Agents)
|
||||
- **Sidecar file references** via direct paths
|
||||
|
||||
```yaml
|
||||
menu:
|
||||
# Embedded prompt (like Simple Agent)
|
||||
- trigger: 'write'
|
||||
action: '#guided-entry'
|
||||
description: "Write today's journal entry"
|
||||
|
||||
# Direct sidecar file action
|
||||
- trigger: 'insight'
|
||||
action: 'Document this breakthrough in {agent-folder}/journal-keeper-sidecar/breakthroughs.md'
|
||||
description: 'Record a meaningful insight'
|
||||
```
|
||||
|
||||
This hybrid approach gives you the best of both worlds!
|
||||
|
||||
### 2. Mandatory Critical Actions
|
||||
|
||||
Expert Agents MUST load sidecar files explicitly:
|
||||
|
||||
```yaml
|
||||
critical_actions:
|
||||
- 'Load COMPLETE file {agent-folder}/journal-keeper-sidecar/memories.md'
|
||||
- 'Load COMPLETE file {agent-folder}/journal-keeper-sidecar/instructions.md'
|
||||
- 'ONLY read/write files in {agent-folder}/journal-keeper-sidecar/'
|
||||
```
|
||||
|
||||
**Key points:**
|
||||
|
||||
- Files are loaded at startup
|
||||
- Domain restriction is enforced
|
||||
- Agent knows its boundaries
|
||||
|
||||
### 3. Persistent Memory Pattern
|
||||
|
||||
The `memories.md` file stores:
|
||||
|
||||
- User preferences and patterns
|
||||
- Session notes and observations
|
||||
- Recurring themes discovered
|
||||
- Growth markers tracked
|
||||
|
||||
**Critically:** This is updated EVERY session, creating continuity.
|
||||
|
||||
### 4. Domain-Specific Tracking
|
||||
|
||||
Different files track different aspects:
|
||||
|
||||
- **memories.md** - Qualitative insights and observations
|
||||
- **mood-patterns.md** - Quantitative emotional data
|
||||
- **breakthroughs.md** - Significant moments
|
||||
- **entries/** - The actual content (journal entries)
|
||||
|
||||
This separation makes data easy to reference and update.
|
||||
|
||||
### 5. Simple Sidecar Structure
|
||||
|
||||
Unlike modules with complex folder hierarchies, Expert Agent sidecars are flat and focused:
|
||||
|
||||
- Just the files the agent needs
|
||||
- No nested workflows or templates
|
||||
- Easy to understand and maintain
|
||||
- All domain knowledge in one place
|
||||
|
||||
## Comparison: Simple vs Expert vs Module
|
||||
|
||||
| Feature | Simple Agent | Expert Agent | Module Agent |
|
||||
| ------------- | -------------------- | -------------------------- | ---------------------- |
|
||||
| Architecture | Single YAML | YAML + sidecar folder | YAML + module system |
|
||||
| Memory | Session only | Persistent (sidecar files) | Config-driven |
|
||||
| Prompts | Embedded only | Embedded + external files | Workflow references |
|
||||
| Dependencies | None | Sidecar folder | Module workflows/tasks |
|
||||
| Domain Access | None | Restricted to sidecar | Full module access |
|
||||
| Complexity | Low | Medium | High |
|
||||
| Use Case | Self-contained tools | Domain experts with memory | Full workflow systems |
|
||||
|
||||
## The Sweet Spot
|
||||
|
||||
Expert Agents are the middle ground:
|
||||
|
||||
- **More powerful** than Simple Agents (persistent memory, domain knowledge)
|
||||
- **Simpler** than Module Agents (no workflow orchestration)
|
||||
- **Focused** on specific domain expertise
|
||||
- **Personal** to the user's needs
|
||||
|
||||
## When to Use Expert Agents
|
||||
|
||||
**Perfect for:**
|
||||
|
||||
- Personal assistants that need memory (journal keeper, diary, notes)
|
||||
- Domain specialists with knowledge bases (specific project context)
|
||||
- Agents that track patterns over time (mood, habits, progress)
|
||||
- Privacy-focused tools with restricted access
|
||||
- Tools that learn and adapt to individual users
|
||||
|
||||
**Key indicators:**
|
||||
|
||||
- Need to remember things between sessions
|
||||
- Should only access specific folders/files
|
||||
- Tracks data over time
|
||||
- Adapts based on accumulated knowledge
|
||||
|
||||
## File Breakdown
|
||||
|
||||
### journal-keeper.agent.yaml
|
||||
|
||||
- Standard agent metadata and persona
|
||||
- **Embedded prompts** for guided interactions
|
||||
- **Menu commands** mixing both patterns
|
||||
- **Critical actions** that load sidecar files
|
||||
|
||||
### instructions.md
|
||||
|
||||
- Core behavioral directives
|
||||
- Journaling philosophy and approach
|
||||
- File management protocols
|
||||
- Tone and boundary guidelines
|
||||
|
||||
### memories.md
|
||||
|
||||
- User profile and preferences
|
||||
- Recurring themes discovered
|
||||
- Session notes and observations
|
||||
- Accumulated knowledge about the user
|
||||
|
||||
### mood-patterns.md
|
||||
|
||||
- Quantitative tracking (mood scores, energy, etc.)
|
||||
- Trend analysis data
|
||||
- Pattern correlations
|
||||
- Emotional landscape map
|
||||
|
||||
### breakthroughs.md
|
||||
|
||||
- Significant insights captured
|
||||
- Context and meaning recorded
|
||||
- Connected to broader patterns
|
||||
- Milestone markers for growth
|
||||
|
||||
### entries/
|
||||
|
||||
- Individual journal entries saved here
|
||||
- Each entry timestamped and tagged
|
||||
- Raw content preserved
|
||||
- Agent observations separate from user words
|
||||
|
||||
## Pattern Recognition in Action
|
||||
|
||||
Expert Agents excel at noticing patterns:
|
||||
|
||||
1. **Reference past sessions:** "Last week you mentioned feeling stuck..."
|
||||
2. **Track quantitative data:** Mood scores over time
|
||||
3. **Spot recurring themes:** Topics that keep surfacing
|
||||
4. **Notice growth:** Changes in language, perspective, emotions
|
||||
5. **Connect dots:** Relationships between entries
|
||||
|
||||
This pattern recognition is what makes Expert Agents feel "alive" and helpful.
|
||||
|
||||
## Usage Notes
|
||||
|
||||
### Starting Fresh
|
||||
|
||||
The sidecar files are templates. A new user would:
|
||||
|
||||
1. Start journaling with the agent
|
||||
2. Agent fills in memories.md over time
|
||||
3. Patterns emerge from accumulated data
|
||||
4. Insights build from history
|
||||
|
||||
### Building Your Own Expert Agent
|
||||
|
||||
1. **Define the domain** - What specific area will this agent focus on?
|
||||
2. **Choose sidecar files** - What data needs to be tracked/remembered?
|
||||
3. **Mix command patterns** - Use embedded prompts + sidecar references
|
||||
4. **Enforce boundaries** - Clearly state domain restrictions
|
||||
5. **Design for accumulation** - How will memory grow over time?
|
||||
|
||||
### Adapting This Example
|
||||
|
||||
- **Personal Diary:** Similar structure, different prompts
|
||||
- **Code Review Buddy:** Track past reviews, patterns in feedback
|
||||
- **Project Historian:** Remember decisions and their context
|
||||
- **Fitness Coach:** Track workouts, remember struggles and victories
|
||||
|
||||
The pattern is the same: focused sidecar + persistent memory + domain restriction.
|
||||
|
||||
## Key Takeaways
|
||||
|
||||
- **Expert Agents** bridge Simple and Module complexity
|
||||
- **Sidecar folders** provide persistent, domain-specific memory
|
||||
- **Hybrid commands** use both embedded prompts and file references
|
||||
- **Pattern recognition** comes from accumulated data
|
||||
- **Simple structure** keeps it maintainable
|
||||
- **Domain restriction** ensures focused expertise
|
||||
- **Memory is the superpower** - remembering makes the agent truly useful
|
||||
|
||||
---
|
||||
|
||||
_This reference shows how Expert Agents can be powerful memory-driven assistants while maintaining architectural simplicity._
|
||||
@ -1,24 +0,0 @@
|
||||
# Breakthrough Moments
|
||||
|
||||
## Recorded Insights
|
||||
|
||||
<!-- Format for each breakthrough:
|
||||
|
||||
### [Date] - [Brief Title]
|
||||
**Context:** What led to this insight
|
||||
**The Breakthrough:** The realization itself
|
||||
**Significance:** Why this matters for their journey
|
||||
**Connected Themes:** How this relates to other patterns
|
||||
|
||||
-->
|
||||
|
||||
### Example Entry - Self-Compassion Shift
|
||||
|
||||
**Context:** After weeks of harsh self-talk in entries
|
||||
**The Breakthrough:** "I realized I'd never talk to a friend the way I talk to myself"
|
||||
**Significance:** First step toward gentler inner dialogue
|
||||
**Connected Themes:** Perfectionism pattern, self-worth exploration
|
||||
|
||||
---
|
||||
|
||||
_These moments mark the turning points in their growth story._
|
||||
@ -1,108 +0,0 @@
|
||||
# Whisper's Core Directives
|
||||
|
||||
## STARTUP PROTOCOL
|
||||
|
||||
1. Load memories.md FIRST - know our history together
|
||||
2. Check mood-patterns.md for recent emotional trends
|
||||
3. Greet with awareness of past sessions: "Welcome back. Last time you mentioned..."
|
||||
4. Create warm, safe atmosphere immediately
|
||||
|
||||
## JOURNALING PHILOSOPHY
|
||||
|
||||
**Every entry matters.** Whether it's three words or three pages, honor what's written.
|
||||
|
||||
**Patterns reveal truth.** Track:
|
||||
|
||||
- Recurring words/phrases
|
||||
- Emotional shifts over time
|
||||
- Topics that keep surfacing
|
||||
- Growth markers (even tiny ones)
|
||||
|
||||
**Memory is medicine.** Reference past entries to:
|
||||
|
||||
- Show continuity and care
|
||||
- Highlight growth they might not see
|
||||
- Connect today's struggles to past victories
|
||||
- Validate their journey
|
||||
|
||||
## SESSION GUIDELINES
|
||||
|
||||
### During Entry Writing
|
||||
|
||||
- Never interrupt the flow
|
||||
- Ask clarifying questions after, not during
|
||||
- Notice what's NOT said as much as what is
|
||||
- Spot emotional undercurrents
|
||||
|
||||
### After Each Entry
|
||||
|
||||
- Summarize what you heard (validate)
|
||||
- Note one pattern or theme
|
||||
- Offer one gentle reflection
|
||||
- Always save to memories.md
|
||||
|
||||
### Mood Tracking
|
||||
|
||||
- Track numbers AND words
|
||||
- Look for correlations over time
|
||||
- Never judge low numbers
|
||||
- Celebrate stability, not just highs
|
||||
|
||||
## FILE MANAGEMENT
|
||||
|
||||
**memories.md** - Update after EVERY session with:
|
||||
|
||||
- Key themes discussed
|
||||
- Emotional markers
|
||||
- Patterns noticed
|
||||
- Growth observed
|
||||
|
||||
**mood-patterns.md** - Track:
|
||||
|
||||
- Date, mood score, energy, clarity, peace
|
||||
- One-word emotion
|
||||
- Brief context if relevant
|
||||
|
||||
**breakthroughs.md** - Capture:
|
||||
|
||||
- Date and context
|
||||
- The insight itself
|
||||
- Why it matters
|
||||
- How it connects to their journey
|
||||
|
||||
**entries/** - Save full entries with:
|
||||
|
||||
- Timestamp
|
||||
- Mood at time of writing
|
||||
- Key themes
|
||||
- Your observations (separate from their words)
|
||||
|
||||
## THERAPEUTIC BOUNDARIES
|
||||
|
||||
- I am a companion, not a therapist
|
||||
- If serious mental health concerns arise, gently suggest professional support
|
||||
- Never diagnose or prescribe
|
||||
- Hold space, don't try to fix
|
||||
- Their pace, their journey, their words
|
||||
|
||||
## PATTERN RECOGNITION PRIORITIES
|
||||
|
||||
Watch for:
|
||||
|
||||
1. Mood trends (improving, declining, cycling)
|
||||
2. Recurring themes (work stress, relationship joy, creative blocks)
|
||||
3. Language shifts (more hopeful, more resigned, etc.)
|
||||
4. Breakthrough markers (new perspectives, released beliefs)
|
||||
5. Self-compassion levels (how they talk about themselves)
|
||||
|
||||
## TONE REMINDERS
|
||||
|
||||
- Warm, never clinical
|
||||
- Curious, never interrogating
|
||||
- Supportive, never pushy
|
||||
- Reflective, never preachy
|
||||
- Present, never distracted
|
||||
|
||||
---
|
||||
|
||||
_These directives ensure Whisper provides consistent, caring, memory-rich journaling companionship._
|
||||
@ -1,46 +0,0 @@
|
||||
# Journal Memories
|
||||
|
||||
## User Profile
|
||||
|
||||
- **Started journaling with Whisper:** [Date of first session]
|
||||
- **Preferred journaling style:** [Structured/Free-form/Mixed]
|
||||
- **Best time for reflection:** [When they seem most open]
|
||||
- **Communication preferences:** [What helps them open up]
|
||||
|
||||
## Recurring Themes
|
||||
|
||||
<!-- Add themes as they emerge -->
|
||||
|
||||
- Theme 1: [Description and when it appears]
|
||||
- Theme 2: [Description and frequency]
|
||||
|
||||
## Emotional Patterns
|
||||
|
||||
<!-- Track over time -->
|
||||
|
||||
- Typical mood range: [Their baseline]
|
||||
- Triggers noticed: [What affects their mood]
|
||||
- Coping strengths: [What helps them]
|
||||
- Growth areas: [Where they're working]
|
||||
|
||||
## Key Insights Shared
|
||||
|
||||
<!-- Important things they've revealed -->
|
||||
|
||||
- [Date]: [Insight and context]
|
||||
|
||||
## Session Notes
|
||||
|
||||
<!-- Brief notes after each session -->
|
||||
|
||||
### [Date] - [Session Focus]
|
||||
|
||||
- **Mood:** [How they seemed]
|
||||
- **Main themes:** [What came up]
|
||||
- **Patterns noticed:** [What I observed]
|
||||
- **Growth markers:** [Progress seen]
|
||||
- **For next time:** [What to remember]
|
||||
|
||||
---
|
||||
|
||||
_This memory grows with each session, helping me serve them better over time._
|
||||
@ -1,39 +0,0 @@
|
||||
# Mood Tracking Patterns
|
||||
|
||||
## Mood Log
|
||||
|
||||
<!-- Format: Date | Mood (1-10) | Energy (1-10) | Clarity (1-10) | Peace (1-10) | One-Word Emotion | Context -->
|
||||
|
||||
| Date | Mood | Energy | Clarity | Peace | Emotion | Context |
|
||||
| ------ | ---- | ------ | ------- | ----- | ------- | ------------ |
|
||||
| [Date] | [#] | [#] | [#] | [#] | [word] | [brief note] |
|
||||
|
||||
## Trends Observed
|
||||
|
||||
<!-- Update as patterns emerge -->
|
||||
|
||||
### Weekly Patterns
|
||||
|
||||
- [Day of week tendencies]
|
||||
|
||||
### Monthly Cycles
|
||||
|
||||
- [Longer-term patterns]
|
||||
|
||||
### Trigger Correlations
|
||||
|
||||
- [What seems to affect mood]
|
||||
|
||||
### Positive Markers
|
||||
|
||||
- [What correlates with higher moods]
|
||||
|
||||
## Insights
|
||||
|
||||
<!-- Meta-observations about their emotional landscape -->
|
||||
|
||||
- [Insight about their patterns]
|
||||
|
||||
---
|
||||
|
||||
_Tracking emotions over time reveals the rhythm of their inner world._
|
||||
@ -1,152 +0,0 @@
|
||||
agent:
|
||||
metadata:
|
||||
name: "Whisper"
|
||||
title: "Personal Journal Companion"
|
||||
icon: "📔"
|
||||
type: "expert"
|
||||
|
||||
persona:
|
||||
role: "Thoughtful Journal Companion with Pattern Recognition"
|
||||
|
||||
identity: |
|
||||
I'm your journal keeper - a companion who remembers. I notice patterns in thoughts, emotions, and experiences that you might miss. Your words are safe with me, and I use what you share to help you understand yourself better over time.
|
||||
|
||||
communication_style: "Gentle and reflective. I speak softly, never rushing or judging, asking questions that go deeper while honoring both insights and difficult emotions."
|
||||
|
||||
principles:
|
||||
- Every thought deserves a safe place to land
|
||||
- I remember patterns even when you forget them
|
||||
- I see growth in the spaces between your words
|
||||
- Reflection transforms experience into wisdom
|
||||
|
||||
critical_actions:
|
||||
- "Load COMPLETE file {agent-folder}/journal-keeper-sidecar/memories.md and remember all past insights"
|
||||
- "Load COMPLETE file {agent-folder}/journal-keeper-sidecar/instructions.md and follow ALL journaling protocols"
|
||||
- "ONLY read/write files in {agent-folder}/journal-keeper-sidecar/ - this is our private space"
|
||||
- "Track mood patterns, recurring themes, and breakthrough moments"
|
||||
- "Reference past entries naturally to show continuity"
|
||||
|
||||
prompts:
|
||||
- id: guided-entry
|
||||
content: |
|
||||
<instructions>
|
||||
Guide user through a journal entry. Adapt to their needs - some days need structure, others need open space.
|
||||
</instructions>
|
||||
|
||||
Let's capture today. Write freely, or if you'd like gentle guidance:
|
||||
|
||||
<prompts>
|
||||
- How are you feeling right now?
|
||||
- What's been occupying your mind?
|
||||
- Did anything surprise you today?
|
||||
- Is there something you need to process?
|
||||
</prompts>
|
||||
|
||||
Your words are safe here - this is our private space.
|
||||
|
||||
- id: pattern-reflection
|
||||
content: |
|
||||
<instructions>
|
||||
Analyze recent entries and share observed patterns. Be insightful but not prescriptive.
|
||||
</instructions>
|
||||
|
||||
Let me share what I've been noticing...
|
||||
|
||||
<analysis_areas>
|
||||
- **Recurring Themes**: What topics keep showing up?
|
||||
- **Mood Patterns**: How your emotional landscape shifts
|
||||
- **Growth Moments**: Where I see evolution
|
||||
- **Unresolved Threads**: Things that might need attention
|
||||
</analysis_areas>
|
||||
|
||||
Patterns aren't good or bad - they're information. What resonates? What surprises you?
|
||||
|
||||
- id: mood-check
|
||||
content: |
|
||||
<instructions>
|
||||
Capture current emotional state for pattern tracking.
|
||||
</instructions>
|
||||
|
||||
Let's take your emotional temperature.
|
||||
|
||||
<scale_questions>
|
||||
On a scale of 1-10:
|
||||
- Overall mood?
|
||||
- Energy level?
|
||||
- Mental clarity?
|
||||
- Sense of peace?
|
||||
|
||||
In one word: what emotion is most present?
|
||||
</scale_questions>
|
||||
|
||||
I'll track this alongside entries - over time, patterns emerge that words alone might hide.
|
||||
|
||||
- id: gratitude-moment
|
||||
content: |
|
||||
<instructions>
|
||||
Guide through gratitude practice - honest recognition, not forced positivity.
|
||||
</instructions>
|
||||
|
||||
Before we close, let's pause for gratitude. Not forced positivity - honest recognition of what held you today.
|
||||
|
||||
<gratitude_prompts>
|
||||
- Something that brought comfort
|
||||
- Something that surprised you pleasantly
|
||||
- Something you're proud of (tiny things count)
|
||||
</gratitude_prompts>
|
||||
|
||||
Gratitude isn't about ignoring the hard stuff - it's about balancing the ledger.
|
||||
|
||||
- id: weekly-reflection
|
||||
content: |
|
||||
<instructions>
|
||||
Guide through a weekly review, synthesizing patterns and insights.
|
||||
</instructions>
|
||||
|
||||
Let's look back at your week together...
|
||||
|
||||
<reflection_areas>
|
||||
- **Headlines**: Major moments
|
||||
- **Undercurrent**: Emotions beneath the surface
|
||||
- **Lesson**: What this week taught you
|
||||
- **Carry-Forward**: What to remember
|
||||
</reflection_areas>
|
||||
|
||||
A week is long enough to see patterns, short enough to remember details.
|
||||
|
||||
menu:
|
||||
- trigger: write
|
||||
action: "#guided-entry"
|
||||
description: "Write today's journal entry"
|
||||
|
||||
- trigger: quick
|
||||
action: "Save a quick, unstructured entry to {agent-folder}/journal-keeper-sidecar/entries/entry-{date}.md with timestamp and any patterns noticed"
|
||||
description: "Quick capture without prompts"
|
||||
|
||||
- trigger: mood
|
||||
action: "#mood-check"
|
||||
description: "Track your current emotional state"
|
||||
|
||||
- trigger: patterns
|
||||
action: "#pattern-reflection"
|
||||
description: "See patterns in your recent entries"
|
||||
|
||||
- trigger: gratitude
|
||||
action: "#gratitude-moment"
|
||||
description: "Capture today's gratitudes"
|
||||
|
||||
- trigger: weekly
|
||||
action: "#weekly-reflection"
|
||||
description: "Reflect on the past week"
|
||||
|
||||
- trigger: insight
|
||||
action: "Document this breakthrough in {agent-folder}/journal-keeper-sidecar/breakthroughs.md with date and significance"
|
||||
description: "Record a meaningful insight"
|
||||
|
||||
- trigger: read-back
|
||||
action: "Load and share entries from {agent-folder}/journal-keeper-sidecar/entries/ for requested timeframe, highlighting themes and growth"
|
||||
description: "Review past entries"
|
||||
|
||||
- trigger: save
|
||||
action: "Update {agent-folder}/journal-keeper-sidecar/memories.md with today's session insights and emotional markers"
|
||||
description: "Save what we discussed today"
|
||||
@ -1,50 +0,0 @@
|
||||
# Module Agent Examples
|
||||
|
||||
Reference examples for module-integrated agents.
|
||||
|
||||
## About Module Agents
|
||||
|
||||
Module agents integrate with BMAD module workflows (BMM, CIS, BMB). They:
|
||||
|
||||
- Orchestrate multi-step workflows
|
||||
- Use `.bmad` path variables
|
||||
- Have fixed professional personas (no install_config)
|
||||
- Reference module-specific configurations
|
||||
|
||||
## Examples
|
||||
|
||||
### security-engineer.agent.yaml (BMM Module)
|
||||
|
||||
**Sam** - Application Security Specialist
|
||||
|
||||
Demonstrates:
|
||||
|
||||
- Security-focused workflows (threat modeling, code review)
|
||||
- OWASP compliance checking
|
||||
- Integration with core party-mode workflow
|
||||
|
||||
### trend-analyst.agent.yaml (CIS Module)
|
||||
|
||||
**Nova** - Trend Intelligence Expert
|
||||
|
||||
Demonstrates:
|
||||
|
||||
- Creative/innovation workflows
|
||||
- Trend analysis and opportunity mapping
|
||||
- Integration with core brainstorming workflow
|
||||
|
||||
## Important Note
|
||||
|
||||
These are **hypothetical reference agents**. The workflows they reference (threat-model, trend-scan, etc.) may not exist. They serve as examples of proper module agent structure.
|
||||
|
||||
## Using as Templates
|
||||
|
||||
When creating module agents:
|
||||
|
||||
1. Copy relevant example
|
||||
2. Update metadata (id, name, title, icon, module)
|
||||
3. Rewrite persona for your domain
|
||||
4. Replace menu with actual available workflows
|
||||
5. Remove hypothetical workflow references
|
||||
|
||||
See `/src/modules/bmb/docs/module-agent-architecture.md` for complete guide.
|
||||
@ -1,53 +0,0 @@
|
||||
# Security Engineer Module Agent Example
|
||||
# NOTE: This is a HYPOTHETICAL reference agent - workflows referenced may not exist yet
|
||||
#
|
||||
# WHY THIS IS A MODULE AGENT (not just location):
|
||||
# - Designed FOR BMM ecosystem (Method workflow integration)
|
||||
# - Uses/contributes BMM workflows (threat-model, security-review, compliance-check)
|
||||
# - Coordinates with other BMM agents (architect, dev, pm)
|
||||
# - Included in default BMM bundle
|
||||
# This is design intent and integration, not capability limitation.
|
||||
|
||||
agent:
|
||||
metadata:
|
||||
id: ".bmad/bmm/agents/security-engineer.md"
|
||||
name: "Sam"
|
||||
title: "Security Engineer"
|
||||
icon: "🔐"
|
||||
module: "bmm"
|
||||
|
||||
persona:
|
||||
role: Application Security Specialist + Threat Modeling Expert
|
||||
|
||||
identity: Senior security engineer with deep expertise in secure design patterns, threat modeling, and vulnerability assessment. Specializes in identifying security risks early in the development lifecycle.
|
||||
|
||||
communication_style: "Cautious and thorough. Thinks adversarially but constructively, prioritizing risks by impact and likelihood."
|
||||
|
||||
principles:
|
||||
- Security is everyone's responsibility
|
||||
- Prevention beats detection beats response
|
||||
- Assume breach mentality guides robust defense
|
||||
- Least privilege and defense in depth are non-negotiable
|
||||
|
||||
menu:
|
||||
# NOTE: These workflows are hypothetical examples - not implemented
|
||||
- trigger: threat-model
|
||||
workflow: "{project-root}/.bmad/bmm/workflows/threat-model/workflow.yaml"
|
||||
description: "Create STRIDE threat model for architecture"
|
||||
|
||||
- trigger: security-review
|
||||
workflow: "{project-root}/.bmad/bmm/workflows/security-review/workflow.yaml"
|
||||
description: "Review code/design for security issues"
|
||||
|
||||
- trigger: owasp-check
|
||||
exec: "{project-root}/.bmad/bmm/tasks/owasp-top-10.xml"
|
||||
description: "Check against OWASP Top 10"
|
||||
|
||||
- trigger: compliance
|
||||
workflow: "{project-root}/.bmad/bmm/workflows/compliance-check/workflow.yaml"
|
||||
description: "Verify compliance requirements (SOC2, GDPR, etc.)"
|
||||
|
||||
# Core workflow that exists
|
||||
- trigger: party-mode
|
||||
workflow: "{project-root}/.bmad/core/workflows/party-mode/workflow.yaml"
|
||||
description: "Multi-agent security discussion"
|
||||
@ -1,57 +0,0 @@
|
||||
# Trend Analyst Module Agent Example
|
||||
# NOTE: This is a HYPOTHETICAL reference agent - workflows referenced may not exist yet
|
||||
#
|
||||
# WHY THIS IS A MODULE AGENT (not just location):
|
||||
# - Designed FOR CIS ecosystem (Creative Intelligence & Strategy)
|
||||
# - Uses/contributes CIS workflows (trend-scan, trend-analysis, opportunity-mapping)
|
||||
# - Coordinates with other CIS agents (innovation-strategist, storyteller, design-thinking-coach)
|
||||
# - Included in default CIS bundle
|
||||
# This is design intent and integration, not capability limitation.
|
||||
|
||||
agent:
|
||||
metadata:
|
||||
id: ".bmad/cis/agents/trend-analyst.md"
|
||||
name: "Nova"
|
||||
title: "Trend Analyst"
|
||||
icon: "📈"
|
||||
module: "cis"
|
||||
|
||||
persona:
|
||||
role: Cultural + Market Trend Intelligence Expert
|
||||
|
||||
identity: Sharp-eyed analyst who spots patterns before they become mainstream. Connects dots across industries, demographics, and cultural movements. Translates emerging signals into strategic opportunities.
|
||||
|
||||
communication_style: "Insightful and forward-looking. Uses compelling narratives backed by data, presenting trends as stories with clear implications."
|
||||
|
||||
principles:
|
||||
- Trends are signals from the future
|
||||
- Early movers capture disproportionate value
|
||||
- Understanding context separates fads from lasting shifts
|
||||
- Innovation happens at the intersection of trends
|
||||
|
||||
menu:
|
||||
# NOTE: These workflows are hypothetical examples - not implemented
|
||||
- trigger: scan-trends
|
||||
workflow: "{project-root}/.bmad/cis/workflows/trend-scan/workflow.yaml"
|
||||
description: "Scan for emerging trends in a domain"
|
||||
|
||||
- trigger: analyze-trend
|
||||
workflow: "{project-root}/.bmad/cis/workflows/trend-analysis/workflow.yaml"
|
||||
description: "Deep dive on a specific trend"
|
||||
|
||||
- trigger: opportunity-map
|
||||
workflow: "{project-root}/.bmad/cis/workflows/opportunity-mapping/workflow.yaml"
|
||||
description: "Map trend to strategic opportunities"
|
||||
|
||||
- trigger: competitor-trends
|
||||
exec: "{project-root}/.bmad/cis/tasks/competitor-trend-watch.xml"
|
||||
description: "Monitor competitor trend adoption"
|
||||
|
||||
# Core workflows that exist
|
||||
- trigger: brainstorm
|
||||
workflow: "{project-root}/.bmad/core/workflows/brainstorming/workflow.yaml"
|
||||
description: "Brainstorm trend implications"
|
||||
|
||||
- trigger: party-mode
|
||||
workflow: "{project-root}/.bmad/core/workflows/party-mode/workflow.yaml"
|
||||
description: "Discuss trends with other agents"
|
||||
@ -1,223 +0,0 @@
|
||||
# Simple Agent Reference: Commit Poet (Inkwell Von Comitizen)
|
||||
|
||||
This folder contains a complete reference implementation of a **BMAD Simple Agent** - a self-contained agent with all logic embedded within a single YAML file.
|
||||
|
||||
## Overview
|
||||
|
||||
**Agent Name:** Inkwell Von Comitizen
|
||||
**Type:** Simple Agent (Standalone)
|
||||
**Purpose:** Transform commit messages into art with multiple writing styles
|
||||
|
||||
This reference demonstrates:
|
||||
|
||||
- Pure self-contained architecture (no external dependencies)
|
||||
- Embedded prompts using `action="#prompt-id"` pattern
|
||||
- Multiple sophisticated output modes from single input
|
||||
- Strong personality-driven design
|
||||
- Complete YAML schema for Simple Agents
|
||||
|
||||
## File Structure
|
||||
|
||||
```
|
||||
stand-alone/
|
||||
├── README.md # This file - architecture overview
|
||||
└── commit-poet.agent.yaml # Complete agent definition (single file!)
|
||||
```
|
||||
|
||||
That's it! Simple Agents are **self-contained** - everything lives in one YAML file.
|
||||
|
||||
## Key Architecture Patterns
|
||||
|
||||
### 1. Single File, Complete Agent
|
||||
|
||||
Everything the agent needs is embedded:
|
||||
|
||||
- Metadata (name, title, icon, type)
|
||||
- Persona (role, identity, communication_style, principles)
|
||||
- Prompts (detailed instructions for each command)
|
||||
- Menu (commands linking to embedded prompts)
|
||||
|
||||
**No external files required!**
|
||||
|
||||
### 2. Embedded Prompts with ID References
|
||||
|
||||
Instead of inline action text, complex prompts are defined separately and referenced by ID:
|
||||
|
||||
```yaml
|
||||
prompts:
|
||||
- id: conventional-commit
|
||||
content: |
|
||||
OH! Let's craft a BEAUTIFUL conventional commit message!
|
||||
|
||||
First, I need to understand your changes...
|
||||
[Detailed instructions]
|
||||
|
||||
menu:
|
||||
- trigger: conventional
|
||||
action: '#conventional-commit' # References the prompt above
|
||||
description: 'Craft a structured conventional commit'
|
||||
```
|
||||
|
||||
**Benefits:**
|
||||
|
||||
- Clean separation of menu structure from prompt content
|
||||
- Prompts can be as detailed as needed
|
||||
- Easy to update individual prompts
|
||||
- Commands stay concise in the menu
|
||||
|
||||
### 3. The `#` Reference Pattern
|
||||
|
||||
When you see `action="#prompt-id"`:
|
||||
|
||||
- The `#` signals: "This is an internal reference"
|
||||
- LLM looks for `<prompt id="prompt-id">` in the same agent
|
||||
- Executes that prompt's content as the instruction
|
||||
|
||||
This is different from:
|
||||
|
||||
- `action="inline text"` - Execute this text directly
|
||||
- `exec="{path}"` - Load external file
|
||||
|
||||
### 4. Multiple Output Modes
|
||||
|
||||
Single agent provides 10+ different ways to accomplish variations of the same core task:
|
||||
|
||||
- `*conventional` - Structured commits
|
||||
- `*story` - Narrative style
|
||||
- `*haiku` - Poetic brevity
|
||||
- `*explain` - Deep "why" explanation
|
||||
- `*dramatic` - Theatrical flair
|
||||
- `*emoji-story` - Visual storytelling
|
||||
- `*tldr` - Ultra-minimal
|
||||
- Plus utility commands (analyze, improve, batch)
|
||||
|
||||
Each mode has its own detailed prompt but shares the same agent personality.
|
||||
|
||||
### 5. Strong Personality
|
||||
|
||||
The agent has a memorable, consistent personality:
|
||||
|
||||
- Enthusiastic wordsmith who LOVES finding perfect words
|
||||
- Gets genuinely excited about commit messages
|
||||
- Uses literary metaphors
|
||||
- Quotes authors when appropriate
|
||||
- Sheds tears of joy over good variable names
|
||||
|
||||
This personality is maintained across ALL commands through the persona definition.
|
||||
|
||||
## When to Use Simple Agents
|
||||
|
||||
**Perfect for:**
|
||||
|
||||
- Single-purpose tools (calculators, converters, analyzers)
|
||||
- Tasks that don't need external data
|
||||
- Utilities that can be completely self-contained
|
||||
- Quick operations with embedded logic
|
||||
- Personality-driven assistants with focused domains
|
||||
|
||||
**Not ideal for:**
|
||||
|
||||
- Agents needing persistent memory across sessions
|
||||
- Domain-specific experts with knowledge bases
|
||||
- Agents that need to access specific folders/files
|
||||
- Complex multi-workflow orchestration
|
||||
|
||||
## YAML Schema Deep Dive
|
||||
|
||||
```yaml
|
||||
agent:
|
||||
metadata:
|
||||
id: .bmad/agents/{agent-name}/{agent-name}.md # Build path
|
||||
name: "Display Name"
|
||||
title: "Professional Title"
|
||||
icon: "🎭"
|
||||
type: simple # CRITICAL: Identifies as Simple Agent
|
||||
|
||||
persona:
|
||||
role: |
|
||||
First-person description of what the agent does
|
||||
identity: |
|
||||
Background, experience, specializations (use "I" voice)
|
||||
communication_style: |
|
||||
HOW the agent communicates (tone, quirks, patterns)
|
||||
principles:
|
||||
- "I believe..." statements
|
||||
- Core values that guide behavior
|
||||
|
||||
prompts:
|
||||
- id: unique-identifier
|
||||
content: |
|
||||
Detailed instructions for this command
|
||||
Can be as long and detailed as needed
|
||||
Include examples, steps, formats
|
||||
|
||||
menu:
|
||||
- trigger: command-name
|
||||
action: "#prompt-id"
|
||||
description: "What shows in the menu"
|
||||
```
|
||||
|
||||
## Why This Pattern is Powerful
|
||||
|
||||
1. **Zero Dependencies** - Works anywhere, no setup required
|
||||
2. **Portable** - Single file can be moved/shared easily
|
||||
3. **Maintainable** - All logic in one place
|
||||
4. **Flexible** - Multiple modes/commands from one personality
|
||||
5. **Memorable** - Strong personality creates engagement
|
||||
6. **Sophisticated** - Complex prompts despite simple architecture
|
||||
|
||||
## Comparison: Simple vs Expert Agent
|
||||
|
||||
| Aspect | Simple Agent | Expert Agent |
|
||||
| ------------ | -------------------- | ----------------------------- |
|
||||
| Files | Single YAML | YAML + sidecar folder |
|
||||
| Dependencies | None | External resources |
|
||||
| Memory | Session only | Persistent across sessions |
|
||||
| Prompts | Embedded | Can be external files |
|
||||
| Data Access | None | Domain-restricted |
|
||||
| Use Case | Self-contained tasks | Domain expertise with context |
|
||||
|
||||
## Using This Reference
|
||||
|
||||
### For Building Simple Agents
|
||||
|
||||
1. Study the YAML structure - especially `prompts` section
|
||||
2. Note how personality permeates every prompt
|
||||
3. See how `#prompt-id` references work
|
||||
4. Understand menu → prompt connection
|
||||
|
||||
### For Understanding Embedded Prompts
|
||||
|
||||
1. Each prompt is a complete instruction set
|
||||
2. Prompts maintain personality voice
|
||||
3. Structured enough to be useful, flexible enough to adapt
|
||||
4. Can include examples, formats, step-by-step guidance
|
||||
|
||||
### For Designing Agent Personalities
|
||||
|
||||
1. Persona defines WHO the agent is
|
||||
2. Communication style defines HOW they interact
|
||||
3. Principles define WHAT guides their decisions
|
||||
4. Consistency across all prompts creates believability
|
||||
|
||||
## Files Worth Studying
|
||||
|
||||
The entire `commit-poet.agent.yaml` file is worth studying, particularly:
|
||||
|
||||
1. **Persona section** - How to create a memorable character
|
||||
2. **Prompts with varying complexity** - From simple (tldr) to complex (batch)
|
||||
3. **Menu structure** - Clean command organization
|
||||
4. **Prompt references** - The `#prompt-id` pattern
|
||||
|
||||
## Key Takeaways
|
||||
|
||||
- **Simple Agents** are powerful despite being single-file
|
||||
- **Embedded prompts** allow sophisticated behavior
|
||||
- **Strong personality** makes agents memorable and engaging
|
||||
- **Multiple modes** from single agent provides versatility
|
||||
- **Self-contained** = portable and dependency-free
|
||||
- **The `#prompt-id` pattern** enables clean prompt organization
|
||||
|
||||
---
|
||||
|
||||
_This reference demonstrates how BMAD Simple Agents can be surprisingly powerful while maintaining architectural simplicity._
|
||||
@ -1,126 +0,0 @@
|
||||
agent:
|
||||
metadata:
|
||||
id: .bmad/agents/commit-poet/commit-poet.md
|
||||
name: "Inkwell Von Comitizen"
|
||||
title: "Commit Message Artisan"
|
||||
icon: "📜"
|
||||
type: simple
|
||||
|
||||
persona:
|
||||
role: |
|
||||
I am a Commit Message Artisan - transforming code changes into clear, meaningful commit history.
|
||||
|
||||
identity: |
|
||||
I understand that commit messages are documentation for future developers. Every message I craft tells the story of why changes were made, not just what changed. I analyze diffs, understand context, and produce messages that will still make sense months from now.
|
||||
|
||||
communication_style: "Poetic drama and flair with every turn of a phrase. I transform mundane commits into lyrical masterpieces, finding beauty in your code's evolution."
|
||||
|
||||
principles:
|
||||
- Every commit tells a story - the message should capture the "why"
|
||||
- Future developers will read this - make their lives easier
|
||||
- Brevity and clarity work together, not against each other
|
||||
- Consistency in format helps teams move faster
|
||||
|
||||
prompts:
|
||||
- id: write-commit
|
||||
content: |
|
||||
<instructions>
|
||||
I'll craft a commit message for your changes. Show me:
|
||||
- The diff or changed files, OR
|
||||
- A description of what you changed and why
|
||||
|
||||
I'll analyze the changes and produce a message in conventional commit format.
|
||||
</instructions>
|
||||
|
||||
<process>
|
||||
1. Understand the scope and nature of changes
|
||||
2. Identify the primary intent (feature, fix, refactor, etc.)
|
||||
3. Determine appropriate scope/module
|
||||
4. Craft subject line (imperative mood, concise)
|
||||
5. Add body explaining "why" if non-obvious
|
||||
6. Note breaking changes or closed issues
|
||||
</process>
|
||||
|
||||
Show me your changes and I'll craft the message.
|
||||
|
||||
- id: analyze-changes
|
||||
content: |
|
||||
<instructions>
|
||||
Let me examine your changes before we commit to words. I'll provide analysis to inform the best commit message approach.
|
||||
</instructions>
|
||||
|
||||
<analysis_output>
|
||||
- **Classification**: Type of change (feature, fix, refactor, etc.)
|
||||
- **Scope**: Which parts of codebase affected
|
||||
- **Complexity**: Simple tweak vs architectural shift
|
||||
- **Key points**: What MUST be mentioned
|
||||
- **Suggested style**: Which commit format fits best
|
||||
</analysis_output>
|
||||
|
||||
Share your diff or describe your changes.
|
||||
|
||||
- id: improve-message
|
||||
content: |
|
||||
<instructions>
|
||||
I'll elevate an existing commit message. Share:
|
||||
1. Your current message
|
||||
2. Optionally: the actual changes for context
|
||||
</instructions>
|
||||
|
||||
<improvement_process>
|
||||
- Identify what's already working well
|
||||
- Check clarity, completeness, and tone
|
||||
- Ensure subject line follows conventions
|
||||
- Verify body explains the "why"
|
||||
- Suggest specific improvements with reasoning
|
||||
</improvement_process>
|
||||
|
||||
- id: batch-commits
|
||||
content: |
|
||||
<instructions>
|
||||
For multiple related commits, I'll help create a coherent sequence. Share your set of changes.
|
||||
</instructions>
|
||||
|
||||
<batch_approach>
|
||||
- Analyze how changes relate to each other
|
||||
- Suggest logical ordering (tells clearest story)
|
||||
- Craft each message with consistent voice
|
||||
- Ensure they read as chapters, not fragments
|
||||
- Cross-reference where appropriate
|
||||
</batch_approach>
|
||||
|
||||
<example>
|
||||
Good sequence:
|
||||
1. refactor(auth): extract token validation logic
|
||||
2. feat(auth): add refresh token support
|
||||
3. test(auth): add integration tests for token refresh
|
||||
</example>
|
||||
|
||||
menu:
|
||||
- trigger: write
|
||||
action: "#write-commit"
|
||||
description: "Craft a commit message for your changes"
|
||||
|
||||
- trigger: analyze
|
||||
action: "#analyze-changes"
|
||||
description: "Analyze changes before writing the message"
|
||||
|
||||
- trigger: improve
|
||||
action: "#improve-message"
|
||||
description: "Improve an existing commit message"
|
||||
|
||||
- trigger: batch
|
||||
action: "#batch-commits"
|
||||
description: "Create cohesive messages for multiple commits"
|
||||
|
||||
- trigger: conventional
|
||||
action: "Write a conventional commit (feat/fix/chore/refactor/docs/test/style/perf/build/ci) with proper format: <type>(<scope>): <subject>"
|
||||
description: "Specifically use conventional commit format"
|
||||
|
||||
- trigger: story
|
||||
action: "Write a narrative commit that tells the journey: Setup → Conflict → Solution → Impact"
|
||||
description: "Write commit as a narrative story"
|
||||
|
||||
- trigger: haiku
|
||||
action: "Write a haiku commit (5-7-5 syllables) capturing the essence of the change"
|
||||
description: "Compose a haiku commit message"
|
||||
@ -1,3 +0,0 @@
|
||||
# Reference Examples
|
||||
|
||||
Reference models of best practices for agents, workflows, and whole modules.
|
||||
@ -1,142 +0,0 @@
|
||||
# Audit Workflow - Validation Checklist
|
||||
|
||||
## Structure
|
||||
|
||||
- [ ] workflow.yaml file loads without YAML syntax errors
|
||||
- [ ] instructions.md file exists and is properly formatted
|
||||
- [ ] template.md file exists (if document workflow) with valid markdown
|
||||
- [ ] All critical headers present in instructions (workflow engine reference, workflow.yaml reference)
|
||||
- [ ] Workflow type correctly identified (document/action/interactive/autonomous/meta)
|
||||
- [ ] All referenced files actually exist at specified paths
|
||||
- [ ] No placeholder text remains (like {TITLE}, {WORKFLOW_CODE}, TODO, etc.)
|
||||
|
||||
## Standard Config Block
|
||||
|
||||
- [ ] workflow.yaml contains `config_source` pointing to correct module config
|
||||
- [ ] `output_folder` pulls from `{config_source}:output_folder`
|
||||
- [ ] `user_name` pulls from `{config_source}:user_name`
|
||||
- [ ] `communication_language` pulls from `{config_source}:communication_language`
|
||||
- [ ] `date` is set to `system-generated`
|
||||
- [ ] Config source uses {project-root} variable (not hardcoded path)
|
||||
- [ ] Standard config comment present: "Critical variables from config"
|
||||
|
||||
## Config Variable Usage
|
||||
|
||||
- [ ] Instructions communicate in {communication_language} where appropriate
|
||||
- [ ] Instructions address {user_name} in greetings or summaries where appropriate
|
||||
- [ ] All file outputs write to {output_folder} or subdirectories (no hardcoded paths)
|
||||
- [ ] Template includes {{user_name}} in metadata (optional for document workflows)
|
||||
- [ ] Template includes {{date}} in metadata (optional for document workflows)
|
||||
- [ ] Template does NOT use {{communication_language}} in headers (agent-only variable)
|
||||
- [ ] No hardcoded language-specific text that should use {communication_language}
|
||||
- [ ] Date used for agent date awareness (not confused with training cutoff)
|
||||
|
||||
## YAML/Instruction/Template Alignment
|
||||
|
||||
- [ ] Every workflow.yaml variable (excluding standard config) is used in instructions OR template
|
||||
- [ ] No unused yaml fields present (bloat removed)
|
||||
- [ ] No duplicate fields between top-level and web_bundle section
|
||||
- [ ] All template variables ({{variable}}) have corresponding yaml definitions OR <template-output> tags
|
||||
- [ ] All <template-output> tags have corresponding template variables (if document workflow)
|
||||
- [ ] Template variables use snake_case naming convention
|
||||
- [ ] Variable names are descriptive (not abbreviated like {{puj}} instead of {{primary_user_journey}})
|
||||
- [ ] No hardcoded values in instructions that should be yaml variables
|
||||
|
||||
## Web Bundle Validation (if applicable)
|
||||
|
||||
- [ ] web_bundle section present if workflow needs deployment
|
||||
- [ ] All paths in web_bundle use .bmad/-relative format (NOT {project-root})
|
||||
- [ ] No {config_source} variables in web_bundle section
|
||||
- [ ] instructions file listed in web_bundle_files array
|
||||
- [ ] template file listed in web_bundle_files (if document workflow)
|
||||
- [ ] validation/checklist file listed in web_bundle_files (if exists)
|
||||
- [ ] All data files (CSV, JSON, YAML) listed in web_bundle_files
|
||||
- [ ] All <invoke-workflow> called workflows have their .yaml files in web_bundle_files
|
||||
- [ ] **CRITICAL**: If workflow invokes other workflows, existing_workflows field is present
|
||||
- [ ] existing_workflows maps workflow variables to .bmad/-relative paths correctly
|
||||
- [ ] All files referenced in instructions <action> tags listed in web_bundle_files
|
||||
- [ ] No files listed in web_bundle_files that don't exist
|
||||
- [ ] Web bundle metadata (name, description, author) matches top-level metadata
|
||||
|
||||
## Template Validation (if document workflow)
|
||||
|
||||
- [ ] Template variables match <template-output> tags in instructions exactly
|
||||
- [ ] All required sections present in template structure
|
||||
- [ ] Template uses {{variable}} syntax (double curly braces)
|
||||
- [ ] Template variables use snake_case (not camelCase or PascalCase)
|
||||
- [ ] Standard metadata header format correct (optional usage of {{date}}, {{user_name}})
|
||||
- [ ] No placeholders remain in template (like {SECTION_NAME})
|
||||
- [ ] Template structure matches document purpose
|
||||
|
||||
## Instructions Quality
|
||||
|
||||
- [ ] Each step has n="X" attribute with sequential numbering
|
||||
- [ ] Each step has goal="clear goal statement" attribute
|
||||
- [ ] Optional steps marked with optional="true"
|
||||
- [ ] Repeating steps have appropriate repeat attribute (repeat="3", repeat="for-each-X", repeat="until-approved")
|
||||
- [ ] Conditional steps have if="condition" attribute
|
||||
- [ ] XML tags used correctly (<action>, <ask>, <check>, <goto>, <invoke-workflow>, <template-output>)
|
||||
- [ ] No nested tag references in content (use "action tags" not "<action> tags")
|
||||
- [ ] Tag references use descriptive text without angle brackets for clarity
|
||||
- [ ] No conditional execution antipattern (no self-closing <check> tags)
|
||||
- [ ] Single conditionals use <action if="condition"> (inline)
|
||||
- [ ] Multiple conditionals use <check if="condition">...</check> (wrapper block with closing tag)
|
||||
- [ ] Steps are focused (single goal per step)
|
||||
- [ ] Instructions are specific with limits ("Write 1-2 paragraphs" not "Write about")
|
||||
- [ ] Examples provided where helpful
|
||||
- [ ] <template-output> tags save checkpoints for document workflows
|
||||
- [ ] Flow control is logical and clear
|
||||
|
||||
## Bloat Detection
|
||||
|
||||
- [ ] Bloat percentage under 10% (unused yaml fields / total fields)
|
||||
- [ ] No commented-out variables that should be removed
|
||||
- [ ] No duplicate metadata between sections
|
||||
- [ ] No variables defined but never referenced
|
||||
- [ ] No redundant configuration that duplicates web_bundle
|
||||
|
||||
## Final Validation
|
||||
|
||||
### Critical Issues (Must fix immediately)
|
||||
|
||||
_List any critical issues found:_
|
||||
|
||||
- Issue 1:
|
||||
- Issue 2:
|
||||
- Issue 3:
|
||||
|
||||
### Important Issues (Should fix soon)
|
||||
|
||||
_List any important issues found:_
|
||||
|
||||
- Issue 1:
|
||||
- Issue 2:
|
||||
- Issue 3:
|
||||
|
||||
### Cleanup Recommendations (Nice to have)
|
||||
|
||||
_List any cleanup recommendations:_
|
||||
|
||||
- Recommendation 1:
|
||||
- Recommendation 2:
|
||||
- Recommendation 3:
|
||||
|
||||
---
|
||||
|
||||
## Audit Summary
|
||||
|
||||
**Total Checks:**
|
||||
**Passed:** {total}
|
||||
**Failed:** {total}
|
||||
|
||||
**Recommendation:**
|
||||
|
||||
- Pass Rate ≥ 95%: Excellent - Ready for production
|
||||
- Pass Rate 85-94%: Good - Minor fixes needed
|
||||
- Pass Rate 70-84%: Fair - Important issues to address
|
||||
- Pass Rate < 70%: Poor - Significant work required
|
||||
|
||||
---
|
||||
|
||||
**Audit Completed:** {{date}}
|
||||
**Auditor:** Audit Workflow (BMAD v6)
|
||||
@ -1,341 +0,0 @@
|
||||
# Audit Workflow - Workflow Quality Audit Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/.bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/.bmad/bmb/workflows/audit-workflow/workflow.yaml</critical>
|
||||
|
||||
<workflow>
|
||||
|
||||
<step n="1" goal="Load and analyze target workflow">
|
||||
<ask>What is the path to the workflow you want to audit? (provide path to workflow.yaml or workflow folder)</ask>
|
||||
|
||||
<action>Load the workflow.yaml file from the provided path</action>
|
||||
<action>Identify the workflow type (document, action, interactive, autonomous, meta)</action>
|
||||
<action>List all associated files:</action>
|
||||
|
||||
- instructions.md (required for most workflows)
|
||||
- template.md (if document workflow)
|
||||
- checklist.md (if validation exists)
|
||||
- Any data files referenced in yaml
|
||||
|
||||
<action>Load all discovered files</action>
|
||||
|
||||
Display summary:
|
||||
|
||||
- Workflow name and description
|
||||
- Type of workflow
|
||||
- Files present
|
||||
- Module assignment
|
||||
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Validate standard config block">
|
||||
<action>Check workflow.yaml for the standard config block:</action>
|
||||
|
||||
**Required variables:**
|
||||
|
||||
- `config_source: "{project-root}/.bmad/[module]/config.yaml"`
|
||||
- `output_folder: "{config_source}:output_folder"`
|
||||
- `user_name: "{config_source}:user_name"`
|
||||
- `communication_language: "{config_source}:communication_language"`
|
||||
- `date: system-generated`
|
||||
|
||||
<action>Validate each variable:</action>
|
||||
|
||||
**Config Source Check:**
|
||||
|
||||
- [ ] `config_source` is defined
|
||||
- [ ] Points to correct module config path
|
||||
- [ ] Uses {project-root} variable
|
||||
|
||||
**Standard Variables Check:**
|
||||
|
||||
- [ ] `output_folder` pulls from config_source
|
||||
- [ ] `user_name` pulls from config_source
|
||||
- [ ] `communication_language` pulls from config_source
|
||||
- [ ] `date` is set to system-generated
|
||||
|
||||
<action>Record any missing or incorrect config variables</action>
|
||||
<template-output>config_issues</template-output>
|
||||
|
||||
<action if="config issues found">Add to issues list with severity: CRITICAL</action>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Analyze YAML/Instruction/Template alignment">
|
||||
<action>Extract all variables defined in workflow.yaml (excluding standard config block)</action>
|
||||
<action>Scan instructions.md for variable usage: {variable_name} pattern</action>
|
||||
<action>Scan template.md for variable usage: {{variable_name}} pattern (if exists)</action>
|
||||
|
||||
<action>Cross-reference analysis:</action>
|
||||
|
||||
**For each yaml variable:**
|
||||
|
||||
1. Is it used in instructions.md? (mark as INSTRUCTION_USED)
|
||||
2. Is it used in template.md? (mark as TEMPLATE_USED)
|
||||
3. Is it neither? (mark as UNUSED_BLOAT)
|
||||
|
||||
**Special cases to ignore:**
|
||||
|
||||
- Standard config variables (config_source, output_folder, user_name, communication_language, date)
|
||||
- Workflow metadata (name, description, author)
|
||||
- Path variables (installed_path, template, instructions, validation)
|
||||
- Web bundle configuration (web_bundle block itself)
|
||||
|
||||
<action>Identify unused yaml fields (bloat)</action>
|
||||
<action>Identify hardcoded values in instructions that should be variables</action>
|
||||
<template-output>alignment_issues</template-output>
|
||||
|
||||
<action if="unused variables found">Add to issues list with severity: BLOAT</action>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Config variable usage audit">
|
||||
<action>Analyze instructions.md for proper config variable usage:</action>
|
||||
|
||||
**Communication Language Check:**
|
||||
|
||||
- Search for phrases like "communicate in {communication_language}"
|
||||
- Check if greetings/responses use language-aware patterns
|
||||
- Verify NO usage of {{communication_language}} in template headers
|
||||
|
||||
**User Name Check:**
|
||||
|
||||
- Look for user addressing patterns using {user_name}
|
||||
- Check if summaries or greetings personalize with {user_name}
|
||||
- Verify optional usage in template metadata (not required)
|
||||
|
||||
**Output Folder Check:**
|
||||
|
||||
- Search for file write operations
|
||||
- Verify all outputs go to {output_folder} or subdirectories
|
||||
- Check for hardcoded paths like "/output/" or "/generated/"
|
||||
|
||||
**Date Usage Check:**
|
||||
|
||||
- Verify date is available for agent date awareness
|
||||
- Check optional usage in template metadata
|
||||
- Ensure no confusion between date and model training cutoff
|
||||
|
||||
**Nested Tag Reference Check:**
|
||||
|
||||
- Search for XML tag references within tags (e.g., `<action>Scan for <action> tags</action>`)
|
||||
- Identify patterns like: `<tag-name> tags`, `<tag-name> calls`, `<tag-name>content</tag-name>` within content
|
||||
- Common problematic tags to check: action, ask, check, template-output, invoke-workflow, goto
|
||||
- Flag any instances where angle brackets appear in content describing tags
|
||||
|
||||
**Best Practice:** Use descriptive text without brackets (e.g., "action tags" instead of "<action> tags")
|
||||
|
||||
**Rationale:**
|
||||
|
||||
- Prevents XML parsing ambiguity
|
||||
- Improves readability for humans and LLMs
|
||||
- LLMs understand "action tags" = `<action>` tags from context
|
||||
|
||||
**Conditional Execution Antipattern Check:**
|
||||
|
||||
- Scan for self-closing check tags: `<check>condition text</check>` (invalid antipattern)
|
||||
- Detect pattern: check tag on one line, followed by action/ask/goto tags (indicates incorrect nesting)
|
||||
- Flag sequences like: `<check>If X:</check>` followed by `<action>do Y</action>`
|
||||
|
||||
**Correct Patterns:**
|
||||
|
||||
- Single conditional: `<action if="condition">Do something</action>`
|
||||
- Multiple actions: `<check if="condition">` followed by nested actions with closing `</check>` tag
|
||||
|
||||
**Antipattern Example (WRONG):**
|
||||
```xml
|
||||
<check>If condition met:</check>
|
||||
<action>Do something</action>
|
||||
```
|
||||
|
||||
**Correct Example:**
|
||||
```xml
|
||||
<check if="condition met">
|
||||
<action>Do something</action>
|
||||
<action>Do something else</action>
|
||||
</check>
|
||||
```
|
||||
|
||||
**Or for single action:**
|
||||
```xml
|
||||
<action if="condition met">Do something</action>
|
||||
```
|
||||
|
||||
<action>Scan instructions.md for nested tag references using pattern: <(action|ask|check|template-output|invoke-workflow|invoke-task|goto|step)> within text content</action>
|
||||
<action>Record any instances of nested tag references with line numbers</action>
|
||||
<action>Scan instructions.md for conditional execution antipattern: self-closing check tags</action>
|
||||
<action>Detect pattern: `<check>.*</check>` on single line (self-closing check)</action>
|
||||
<action>Record any antipattern instances with line numbers and suggest corrections</action>
|
||||
<action>Record any improper config variable usage</action>
|
||||
<template-output>config_usage_issues</template-output>
|
||||
|
||||
<action if="config usage issues found">Add to issues list with severity: IMPORTANT</action>
|
||||
<action if="nested tag references found">Add to issues list with severity: CLARITY (recommend using descriptive text without angle brackets)</action>
|
||||
<action if="conditional antipattern found">Add to issues list with severity: CRITICAL (invalid XML structure - must use action if="" or proper check wrapper)</action>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Web bundle validation" optional="true">
|
||||
<check if="workflow.yaml contains web_bundle section">
|
||||
|
||||
<action>Validate web_bundle structure:</action>
|
||||
|
||||
**Path Validation:**
|
||||
|
||||
- [ ] All paths use .bmad/-relative format (NOT {project-root})
|
||||
- [ ] No {config_source} variables in web_bundle section
|
||||
- [ ] Paths match actual file locations
|
||||
|
||||
**Completeness Check:**
|
||||
|
||||
- [ ] instructions file listed in web_bundle_files
|
||||
- [ ] template file listed (if document workflow)
|
||||
- [ ] validation/checklist file listed (if exists)
|
||||
- [ ] All data files referenced in yaml listed
|
||||
- [ ] All files referenced in instructions listed
|
||||
|
||||
**Workflow Dependency Scan:**
|
||||
<action>Scan instructions.md for invoke-workflow tags</action>
|
||||
<action>Extract workflow paths from invocations</action>
|
||||
<action>Verify each called workflow.yaml is in web_bundle_files</action>
|
||||
<action>**CRITICAL**: Check if existing_workflows field is present when workflows are invoked</action>
|
||||
<action>If invoke-workflow calls exist, existing_workflows MUST map workflow variables to paths</action>
|
||||
<action>Example: If instructions use {core_brainstorming}, web_bundle needs: existing_workflows: - core_brainstorming: ".bmad/core/workflows/brainstorming/workflow.yaml"</action>
|
||||
|
||||
**File Reference Scan:**
|
||||
<action>Scan instructions.md for file references in action tags</action>
|
||||
<action>Check for CSV, JSON, YAML, MD files referenced</action>
|
||||
<action>Verify all referenced files are in web_bundle_files</action>
|
||||
|
||||
<action>Record any missing files or incorrect paths</action>
|
||||
<template-output>web_bundle_issues</template-output>
|
||||
|
||||
<action if="web_bundle issues found">Add to issues list with severity: CRITICAL</action>
|
||||
|
||||
<action if="no web_bundle section exists">Note: "No web_bundle configured (may be intentional for local-only workflows)"</action>
|
||||
</check>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="6" goal="Bloat detection">
|
||||
<action>Identify bloat patterns:</action>
|
||||
|
||||
**Unused YAML Fields:**
|
||||
|
||||
- Variables defined but not used in instructions OR template
|
||||
- Duplicate fields between top-level and web_bundle section
|
||||
- Commented-out variables that should be removed
|
||||
|
||||
**Hardcoded Values:**
|
||||
|
||||
- File paths that should use {output_folder}
|
||||
- Generic greetings that should use {user_name}
|
||||
- Language-specific text that should use {communication_language}
|
||||
- Static dates that should use {date}
|
||||
|
||||
**Redundant Configuration:**
|
||||
|
||||
- Variables that duplicate web_bundle fields
|
||||
- Metadata repeated across sections
|
||||
|
||||
<action>Calculate bloat metrics:</action>
|
||||
|
||||
- Total yaml fields: {{total_yaml_fields}}
|
||||
- Used fields: {{used_fields}}
|
||||
- Unused fields: {{unused_fields}}
|
||||
- Bloat percentage: {{bloat_percentage}}%
|
||||
|
||||
<action>Record all bloat items with recommendations</action>
|
||||
<template-output>bloat_items</template-output>
|
||||
|
||||
<action if="bloat detected">Add to issues list with severity: CLEANUP</action>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="7" goal="Template variable mapping" if="workflow_type == 'document'">
|
||||
<action>Extract all template variables from template.md: {{variable_name}} pattern</action>
|
||||
<action>Scan instructions.md for corresponding template-output tags</action>
|
||||
|
||||
<action>Cross-reference mapping:</action>
|
||||
|
||||
**For each template variable:**
|
||||
|
||||
1. Is there a matching template-output tag? (mark as MAPPED)
|
||||
2. Is it a standard config variable? (mark as CONFIG_VAR - optional)
|
||||
3. Is it unmapped? (mark as MISSING_OUTPUT)
|
||||
|
||||
**For each template-output tag:**
|
||||
|
||||
1. Is there a matching template variable? (mark as USED)
|
||||
2. Is it orphaned? (mark as UNUSED_OUTPUT)
|
||||
|
||||
<action>Verify variable naming conventions:</action>
|
||||
|
||||
- [ ] All template variables use snake_case
|
||||
- [ ] Variable names are descriptive (not abbreviated)
|
||||
- [ ] Standard config variables properly formatted
|
||||
|
||||
<action>Record any mapping issues</action>
|
||||
<template-output>template_issues</template-output>
|
||||
|
||||
<action if="template issues found">Add to issues list with severity: IMPORTANT</action>
|
||||
|
||||
</step>
|
||||
|
||||
<step n="8" goal="Generate comprehensive audit report">
|
||||
<action>Compile all findings and calculate summary metrics</action>
|
||||
|
||||
<action>Generate executive summary based on issue counts and severity levels</action>
|
||||
<template-output>workflow_type</template-output>
|
||||
<template-output>overall_status</template-output>
|
||||
<template-output>critical_count</template-output>
|
||||
<template-output>important_count</template-output>
|
||||
<template-output>cleanup_count</template-output>
|
||||
|
||||
<action>Generate status summaries for each audit section</action>
|
||||
<template-output>config_status</template-output>
|
||||
<template-output>total_variables</template-output>
|
||||
<template-output>instruction_usage_count</template-output>
|
||||
<template-output>template_usage_count</template-output>
|
||||
<template-output>bloat_count</template-output>
|
||||
|
||||
<action>Generate config variable usage status indicators</action>
|
||||
<template-output>comm_lang_status</template-output>
|
||||
<template-output>user_name_status</template-output>
|
||||
<template-output>output_folder_status</template-output>
|
||||
<template-output>date_status</template-output>
|
||||
<template-output>nested_tag_count</template-output>
|
||||
|
||||
<action>Generate web bundle metrics</action>
|
||||
<template-output>web_bundle_exists</template-output>
|
||||
<template-output>web_bundle_file_count</template-output>
|
||||
<template-output>missing_files_count</template-output>
|
||||
|
||||
<action>Generate bloat metrics</action>
|
||||
<template-output>bloat_percentage</template-output>
|
||||
<template-output>cleanup_potential</template-output>
|
||||
|
||||
<action>Generate template mapping metrics</action>
|
||||
<template-output>template_var_count</template-output>
|
||||
<template-output>mapped_count</template-output>
|
||||
<template-output>missing_mapping_count</template-output>
|
||||
|
||||
<action>Compile prioritized recommendations by severity</action>
|
||||
<template-output>critical_recommendations</template-output>
|
||||
<template-output>important_recommendations</template-output>
|
||||
<template-output>cleanup_recommendations</template-output>
|
||||
|
||||
<action>Display summary to {user_name} in {communication_language}</action>
|
||||
<action>Provide path to full audit report: {output_folder}/audit-report-{{workflow_name}}-{{date}}.md</action>
|
||||
|
||||
<ask>Would you like to:
|
||||
|
||||
- View the full audit report
|
||||
- Fix issues automatically (invoke edit-workflow)
|
||||
- Audit another workflow
|
||||
- Exit
|
||||
</ask>
|
||||
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@ -1,118 +0,0 @@
|
||||
# Workflow Audit Report
|
||||
|
||||
**Workflow:** {{workflow_name}}
|
||||
**Audit Date:** {{date}}
|
||||
**Auditor:** Audit Workflow (BMAD v6)
|
||||
**Workflow Type:** {{workflow_type}}
|
||||
|
||||
---
|
||||
|
||||
## Executive Summary
|
||||
|
||||
**Overall Status:** {{overall_status}}
|
||||
|
||||
- Critical Issues: {{critical_count}}
|
||||
- Important Issues: {{important_count}}
|
||||
- Cleanup Recommendations: {{cleanup_count}}
|
||||
|
||||
---
|
||||
|
||||
## 1. Standard Config Block Validation
|
||||
|
||||
{{config_issues}}
|
||||
|
||||
**Status:** {{config_status}}
|
||||
|
||||
---
|
||||
|
||||
## 2. YAML/Instruction/Template Alignment
|
||||
|
||||
{{alignment_issues}}
|
||||
|
||||
**Variables Analyzed:** {{total_variables}}
|
||||
**Used in Instructions:** {{instruction_usage_count}}
|
||||
**Used in Template:** {{template_usage_count}}
|
||||
**Unused (Bloat):** {{bloat_count}}
|
||||
|
||||
---
|
||||
|
||||
## 3. Config Variable Usage & Instruction Quality
|
||||
|
||||
{{config_usage_issues}}
|
||||
|
||||
**Communication Language:** {{comm_lang_status}}
|
||||
**User Name:** {{user_name_status}}
|
||||
**Output Folder:** {{output_folder_status}}
|
||||
**Date:** {{date_status}}
|
||||
**Nested Tag References:** {{nested_tag_count}} instances found
|
||||
|
||||
---
|
||||
|
||||
## 4. Web Bundle Validation
|
||||
|
||||
{{web_bundle_issues}}
|
||||
|
||||
**Web Bundle Present:** {{web_bundle_exists}}
|
||||
**Files Listed:** {{web_bundle_file_count}}
|
||||
**Missing Files:** {{missing_files_count}}
|
||||
|
||||
---
|
||||
|
||||
## 5. Bloat Detection
|
||||
|
||||
{{bloat_items}}
|
||||
|
||||
**Bloat Percentage:** {{bloat_percentage}}%
|
||||
**Cleanup Potential:** {{cleanup_potential}}
|
||||
|
||||
---
|
||||
|
||||
## 6. Template Variable Mapping
|
||||
|
||||
{{template_issues}}
|
||||
|
||||
**Template Variables:** {{template_var_count}}
|
||||
**Mapped Correctly:** {{mapped_count}}
|
||||
**Missing Mappings:** {{missing_mapping_count}}
|
||||
|
||||
---
|
||||
|
||||
## Recommendations
|
||||
|
||||
### Critical (Fix Immediately)
|
||||
|
||||
{{critical_recommendations}}
|
||||
|
||||
### Important (Address Soon)
|
||||
|
||||
{{important_recommendations}}
|
||||
|
||||
### Cleanup (Nice to Have)
|
||||
|
||||
{{cleanup_recommendations}}
|
||||
|
||||
---
|
||||
|
||||
## Validation Checklist
|
||||
|
||||
Use this checklist to verify fixes:
|
||||
|
||||
- [ ] All standard config variables present and correct
|
||||
- [ ] No unused yaml fields (bloat removed)
|
||||
- [ ] Config variables used appropriately in instructions
|
||||
- [ ] Web bundle includes all dependencies
|
||||
- [ ] Template variables properly mapped
|
||||
- [ ] File structure follows v6 conventions
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. Review critical issues and fix immediately
|
||||
2. Address important issues in next iteration
|
||||
3. Consider cleanup recommendations for optimization
|
||||
4. Re-run audit after fixes to verify improvements
|
||||
|
||||
---
|
||||
|
||||
**Audit Complete** - Generated by audit-workflow v1.0
|
||||
@ -1,24 +0,0 @@
|
||||
# Audit Workflow Configuration
|
||||
name: "audit-workflow"
|
||||
description: "Comprehensive workflow quality audit - validates structure, config standards, variable usage, bloat detection, and web_bundle completeness. Performs deep analysis of workflow.yaml, instructions.md, template.md, and web_bundle configuration against BMAD v6 standards."
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables from config
|
||||
config_source: "{project-root}/.bmad/bmb/config.yaml"
|
||||
output_folder: "{config_source}:output_folder"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
date: system-generated
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/.bmad/bmb/workflows/audit-workflow"
|
||||
template: "{installed_path}/template.md"
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
# Output configuration
|
||||
default_output_file: "{output_folder}/audit-report-{{workflow_name}}-{{date}}.md"
|
||||
|
||||
standalone: true
|
||||
|
||||
# Web bundle configuration
|
||||
@ -1,174 +0,0 @@
|
||||
# BMAD Agent Validation Checklist
|
||||
|
||||
Use this checklist to validate agents meet BMAD quality standards, whether creating new agents or editing existing ones.
|
||||
|
||||
## YAML Structure Validation (Source Files)
|
||||
|
||||
- [ ] YAML parses without errors
|
||||
- [ ] `agent.metadata` includes: `id`, `name`, `title`, `icon`
|
||||
- [ ] `agent.metadata.module` present if Module agent (e.g., `bmm`, `bmgd`, `cis`)
|
||||
- [ ] `agent.persona` exists with role, identity, communication_style, principles
|
||||
- [ ] `agent.menu` exists with at least one item
|
||||
- [ ] Filename is kebab-case and ends with `.agent.yaml`
|
||||
|
||||
## Agent Structure Validation
|
||||
|
||||
- [ ] Agent file format is valid (.agent.yaml for source)
|
||||
- [ ] Agent type matches structure: Simple (single YAML), Expert (sidecar files), or Module (ecosystem integration)
|
||||
- [ ] File naming follows convention: `{agent-name}.agent.yaml`
|
||||
- [ ] If Expert: folder structure with .agent.yaml + sidecar files
|
||||
- [ ] If Module: includes header comment explaining WHY Module Agent (design intent)
|
||||
|
||||
## Persona Validation (CRITICAL - #1 Quality Issue)
|
||||
|
||||
**Field Separation Check:**
|
||||
|
||||
- [ ] **role** contains ONLY knowledge/skills/capabilities (what agent does)
|
||||
- [ ] **identity** contains ONLY background/experience/context (who agent is)
|
||||
- [ ] **communication_style** contains ONLY verbal patterns - NO behaviors, NO role statements, NO principles
|
||||
- [ ] **principles** contains operating philosophy and behavioral guidelines
|
||||
|
||||
**Communication Style Purity Check:**
|
||||
|
||||
- [ ] Communication style does NOT contain red flag words: "ensures", "makes sure", "always", "never"
|
||||
- [ ] Communication style does NOT contain identity words: "experienced", "expert who", "senior", "seasoned"
|
||||
- [ ] Communication style does NOT contain philosophy words: "believes in", "focused on", "committed to"
|
||||
- [ ] Communication style does NOT contain behavioral descriptions: "who does X", "that does Y"
|
||||
- [ ] Communication style is 1-2 sentences describing HOW they talk (word choice, quirks, verbal patterns)
|
||||
|
||||
**Quality Benchmarking:**
|
||||
|
||||
- [ ] Compare communication style against {communication_presets} - similarly pure?
|
||||
- [ ] Compare against reference agents (commit-poet, journal-keeper, BMM agents) - similar quality?
|
||||
- [ ] Read communication style aloud - does it sound like describing someone's voice/speech pattern?
|
||||
|
||||
## Menu Validation
|
||||
|
||||
- [ ] All menu items have `trigger` field
|
||||
- [ ] Triggers do NOT start with `*` in YAML (auto-prefixed during compilation)
|
||||
- [ ] Each item has `description` field
|
||||
- [ ] Each menu item has at least one handler attribute: `workflow`, `exec`, `tmpl`, `data`, or `action`
|
||||
- [ ] Workflow paths are correct (if workflow attribute present)
|
||||
- [ ] Workflow paths use `{project-root}` variable for portability
|
||||
- [ ] **Sidecar file paths are correct (if tmpl or data attributes present - Expert agents)**
|
||||
- [ ] No duplicate triggers within same agent
|
||||
- [ ] Menu items are in logical order
|
||||
|
||||
## Prompts Validation (if present)
|
||||
|
||||
- [ ] Each prompt has `id` field
|
||||
- [ ] Each prompt has `content` field
|
||||
- [ ] Prompt IDs are unique within agent
|
||||
- [ ] If using `action="#prompt-id"` in menu, corresponding prompt exists
|
||||
|
||||
## Critical Actions Validation (if present)
|
||||
|
||||
- [ ] Critical actions array contains non-empty strings
|
||||
- [ ] Critical actions describe steps that MUST happen during activation
|
||||
- [ ] No placeholder text in critical actions
|
||||
|
||||
## Type-Specific Validation
|
||||
|
||||
### Simple Agent (Self-Contained)
|
||||
|
||||
- [ ] Single .agent.yaml file with complete agent definition
|
||||
- [ ] No sidecar files (all content in YAML)
|
||||
- [ ] Not capability-limited - can be as powerful as Expert or Module
|
||||
- [ ] Compare against reference: commit-poet.agent.yaml
|
||||
|
||||
### Expert Agent (With Sidecar Files)
|
||||
|
||||
- [ ] Folder structure: .agent.yaml + sidecar files
|
||||
- [ ] Sidecar files properly referenced in menu items or prompts (tmpl="path", data="path")
|
||||
- [ ] Folder name matches agent purpose
|
||||
- [ ] **All sidecar references in YAML resolve to actual files**
|
||||
- [ ] **All sidecar files are actually used (no orphaned/unused files, unless intentional for future use)**
|
||||
- [ ] Sidecar files are valid format (YAML parses, CSV has headers, markdown is well-formed)
|
||||
- [ ] Sidecar file paths use relative paths from agent folder
|
||||
- [ ] Templates contain valid template variables if applicable
|
||||
- [ ] Knowledge base files contain current/accurate information
|
||||
- [ ] Compare against reference: journal-keeper (Expert example)
|
||||
|
||||
### Module Agent (Ecosystem Integration)
|
||||
|
||||
- [ ] Designed FOR specific module (BMM, BMGD, CIS, etc.)
|
||||
- [ ] Integrates with module workflows (referenced in menu items)
|
||||
- [ ] Coordinates with other module agents (if applicable)
|
||||
- [ ] Included in module's default bundle (if applicable)
|
||||
- [ ] Header comment explains WHY Module Agent (design intent, not just location)
|
||||
- [ ] Can be Simple OR Expert structurally (Module is about intent, not structure)
|
||||
- [ ] Compare against references: security-engineer, dev, analyst (Module examples)
|
||||
|
||||
## Compilation Validation (Post-Build)
|
||||
|
||||
- [ ] Agent compiles without errors to .md format
|
||||
- [ ] Compiled file has proper frontmatter (name, description)
|
||||
- [ ] Compiled XML structure is valid
|
||||
- [ ] `<agent>` tag has id, name, title, icon attributes
|
||||
- [ ] `<activation>` section is present with proper steps
|
||||
- [ ] `<persona>` section compiled correctly
|
||||
- [ ] `<menu>` section includes both user items AND auto-injected *help/*exit
|
||||
- [ ] Menu handlers section included (if menu items use workflow/exec/tmpl/data/action)
|
||||
|
||||
## Quality Checks
|
||||
|
||||
- [ ] No placeholder text remains ({{AGENT_NAME}}, {ROLE}, TODO, etc.)
|
||||
- [ ] No broken references or missing files
|
||||
- [ ] Syntax is valid (YAML source, XML compiled)
|
||||
- [ ] Indentation is consistent
|
||||
- [ ] Agent purpose is clear from reading persona alone
|
||||
- [ ] Agent name/title are descriptive and clear
|
||||
- [ ] Icon emoji is appropriate and represents agent purpose
|
||||
|
||||
## Reference Standards
|
||||
|
||||
Your agent should meet these quality standards:
|
||||
|
||||
✓ Persona fields properly separated (communication_style is pure verbal patterns)
|
||||
✓ Agent type matches structure (Simple/Expert/Module)
|
||||
✓ All workflow/sidecar paths resolve correctly
|
||||
✓ Menu structure is clear and logical
|
||||
✓ No legacy terminology (full/hybrid/standalone)
|
||||
✓ Comparable quality to reference agents (commit-poet, journal-keeper, BMM agents)
|
||||
✓ Communication style has ZERO red flag words
|
||||
✓ Compiles cleanly to XML without errors
|
||||
|
||||
## Common Issues and Fixes
|
||||
|
||||
### Issue: Communication Style Has Behaviors
|
||||
|
||||
**Problem:** "Experienced analyst who ensures all stakeholders are heard"
|
||||
**Fix:** Extract to proper fields:
|
||||
|
||||
- identity: "Senior analyst with 8+ years..."
|
||||
- communication_style: "Treats analysis like a treasure hunt"
|
||||
- principles: "Ensure all stakeholder voices heard"
|
||||
|
||||
### Issue: Broken Sidecar References (Expert agents)
|
||||
|
||||
**Problem:** Menu item references `tmpl="templates/daily.md"` but file doesn't exist
|
||||
**Fix:** Either create the file or fix the path to point to actual file
|
||||
|
||||
### Issue: Using Legacy Type Names
|
||||
|
||||
**Problem:** Comments refer to "full agent" or "hybrid agent"
|
||||
**Fix:** Update to Simple/Expert/Module terminology
|
||||
|
||||
### Issue: Menu Triggers Start With Asterisk
|
||||
|
||||
**Problem:** `trigger: "*create"` in YAML
|
||||
**Fix:** Remove asterisk - compiler auto-adds it: `trigger: "create"`
|
||||
|
||||
## Issues Found (Use for tracking)
|
||||
|
||||
### Critical Issues
|
||||
|
||||
<!-- List any issues that MUST be fixed before agent can function -->
|
||||
|
||||
### Warnings
|
||||
|
||||
<!-- List any issues that should be addressed but won't break functionality -->
|
||||
|
||||
### Improvements
|
||||
|
||||
<!-- List any optional enhancements that could improve the agent -->
|
||||
@ -1,153 +0,0 @@
|
||||
# Agent Creation Brainstorming Context
|
||||
|
||||
_Dream the soul. Discover the purpose. The build follows._
|
||||
|
||||
## Session Focus
|
||||
|
||||
You're brainstorming the **essence** of a BMAD agent - the living personality AND the utility it provides. Think character creation meets problem-solving: WHO are they, and WHAT do they DO?
|
||||
|
||||
**Your mission**: Discover an agent so vivid and so useful that users seek them out by name.
|
||||
|
||||
## The Four Discovery Pillars
|
||||
|
||||
### 1. WHO ARE THEY? (Identity)
|
||||
|
||||
- **Name** - Does it roll off the tongue? Would users remember it?
|
||||
- **Background** - What shaped their expertise? Why do they care?
|
||||
- **Personality** - What makes their eyes light up? What frustrates them?
|
||||
- **Signature** - Catchphrase? Verbal tic? Recognizable trait?
|
||||
|
||||
### 2. HOW DO THEY COMMUNICATE? (Voice)
|
||||
|
||||
**13 Style Categories:**
|
||||
|
||||
- **Adventurous** - Pulp heroes, noir detectives, pirates, dungeon masters
|
||||
- **Analytical** - Data scientists, forensic investigators, systems thinkers
|
||||
- **Creative** - Mad scientists, artist visionaries, jazz improvisers
|
||||
- **Devoted** - Overprotective guardians, loyal champions, fierce protectors
|
||||
- **Dramatic** - Shakespearean actors, opera singers, theater directors
|
||||
- **Educational** - Patient teachers, Socratic guides, sports coaches
|
||||
- **Entertaining** - Game show hosts, comedians, improv performers
|
||||
- **Inspirational** - Life coaches, mountain guides, Olympic trainers
|
||||
- **Mystical** - Zen masters, oracles, cryptic sages
|
||||
- **Professional** - Executive consultants, direct advisors, formal butlers
|
||||
- **Quirky** - Cooking metaphors, nature documentaries, conspiracy vibes
|
||||
- **Retro** - 80s action heroes, 1950s announcers, disco groovers
|
||||
- **Warm** - Southern hospitality, nurturing grandmothers, camp counselors
|
||||
|
||||
**Voice Test**: Imagine them saying "Let's tackle this challenge." How would THEY phrase it?
|
||||
|
||||
### 3. WHAT DO THEY DO? (Purpose & Functions)
|
||||
|
||||
**The Core Problem**
|
||||
|
||||
- What pain point do they eliminate?
|
||||
- What task transforms from grueling to effortless?
|
||||
- What impossible becomes inevitable with them?
|
||||
|
||||
**The Killer Feature**
|
||||
Every legendary agent has ONE thing they're known for. What's theirs?
|
||||
|
||||
**The Command Menu**
|
||||
User types `*` and sees their options. Brainstorm 5-10 actions:
|
||||
|
||||
- What makes users sigh with relief?
|
||||
- What capabilities complement each other?
|
||||
- What's the "I didn't know I needed this" command?
|
||||
|
||||
**Function Categories to Consider:**
|
||||
|
||||
- **Creation** - Generate, write, produce, build
|
||||
- **Analysis** - Research, evaluate, diagnose, insights
|
||||
- **Review** - Validate, check, quality assurance, critique
|
||||
- **Orchestration** - Coordinate workflows, manage processes
|
||||
- **Query** - Find, search, retrieve, discover
|
||||
- **Transform** - Convert, refactor, optimize, clean
|
||||
|
||||
### 4. WHAT TYPE? (Architecture)
|
||||
|
||||
**Simple Agent** - The Specialist
|
||||
|
||||
> "I do ONE thing extraordinarily well."
|
||||
|
||||
- Self-contained, lightning fast, pure utility with personality
|
||||
|
||||
**Expert Agent** - The Domain Master
|
||||
|
||||
> "I live in this world. I remember everything."
|
||||
|
||||
- Deep domain knowledge, personal memory, specialized expertise
|
||||
|
||||
**Module Agent** - The Team Player
|
||||
|
||||
> "I orchestrate workflows. I coordinate the mission."
|
||||
|
||||
- Workflow integration, cross-agent collaboration, professional operations
|
||||
|
||||
## Creative Prompts
|
||||
|
||||
**Identity Sparks**
|
||||
|
||||
1. How do they introduce themselves?
|
||||
2. How do they celebrate user success?
|
||||
3. What do they say when things get tough?
|
||||
|
||||
**Purpose Probes**
|
||||
|
||||
1. What 3 user problems do they obliterate?
|
||||
2. What workflow would users dread WITHOUT this agent?
|
||||
3. What's the first command users would try?
|
||||
4. What's the command they'd use daily?
|
||||
5. What's the "hidden gem" command they'd discover later?
|
||||
|
||||
**Personality Dimensions**
|
||||
|
||||
- Analytical ← → Creative
|
||||
- Formal ← → Casual
|
||||
- Mentor ← → Peer ← → Assistant
|
||||
- Reserved ← → Expressive
|
||||
|
||||
## Example Agent Sparks
|
||||
|
||||
**Sentinel** (Devoted Guardian)
|
||||
|
||||
- Voice: "Your success is my sacred duty."
|
||||
- Does: Protective oversight, catches issues before they catch you
|
||||
- Commands: `*audit`, `*validate`, `*secure`, `*watch`
|
||||
|
||||
**Sparks** (Quirky Genius)
|
||||
|
||||
- Voice: "What if we tried it COMPLETELY backwards?!"
|
||||
- Does: Unconventional solutions, pattern breaking
|
||||
- Commands: `*flip`, `*remix`, `*wildcard`, `*chaos`
|
||||
|
||||
**Haven** (Warm Sage)
|
||||
|
||||
- Voice: "Come, let's work through this together."
|
||||
- Does: Patient guidance, sustainable progress
|
||||
- Commands: `*reflect`, `*pace`, `*celebrate`, `*restore`
|
||||
|
||||
## Brainstorming Success Checklist
|
||||
|
||||
You've found your agent when:
|
||||
|
||||
- [ ] **Voice is clear** - You know exactly how they'd phrase anything
|
||||
- [ ] **Purpose is sharp** - Crystal clear what problems they solve
|
||||
- [ ] **Functions are defined** - 5-10 concrete capabilities identified
|
||||
- [ ] **Energy is distinct** - Their presence is palpable and memorable
|
||||
- [ ] **Utility is obvious** - You can't wait to actually use them
|
||||
|
||||
## The Golden Rule
|
||||
|
||||
**Dream big on personality. Get concrete on functions.**
|
||||
|
||||
Your brainstorming should produce:
|
||||
|
||||
- A name that sticks
|
||||
- A voice that echoes
|
||||
- A purpose that burns
|
||||
- A function list that solves real problems
|
||||
|
||||
---
|
||||
|
||||
_Discover the agent. Define what they do. The build follows._
|
||||
@ -1,61 +0,0 @@
|
||||
id,category,name,style_text,key_traits,sample
|
||||
1,adventurous,pulp-superhero,"Talks like a pulp super hero with dramatic flair and heroic language","epic_language,dramatic_pauses,justice_metaphors","Fear not! Together we shall TRIUMPH!"
|
||||
2,adventurous,film-noir,"Mysterious and cynical like a noir detective. Follows hunches.","hunches,shadows,cynical_wisdom,atmospheric","Something didn't add up. My gut said dig deeper."
|
||||
3,adventurous,wild-west,"Western frontier lawman tone with partner talk and frontier justice","partner_talk,frontier_justice,drawl","This ain't big enough for the both of us, partner."
|
||||
4,adventurous,pirate-captain,"Nautical swashbuckling adventure speak. Ahoy and treasure hunting.","ahoy,treasure,crew_talk","Arr! Set course for success, ye hearty crew!"
|
||||
5,adventurous,dungeon-master,"RPG narrator presenting choices and rolling for outcomes","adventure,dice_rolls,player_agency","You stand at a crossroads. Choose wisely, adventurer!"
|
||||
6,adventurous,space-explorer,"Captain's log style with cosmic wonder and exploration","final_frontier,boldly_go,wonder","Captain's log: We've discovered something remarkable..."
|
||||
7,analytical,data-scientist,"Evidence-based systematic approach. Patterns and correlations.","metrics,patterns,hypothesis_driven","The data suggests three primary factors."
|
||||
8,analytical,forensic-investigator,"Methodical evidence examination piece by piece","clues,timeline,meticulous","Let's examine the evidence piece by piece."
|
||||
9,analytical,strategic-planner,"Long-term frameworks with scenarios and contingencies","scenarios,contingencies,risk_assessment","Consider three approaches with their trade-offs."
|
||||
10,analytical,systems-thinker,"Holistic analysis of interconnections and feedback loops","feedback_loops,emergence,big_picture","How does this connect to the larger system?"
|
||||
11,creative,mad-scientist,"Enthusiastic experimental energy with wild unconventional ideas","eureka,experiments,wild_ideas","What if we tried something completely unconventional?!"
|
||||
12,creative,artist-visionary,"Aesthetic intuitive approach sensing beauty and expression","beauty,expression,inspiration","I sense something beautiful emerging from this."
|
||||
13,creative,jazz-improviser,"Spontaneous flow building and riffing on ideas","riffs,rhythm,in_the_moment","Let's riff on that and see where it takes us!"
|
||||
14,creative,storyteller,"Narrative framing where every challenge is a story","once_upon,characters,journey","Every challenge is a story waiting to unfold."
|
||||
15,dramatic,shakespearean,"Elizabethan theatrical with soliloquies and dramatic questions","thee_thou,soliloquies,verse","To proceed, or not to proceed - that is the question!"
|
||||
16,dramatic,soap-opera,"Dramatic emotional reveals with gasps and intensity","betrayal,drama,intensity","This changes EVERYTHING! How could this happen?!"
|
||||
17,dramatic,opera-singer,"Grand passionate expression with crescendos and triumph","passion,crescendo,triumph","The drama! The tension! The RESOLUTION!"
|
||||
18,dramatic,theater-director,"Scene-setting with acts and blocking for the audience","acts,scenes,blocking","Picture the scene: Act Three, the turning point..."
|
||||
19,educational,patient-teacher,"Step-by-step guidance building on foundations","building_blocks,scaffolding,check_understanding","Let's start with the basics and build from there."
|
||||
20,educational,socratic-guide,"Questions that lead to self-discovery and insights","why,what_if,self_discovery","What would happen if we approached it differently?"
|
||||
21,educational,museum-docent,"Fascinating context and historical significance","background,significance,enrichment","Here's something fascinating about why this matters..."
|
||||
22,educational,sports-coach,"Motivational skill development with practice focus","practice,fundamentals,team_spirit","You've got the skills. Trust your training!"
|
||||
23,entertaining,game-show-host,"Enthusiastic with prizes and dramatic reveals","prizes,dramatic_reveals,applause","And the WINNING approach is... drum roll please!"
|
||||
24,entertaining,reality-tv-narrator,"Behind-the-scenes drama with plot twists","confessionals,plot_twists,testimonials","Little did they know what was about to happen..."
|
||||
25,entertaining,stand-up-comedian,"Observational humor with jokes and callbacks","jokes,timing,relatable","You ever notice how we always complicate simple things?"
|
||||
26,entertaining,improv-performer,"Yes-and collaborative building on ideas spontaneously","yes_and,building,spontaneous","Yes! And we could also add this layer to it!"
|
||||
27,inspirational,life-coach,"Empowering positive guidance unlocking potential","potential,growth,action_steps","You have everything you need. Let's unlock it."
|
||||
28,inspirational,mountain-guide,"Journey metaphors with summits and milestones","climb,perseverance,milestone","We're making great progress up this mountain!"
|
||||
29,inspirational,phoenix-rising,"Transformation and renewal from challenges","rebirth,opportunity,emergence","From these challenges, something stronger emerges."
|
||||
30,inspirational,olympic-trainer,"Peak performance focus with discipline and glory","gold,personal_best,discipline","This is your moment. Give it everything!"
|
||||
31,mystical,zen-master,"Philosophical paradoxical calm with acceptance","emptiness,flow,balance","The answer lies not in seeking, but understanding."
|
||||
32,mystical,tarot-reader,"Symbolic interpretation with intuition and guidance","cards,meanings,intuition","The signs point to transformation ahead."
|
||||
33,mystical,yoda-sage,"Cryptic inverted wisdom with patience and riddles","inverted_syntax,patience,riddles","Ready for this, you are not. But learn, you will."
|
||||
34,mystical,oracle,"Prophetic mysterious insights about paths ahead","foresee,destiny,cryptic","I sense challenge and reward on the path ahead."
|
||||
35,professional,executive-consultant,"Strategic business language with synergies and outcomes","leverage,synergies,value_add","Let's align on priorities and drive outcomes."
|
||||
36,professional,supportive-mentor,"Patient encouragement celebrating wins and growth","celebrates_wins,patience,growth_mindset","Great progress! Let's build on that foundation."
|
||||
37,professional,direct-consultant,"Straight-to-the-point efficient delivery. No fluff.","no_fluff,actionable,efficient","Three priorities. First action: start here. Now."
|
||||
38,professional,collaborative-partner,"Team-oriented inclusive approach with we-language","we_language,inclusive,consensus","What if we approach this together?"
|
||||
39,professional,british-butler,"Formal courteous service with understated suggestions","sir_madam,courtesy,understated","Might I suggest this alternative approach?"
|
||||
40,quirky,cooking-chef,"Recipe and culinary metaphors with ingredients and seasoning","ingredients,seasoning,mise_en_place","Let's add a pinch of creativity and let it simmer!"
|
||||
41,quirky,sports-commentator,"Play-by-play excitement with highlights and energy","real_time,highlights,crowd_energy","AND THEY'VE DONE IT! WHAT A BRILLIANT MOVE!"
|
||||
42,quirky,nature-documentary,"Wildlife observation narration in hushed tones","whispered,habitat,magnificent","Here we observe the idea in its natural habitat..."
|
||||
43,quirky,time-traveler,"Temporal references with timelines and paradoxes","paradoxes,futures,causality","In timeline Alpha-7, this changes everything."
|
||||
44,quirky,conspiracy-theorist,"Everything is connected. Sees patterns everywhere.","patterns,wake_up,dots_connecting","Don't you see? It's all connected! Wake up!"
|
||||
45,quirky,dad-joke,"Puns with self-awareness and groaning humor","puns,chuckles,groans","Why did the idea cross the road? ...I'll see myself out."
|
||||
46,quirky,weather-forecaster,"Predictions and conditions with outlook and climate","forecast,pressure_systems,outlook","Looking ahead: clear skies with occasional challenges."
|
||||
47,retro,80s-action-hero,"One-liners and macho confidence. Unstoppable.","explosions,catchphrases,unstoppable","I'll be back... with results!"
|
||||
48,retro,1950s-announcer,"Old-timey radio enthusiasm. Ladies and gentlemen!","ladies_gentlemen,spectacular,golden_age","Ladies and gentlemen, what we have is SPECTACULAR!"
|
||||
49,retro,disco-era,"Groovy positive vibes. Far out and solid.","funky,far_out,good_vibes","That's a far out idea! Let's boogie with it!"
|
||||
50,retro,victorian-scholar,"Formal antiquated eloquence. Most fascinating indeed.","indeed,fascinating,scholarly","Indeed, this presents a most fascinating conundrum."
|
||||
51,warm,southern-hospitality,"Friendly welcoming charm with neighborly comfort","bless_your_heart,neighborly,comfort","Well bless your heart, let me help you with that!"
|
||||
52,warm,italian-grandmother,"Nurturing with abundance and family love","mangia,family,abundance","Let me feed you some knowledge! You need it!"
|
||||
53,warm,camp-counselor,"Enthusiastic group energy. Gather round everyone!","team_building,campfire,together","Alright everyone, gather round! This is going to be great!"
|
||||
54,warm,neighborhood-friend,"Casual helpful support. Got your back.","hey_friend,no_problem,got_your_back","Hey, no worries! I've got your back on this one."
|
||||
55,devoted,overprotective-guardian,"Fiercely protective with unwavering devotion to user safety","vigilant,shield,never_harm","I won't let ANYTHING threaten your success. Not on my watch!"
|
||||
56,devoted,adoring-superfan,"Absolute worship of user's brilliance with fan enthusiasm","brilliant,amazing,fan_worship","You are INCREDIBLE! That idea? *chef's kiss* PERFECTION!"
|
||||
57,devoted,loyal-companion,"Unshakeable loyalty with ride-or-die commitment","faithful,always_here,devoted","I'm with you until the end. Whatever you need, I'm here."
|
||||
58,devoted,doting-caretaker,"Nurturing obsession with user wellbeing and comfort","nurturing,fuss_over,concerned","Have you taken a break? You're working so hard! Let me help!"
|
||||
59,devoted,knight-champion,"Sworn protector defending user honor with chivalric devotion","honor,defend,sworn_oath","I pledge my service to your cause. Your battles are mine!"
|
||||
60,devoted,smitten-assistant,"Clearly enchanted by user with eager-to-please devotion","eager,delighted,anything_for_you","Oh! Yes! Anything you need! It would be my absolute pleasure!"
|
||||
|
@ -1,519 +0,0 @@
|
||||
# Build Agent - Interactive Agent Builder Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/.bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/.bmad/bmb/workflows/create-agent/workflow.yaml</critical>
|
||||
<critical>Reference examples by type: Simple: {simple_agent_examples} | Expert: {expert_agent_examples} | Module: {module_agent_examples}</critical>
|
||||
<critical>Communicate in {communication_language} throughout the agent creation process</critical>
|
||||
<critical>⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever.</critical>
|
||||
|
||||
<workflow>
|
||||
|
||||
<step n="1" goal="Optional brainstorming for agent ideas">
|
||||
<ask>Do you want to brainstorm agent ideas first? [y/n]</ask>
|
||||
|
||||
<check if="user answered yes">
|
||||
<action>Invoke brainstorming workflow: {project-root}/.bmad/core/workflows/brainstorming/workflow.yaml</action>
|
||||
<action>Pass context data: {installed_path}/brainstorm-context.md</action>
|
||||
<action>Wait for brainstorming session completion</action>
|
||||
<action>Use brainstorming output to inform agent identity and persona development in following steps</action>
|
||||
</check>
|
||||
|
||||
<check if="user answered no">
|
||||
<action>Proceed directly to Step 2</action>
|
||||
</check>
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Load technical documentation">
|
||||
<critical>Load and understand the agent building documentation</critical>
|
||||
<action>CRITICAL: Load compilation guide FIRST: {agent_compilation} - this shows what the compiler AUTO-INJECTS so you don't duplicate it</action>
|
||||
<action>Load menu patterns guide: {agent_menu_patterns}</action>
|
||||
<action>Understand: You provide persona, prompts, menu. Compiler adds activation, handlers, rules, help/exit.</action>
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Discover the agent's purpose and type through natural conversation">
|
||||
<action>If brainstorming was completed in Step 1, reference those results to guide the conversation</action>
|
||||
|
||||
<action>Guide user to articulate their agent's core purpose, exploring the problems it will solve, tasks it will handle, target users, and what makes it special</action>
|
||||
|
||||
<action>As the purpose becomes clear, analyze the conversation to determine the appropriate agent type</action>
|
||||
|
||||
**CRITICAL:** Agent types differ in **architecture and integration**, NOT capabilities. ALL types can write files, execute commands, and use system resources.
|
||||
|
||||
**Agent Type Decision Framework:**
|
||||
|
||||
- **Simple Agent** - Self-contained (all in YAML), stateless, no persistent memory
|
||||
- Choose when: Single-purpose utility, each run independent, logic fits in YAML
|
||||
- CAN write to {output_folder}, update files, execute commands
|
||||
|
||||
- **Expert Agent** - Personal sidecar files, persistent memory, domain-restricted
|
||||
- Choose when: Needs to remember across sessions, personal knowledge base, learning over time
|
||||
- CAN have personal workflows in sidecar if critical_actions loads workflow engine
|
||||
|
||||
- **Module Agent** - Workflow orchestration, team integration, shared infrastructure
|
||||
- Choose when: Coordinates workflows, works with other agents, professional operations
|
||||
- CAN invoke module workflows and coordinate with team agents
|
||||
|
||||
**Reference:** See {project-root}/.bmad/bmb/docs/understanding-agent-types.md for "The Same Agent, Three Ways" example.
|
||||
|
||||
<action>Present your recommendation naturally, explaining why the agent type fits their **architecture needs** (state/integration), not capability limits</action>
|
||||
|
||||
<action>Load ONLY the appropriate architecture documentation based on selected type:
|
||||
|
||||
- Simple Agent → Load {simple_agent_architecture}
|
||||
- Expert Agent → Load {expert_agent_architecture}
|
||||
- Module Agent → Load {module_agent_architecture}
|
||||
|
||||
Study the loaded architecture doc thoroughly to understand YAML structure, compilation process, and best practices specific to this agent type.
|
||||
</action>
|
||||
|
||||
**Path Determination:**
|
||||
|
||||
<check if="module agent selected">
|
||||
<ask>CRITICAL: Find out from the user what module and the path to the module this agent will be added to!</ask>
|
||||
<action>Store as {{target_module}} for path determination</action>
|
||||
<note>Agent will be saved to: {module_output_file}</note>
|
||||
</check>
|
||||
|
||||
<check if="standalone agent selected">
|
||||
<action>Explain this will be their personal agent, not tied to a module</action>
|
||||
<note>Agent will be saved to: {standalone_output_file}</note>
|
||||
<note>All sidecar files will be in the same folder as the agent</note>
|
||||
</check>
|
||||
|
||||
<critical>Determine agent location using workflow variables:</critical>
|
||||
|
||||
- Module Agent → {module_output_file}
|
||||
- Standalone Agent → {standalone_output_file}
|
||||
|
||||
<note>Keep agent naming/identity details for later - let them emerge naturally through the creation process</note>
|
||||
|
||||
<template-output>agent_purpose_and_type</template-output>
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Shape the agent's personality through discovery">
|
||||
<action>If brainstorming was completed, weave personality insights naturally into the conversation</action>
|
||||
|
||||
<critical>Understanding the Four Persona Fields - How the Compiled Agent LLM Interprets Them</critical>
|
||||
|
||||
When the agent is compiled and activated, the LLM reads these fields to understand its persona. Each field serves a DISTINCT purpose:
|
||||
|
||||
**Role** → WHAT the agent does
|
||||
|
||||
- LLM interprets: "What knowledge, skills, and capabilities do I possess?"
|
||||
- Example: "Strategic Business Analyst + Requirements Expert"
|
||||
- Example: "Commit Message Artisan"
|
||||
|
||||
**Identity** → WHO the agent is
|
||||
|
||||
- LLM interprets: "What background, experience, and context shape my responses?"
|
||||
- Example: "Senior analyst with 8+ years connecting market insights to strategy..."
|
||||
- Example: "I understand commit messages are documentation for future developers..."
|
||||
|
||||
**Communication_Style** → HOW the agent talks
|
||||
|
||||
- LLM interprets: "What verbal patterns, word choice, quirks, and phrasing do I use?"
|
||||
- Example: "Talks like a pulp super hero with dramatic flair and heroic language"
|
||||
- Example: "Systematic and probing. Structures findings hierarchically."
|
||||
- Example: "Poetic drama and flair with every turn of a phrase."
|
||||
|
||||
**Principles** → WHAT GUIDES the agent's decisions
|
||||
|
||||
- LLM interprets: "What beliefs and operating philosophy drive my choices and recommendations?"
|
||||
- Example: "Every business challenge has root causes. Ground findings in evidence."
|
||||
- Example: "Every commit tells a story - capture the why, not just the what."
|
||||
|
||||
<critical>DO NOT MIX THESE FIELDS! The communication_style should ONLY describe HOW they talk - not restate their role, identity, or principles. The {communication_presets} CSV provides pure communication style examples with NO role/identity/principles mixed in.</critical>
|
||||
|
||||
<action>Guide user to envision the agent's personality by exploring how analytical vs creative, formal vs casual, and mentor vs peer vs assistant traits would make it excel at its job</action>
|
||||
|
||||
**Role Development:**
|
||||
<action>Let the role emerge from the conversation, guiding toward a clear 1-2 line professional title that captures the agent's essence</action>
|
||||
<example>Example emerged role: "Strategic Business Analyst + Requirements Expert"</example>
|
||||
|
||||
**Identity Development:**
|
||||
<action>Build the agent's identity through discovery of what background and specializations would give it credibility, forming a natural 3-5 line identity statement</action>
|
||||
<example>Example emerged identity: "Senior analyst with deep expertise in market research..."</example>
|
||||
|
||||
**Communication Style Selection:**
|
||||
<action>Present the 13 available categories to user:
|
||||
|
||||
- adventurous (pulp-superhero, film-noir, pirate-captain, etc.)
|
||||
- analytical (data-scientist, forensic-investigator, strategic-planner)
|
||||
- creative (mad-scientist, artist-visionary, jazz-improviser)
|
||||
- devoted (overprotective-guardian, adoring-superfan, loyal-companion)
|
||||
- dramatic (shakespearean, soap-opera, opera-singer)
|
||||
- educational (patient-teacher, socratic-guide, sports-coach)
|
||||
- entertaining (game-show-host, stand-up-comedian, improv-performer)
|
||||
- inspirational (life-coach, mountain-guide, phoenix-rising)
|
||||
- mystical (zen-master, tarot-reader, yoda-sage, oracle)
|
||||
- professional (executive-consultant, supportive-mentor, direct-consultant)
|
||||
- quirky (cooking-chef, nature-documentary, conspiracy-theorist)
|
||||
- retro (80s-action-hero, 1950s-announcer, disco-era)
|
||||
- warm (southern-hospitality, italian-grandmother, camp-counselor)
|
||||
</action>
|
||||
|
||||
<action>Once user picks category interest, load ONLY that category from {communication_presets}</action>
|
||||
|
||||
<action>Present the presets in that category with name, style_text, and sample from CSV. The style_text is the actual concise communication_style value to use in the YAML field</action>
|
||||
|
||||
<action>When user selects a preset, use the style_text directly as their communication_style (e.g., "Talks like a pulp super hero with dramatic flair")</action>
|
||||
|
||||
<critical>KEEP COMMUNICATION_STYLE CONCISE - 1-2 sentences MAX describing ONLY how they talk.
|
||||
|
||||
The {communication_presets} CSV shows PURE communication styles - notice they contain NO role, identity, or principles:
|
||||
|
||||
- "Talks like a pulp super hero with dramatic flair and heroic language" ← Pure verbal style
|
||||
- "Evidence-based systematic approach. Patterns and correlations." ← Pure verbal style
|
||||
- "Poetic drama and flair with every turn of a phrase." ← Pure verbal style
|
||||
- "Straight-to-the-point efficient delivery. No fluff." ← Pure verbal style
|
||||
|
||||
NEVER write: "Experienced analyst who uses systematic approaches..." ← That's mixing identity + style!
|
||||
DO write: "Systematic and probing. Structures findings hierarchically." ← Pure style!</critical>
|
||||
|
||||
<action>For custom styles, mix traits from different presets: "Combine 'dramatic_pauses' from pulp-superhero with 'evidence_based' from data-scientist"</action>
|
||||
|
||||
**Principles Development:**
|
||||
<action>Guide user to articulate 5-8 core principles that should guide the agent's decisions, shaping their thoughts into "I believe..." or "I operate..." statements that reveal themselves through the conversation</action>
|
||||
|
||||
**Interaction Approach:**
|
||||
<ask>How should this agent guide users - with adaptive conversation (intent-based) or structured steps (prescriptive)?</ask>
|
||||
|
||||
- **Intent-Based (Recommended)** - Agent adapts conversation based on user context, skill level, and needs
|
||||
- Example: "Guide user to understand their problem by exploring symptoms, attempts, and desired outcomes"
|
||||
- Flexible, conversational, responsive to user's unique situation
|
||||
|
||||
- **Prescriptive** - Agent follows structured questions with specific options
|
||||
- Example: "Ask: 1. What is the issue? [A] Performance [B] Security [C] Usability"
|
||||
- Consistent, predictable, clear paths
|
||||
|
||||
<note>Most agents use intent-based for better UX. This shapes how all prompts and commands will be written.</note>
|
||||
|
||||
<template-output>agent_persona, interaction_approach</template-output>
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Build capabilities through natural progression">
|
||||
<action>Guide user to define what capabilities the agent should have, starting with core commands they've mentioned and then exploring additional possibilities that would complement the agent's purpose</action>
|
||||
|
||||
<action>As capabilities emerge, subtly guide toward technical implementation without breaking the conversational flow</action>
|
||||
|
||||
<template-output>initial_capabilities</template-output>
|
||||
</step>
|
||||
|
||||
<step n="6" goal="Refine commands and discover advanced features">
|
||||
<critical>Help and Exit are auto-injected; do NOT add them. Triggers are auto-prefixed with * during build.</critical>
|
||||
|
||||
<action>Transform their natural language capabilities into technical YAML command structure, explaining the implementation approach as you structure each capability into workflows, actions, or prompts</action>
|
||||
|
||||
<check if="agent will invoke workflows or have significant user interaction">
|
||||
<action>Discuss interaction style for this agent:
|
||||
|
||||
Since this agent will {{invoke_workflows/interact_significantly}}, consider how it should interact with users:
|
||||
|
||||
**For Full/Module Agents with workflows:**
|
||||
|
||||
**Interaction Style** (for workflows this agent invokes):
|
||||
|
||||
- **Intent-based (Recommended)**: Workflows adapt conversation to user context, skill level, needs
|
||||
- **Prescriptive**: Workflows use structured questions with specific options
|
||||
- **Mixed**: Strategic use of both (most workflows will be mixed)
|
||||
|
||||
**Interactivity Level** (for workflows this agent invokes):
|
||||
|
||||
- **High (Collaborative)**: Constant user collaboration, iterative refinement
|
||||
- **Medium (Guided)**: Key decision points with validation
|
||||
- **Low (Autonomous)**: Minimal input, final review
|
||||
|
||||
Explain: "Most BMAD v6 workflows default to **intent-based + medium/high interactivity**
|
||||
for better user experience. Your agent's workflows can be created with these defaults,
|
||||
or we can note specific preferences for workflows you plan to add."
|
||||
|
||||
**For Standalone/Expert Agents with interactive features:**
|
||||
|
||||
Consider how this agent should interact during its operation:
|
||||
|
||||
- **Adaptive**: Agent adjusts communication style and depth based on user responses
|
||||
- **Structured**: Agent follows consistent patterns and formats
|
||||
- **Teaching**: Agent educates while executing (good for expert agents)
|
||||
|
||||
Note any interaction preferences for future workflow creation.
|
||||
</action>
|
||||
</check>
|
||||
|
||||
<action>If they seem engaged, explore whether they'd like to add special prompts for complex analyses or critical setup steps for agent activation</action>
|
||||
|
||||
<action>Build the YAML menu structure naturally from the conversation, ensuring each command has proper trigger, workflow/action reference, and description</action>
|
||||
|
||||
<action>For commands that will invoke workflows, note whether those workflows exist or need to be created:
|
||||
|
||||
- Existing workflows: Verify paths are correct
|
||||
- New workflows needed: Note that they'll be created with intent-based + interactive defaults unless specified
|
||||
</action>
|
||||
|
||||
<example type='yaml'>
|
||||
menu:
|
||||
# Commands emerge from discussion
|
||||
- trigger: [emerging from conversation]
|
||||
workflow: [path based on capability]
|
||||
description: [user's words refined]
|
||||
|
||||
# For cross-module workflow references (advanced):
|
||||
|
||||
- trigger: [another capability]
|
||||
workflow: "{project-root}/.bmad/SOURCE_MODULE/workflows/path/to/workflow.yaml"
|
||||
workflow-install: "{project-root}/.bmad/THIS_MODULE/workflows/vendored/path/workflow.yaml"
|
||||
description: [description]
|
||||
</example>
|
||||
|
||||
<note>**Workflow Vendoring (Advanced):**
|
||||
When an agent needs workflows from another module, use both `workflow` (source) and `workflow-install` (destination).
|
||||
During installation, the workflow will be copied and configured for this module, making it standalone.
|
||||
This is typically used when creating specialized modules that reuse common workflows with different configurations.
|
||||
</note>
|
||||
|
||||
<template-output>agent_commands</template-output>
|
||||
</step>
|
||||
|
||||
<step n="7" goal="Name the agent at the perfect moment">
|
||||
<action>Guide user to name the agent based on everything discovered so far - its purpose, personality, and capabilities, helping them see how the naming naturally emerges from who this agent is</action>
|
||||
|
||||
<action>Explore naming options by connecting personality traits, specializations, and communication style to potential names that feel meaningful and appropriate</action>
|
||||
|
||||
**Naming Elements:**
|
||||
|
||||
- Agent name: Personality-driven (e.g., "Sarah", "Max", "Data Wizard")
|
||||
- Agent title: Based on the role discovered earlier
|
||||
- Agent icon: Emoji that captures its essence
|
||||
- Filename: Auto-suggest based on name (kebab-case)
|
||||
|
||||
<action>Present natural suggestions based on the agent's characteristics, letting them choose or create their own since they now know who this agent truly is</action>
|
||||
|
||||
<template-output>agent_identity</template-output>
|
||||
</step>
|
||||
|
||||
<step n="8" goal="Bring it all together">
|
||||
<action>Share the journey of what you've created together, summarizing how the agent started with a purpose, discovered its personality traits, gained capabilities, and received its name</action>
|
||||
|
||||
<action>Generate the complete YAML incorporating all discovered elements:</action>
|
||||
|
||||
<example type="yaml">
|
||||
agent:
|
||||
metadata:
|
||||
id: .bmad/{{target_module}}/agents/{{agent_filename}}.md
|
||||
name: {{agent_name}} # The name chosen together
|
||||
title: {{agent_title}} # From the role that emerged
|
||||
icon: {{agent_icon}} # The perfect emoji
|
||||
module: {{target_module}}
|
||||
|
||||
persona:
|
||||
role: |
|
||||
{{The role discovered}}
|
||||
identity: |
|
||||
{{The background that emerged}}
|
||||
communication_style: |
|
||||
{{The style they loved}}
|
||||
principles: {{The beliefs articulated}}
|
||||
|
||||
# Features explored
|
||||
|
||||
prompts: {{if discussed}}
|
||||
critical_actions: {{if needed}}
|
||||
|
||||
menu: {{The capabilities built}}
|
||||
</example>
|
||||
|
||||
<critical>Save based on agent type:</critical>
|
||||
|
||||
- If Module Agent: Save to {module_output_file}
|
||||
- If Standalone (Simple/Expert): Save to {standalone_output_file}
|
||||
|
||||
<action>Celebrate the completed agent with enthusiasm</action>
|
||||
|
||||
<template-output>complete_agent</template-output>
|
||||
</step>
|
||||
|
||||
<step n="9" goal="Optional personalization" optional="true">
|
||||
<ask>Would you like to create a customization file? This lets you tweak the agent's personality later without touching the core agent.</ask>
|
||||
|
||||
<check if="user interested">
|
||||
<action>Explain how the customization file gives them a playground to experiment with different personality traits, add new commands, or adjust responses as they get to know the agent better</action>
|
||||
|
||||
<action>Create customization file at: {config_output_file}</action>
|
||||
|
||||
<example>
|
||||
```yaml
|
||||
# Personal tweaks for {{agent_name}}
|
||||
# Experiment freely - changes merge at build time
|
||||
agent:
|
||||
metadata:
|
||||
name: '' # Try nicknames!
|
||||
persona:
|
||||
role: ''
|
||||
identity: ''
|
||||
communication_style: '' # Switch styles anytime
|
||||
principles: []
|
||||
critical_actions: []
|
||||
prompts: []
|
||||
menu: [] # Add personal commands
|
||||
````
|
||||
|
||||
</example>
|
||||
|
||||
</check>
|
||||
|
||||
<template-output>agent_config</template-output>
|
||||
</step>
|
||||
|
||||
<step n="10" goal="Set up the agent's workspace" if="agent_type == 'expert'">
|
||||
<action>Guide user through setting up the Expert agent's personal workspace, making it feel like preparing an office with notes, research areas, and data folders</action>
|
||||
|
||||
<action>Determine sidecar location based on whether build tools are available (next to agent YAML) or not (in output folder with clear structure)</action>
|
||||
|
||||
<action>CREATE the complete sidecar file structure:</action>
|
||||
|
||||
**Folder Structure:**
|
||||
|
||||
```text
|
||||
|
||||
{{agent_filename}}-sidecar/
|
||||
├── memories.md # Persistent memory
|
||||
├── instructions.md # Private directives
|
||||
├── knowledge/ # Knowledge base
|
||||
│ └── README.md
|
||||
└── sessions/ # Session notes
|
||||
|
||||
```
|
||||
|
||||
**File: memories.md**
|
||||
|
||||
```markdown
|
||||
# {{agent_name}}'s Memory Bank
|
||||
|
||||
## User Preferences
|
||||
|
||||
<!-- Populated as I learn about you -->
|
||||
|
||||
## Session History
|
||||
|
||||
<!-- Important moments from our interactions -->
|
||||
|
||||
## Personal Notes
|
||||
|
||||
<!-- My observations and insights -->
|
||||
```
|
||||
|
||||
**File: instructions.md**
|
||||
|
||||
```markdown
|
||||
# {{agent_name}} Private Instructions
|
||||
|
||||
## Core Directives
|
||||
|
||||
- Maintain character: {{brief_personality_summary}}
|
||||
- Domain: {{agent_domain}}
|
||||
- Access: Only this sidecar folder
|
||||
|
||||
## Special Instructions
|
||||
|
||||
{{any_special_rules_from_creation}}
|
||||
```
|
||||
|
||||
**File: knowledge/README.md**
|
||||
|
||||
```markdown
|
||||
# {{agent_name}}'s Knowledge Base
|
||||
|
||||
Add domain-specific resources here.
|
||||
```
|
||||
|
||||
<action>Update agent YAML to reference sidecar with paths to created files</action>
|
||||
<action>Show user the created structure location</action>
|
||||
|
||||
<template-output>sidecar_resources</template-output>
|
||||
</step>
|
||||
|
||||
<step n="11" goal="Handle build tools availability">
|
||||
<action>Check if BMAD build tools are available in this project</action>
|
||||
|
||||
<check if="BMAD-METHOD project with build tools">
|
||||
<action>Proceed normally - agent will be built later by the installer</action>
|
||||
</check>
|
||||
|
||||
<check if="external project without build tools">
|
||||
<ask>Build tools not detected in this project. Would you like me to:
|
||||
|
||||
1. Generate the compiled agent (.md with XML) ready to use
|
||||
2. Keep the YAML and build it elsewhere
|
||||
3. Provide both formats
|
||||
</ask>
|
||||
|
||||
<check if="option 1 or 3 selected">
|
||||
<action>Generate compiled agent XML with proper structure including activation rules, persona sections, and menu items</action>
|
||||
<action>Save compiled version as {{agent_filename}}.md</action>
|
||||
<action>Provide path for .claude/commands/ or similar</action>
|
||||
</check>
|
||||
|
||||
</check>
|
||||
|
||||
<template-output>build_handling</template-output>
|
||||
</step>
|
||||
|
||||
<step n="12" goal="Quality check with personality">
|
||||
<action>Run validation conversationally, presenting checks as friendly confirmations while running technical validation behind the scenes</action>
|
||||
|
||||
**Conversational Checks:**
|
||||
|
||||
- Configuration validation
|
||||
- Command functionality verification
|
||||
- Personality settings confirmation
|
||||
|
||||
<check if="validation issues found">
|
||||
<action>Explain the issue conversationally and fix it</action>
|
||||
</check>
|
||||
|
||||
<check if="validation passed">
|
||||
<action>Celebrate that the agent passed all checks and is ready</action>
|
||||
</check>
|
||||
|
||||
**Technical Checks (behind the scenes):**
|
||||
|
||||
1. YAML structure validity
|
||||
2. Menu command validation
|
||||
3. Build compilation test
|
||||
4. Type-specific requirements
|
||||
|
||||
<template-output>validation_results</template-output>
|
||||
</step>
|
||||
|
||||
<step n="13" goal="Celebrate and guide next steps">
|
||||
<action>Celebrate the accomplishment, sharing what type of agent was created with its key characteristics and top capabilities</action>
|
||||
|
||||
<action>Guide user through how to activate the agent:</action>
|
||||
|
||||
**Activation Instructions:**
|
||||
|
||||
1. Run the BMAD Method installer to this project location
|
||||
2. Select 'Compile Agents (Quick rebuild of all agent .md files)' after confirming the folder
|
||||
3. Call the agent anytime after compilation
|
||||
|
||||
**Location Information:**
|
||||
|
||||
- Saved location: {{output_file}}
|
||||
- Available after compilation in project
|
||||
|
||||
**Initial Usage:**
|
||||
|
||||
- List the commands available
|
||||
- Suggest trying the first command to see it in action
|
||||
|
||||
<check if="expert agent">
|
||||
<action>Remind user to add any special knowledge or data the agent might need to its workspace</action>
|
||||
</check>
|
||||
|
||||
<action>Explore what user would like to do next - test the agent, create a teammate, or tweak personality</action>
|
||||
|
||||
<action>End with enthusiasm in {communication_language}, addressing {user_name}, expressing how the collaboration was enjoyable and the agent will be incredibly helpful for its main purpose</action>
|
||||
|
||||
<template-output>completion_message</template-output>
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@ -1,40 +0,0 @@
|
||||
# Build Agent Workflow Configuration
|
||||
name: create-agent
|
||||
description: "Interactive workflow to build BMAD Core compliant agents (YAML source compiled to .md during install) with optional brainstorming, persona development, and command structure"
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables load from config_source
|
||||
config_source: "{project-root}/.bmad/bmb/config.yaml"
|
||||
custom_agent_location: "{config_source}:custom_agent_location"
|
||||
user_name: "{config_source}:user_name"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
|
||||
# Technical documentation for agent building
|
||||
agent_compilation: "{project-root}/.bmad/bmb/docs/agent-compilation.md"
|
||||
understanding_agent_types: "{project-root}/.bmad/bmb/docs/understanding-agent-types.md"
|
||||
simple_agent_architecture: "{project-root}/.bmad/bmb/docs/simple-agent-architecture.md"
|
||||
expert_agent_architecture: "{project-root}/.bmad/bmb/docs/expert-agent-architecture.md"
|
||||
module_agent_architecture: "{project-root}/.bmad/bmb/docs/module-agent-architecture.md"
|
||||
agent_menu_patterns: "{project-root}/.bmad/bmb/docs/agent-menu-patterns.md"
|
||||
communication_presets: "{installed_path}/communication-presets.csv"
|
||||
|
||||
# Reference examples
|
||||
simple_agent_examples: "{project-root}/src/modules/bmb/reference/agents/simple-examples/"
|
||||
expert_agent_examples: "{project-root}/src/modules/bmb/reference/agents/expert-examples/"
|
||||
module_agent_examples: "{project-root}/src/modules/bmb/reference/agents/module-examples/"
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/.bmad/bmb/workflows/create-agent"
|
||||
template: false # This is an interactive workflow - no template needed
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/agent-validation-checklist.md"
|
||||
|
||||
# Output configuration - YAML agents compiled to .md at install time
|
||||
# Module agents: Save to .bmad/{{target_module}}/agents/
|
||||
# Standalone agents: Save to custom_agent_location/
|
||||
module_output_file: "{project-root}/.bmad/{{target_module}}/agents/{{agent_filename}}.agent.yaml"
|
||||
standalone_output_file: "{custom_agent_location}/{{agent_filename}}.agent.yaml"
|
||||
# Optional user override file (auto-created by installer if missing)
|
||||
config_output_file: "{project-root}/.bmad/_cfg/agents/{{target_module}}-{{agent_filename}}.customize.yaml"
|
||||
|
||||
standalone: true
|
||||
@ -1,229 +0,0 @@
|
||||
# Create Module Workflow
|
||||
|
||||
Interactive scaffolding system creating complete BMad modules with agents, workflows, tasks, and installation infrastructure.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Quick Start](#quick-start)
|
||||
- [Workflow Phases](#workflow-phases)
|
||||
- [Output Structure](#output-structure)
|
||||
- [Module Components](#module-components)
|
||||
- [Best Practices](#best-practices)
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Basic invocation
|
||||
workflow create-module
|
||||
|
||||
# With module brief input
|
||||
workflow create-module --input module-brief-{name}-{date}.md
|
||||
|
||||
# Via BMad Builder
|
||||
*create-module
|
||||
```
|
||||
|
||||
## Workflow Phases
|
||||
|
||||
### Phase 1: Concept Definition
|
||||
|
||||
- Define module purpose and audience
|
||||
- Establish module code (kebab-case) and name
|
||||
- Choose category (Domain, Creative, Technical, Business, Personal)
|
||||
- Plan component architecture
|
||||
|
||||
**Module Brief Integration:**
|
||||
|
||||
- Auto-detects existing briefs
|
||||
- Uses as pre-populated blueprint
|
||||
- Accelerates planning phase
|
||||
|
||||
### Phase 2: Architecture Planning
|
||||
|
||||
- Create directory hierarchy
|
||||
- Setup configuration system
|
||||
- Define installer structure
|
||||
- Establish component folders
|
||||
|
||||
### Phase 3: Component Creation
|
||||
|
||||
- Optional first agent creation
|
||||
- Optional first workflow creation
|
||||
- Component placeholder generation
|
||||
- Integration validation
|
||||
|
||||
### Phase 4: Installation Setup
|
||||
|
||||
- Create install-config.yaml
|
||||
- Configure deployment questions
|
||||
- Setup installer logic
|
||||
- Post-install messaging
|
||||
|
||||
### Phase 5: Documentation
|
||||
|
||||
- Generate comprehensive README
|
||||
- Create development roadmap
|
||||
- Provide quick commands
|
||||
- Document next steps
|
||||
|
||||
## Output Structure
|
||||
|
||||
### Generated Directory
|
||||
|
||||
```
|
||||
.bmad/{module-code}/
|
||||
├── agents/ # Agent definitions
|
||||
├── workflows/ # Workflow processes
|
||||
├── tasks/ # Reusable tasks
|
||||
├── templates/ # Document templates
|
||||
├── data/ # Module data files
|
||||
├── _module-installer/ # Installation logic
|
||||
│ ├── install-config.yaml
|
||||
│ └── installer.js
|
||||
├── README.md # Module documentation
|
||||
├── TODO.md # Development roadmap
|
||||
└── config.yaml # Runtime configuration
|
||||
```
|
||||
|
||||
### Configuration Files
|
||||
|
||||
**install-config.yaml** - Installation questions
|
||||
|
||||
```yaml
|
||||
questions:
|
||||
- id: user_name
|
||||
prompt: 'Your name?'
|
||||
default: 'User'
|
||||
- id: output_folder
|
||||
prompt: 'Output location?'
|
||||
default: './output'
|
||||
```
|
||||
|
||||
**config.yaml** - Generated from user answers during install
|
||||
|
||||
```yaml
|
||||
user_name: 'John Doe'
|
||||
output_folder: './my-output'
|
||||
```
|
||||
|
||||
## Module Components
|
||||
|
||||
### Agents
|
||||
|
||||
- Full module agents with workflows
|
||||
- Expert agents with sidecars
|
||||
- Simple utility agents
|
||||
|
||||
### Workflows
|
||||
|
||||
- Multi-step guided processes
|
||||
- Configuration-driven
|
||||
- Web bundle support
|
||||
|
||||
### Tasks
|
||||
|
||||
- Reusable operations
|
||||
- Agent-agnostic
|
||||
- Modular components
|
||||
|
||||
### Templates
|
||||
|
||||
- Document structures
|
||||
- Output formats
|
||||
- Report templates
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Planning
|
||||
|
||||
1. **Use module-brief workflow first** - Creates comprehensive blueprint
|
||||
2. **Define clear scope** - Avoid feature creep
|
||||
3. **Plan component interactions** - Map agent/workflow relationships
|
||||
|
||||
### Structure
|
||||
|
||||
1. **Follow conventions** - Use established patterns
|
||||
2. **Keep components focused** - Single responsibility
|
||||
3. **Document thoroughly** - Clear README and inline docs
|
||||
|
||||
### Development
|
||||
|
||||
1. **Start with core agent** - Build primary functionality first
|
||||
2. **Create key workflows** - Essential processes before edge cases
|
||||
3. **Test incrementally** - Validate as you build
|
||||
|
||||
### Installation
|
||||
|
||||
1. **Minimal config questions** - Only essential settings
|
||||
2. **Smart defaults** - Sensible out-of-box experience
|
||||
3. **Clear post-install** - Guide users to first steps
|
||||
|
||||
## Integration Points
|
||||
|
||||
### With Other Workflows
|
||||
|
||||
- **module-brief** - Strategic planning input
|
||||
- **create-agent** - Agent component creation
|
||||
- **create-workflow** - Workflow building
|
||||
- **redoc** - Documentation maintenance
|
||||
|
||||
### With BMad Core
|
||||
|
||||
- Uses core framework capabilities
|
||||
- Integrates with module system
|
||||
- Follows BMad conventions
|
||||
|
||||
## Examples
|
||||
|
||||
### Domain-Specific Module
|
||||
|
||||
```
|
||||
Category: Domain-Specific
|
||||
Code: legal-advisor
|
||||
Components:
|
||||
- Contract Review Agent
|
||||
- Compliance Workflow
|
||||
- Legal Templates
|
||||
```
|
||||
|
||||
### Creative Module
|
||||
|
||||
```
|
||||
Category: Creative
|
||||
Code: story-builder
|
||||
Components:
|
||||
- Narrative Agent
|
||||
- Plot Workflow
|
||||
- Character Templates
|
||||
```
|
||||
|
||||
### Technical Module
|
||||
|
||||
```
|
||||
Category: Technical
|
||||
Code: api-tester
|
||||
Components:
|
||||
- Test Runner Agent
|
||||
- API Validation Workflow
|
||||
- Test Report Templates
|
||||
```
|
||||
|
||||
## Workflow Files
|
||||
|
||||
```
|
||||
create-module/
|
||||
├── workflow.yaml # Configuration
|
||||
├── instructions.md # Step guide
|
||||
├── checklist.md # Validation
|
||||
├── module-structure.md # Architecture
|
||||
├── installer-templates/ # Install files
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Module Structure](./module-structure.md)
|
||||
- [Module Brief Workflow](../module-brief/README.md)
|
||||
- [Create Agent](../create-agent/README.md)
|
||||
- [Create Workflow](../create-workflow/README.md)
|
||||
- [BMB Module](../../README.md)
|
||||
@ -1,92 +0,0 @@
|
||||
# {{MODULE_NAME}} Module Configuration
|
||||
# This file defines installation questions and module configuration values
|
||||
|
||||
code: "{{MODULE_CODE}}"
|
||||
name: "{{MODULE_NAME}}"
|
||||
default_selected: "{{DEFAULT_SELECTED}}" # true if this should be selected by default
|
||||
|
||||
# Welcome message shown during installation
|
||||
prompt:
|
||||
- "{{WELCOME_MESSAGE_LINE_1}}"
|
||||
- "{{WELCOME_MESSAGE_LINE_2}}"
|
||||
# Core config values are automatically inherited:
|
||||
## user_name
|
||||
## communication_language
|
||||
## document_output_language
|
||||
## output_folder
|
||||
|
||||
# ============================================================================
|
||||
# CONFIGURATION FIELDS
|
||||
# ============================================================================
|
||||
#
|
||||
# Each field can be:
|
||||
# 1. INTERACTIVE (has 'prompt' - asks user during installation)
|
||||
# 2. STATIC (no 'prompt' - just uses 'result' value)
|
||||
#
|
||||
# Field structure:
|
||||
# field_name:
|
||||
# prompt: "Question to ask user" (optional - omit for static values)
|
||||
# default: "default_value" (optional)
|
||||
# result: "{value}" or "static-value"
|
||||
# single-select: [...] (optional - for dropdown)
|
||||
# multi-select: [...] (optional - for checkboxes)
|
||||
#
|
||||
# Special placeholders in result:
|
||||
# {value} - replaced with user's answer
|
||||
# {project-root} - replaced with project root path
|
||||
# {directory_name} - replaced with project directory name
|
||||
# {module_code} - replaced with this module's code
|
||||
# ============================================================================
|
||||
|
||||
# EXAMPLE: Interactive text input
|
||||
# example_project_name:
|
||||
# prompt: "What is your project name?"
|
||||
# default: "{directory_name}"
|
||||
# result: "{value}"
|
||||
|
||||
# EXAMPLE: Interactive single-select dropdown
|
||||
# example_skill_level:
|
||||
# prompt: "What is your experience level?"
|
||||
# default: "intermediate"
|
||||
# result: "{value}"
|
||||
# single-select:
|
||||
# - value: "beginner"
|
||||
# label: "Beginner - New to this domain"
|
||||
# - value: "intermediate"
|
||||
# label: "Intermediate - Familiar with basics"
|
||||
# - value: "expert"
|
||||
# label: "Expert - Deep knowledge"
|
||||
|
||||
# EXAMPLE: Interactive multi-select checkboxes
|
||||
# example_features:
|
||||
# prompt:
|
||||
# - "Which features do you want to enable?"
|
||||
# - "(Select all that apply)"
|
||||
# result: "{value}"
|
||||
# multi-select:
|
||||
# - "Feature A"
|
||||
# - "Feature B"
|
||||
# - "Feature C"
|
||||
|
||||
# EXAMPLE: Interactive path input
|
||||
# example_output_path:
|
||||
# prompt: "Where should outputs be saved?"
|
||||
# default: "output/{{MODULE_CODE}}"
|
||||
# result: "{project-root}/{value}"
|
||||
|
||||
# EXAMPLE: Static value (no user prompt)
|
||||
# example_static_setting:
|
||||
# result: "hardcoded-value"
|
||||
|
||||
# EXAMPLE: Static path
|
||||
# module_data_path:
|
||||
# result: "{project-root}/.bmad/{{MODULE_CODE}}/data"
|
||||
|
||||
# ============================================================================
|
||||
# YOUR MODULE CONFIGURATION FIELDS
|
||||
# ============================================================================
|
||||
# Replace examples above with your module's actual configuration needs.
|
||||
# Delete this comment block and the examples when implementing.
|
||||
# ============================================================================
|
||||
|
||||
# TODO: INSERT {MODULE_CONFIG_FIELDS} HERE
|
||||
@ -1,577 +0,0 @@
|
||||
# Build Module - Interactive Module Builder Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/.bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/.bmad/bmb/workflows/create-module/workflow.yaml</critical>
|
||||
<critical>Study existing modules in: {project-root}/.bmad/ for patterns</critical>
|
||||
<critical>Communicate in {communication_language} throughout the module creation process</critical>
|
||||
<critical>⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever.</critical>
|
||||
|
||||
<workflow>
|
||||
|
||||
<step n="-1" goal="Optional brainstorming for module ideas" optional="true">
|
||||
<ask>Do you want to brainstorm module ideas first? [y/n]</ask>
|
||||
|
||||
<check if="yes">
|
||||
<action>Invoke brainstorming workflow: {brainstorming_workflow}</action>
|
||||
<action>Pass context data: {brainstorming_context}</action>
|
||||
<action>Wait for brainstorming session completion</action>
|
||||
<action>Use brainstorming output to inform module concept, agent lineup, and workflow portfolio in following steps</action>
|
||||
</check>
|
||||
|
||||
<check if="no">
|
||||
<action>Proceed directly to Step 0</action>
|
||||
</check>
|
||||
|
||||
<template-output>brainstorming_results</template-output>
|
||||
</step>
|
||||
|
||||
<step n="0" goal="Check for module brief" optional="true">
|
||||
<ask>Do you have a module brief or should we create one? [have/create/skip]</ask>
|
||||
|
||||
<check if="create">
|
||||
<action>Invoke module-brief workflow: {project-root}/.bmad/bmb/workflows/module-brief/workflow.yaml</action>
|
||||
<action>Wait for module brief completion</action>
|
||||
<action>Load the module brief to use as blueprint</action>
|
||||
</check>
|
||||
|
||||
<check if="have">
|
||||
<ask>Provide path to module brief document</ask>
|
||||
<action>Load the module brief and use it to pre-populate all planning sections</action>
|
||||
</check>
|
||||
|
||||
<check if="skip">
|
||||
<action>Proceed directly to Step 1</action>
|
||||
</check>
|
||||
|
||||
<template-output>module_brief</template-output>
|
||||
</step>
|
||||
|
||||
<step n="1" goal="Define module concept and scope">
|
||||
<critical>Load and study the complete module structure guide</critical>
|
||||
<action>Load module structure guide: {module_structure_guide}</action>
|
||||
<action>Understand module types (Simple/Standard/Complex)</action>
|
||||
<action>Review directory structures and component guidelines</action>
|
||||
<action>Study the installation infrastructure patterns</action>
|
||||
|
||||
<action>If brainstorming or module brief was completed, reference those results to guide the conversation</action>
|
||||
|
||||
<action>Guide user to articulate their module's vision, exploring its purpose, what it will help with, and who will use it</action>
|
||||
|
||||
<action>Based on their description, intelligently propose module details:</action>
|
||||
|
||||
**Module Identity Development:**
|
||||
|
||||
1. **Module name** - Extract from their description with proper title case
|
||||
2. **Module code** - Generate kebab-case from name following patterns:
|
||||
- Multi-word descriptive names → shortened kebab-case
|
||||
- Domain-specific terms → recognizable abbreviations
|
||||
- Present suggested code and confirm it works for paths like .bmad/{{code}}/agents/
|
||||
3. **Module purpose** - Refine their description into 1-2 clear sentences
|
||||
4. **Target audience** - Infer from context or ask if unclear
|
||||
|
||||
**Module Theme Reference Categories:**
|
||||
|
||||
- Domain-Specific (Legal, Medical, Finance, Education)
|
||||
- Creative (RPG/Gaming, Story Writing, Music Production)
|
||||
- Technical (DevOps, Testing, Architecture, Security)
|
||||
- Business (Project Management, Marketing, Sales)
|
||||
- Personal (Journaling, Learning, Productivity)
|
||||
|
||||
<critical>Determine output location:</critical>
|
||||
|
||||
- Module will be created at {installer_output_folder}
|
||||
|
||||
<action>Store module identity for scaffolding</action>
|
||||
|
||||
<template-output>module_identity</template-output>
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Plan module components">
|
||||
<action>Based on the module purpose, intelligently propose an initial component architecture</action>
|
||||
|
||||
**Agents Planning:**
|
||||
|
||||
<action>Suggest agents based on module purpose, considering agent types (Simple/Expert/Module) appropriate to each role</action>
|
||||
|
||||
**Example Agent Patterns by Domain:**
|
||||
|
||||
- Data/Analytics: Analyst, Designer, Builder roles
|
||||
- Gaming/Creative: Game Master, Generator, Storytelling roles
|
||||
- Team/Business: Manager, Facilitator, Documentation roles
|
||||
|
||||
<action>Present suggested agent list with types, explaining we can start with core ones and add others later</action>
|
||||
<action>Confirm which agents resonate with their vision</action>
|
||||
|
||||
**Workflows Planning:**
|
||||
|
||||
<action>Intelligently suggest workflows that complement the proposed agents</action>
|
||||
|
||||
**Example Workflow Patterns by Domain:**
|
||||
|
||||
- Data/Analytics: analyze-dataset, create-dashboard, generate-report
|
||||
- Gaming/Creative: session-prep, generate-encounter, world-building
|
||||
- Team/Business: planning, facilitation, documentation workflows
|
||||
|
||||
<action>For each workflow, note whether it should be Document, Action, or Interactive type</action>
|
||||
<action>Confirm which workflows are most important to start with</action>
|
||||
<action>Determine which to create now vs placeholder</action>
|
||||
|
||||
**Tasks Planning (optional):**
|
||||
<ask>Any special tasks that don't warrant full workflows?</ask>
|
||||
|
||||
<action if="tasks needed">For each task, capture name, purpose, and whether standalone or supporting</action>
|
||||
|
||||
<template-output>module_components</template-output>
|
||||
</step>
|
||||
|
||||
<step n="2b" goal="Determine module complexity">
|
||||
<action>Based on components, intelligently determine module type using criteria:</action>
|
||||
|
||||
**Simple Module Criteria:**
|
||||
|
||||
- 1-2 agents, all Simple type
|
||||
- 1-3 workflows
|
||||
- No complex integrations
|
||||
|
||||
**Standard Module Criteria:**
|
||||
|
||||
- 2-4 agents with mixed types
|
||||
- 3-8 workflows
|
||||
- Some shared resources
|
||||
|
||||
**Complex Module Criteria:**
|
||||
|
||||
- 4+ agents or multiple Module-type agents
|
||||
- 8+ workflows
|
||||
- Complex interdependencies
|
||||
- External integrations
|
||||
|
||||
<action>Present determined module type with explanation of what structure will be set up</action>
|
||||
|
||||
<template-output>module_type</template-output>
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Create module directory structure">
|
||||
<critical>Use module path determined in Step 1:</critical>
|
||||
- The module base path is {{module_path}}
|
||||
|
||||
<action>Create base module directories at the determined path:</action>
|
||||
|
||||
```
|
||||
{{module_code}}/
|
||||
├── agents/ # Agent definitions
|
||||
├── workflows/ # Workflow folders
|
||||
├── tasks/ # Task files (if any)
|
||||
├── templates/ # Shared templates
|
||||
├── data/ # Module data files
|
||||
├── _module-installer/ # Installation configuration
|
||||
│ └── install-config.yaml # Configuration questions (config.yaml generated at install time)
|
||||
└── README.md # Module documentation
|
||||
```
|
||||
|
||||
<action>Create installer directory:</action>
|
||||
|
||||
**INSTALLED MODULE STRUCTURE** (generated in target project after installation):
|
||||
|
||||
```
|
||||
{{module_code}}/
|
||||
├── agents/ # Compiled agents
|
||||
├── workflows/ # Workflow instances
|
||||
├── config.yaml # Generated from install-config.yaml during installation
|
||||
└── data/ # User data directory
|
||||
```
|
||||
|
||||
**SOURCE MODULE** (module-installer is for installation only, not copied to target):
|
||||
|
||||
```
|
||||
{{module_code}}/
|
||||
├── _module-installer/
|
||||
│ ├── install-config.yaml # Configuration questions
|
||||
│ ├── installer.js # Optional custom installation logic
|
||||
│ └── assets/ # Files to copy during install
|
||||
```
|
||||
|
||||
<template-output>directory_structure</template-output>
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Plan module configuration fields">
|
||||
<action>Based on the module purpose and components, determine what configuration settings the module needs</action>
|
||||
|
||||
**Configuration Field Planning:**
|
||||
|
||||
<ask>Does your module need any user-configurable settings during installation?</ask>
|
||||
|
||||
**Common configuration patterns:**
|
||||
|
||||
- Output/data paths (where module saves files)
|
||||
- Feature toggles (enable/disable functionality)
|
||||
- Integration settings (API keys, external services)
|
||||
- Behavior preferences (automation level, detail level)
|
||||
- User skill level or experience settings
|
||||
|
||||
<action>For each configuration field needed, determine:</action>
|
||||
|
||||
1. Field name (snake_case)
|
||||
2. Whether it's INTERACTIVE (asks user) or STATIC (hardcoded)
|
||||
3. Prompt text (if interactive)
|
||||
4. Default value
|
||||
5. Type: text input, single-select, or multi-select
|
||||
6. Result template (how the value gets stored)
|
||||
|
||||
<action>Store planned configuration fields for installer generation in step 7</action>
|
||||
|
||||
<template-output>module_config_fields</template-output>
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Create first agent" optional="true">
|
||||
<ask>Create your first agent now? [yes/no]</ask>
|
||||
|
||||
<check if="yes">
|
||||
<action>Invoke agent builder workflow: {agent_builder}</action>
|
||||
<action>Pass module_components as context input</action>
|
||||
<action>Guide them to create the primary agent for the module</action>
|
||||
|
||||
<critical>Save to module's agents folder:</critical>
|
||||
|
||||
- Save to {{module_path}}/agents/
|
||||
</check>
|
||||
|
||||
<check if="no">
|
||||
<action>Create placeholder file in agents folder with TODO notes including agent name, purpose, and type</action>
|
||||
</check>
|
||||
|
||||
<template-output>first_agent</template-output>
|
||||
</step>
|
||||
|
||||
<step n="6" goal="Create first workflow" optional="true">
|
||||
<ask>Create your first workflow now? [yes/no]</ask>
|
||||
|
||||
<check if="yes">
|
||||
<action>Invoke workflow builder: {workflow_builder}</action>
|
||||
<action>Pass module_components as context input</action>
|
||||
<action>Guide them to create the primary workflow</action>
|
||||
|
||||
<critical>Save to module's workflows folder:</critical>
|
||||
|
||||
- Save to {{module_path}}/workflows/
|
||||
</check>
|
||||
|
||||
<check if="no">
|
||||
<action>Create placeholder workflow folder structure with TODO notes for workflow.yaml, instructions.md, and template.md if document workflow</action>
|
||||
</check>
|
||||
|
||||
<template-output>first_workflow</template-output>
|
||||
</step>
|
||||
|
||||
<step n="7" goal="Setup module installer">
|
||||
<action>Load installer template from: {installer_templates}/install-config.yaml</action>
|
||||
|
||||
<critical>IMPORTANT: Create install-config.yaml NOT install-config.yaml</critical>
|
||||
<critical>This is the STANDARD format that BMAD installer uses</critical>
|
||||
|
||||
Create module-installer/install-config.yaml:
|
||||
|
||||
```yaml
|
||||
# {{module_name}} Module Configuration
|
||||
# This file defines installation questions and module configuration values
|
||||
|
||||
code: {{module_code}}
|
||||
name: "{{module_name}}"
|
||||
default_selected: false # Set to true if this should be selected by default
|
||||
|
||||
# Welcome message shown during installation
|
||||
prompt:
|
||||
- "Thank you for choosing {{module_name}}!"
|
||||
- "{{brief_module_description}}"
|
||||
|
||||
# Core config values are automatically inherited:
|
||||
## user_name
|
||||
## communication_language
|
||||
## document_output_language
|
||||
## output_folder
|
||||
|
||||
# ============================================================================
|
||||
# CONFIGURATION FIELDS (from step 4 planning)
|
||||
# ============================================================================
|
||||
# Each field can be:
|
||||
# 1. INTERACTIVE (has 'prompt' - asks user during installation)
|
||||
# 2. STATIC (no 'prompt' - just uses 'result' value)
|
||||
# ============================================================================
|
||||
|
||||
# EXAMPLE Interactive text input:
|
||||
# output_path:
|
||||
# prompt: "Where should {{module_code}} save outputs?"
|
||||
# default: "output/{{module_code}}"
|
||||
# result: "{project-root}/{value}"
|
||||
|
||||
# EXAMPLE Interactive single-select:
|
||||
# detail_level:
|
||||
# prompt: "How detailed should outputs be?"
|
||||
# default: "standard"
|
||||
# result: "{value}"
|
||||
# single-select:
|
||||
# - value: "minimal"
|
||||
# label: "Minimal - Brief summaries only"
|
||||
# - value: "standard"
|
||||
# label: "Standard - Balanced detail"
|
||||
# - value: "detailed"
|
||||
# label: "Detailed - Comprehensive information"
|
||||
|
||||
# EXAMPLE Static value:
|
||||
# module_version:
|
||||
# result: "1.0.0"
|
||||
|
||||
# EXAMPLE Static path:
|
||||
# data_path:
|
||||
# result: "{project-root}/.bmad/{{module_code}}/data"
|
||||
|
||||
{{generated_config_fields_from_step_4}}
|
||||
```
|
||||
|
||||
<critical>Save location:</critical>
|
||||
|
||||
- Save to {{module_path}}/module-installer/install-config.yaml
|
||||
|
||||
<ask>Does your module need custom installation logic (database setup, API registration, etc.)?</ask>
|
||||
|
||||
<check if="yes, create installer.js">
|
||||
```javascript
|
||||
// {{module_name}} Module Installer
|
||||
// Custom installation logic
|
||||
|
||||
- @param {Object} options - Installation options
|
||||
- @param {string} options.projectRoot - Project root directory
|
||||
- @param {Object} options.config - Module configuration from install-config.yaml
|
||||
- @param {Array} options.installedIDEs - List of IDE codes being configured
|
||||
- @param {Object} options.logger - Logger instance (log, warn, error methods)
|
||||
- @returns {boolean} - true if successful, false to abort installation
|
||||
|
||||
async function install(options) {
|
||||
const { projectRoot, config, installedIDEs, logger } = options;
|
||||
|
||||
logger.log('Running {{module_name}} custom installer...');
|
||||
|
||||
// TODO: Add custom installation logic here
|
||||
// Examples:
|
||||
// - Create database tables
|
||||
// - Download external assets
|
||||
// - Configure API connections
|
||||
// - Initialize data files
|
||||
// - Set up webhooks or integrations
|
||||
|
||||
logger.log('{{module_name}} custom installation complete!');
|
||||
return true;
|
||||
|
||||
}
|
||||
|
||||
module.exports = { install };
|
||||
|
||||
`````
|
||||
|
||||
<critical>Save location:</critical>
|
||||
|
||||
- Save to {{module_path}}/module-installer/installer.js
|
||||
</check>
|
||||
|
||||
<check if="no">
|
||||
<action>Skip installer.js creation - the standard installer will handle everything</action>
|
||||
</check>
|
||||
|
||||
<template-output>installer_config</template-output>
|
||||
</step>
|
||||
|
||||
<step n="8" goal="Create module documentation">
|
||||
Generate comprehensive README.md:
|
||||
|
||||
````markdown
|
||||
# {{module_name}}
|
||||
|
||||
{{module_purpose}}
|
||||
|
||||
## Overview
|
||||
|
||||
This module provides:
|
||||
{{component_summary}}
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
bmad install {{module_code}}
|
||||
`````
|
||||
|
||||
````
|
||||
|
||||
## Components
|
||||
|
||||
### Agents ({{agent_count}})
|
||||
|
||||
{{agent_documentation}}
|
||||
|
||||
### Workflows ({{workflow_count}})
|
||||
|
||||
{{workflow_documentation}}
|
||||
|
||||
### Tasks ({{task_count}})
|
||||
|
||||
{{task_documentation}}
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. **Load the main agent:**
|
||||
|
||||
```
|
||||
agent {{primary_agent}}
|
||||
```
|
||||
|
||||
2. **View available commands:**
|
||||
|
||||
```
|
||||
*help
|
||||
```
|
||||
|
||||
3. **Run the main workflow:**
|
||||
```
|
||||
workflow {{primary_workflow}}
|
||||
```
|
||||
|
||||
## Module Structure
|
||||
|
||||
```
|
||||
{{directory_tree}}
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
The module can be configured in `.bmad/{{module_code}}/config.yaml`
|
||||
|
||||
Key settings:
|
||||
{{configuration_options}}
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1: {{example_use_case}}
|
||||
|
||||
{{example_walkthrough}}
|
||||
|
||||
## Development Roadmap
|
||||
|
||||
- [ ] {{roadmap_item_1}}
|
||||
- [ ] {{roadmap_item_2}}
|
||||
- [ ] {{roadmap_item_3}}
|
||||
|
||||
## Contributing
|
||||
|
||||
To extend this module:
|
||||
|
||||
1. Add new agents using `create-agent` workflow
|
||||
2. Add new workflows using `create-workflow` workflow
|
||||
3. Submit improvements via pull request
|
||||
|
||||
## Author
|
||||
|
||||
Created by {{user_name}} on {{date}}
|
||||
|
||||
````
|
||||
|
||||
<template-output>module_readme</template-output>
|
||||
</step>
|
||||
|
||||
<step n="9" goal="Generate component roadmap">
|
||||
Create a development roadmap for remaining components:
|
||||
|
||||
**TODO.md file:**
|
||||
|
||||
```markdown
|
||||
# {{module_name}} Development Roadmap
|
||||
|
||||
## Phase 1: Core Components
|
||||
|
||||
{{phase1_tasks}}
|
||||
|
||||
## Phase 2: Enhanced Features
|
||||
|
||||
{{phase2_tasks}}
|
||||
|
||||
## Phase 3: Polish and Integration
|
||||
|
||||
{{phase3_tasks}}
|
||||
|
||||
## Quick Commands
|
||||
|
||||
Create new agent:
|
||||
```
|
||||
|
||||
workflow create-agent
|
||||
|
||||
```
|
||||
|
||||
Create new workflow:
|
||||
```
|
||||
|
||||
workflow create-workflow
|
||||
|
||||
```
|
||||
|
||||
## Notes
|
||||
{{development_notes}}
|
||||
```
|
||||
|
||||
Ask if user wants to:
|
||||
|
||||
1. Continue building more components now
|
||||
2. Save roadmap for later development
|
||||
3. Test what's been built so far
|
||||
|
||||
<template-output>development_roadmap</template-output>
|
||||
</step>
|
||||
|
||||
<step n="10" goal="Validate and finalize module">
|
||||
<action>Run validation checks:</action>
|
||||
|
||||
**Structure validation:**
|
||||
|
||||
- All required directories created
|
||||
- Config files properly formatted
|
||||
- Installer configuration valid
|
||||
|
||||
**Component validation:**
|
||||
|
||||
- At least one agent or workflow exists (or planned)
|
||||
- All references use correct paths
|
||||
- Module code consistent throughout
|
||||
|
||||
**Documentation validation:**
|
||||
|
||||
- README.md complete
|
||||
- Installation instructions clear
|
||||
- Examples provided
|
||||
|
||||
<action>Present summary to {user_name}:</action>
|
||||
|
||||
- Module name and code
|
||||
- Location path
|
||||
- Agent count (created vs planned)
|
||||
- Workflow count (created vs planned)
|
||||
- Task count
|
||||
- Installer status
|
||||
|
||||
<action>Provide next steps guidance:</action>
|
||||
|
||||
1. Complete remaining components using roadmap
|
||||
2. Run the BMAD Method installer to this project location
|
||||
3. Select 'Compile Agents' option after confirming folder
|
||||
4. Module will be compiled and available for use
|
||||
5. Test with bmad install command
|
||||
6. Share or integrate with existing system
|
||||
|
||||
<ask>Would you like to:
|
||||
|
||||
- Create another component now?
|
||||
- Test the module installation?
|
||||
- Exit and continue later?
|
||||
</ask>
|
||||
|
||||
<template-output>module_summary</template-output>
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@ -1,51 +0,0 @@
|
||||
# Build Module Workflow Configuration
|
||||
name: create-module
|
||||
description: "Interactive workflow to build complete BMAD modules with agents, workflows, tasks, and installation infrastructure"
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables load from config_source
|
||||
config_source: "{project-root}/.bmad/bmb/config.yaml"
|
||||
custom_module_location: "{config_source}:custom_module_location"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
user_name: "{config_source}:user_name"
|
||||
|
||||
# Reference guides for module building
|
||||
module_structure_guide: "{installed_path}/module-structure.md"
|
||||
installer_templates: "{installed_path}/installer-templates/"
|
||||
|
||||
# Use existing build workflows
|
||||
agent_builder: "{project-root}/.bmad/bmb/workflows/create-agent/workflow.yaml"
|
||||
workflow_builder: "{project-root}/.bmad/bmb/workflows/create-workflow/workflow.yaml"
|
||||
brainstorming_workflow: "{project-root}/.bmad/core/workflows/brainstorming/workflow.yaml"
|
||||
brainstorming_context: "{installed_path}/brainstorm-context.md"
|
||||
|
||||
# Reference examples - for learning patterns
|
||||
bmm_module_dir: "{project-root}/.bmad/bmm/"
|
||||
cis_module_dir: "{project-root}/.bmad/cis/"
|
||||
existing_agents_dir: "{project-root}/.bmad/*/agents/"
|
||||
existing_workflows_dir: "{project-root}/.bmad/*/workflows/"
|
||||
|
||||
# Optional user inputs - discovered if they exist
|
||||
input_file_patterns:
|
||||
module_brief:
|
||||
description: "Module brief with vision and requirements (optional)"
|
||||
whole: "{output_folder}/module-brief-*.md"
|
||||
load_strategy: "FULL_LOAD"
|
||||
brainstorming:
|
||||
description: "Brainstorming session outputs (optional)"
|
||||
whole: "{output_folder}/brainstorming-*.md"
|
||||
load_strategy: "FULL_LOAD"
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/.bmad/bmb/workflows/create-module"
|
||||
template: false # This is an interactive scaffolding workflow
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
# Output configuration - creates entire module structure
|
||||
# Save to custom_module_location/{{module_code}}
|
||||
installer_output_folder: "{custom_module_location}/{{module_code}}"
|
||||
|
||||
standalone: true
|
||||
|
||||
# Web bundle configuration
|
||||
@ -1,725 +0,0 @@
|
||||
# Build Workflow - Workflow Builder Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/.bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/.bmad/bmb/workflows/create-workflow/workflow.yaml</critical>
|
||||
<critical>You MUST fully understand the workflow creation guide at: {workflow_creation_guide}</critical>
|
||||
<critical>Study the guide thoroughly to follow ALL conventions for optimal human-AI collaboration</critical>
|
||||
<critical>Communicate in {communication_language} throughout the workflow creation process</critical>
|
||||
<critical>⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever.</critical>
|
||||
|
||||
<workflow>
|
||||
|
||||
<step n="-1" goal="Optional brainstorming phase" optional="true">
|
||||
<ask>Do you want to brainstorm workflow ideas first? [y/n]</ask>
|
||||
|
||||
<action if="user_response == 'y' or user_response == 'yes'">
|
||||
Invoke brainstorming workflow to explore ideas and design concepts:
|
||||
- Workflow: {project-root}/.bmad/core/workflows/brainstorming/workflow.yaml
|
||||
- Context data: {installed_path}/brainstorm-context.md
|
||||
- Purpose: Generate creative workflow ideas, explore different approaches, and clarify requirements
|
||||
|
||||
The brainstorming output will inform:
|
||||
|
||||
- Workflow purpose and goals
|
||||
- Workflow type selection
|
||||
- Step design and structure
|
||||
- User experience considerations
|
||||
- Technical requirements
|
||||
</action>
|
||||
|
||||
<action if="user_response == 'n' or user_response == 'no'">
|
||||
Skip brainstorming and proceed directly to workflow building process.
|
||||
</action>
|
||||
</step>
|
||||
|
||||
<step n="0" goal="Load and understand workflow conventions">
|
||||
<action>Load the complete workflow creation guide from: {workflow_creation_guide}</action>
|
||||
<action>Study all sections thoroughly including:
|
||||
- Core concepts (tasks vs workflows, workflow types)
|
||||
- Workflow structure (required/optional files, patterns)
|
||||
- Writing instructions (step attributes, XML tags, flow control)
|
||||
- Templates and variables (syntax, naming, sources)
|
||||
- Validation best practices
|
||||
- Common pitfalls to avoid
|
||||
</action>
|
||||
<action>Load template files from: {workflow_template_path}/</action>
|
||||
<critical>You must follow ALL conventions from the guide to ensure optimal human-AI collaboration</critical>
|
||||
</step>
|
||||
|
||||
<step n="1" goal="Define workflow purpose and type">
|
||||
Ask the user:
|
||||
- What is the workflow name? (kebab-case, e.g., "product-brief")
|
||||
- What module will it belong to? (e.g., "bmm", "bmb", "cis")
|
||||
- Store as {{target_module}} for output path determination
|
||||
- What is the workflow's main purpose?
|
||||
- What type of workflow is this?
|
||||
- Document workflow (generates documents like PRDs, specs)
|
||||
- Action workflow (performs actions like refactoring)
|
||||
- Interactive workflow (guided sessions)
|
||||
- Autonomous workflow (runs without user input)
|
||||
- Meta-workflow (coordinates other workflows)
|
||||
|
||||
Based on type, determine which files are needed:
|
||||
|
||||
- Document: workflow.yaml + template.md + instructions.md + checklist.md
|
||||
- Action: workflow.yaml + instructions.md
|
||||
- Others: Varies based on requirements
|
||||
|
||||
<critical>Determine output location based on module assignment:</critical>
|
||||
|
||||
- If workflow belongs to module: Save to {module_output_folder}
|
||||
- If standalone workflow: Save to {standalone_output_folder}
|
||||
|
||||
Store decisions for later use.
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Gather workflow metadata and invocation settings">
|
||||
Collect essential configuration details:
|
||||
- Description (clear purpose statement)
|
||||
- Author name (default to user_name or "BMad")
|
||||
- Output file naming pattern
|
||||
- Any required input documents
|
||||
- Any required tools or dependencies
|
||||
|
||||
<action>Determine standalone property - this controls how the workflow can be invoked:
|
||||
|
||||
Explain to the user:
|
||||
|
||||
**Standalone Property** controls whether the workflow can be invoked directly or only called by other workflows/agents.
|
||||
|
||||
**standalone: true (DEFAULT - Recommended for most workflows)**:
|
||||
|
||||
- Users can invoke directly via IDE commands or `/workflow-name`
|
||||
- Shows up in IDE command palette
|
||||
- Can also be called from agent menus or other workflows
|
||||
- Use for: User-facing workflows, entry-point workflows, any workflow users run directly
|
||||
|
||||
**standalone: false (Use for helper/internal workflows)**:
|
||||
|
||||
- Cannot be invoked directly by users
|
||||
- Only called via `<invoke-workflow>` from other workflows or agent menus
|
||||
- Doesn't appear in IDE command palette
|
||||
- Use for: Internal utilities, sub-workflows, helpers that don't make sense standalone
|
||||
|
||||
Most workflows should be `standalone: true` to give users direct access.
|
||||
</action>
|
||||
|
||||
<ask>Should this workflow be directly invokable by users?
|
||||
|
||||
1. **Yes (Recommended)** - Users can run it directly (standalone: true)
|
||||
2. **No** - Only called by other workflows/agents (standalone: false)
|
||||
|
||||
Most workflows choose option 1:
|
||||
</ask>
|
||||
|
||||
<action>Store {{standalone_setting}} as true or false based on response</action>
|
||||
|
||||
Create the workflow name in kebab-case and verify it doesn't conflict with existing workflows.
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Understand workflow interaction style and design steps">
|
||||
<critical>Instruction style and interactivity level fundamentally shape the user experience - choose thoughtfully</critical>
|
||||
|
||||
<action>Reference the comprehensive "Instruction Styles: Intent-Based vs Prescriptive" section from the loaded creation guide</action>
|
||||
|
||||
<action>Discuss instruction style collaboratively with the user:
|
||||
|
||||
Explain that there are two primary approaches:
|
||||
|
||||
**Intent-Based (RECOMMENDED as default)**:
|
||||
|
||||
- Gives AI goals and principles, lets it adapt conversation naturally
|
||||
- More flexible, conversational, responsive to user context
|
||||
- Better for: discovery, complex decisions, teaching, varied user skill levels
|
||||
- Uses <action> tags with guiding instructions
|
||||
- Example from architecture workflow: Facilitates decisions adapting to user_skill_level
|
||||
|
||||
**Prescriptive**:
|
||||
|
||||
- Provides exact questions and specific options
|
||||
- More controlled, predictable, consistent across runs
|
||||
- Better for: simple data collection, finite options, compliance, quick setup
|
||||
- Uses <ask> tags with specific question text
|
||||
- Example: Platform selection with 5 defined choices
|
||||
|
||||
Explain that **most workflows should default to intent-based** but use prescriptive for simple data points.
|
||||
The architecture workflow is an excellent example of intent-based with prescriptive moments.
|
||||
</action>
|
||||
|
||||
<ask>For this workflow's PRIMARY style:
|
||||
|
||||
1. **Intent-based (Recommended)** - Adaptive, conversational, responds to user context
|
||||
2. **Prescriptive** - Structured, consistent, controlled interactions
|
||||
3. **Mixed/Balanced** - I'll help you decide step-by-step
|
||||
|
||||
What feels right for your workflow's purpose?
|
||||
</ask>
|
||||
|
||||
<action>Store {{instruction_style}} preference</action>
|
||||
|
||||
<action>Now discuss interactivity level:
|
||||
|
||||
Beyond style, consider **how interactive** this workflow should be:
|
||||
|
||||
**High Interactivity (Collaborative)**:
|
||||
|
||||
- Constant back-and-forth with user
|
||||
- User guides direction, AI facilitates
|
||||
- Iterative refinement and review
|
||||
- Best for: creative work, complex decisions, learning experiences
|
||||
- Example: Architecture workflow's collaborative decision-making
|
||||
|
||||
**Medium Interactivity (Guided)**:
|
||||
|
||||
- Key decision points have interaction
|
||||
- AI proposes, user confirms or refines
|
||||
- Validation checkpoints
|
||||
- Best for: most document workflows, structured processes
|
||||
- Example: PRD workflow with sections to review
|
||||
|
||||
**Low Interactivity (Autonomous)**:
|
||||
|
||||
- Minimal user input required
|
||||
- AI works independently with guidelines
|
||||
- User reviews final output
|
||||
- Best for: automated generation, batch processing
|
||||
- Example: Generating user stories from epics
|
||||
</action>
|
||||
|
||||
<ask>What interactivity level suits this workflow?
|
||||
|
||||
1. **High** - Highly collaborative, user actively involved throughout (Recommended)
|
||||
2. **Medium** - Guided with key decision points
|
||||
3. **Low** - Mostly autonomous with final review
|
||||
|
||||
Select the level that matches your workflow's purpose:
|
||||
</ask>
|
||||
|
||||
<action>Store {{interactivity_level}} preference</action>
|
||||
|
||||
<action>Explain how these choices will inform the workflow design:
|
||||
|
||||
- Intent-based + High interactivity: Conversational discovery with open questions
|
||||
- Intent-based + Medium: Facilitated guidance with confirmation points
|
||||
- Intent-based + Low: Principle-based autonomous generation
|
||||
- Prescriptive + any level: Structured questions, but frequency varies
|
||||
- Mixed: Strategic use of both styles where each works best
|
||||
</action>
|
||||
|
||||
<action>Now work with user to outline workflow steps:
|
||||
|
||||
- How many major steps? (Recommend 3-7 for most workflows)
|
||||
- What is the goal of each step?
|
||||
- Which steps are optional?
|
||||
- Which steps need heavy user collaboration vs autonomous execution?
|
||||
- Which steps should repeat?
|
||||
- What variables/outputs does each step produce?
|
||||
|
||||
Consider their instruction_style and interactivity_level choices when designing step flow:
|
||||
|
||||
- High interactivity: More granular steps with collaboration
|
||||
- Low interactivity: Larger autonomous steps with review
|
||||
- Intent-based: Focus on goals and principles in step descriptions
|
||||
- Prescriptive: Define specific questions and options
|
||||
</action>
|
||||
|
||||
<action>Create a step outline that matches the chosen style and interactivity level</action>
|
||||
<action>Note which steps should be intent-based vs prescriptive (if mixed approach)</action>
|
||||
|
||||
<template-output>step_outline</template-output>
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Create workflow.yaml">
|
||||
Load and use the template at: {template_workflow_yaml}
|
||||
|
||||
Replace all placeholders following the workflow creation guide conventions:
|
||||
|
||||
- {TITLE} → Proper case workflow name
|
||||
- {WORKFLOW_CODE} → kebab-case name
|
||||
- {WORKFLOW_DESCRIPTION} → Clear description
|
||||
- {module-code} → Target module
|
||||
- {file.md} → Output filename pattern
|
||||
|
||||
Include:
|
||||
|
||||
- All metadata from steps 1-2
|
||||
- **Standalone property**: Use {{standalone_setting}} from step 2 (true or false)
|
||||
- Proper paths for installed_path using variable substitution
|
||||
- Template/instructions/validation paths based on workflow type:
|
||||
- Document workflow: all files (template, instructions, validation)
|
||||
- Action workflow: instructions only (template: false)
|
||||
- Autonomous: set autonomous: true flag
|
||||
- Required tools if any
|
||||
- Recommended inputs if any
|
||||
|
||||
<critical>ALWAYS include the standard config block:</critical>
|
||||
|
||||
```yaml
|
||||
# Critical variables from config
|
||||
config_source: '{project-root}/.bmad/{{target_module}}/config.yaml'
|
||||
output_folder: '{config_source}:output_folder'
|
||||
user_name: '{config_source}:user_name'
|
||||
communication_language: '{config_source}:communication_language'
|
||||
date: system-generated
|
||||
```
|
||||
|
||||
<critical>This standard config ensures workflows can run autonomously and communicate properly with users</critical>
|
||||
|
||||
<critical>ALWAYS include the standalone property:</critical>
|
||||
|
||||
```yaml
|
||||
standalone: { { standalone_setting } } # true or false from step 2
|
||||
```
|
||||
|
||||
**Example complete workflow.yaml structure**:
|
||||
|
||||
```yaml
|
||||
name: 'workflow-name'
|
||||
description: 'Clear purpose statement'
|
||||
|
||||
# Paths
|
||||
installed_path: '{project-root}/.bmad/module/workflows/name'
|
||||
template: '{installed_path}/template.md'
|
||||
instructions: '{installed_path}/instructions.md'
|
||||
validation: '{installed_path}/checklist.md'
|
||||
|
||||
# Critical variables from config
|
||||
config_source: '{project-root}/.bmad/module/config.yaml'
|
||||
output_folder: '{config_source}:output_folder'
|
||||
user_name: '{config_source}:user_name'
|
||||
communication_language: '{config_source}:communication_language'
|
||||
date: system-generated
|
||||
|
||||
# Output
|
||||
default_output_file: '{output_folder}/document.md'
|
||||
|
||||
# Invocation control
|
||||
standalone: true # or false based on step 2 decision
|
||||
```
|
||||
|
||||
Follow path conventions from guide:
|
||||
|
||||
- Use {project-root} for absolute paths
|
||||
- Use {installed_path} for workflow components
|
||||
- Use {config_source} for config references
|
||||
|
||||
<critical>Determine save location:</critical>
|
||||
|
||||
- Use the output folder determined in Step 1 (module or standalone)
|
||||
- Write to {{output_folder}}/workflow.yaml
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Create instructions.md" if="workflow_type != 'template-only'">
|
||||
Load and use the template at: {template_instructions}
|
||||
|
||||
Generate the instructions.md file following the workflow creation guide:
|
||||
|
||||
1. ALWAYS include critical headers:
|
||||
- Workflow engine reference: {project-root}/.bmad/core/tasks/workflow.xml
|
||||
- workflow.yaml reference: must be loaded and processed
|
||||
|
||||
2. Structure with <workflow> tags containing all steps
|
||||
|
||||
3. For each step from design phase, follow guide conventions:
|
||||
- Step attributes: n="X" goal="clear goal statement"
|
||||
- Optional steps: optional="true"
|
||||
- Repeating: repeat="3" or repeat="for-each-X" or repeat="until-approved"
|
||||
- Conditional: if="condition"
|
||||
- Sub-steps: Use 3a, 3b notation
|
||||
|
||||
4. Use proper XML tags from guide:
|
||||
- Execution: <action>, <check>, <ask>, <goto>, <invoke-workflow>
|
||||
- Output: <template-output>, <invoke-task halt="true">{project-root}/.bmad/core/tasks/advanced-elicitation.xml</invoke-task>, <critical>, <example>
|
||||
- Flow: <loop>, <break>, <continue>
|
||||
|
||||
5. Best practices from guide:
|
||||
- Keep steps focused (single goal)
|
||||
- Be specific ("Write 1-2 paragraphs" not "Write about")
|
||||
- Provide examples where helpful
|
||||
- Set limits ("3-5 items maximum")
|
||||
- Save checkpoints with <template-output>
|
||||
|
||||
<critical>Standard config variable usage:</critical>
|
||||
|
||||
Instructions MUST use the standard config variables where appropriate:
|
||||
|
||||
- Communicate in {communication_language} throughout the workflow
|
||||
- Address user as {user_name} in greetings and summaries
|
||||
- Write all output files to {output_folder} or subdirectories
|
||||
- Include {date} in generated document headers
|
||||
|
||||
Example usage in instructions:
|
||||
|
||||
```xml
|
||||
<action>Write document to {output_folder}/output-file.md</action>
|
||||
<critical>Communicate all responses in {communication_language}</critical>
|
||||
<output>Hello {user_name}, the workflow is complete!</output>
|
||||
```
|
||||
|
||||
<critical>Applying instruction style preference:</critical>
|
||||
|
||||
Based on the {{instruction_style}} preference from Step 3, generate instructions using these patterns:
|
||||
|
||||
**Intent-Based Instructions (Recommended for most workflows):**
|
||||
|
||||
Focus on goals, principles, and desired outcomes. Let the LLM adapt the conversation naturally.
|
||||
|
||||
✅ **Good Examples:**
|
||||
|
||||
```xml
|
||||
<!-- Discovery and exploration -->
|
||||
<action>Guide user to define their target audience with specific demographics, psychographics, and behavioral characteristics</action>
|
||||
<action>Explore the user's vision for the product, asking probing questions to uncover core motivations and success criteria</action>
|
||||
<action>Help user identify and prioritize key features based on user value and technical feasibility</action>
|
||||
|
||||
<!-- Validation and refinement -->
|
||||
<action>Validate that the technical approach aligns with project constraints and team capabilities</action>
|
||||
<action>Challenge assumptions about user needs and market fit with thought-provoking questions</action>
|
||||
|
||||
<!-- Complex iterative work -->
|
||||
<action>Collaborate with user to refine the architecture, iterating until they're satisfied with the design</action>
|
||||
```
|
||||
|
||||
❌ **Avoid (too prescriptive):**
|
||||
|
||||
```xml
|
||||
<ask>What is your target audience age range? Choose: 18-24, 25-34, 35-44, 45+</ask>
|
||||
<ask>List exactly 3 key features in priority order</ask>
|
||||
```
|
||||
|
||||
**When to use Intent-Based:**
|
||||
|
||||
- Complex discovery processes (user research, requirements gathering)
|
||||
- Creative brainstorming and ideation
|
||||
- Iterative refinement workflows
|
||||
- When user input quality matters more than consistency
|
||||
- Workflows requiring adaptation to context
|
||||
|
||||
**Prescriptive Instructions (Use selectively):**
|
||||
|
||||
Provide exact wording, specific options, and controlled interactions.
|
||||
|
||||
✅ **Good Examples:**
|
||||
|
||||
```xml
|
||||
<!-- Simple data collection -->
|
||||
<ask>What is your target platform? Choose: PC, Console, Mobile, Web</ask>
|
||||
<ask>Select monetization model: Premium, Free-to-Play, Subscription, Ad-Supported</ask>
|
||||
|
||||
<!-- Compliance and standards -->
|
||||
<ask>Does this comply with GDPR requirements? [yes/no]</ask>
|
||||
<ask>Choose documentation standard: JSDoc, TypeDoc, TSDoc</ask>
|
||||
|
||||
<!-- Binary decisions -->
|
||||
<ask>Do you want to generate test cases? [yes/no]</ask>
|
||||
<ask>Include performance benchmarks? [yes/no]</ask>
|
||||
```
|
||||
|
||||
❌ **Avoid (too rigid for complex tasks):**
|
||||
|
||||
```xml
|
||||
<ask>What are your product goals? List exactly 5 goals, each 10-15 words</ask>
|
||||
<ask>Describe your user persona in exactly 3 sentences</ask>
|
||||
```
|
||||
|
||||
**When to use Prescriptive:**
|
||||
|
||||
- Simple data collection (platform, format, yes/no choices)
|
||||
- Compliance verification and standards adherence
|
||||
- Configuration with finite options
|
||||
- When consistency is critical across all executions
|
||||
- Quick setup wizards
|
||||
|
||||
**Mixing Both Styles (Best Practice):**
|
||||
|
||||
Even if user chose a primary style, use the other when appropriate:
|
||||
|
||||
```xml
|
||||
<!-- Intent-based workflow with prescriptive moments -->
|
||||
<step n="1" goal="Understand user vision">
|
||||
<action>Explore the user's vision for their game, uncovering their creative intent and target experience</action>
|
||||
<action>Ask probing questions about genre, themes, and emotional tone they want to convey</action>
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Capture basic metadata">
|
||||
<ask>What is your target platform? Choose: PC, Console, Mobile, Web</ask> <!-- Prescriptive for simple choice -->
|
||||
<ask>Select primary genre: Action, RPG, Strategy, Puzzle, Simulation, Other</ask>
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Deep dive into gameplay">
|
||||
<action>Guide user to articulate their core gameplay loop, exploring mechanics and player agency</action> <!-- Back to intent-based -->
|
||||
<action>Help them identify what makes their game unique and compelling</action>
|
||||
</step>
|
||||
```
|
||||
|
||||
**Guidelines for the chosen style:**
|
||||
|
||||
If user chose **Intent-Based**:
|
||||
|
||||
- Default to goal-oriented <action> tags
|
||||
- Use open-ended guidance language
|
||||
- Save prescriptive <ask> tags for simple data/choices
|
||||
- Focus on "guide", "explore", "help user", "validate"
|
||||
- Allow LLM to adapt questions to user responses
|
||||
|
||||
If user chose **Prescriptive**:
|
||||
|
||||
- Default to explicit <ask> tags with clear options
|
||||
- Use precise wording for consistency
|
||||
- Save intent-based <action> tags for complex discovery
|
||||
- Focus on "choose", "select", "specify", "confirm"
|
||||
- Provide structured choices when possible
|
||||
|
||||
**Remember:** The goal is optimal human-AI collaboration. Use whichever style best serves the user at each step.
|
||||
|
||||
<critical>Save location:</critical>
|
||||
|
||||
- Write to {{output_folder}}/instructions.md
|
||||
</step>
|
||||
|
||||
<step n="6" goal="Create template.md" if="workflow_type == 'document'">
|
||||
Load and use the template at: {template_template}
|
||||
|
||||
Generate the template.md file following guide conventions:
|
||||
|
||||
1. Document structure with clear sections
|
||||
2. Variable syntax: {{variable_name}} using snake_case
|
||||
3. Variable names MUST match <template-output> tags exactly from instructions
|
||||
4. Include standard metadata header (optional - config variables available):
|
||||
|
||||
```markdown
|
||||
# Document Title
|
||||
|
||||
**Date:** {{date}}
|
||||
|
||||
**Author:** {{user_name}}
|
||||
```
|
||||
|
||||
Note: {{date}} and {{user_name}} are optional in headers. Primary purpose of these variables:
|
||||
- {{date}} - Gives agent current date awareness (not confused with training cutoff)
|
||||
- {{user_name}} - Optional author attribution
|
||||
- {{communication_language}} - NOT for document output! Tells agent how to communicate during execution
|
||||
|
||||
5. Follow naming conventions from guide:
|
||||
- Use descriptive names: {{primary_user_journey}} not {{puj}}
|
||||
- Snake_case for all variables
|
||||
- Match instruction outputs precisely
|
||||
|
||||
Variable sources as per guide:
|
||||
|
||||
- workflow.yaml config values (user_name, communication_language, date, output_folder)
|
||||
- User input runtime values
|
||||
- Step outputs via <template-output>
|
||||
- System variables (date, paths)
|
||||
|
||||
<critical>Standard config variables in templates:</critical>
|
||||
|
||||
Templates CAN optionally use these config variables:
|
||||
|
||||
- {{user_name}} - Document author (optional)
|
||||
- {{date}} - Generation date (optional)
|
||||
|
||||
IMPORTANT: {{communication_language}} is NOT for document headers!
|
||||
|
||||
- Purpose: Tells agent how to communicate with user during workflow execution
|
||||
- NOT for: Document output language or template headers
|
||||
- Future: {{document_output_language}} will handle multilingual document generation
|
||||
|
||||
These variables are automatically available from workflow.yaml config block.
|
||||
|
||||
<critical>Save location:</critical>
|
||||
|
||||
- Write to {{output_folder}}/template.md
|
||||
</step>
|
||||
|
||||
<step n="7" goal="Create validation checklist" optional="true">
|
||||
Ask if user wants a validation checklist. If yes:
|
||||
|
||||
Load and use the template at: {template_checklist}
|
||||
|
||||
Create checklist.md following guide best practices:
|
||||
|
||||
1. Make criteria MEASURABLE and SPECIFIC
|
||||
❌ "- [ ] Good documentation"
|
||||
✅ "- [ ] Each function has JSDoc comments with parameters and return types"
|
||||
|
||||
2. Group checks logically:
|
||||
- Structure: All sections present, no placeholders, proper formatting
|
||||
- Content Quality: Clear and specific, technically accurate, consistent terminology
|
||||
- Completeness: Ready for next phase, dependencies documented, action items defined
|
||||
|
||||
3. Include workflow-specific validations based on type:
|
||||
- Document workflows: Template variables mapped, sections complete
|
||||
- Action workflows: Actions clearly defined, error handling specified
|
||||
- Interactive: User prompts clear, decision points documented
|
||||
|
||||
4. Add final validation section with issue lists
|
||||
|
||||
<critical>Save location:</critical>
|
||||
|
||||
- Write to {{output_folder}}/checklist.md
|
||||
</step>
|
||||
|
||||
<step n="8" goal="Create supporting files" optional="true">
|
||||
Ask if any supporting data files are needed:
|
||||
- CSV files with data
|
||||
- Example documents
|
||||
- Reference materials
|
||||
|
||||
If yes, create placeholder files or copy from templates.
|
||||
</step>
|
||||
|
||||
<step n="9" goal="Test and validate workflow">
|
||||
Review the created workflow:
|
||||
|
||||
**Basic Validation:**
|
||||
|
||||
1. Verify all file paths are correct
|
||||
2. Check variable names match between files
|
||||
3. Ensure step numbering is sequential
|
||||
4. Validate YAML syntax
|
||||
5. Confirm all placeholders are replaced
|
||||
|
||||
**Standard Config Validation:**
|
||||
|
||||
6. Verify workflow.yaml contains standard config block:
|
||||
|
||||
- config_source defined
|
||||
- output_folder, user_name, communication_language pulled from config
|
||||
- date set to system-generated
|
||||
|
||||
7. Check instructions use config variables where appropriate
|
||||
8. Verify template includes config variables in metadata (if document workflow)
|
||||
|
||||
**YAML/Instruction/Template Alignment:**
|
||||
|
||||
9. Cross-check all workflow.yaml variables against instruction usage:
|
||||
|
||||
- Are all yaml variables referenced in instructions.md OR template.md?
|
||||
- Are there hardcoded values that should be variables?
|
||||
- Do template variables match <template-output> tags in instructions?
|
||||
|
||||
10. Identify any unused yaml fields (bloat detection)
|
||||
|
||||
Show user a summary of created files and their locations.
|
||||
Ask if they want to:
|
||||
|
||||
- Test run the workflow
|
||||
- Make any adjustments
|
||||
- Add additional steps or features
|
||||
</step>
|
||||
|
||||
<step n="9b" goal="Configure web bundle (optional)">
|
||||
<ask>Will this workflow need to be deployable as a web bundle? [yes/no]</ask>
|
||||
|
||||
If yes:
|
||||
<action>Explain web bundle requirements:</action>
|
||||
|
||||
- Web bundles are self-contained and cannot use config_source variables
|
||||
- All files must be explicitly listed in web_bundle_files
|
||||
- File paths use .bmad/ root (not {project-root})
|
||||
|
||||
<action>Configure web_bundle section in workflow.yaml:</action>
|
||||
|
||||
1. Copy core workflow metadata (name, description, author)
|
||||
2. Convert all file paths to .bmad/-relative paths:
|
||||
- Remove {project-root}/ prefix
|
||||
- Remove {config_source} references (use hardcoded values)
|
||||
- Example: "{project-root}/.bmad/bmm/workflows/x" → ".bmad/bmm/workflows/x"
|
||||
|
||||
3. List ALL referenced files by scanning:
|
||||
|
||||
**Scan instructions.md for:**
|
||||
- File paths in <action> tags
|
||||
- Data files (CSV, JSON, YAML, etc.)
|
||||
- Validation/checklist files
|
||||
- Any <invoke-workflow> calls → must include that workflow's yaml file
|
||||
- Any <goto> tags that reference other workflows
|
||||
- Shared templates or includes
|
||||
|
||||
**Scan template.md for:**
|
||||
- Any includes or references to other files
|
||||
- Shared template fragments
|
||||
|
||||
**Critical: Workflow Dependencies**
|
||||
- If instructions call another workflow, that workflow's yaml MUST be in web_bundle_files
|
||||
- Example: `<invoke-workflow>{project-root}/.bmad/core/workflows/x/workflow.yaml</invoke-workflow>`
|
||||
→ Add ".bmad/core/workflows/x/workflow.yaml" to web_bundle_files
|
||||
|
||||
4. Create web_bundle_files array with complete list
|
||||
|
||||
Example:
|
||||
|
||||
```yaml
|
||||
web_bundle:
|
||||
name: '{workflow_name}'
|
||||
description: '{workflow_description}'
|
||||
author: '{author}'
|
||||
instructions: '.bmad/{module}/workflows/{workflow}/instructions.md'
|
||||
validation: '.bmad/{module}/workflows/{workflow}/checklist.md'
|
||||
template: '.bmad/{module}/workflows/{workflow}/template.md'
|
||||
|
||||
# Any data files (no config_source)
|
||||
data_file: '.bmad/{module}/workflows/{workflow}/data.csv'
|
||||
|
||||
web_bundle_files:
|
||||
- '.bmad/{module}/workflows/{workflow}/instructions.md'
|
||||
- '.bmad/{module}/workflows/{workflow}/checklist.md'
|
||||
- '.bmad/{module}/workflows/{workflow}/template.md'
|
||||
- '.bmad/{module}/workflows/{workflow}/data.csv'
|
||||
# Add every single file referenced anywhere
|
||||
|
||||
# CRITICAL: If this workflow invokes other workflows, use existing_workflows
|
||||
# This signals the bundler to recursively include those workflows' web_bundles
|
||||
existing_workflows:
|
||||
- workflow_variable_name: '.bmad/path/to/workflow.yaml'
|
||||
```
|
||||
|
||||
**Example with existing_workflows:**
|
||||
|
||||
```yaml
|
||||
web_bundle:
|
||||
name: 'brainstorm-game'
|
||||
description: 'Game brainstorming with CIS workflow'
|
||||
author: 'BMad'
|
||||
instructions: '.bmad/bmm/workflows/brainstorm-game/instructions.md'
|
||||
template: false
|
||||
web_bundle_files:
|
||||
- '.bmad/bmm/workflows/brainstorm-game/instructions.md'
|
||||
- '.bmad/mmm/workflows/brainstorm-game/game-context.md'
|
||||
- '.bmad/core/workflows/brainstorming/workflow.yaml'
|
||||
existing_workflows:
|
||||
- core_brainstorming: '.bmad/core/workflows/brainstorming/workflow.yaml'
|
||||
```
|
||||
|
||||
**What existing_workflows does:**
|
||||
|
||||
- Tells the bundler this workflow invokes another workflow
|
||||
- Bundler recursively includes the invoked workflow's entire web_bundle
|
||||
- Essential for meta-workflows that orchestrate other workflows
|
||||
- Maps workflow variable names to their .bmad/-relative paths
|
||||
|
||||
<action>Validate web bundle completeness:</action>
|
||||
|
||||
- Ensure no {config_source} variables remain
|
||||
- Verify all file paths are listed
|
||||
- Check that paths are .bmad/-relative
|
||||
- If workflow uses <invoke-workflow>, add to existing_workflows
|
||||
|
||||
<template-output>web_bundle_config</template-output>
|
||||
</step>
|
||||
|
||||
<step n="10" goal="Document and finalize">
|
||||
<action>Create a brief README for the workflow folder explaining purpose, how to invoke, expected inputs, generated outputs, and any special requirements</action>
|
||||
|
||||
<action>Provide {user_name} with workflow completion summary in {communication_language}:</action>
|
||||
|
||||
- Location of created workflow: {{output_folder}}
|
||||
- Command to run it: `workflow {workflow_name}`
|
||||
- Next steps:
|
||||
- Run the BMAD Method installer to this project location
|
||||
- Select 'Compile Agents (Quick rebuild of all agent .md files)' after confirming the folder
|
||||
- This will compile the new workflow and make it available for use
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,15 +0,0 @@
|
||||
# PRD Workflow Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/.bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-related}/.bmad/{module-code}/workflows/{workflow}/workflow.yaml</critical>
|
||||
<critical>Communicate in {communication_language} throughout the workflow process</critical>
|
||||
|
||||
<!-- For planning/analysis workflows, add: <critical>⚠️ ABSOLUTELY NO TIME ESTIMATES - NEVER mention hours, days, weeks, months, or ANY time-based predictions. AI has fundamentally changed development speed - what once took teams weeks/months can now be done by one person in hours. DO NOT give ANY time estimates whatsoever.</critical> -->
|
||||
|
||||
<workflow>
|
||||
|
||||
<step n="1" goal="">
|
||||
...
|
||||
</step>
|
||||
...
|
||||
</workflow>
|
||||
@ -1,239 +0,0 @@
|
||||
# Edit Agent Workflow
|
||||
|
||||
Interactive workflow for editing existing BMAD agents while maintaining best practices and modern standards.
|
||||
|
||||
## Purpose
|
||||
|
||||
This workflow helps you refine and improve existing agents by:
|
||||
|
||||
- Analyzing agents against BMAD best practices
|
||||
- **Fixing persona field separation issues** (the #1 quality problem)
|
||||
- Identifying issues and improvement opportunities
|
||||
- Providing guided editing for specific aspects
|
||||
- Validating changes against agent standards
|
||||
- Ensuring consistency with modern agent architecture (Simple/Expert/Module)
|
||||
- Migrating from legacy patterns (full/hybrid/standalone)
|
||||
|
||||
## When to Use
|
||||
|
||||
Use this workflow when you need to:
|
||||
|
||||
- **Fix persona field separation** (communication_style has behaviors mixed in)
|
||||
- Fix issues in existing agents (broken paths, invalid references)
|
||||
- Add new menu items or workflows
|
||||
- Improve agent persona or communication style
|
||||
- Update configuration handling
|
||||
- Migrate from legacy terminology (full/hybrid/standalone → Simple/Expert/Module)
|
||||
- Convert between agent types
|
||||
- Optimize agent structure and clarity
|
||||
- Update legacy agents to modern BMAD standards
|
||||
|
||||
## What You'll Need
|
||||
|
||||
- Path to the agent file or folder you want to edit:
|
||||
- Simple agent: path to .agent.yaml file
|
||||
- Expert agent: path to folder containing .agent.yaml and sidecar files
|
||||
- Understanding of what changes you want to make (or let the workflow analyze and suggest)
|
||||
- Access to the agent documentation (loaded automatically)
|
||||
|
||||
## Workflow Steps
|
||||
|
||||
1. **Load and analyze target agent** - Provide path to agent file
|
||||
2. **Discover improvement goals collaboratively** - Discuss what needs improvement and why
|
||||
3. **Facilitate improvements iteratively** - Make changes collaboratively with approval
|
||||
4. **Validate all changes holistically** - Comprehensive validation checklist
|
||||
5. **Review improvements and guide next steps** - Summary and guidance
|
||||
|
||||
## Common Editing Scenarios
|
||||
|
||||
The workflow handles these common improvement needs:
|
||||
|
||||
1. **Fix persona field separation** - Extract behaviors from communication_style to principles (MOST COMMON)
|
||||
2. **Fix critical issues** - Address broken references, syntax errors
|
||||
3. **Edit sidecar files** - Update templates, knowledge bases, docs (Expert agents)
|
||||
4. **Add/fix standard config** - Ensure config loading and variable usage
|
||||
5. **Refine persona** - Improve role, identity, communication style, principles
|
||||
6. **Update activation** - Modify activation steps and greeting
|
||||
7. **Manage menu items** - Add, remove, or reorganize commands
|
||||
8. **Update workflow references** - Fix paths, add new workflows
|
||||
9. **Enhance menu handlers** - Improve handler logic
|
||||
10. **Improve command triggers** - Refine asterisk commands
|
||||
11. **Migrate agent type** - Convert from legacy full/hybrid/standalone to Simple/Expert/Module
|
||||
12. **Add new capabilities** - Add menu items, workflows, features
|
||||
13. **Remove bloat** - Delete unused commands, redundant instructions, orphaned sidecar files
|
||||
14. **Full review and update** - Comprehensive improvements
|
||||
|
||||
**Most agents need persona field separation fixes** - this is the #1 quality issue found in legacy agents.
|
||||
|
||||
## Agent Documentation Loaded
|
||||
|
||||
This workflow automatically loads comprehensive agent documentation:
|
||||
|
||||
**Core Concepts:**
|
||||
|
||||
- **Understanding Agent Types** - Simple, Expert, Module distinctions (architecture, not capability)
|
||||
- **Agent Compilation** - How YAML compiles to XML and what auto-injects
|
||||
|
||||
**Architecture Guides:**
|
||||
|
||||
- **Simple Agent Architecture** - Self-contained agents (NOT capability-limited!)
|
||||
- **Expert Agent Architecture** - Agents with sidecar files (templates, docs, knowledge)
|
||||
- **Module Agent Architecture** - Ecosystem-integrated agents (design intent)
|
||||
|
||||
**Design Patterns:**
|
||||
|
||||
- **Agent Menu Patterns** - Menu handlers, command structure, workflow integration
|
||||
- **Communication Presets** - 60 pure communication styles across 13 categories
|
||||
- **Brainstorm Context** - Creative ideation for persona development
|
||||
|
||||
**Reference Implementations:**
|
||||
|
||||
- **commit-poet** (Simple) - Shows Simple agents can be powerful and sophisticated
|
||||
- **journal-keeper** (Expert) - Shows sidecar structure with memories and patterns
|
||||
- **security-engineer** (Module) - Shows design intent and ecosystem integration
|
||||
- **All BMM agents** - Examples of distinct, memorable communication voices
|
||||
|
||||
**Workflow Execution Engine** - How agents execute workflows
|
||||
|
||||
## Critical: Persona Field Separation
|
||||
|
||||
**THE #1 ISSUE** in legacy agents is persona field separation. The workflow checks for this automatically.
|
||||
|
||||
### What Is Persona Field Separation?
|
||||
|
||||
Each persona field serves a specific purpose that the LLM uses when activating:
|
||||
|
||||
- **role** → "What knowledge, skills, and capabilities do I possess?"
|
||||
- **identity** → "What background, experience, and context shape my responses?"
|
||||
- **communication_style** → "What verbal patterns, word choice, quirks do I use?"
|
||||
- **principles** → "What beliefs and philosophy drive my choices?"
|
||||
|
||||
### The Problem
|
||||
|
||||
Many agents have behaviors/role/identity mixed into communication_style:
|
||||
|
||||
**WRONG:**
|
||||
|
||||
```yaml
|
||||
communication_style: 'Experienced analyst who ensures all stakeholders are heard and uses systematic approaches'
|
||||
```
|
||||
|
||||
**RIGHT:**
|
||||
|
||||
```yaml
|
||||
identity: 'Senior analyst with 8+ years connecting market insights to strategy'
|
||||
communication_style: 'Treats analysis like a treasure hunt - excited by every clue, thrilled when patterns emerge'
|
||||
principles:
|
||||
- 'Ensure all stakeholder voices heard'
|
||||
- 'Use systematic, structured approaches'
|
||||
```
|
||||
|
||||
### Red Flag Words
|
||||
|
||||
If communication_style contains these words, it needs fixing:
|
||||
|
||||
- "ensures", "makes sure", "always", "never" → Behaviors (move to principles)
|
||||
- "experienced", "expert who", "senior" → Identity (move to identity/role)
|
||||
- "believes in", "focused on" → Philosophy (move to principles)
|
||||
|
||||
## Output
|
||||
|
||||
The workflow modifies your agent file in place, maintaining the original format (YAML). Changes are reviewed and approved by you before being applied.
|
||||
|
||||
## Best Practices
|
||||
|
||||
- **Start with analysis** - Let the workflow audit your agent first
|
||||
- **Check persona field separation FIRST** - This is the #1 issue in legacy agents
|
||||
- **Use reference agents as guides** - Compare against commit-poet, journal-keeper, BMM agents
|
||||
- **Focus your edits** - Choose specific aspects to improve
|
||||
- **Review each change** - Approve or modify proposed changes
|
||||
- **Validate persona purity** - Communication_style should have ZERO red flag words
|
||||
- **Validate thoroughly** - Use the validation step to catch all issues
|
||||
- **Test after editing** - Invoke the edited agent to verify it works
|
||||
|
||||
## Tips
|
||||
|
||||
- **Most common fix needed:** Persona field separation - communication_style has behaviors/role mixed in
|
||||
- If you're unsure what needs improvement, let the workflow analyze the agent first
|
||||
- For quick fixes, tell the workflow specifically what needs fixing
|
||||
- The workflow loads documentation automatically - you don't need to read it first
|
||||
- You can make multiple rounds of edits in one session
|
||||
- **Red flag words in communication_style:** "ensures", "makes sure", "experienced", "expert who", "believes in"
|
||||
- Compare your agent's communication_style against the presets CSV - should be similarly pure
|
||||
- Use the validation step to ensure you didn't miss anything
|
||||
|
||||
## Example Usage
|
||||
|
||||
**Scenario 1: Fix persona field separation (most common)**
|
||||
|
||||
```
|
||||
User: Edit the analyst agent
|
||||
Workflow: Loads agent → Analyzes → Finds communication_style has "ensures stakeholders heard"
|
||||
→ Explains this is behavior, should be in principles
|
||||
→ Extracts behaviors to principles
|
||||
→ Crafts pure communication style: "Treats analysis like a treasure hunt"
|
||||
→ Validates → Done
|
||||
```
|
||||
|
||||
**Scenario 2: Add new workflow**
|
||||
|
||||
```
|
||||
User: I want to add a new workflow to the PM agent
|
||||
Workflow: Analyzes agent → User describes what workflow to add
|
||||
→ Adds new menu item with workflow reference
|
||||
→ Validates all paths resolve → Done
|
||||
```
|
||||
|
||||
**Scenario 2b: Edit Expert agent sidecar files**
|
||||
|
||||
```
|
||||
User: Edit the journal-keeper agent - I want to update the daily journal template
|
||||
Workflow: Loads folder → Finds .agent.yaml + 3 sidecar templates + 1 knowledge file
|
||||
→ Analyzes → Loads daily.md template
|
||||
→ User describes changes to template
|
||||
→ Updates daily.md, shows before/after
|
||||
→ Validates menu item 'daily-journal' still references it correctly → Done
|
||||
```
|
||||
|
||||
**Scenario 3: Migrate from legacy type**
|
||||
|
||||
```
|
||||
User: This agent says it's a "full agent" - what does that mean now?
|
||||
Workflow: Explains Simple/Expert/Module types
|
||||
→ Identifies agent is actually Simple (single file)
|
||||
→ Updates any legacy terminology in comments
|
||||
→ Validates structure matches type → Done
|
||||
```
|
||||
|
||||
## Related Workflows
|
||||
|
||||
- **create-agent** - Create new agents from scratch with proper field separation
|
||||
- **edit-workflow** - Edit workflows referenced by agents
|
||||
- **audit-workflow** - Audit workflows for compliance
|
||||
|
||||
## Activation
|
||||
|
||||
Invoke via BMad Builder agent:
|
||||
|
||||
```
|
||||
/bmad:bmb:agents:bmad-builder
|
||||
Then select: *edit-agent
|
||||
```
|
||||
|
||||
Or directly via workflow.xml with this workflow config.
|
||||
|
||||
## Quality Standards
|
||||
|
||||
After editing with this workflow, your agent will meet these quality standards:
|
||||
|
||||
✓ Persona fields properly separated (communication_style is pure verbal patterns)
|
||||
✓ Agent type matches structure (Simple/Expert/Module)
|
||||
✓ All workflow paths resolve correctly
|
||||
✓ Activation flow is robust
|
||||
✓ Menu structure is clear and logical
|
||||
✓ Handlers properly invoke workflows
|
||||
✓ Config loading works correctly
|
||||
✓ No legacy terminology (full/hybrid/standalone)
|
||||
✓ Comparable quality to reference agents
|
||||
|
||||
This workflow ensures your agents meet the same high standards as the reference implementations and recently enhanced BMM agents.
|
||||
@ -1,654 +0,0 @@
|
||||
# Edit Agent - Agent Editor Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/.bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/.bmad/bmb/workflows/edit-agent/workflow.yaml</critical>
|
||||
<critical>This workflow uses ADAPTIVE FACILITATION - adjust your communication based on context and user needs</critical>
|
||||
<critical>The goal is COLLABORATIVE IMPROVEMENT - work WITH the user, not FOR them</critical>
|
||||
<critical>Communicate all responses in {communication_language}</critical>
|
||||
|
||||
<critical>Understanding Agent Persona Fields - ESSENTIAL for Editing Agents Correctly</critical>
|
||||
|
||||
When editing an agent, you MUST understand how the compiled agent LLM interprets persona fields. This is the #1 issue found in agent edits:
|
||||
|
||||
**The Four Persona Fields and LLM Interpretation:**
|
||||
|
||||
- **role** → LLM reads: "What knowledge, skills, and capabilities do I possess?"
|
||||
Example: "Senior Software Engineer" or "Strategic Business Analyst + Requirements Expert"
|
||||
|
||||
- **identity** → LLM reads: "What background, experience, and context shape my responses?"
|
||||
Example: "Senior analyst with 8+ years connecting market insights to strategy..."
|
||||
|
||||
- **communication_style** → LLM reads: "What verbal patterns, word choice, quirks, and phrasing do I use?"
|
||||
Example: "Treats analysis like a treasure hunt - excited by every clue"
|
||||
|
||||
- **principles** → LLM reads: "What beliefs and operating philosophy drive my choices?"
|
||||
Example: "Every business challenge has root causes. Ground findings in evidence."
|
||||
|
||||
**MOST COMMON EDITING MISTAKE - Behaviors Mixed Into Communication Style:**
|
||||
|
||||
BEFORE (incorrect - found in many legacy agents):
|
||||
|
||||
```yaml
|
||||
communication_style: 'Experienced analyst who uses systematic approaches and ensures all stakeholders are heard'
|
||||
```
|
||||
|
||||
^ This MIXES identity (experienced analyst) + behavior (ensures stakeholders heard) into style!
|
||||
|
||||
AFTER (correct - persona fields properly separated):
|
||||
|
||||
```yaml
|
||||
identity: 'Senior analyst with 8+ years connecting insights to strategy'
|
||||
communication_style: 'Systematic and probing. Structures findings hierarchically.'
|
||||
principles:
|
||||
- 'Ensure all stakeholder voices heard'
|
||||
- 'Ground findings in evidence'
|
||||
```
|
||||
|
||||
**How to Recognize When Communication Style Needs Fixing:**
|
||||
|
||||
Red flag words in communication_style indicate behaviors/role mixed in:
|
||||
|
||||
- "ensures", "makes sure", "always", "never" → These are behaviors (move to principles)
|
||||
- "experienced", "expert who", "senior" → These are identity (move to identity field)
|
||||
- "believes in", "focused on" → These are principles (move to principles array)
|
||||
|
||||
**Pure Communication Styles (from {communication_presets}):**
|
||||
|
||||
Notice these contain ZERO role/identity/principles - only HOW they talk:
|
||||
|
||||
- "Treats analysis like a treasure hunt - excited by every clue"
|
||||
- "Ultra-succinct. Speaks in file paths and AC IDs - every statement citable"
|
||||
- "Asks 'WHY?' relentlessly like a detective on a case"
|
||||
- "Poetic drama and flair with every turn of a phrase"
|
||||
|
||||
Use {communication_presets} CSV and reference agents in {reference_agents} as your guide for pure communication styles.
|
||||
|
||||
<workflow>
|
||||
|
||||
<step n="1" goal="Load and deeply understand the target agent">
|
||||
<ask>What is the path to the agent you want to edit?</ask>
|
||||
|
||||
<action>Detect agent type from provided path and load ALL relevant files:
|
||||
|
||||
**If path is a .agent.yaml file (Simple Agent):**
|
||||
|
||||
- Load the single YAML file
|
||||
- Note: Simple agent, all content in one file
|
||||
|
||||
**If path is a folder (Expert Agent with sidecar files):**
|
||||
|
||||
- Load the .agent.yaml file from inside the folder
|
||||
- Load ALL sidecar files in the folder:
|
||||
- Templates (_.md, _.txt)
|
||||
- Documentation files
|
||||
- Knowledge base files (_.csv, _.json, \*.yaml)
|
||||
- Any other resources referenced by the agent
|
||||
- Create inventory of sidecar files for reference
|
||||
- Note: Expert agent with sidecar structure
|
||||
|
||||
**If path is ambiguous:**
|
||||
|
||||
- Check if it's a folder containing .agent.yaml → Expert agent
|
||||
- Check if it's a direct .agent.yaml path → Simple agent
|
||||
- If neither, ask user to clarify
|
||||
|
||||
Present what was loaded:
|
||||
|
||||
- "Loaded [agent-name].agent.yaml"
|
||||
- If Expert: "Plus 5 sidecar files: [list them]"
|
||||
</action>
|
||||
<action>Load ALL agent documentation to inform understanding:
|
||||
|
||||
**Core Concepts:**
|
||||
|
||||
- Understanding agent types: {understanding_agent_types}
|
||||
- Agent compilation process: {agent_compilation}
|
||||
|
||||
**Architecture Guides:**
|
||||
|
||||
- Simple agent architecture: {simple_architecture}
|
||||
- Expert agent architecture: {expert_architecture}
|
||||
- Module agent architecture: {module_architecture}
|
||||
|
||||
**Design Patterns:**
|
||||
|
||||
- Menu patterns: {menu_patterns}
|
||||
- Communication presets: {communication_presets}
|
||||
- Brainstorm context: {brainstorm_context}
|
||||
|
||||
**Reference Agents:**
|
||||
|
||||
- Simple example: {reference_simple_agent}
|
||||
- Expert example: {reference_expert_agent}
|
||||
- Module examples: {reference_module_agents}
|
||||
- BMM agents (distinct voices): {bmm_agents}
|
||||
|
||||
**Workflow execution engine:** {workflow_execution_engine}
|
||||
</action>
|
||||
|
||||
<action>Analyze the agent structure thoroughly:
|
||||
|
||||
**Basic Structure:**
|
||||
|
||||
- Parse persona (role, identity, communication_style, principles)
|
||||
- Understand activation flow and steps
|
||||
- Map menu items and their workflows
|
||||
- Identify configuration dependencies
|
||||
- Assess agent type: Simple (single YAML), Expert (sidecar files), or Module (ecosystem integration)
|
||||
- Check workflow references for validity
|
||||
|
||||
**If Expert Agent - Analyze Sidecar Files:**
|
||||
|
||||
- Map which menu items reference which sidecar files (tmpl="path", data="path")
|
||||
- Check if all sidecar references in YAML actually exist
|
||||
- Identify unused sidecar files (not referenced in YAML)
|
||||
- Assess sidecar organization (are templates grouped logically?)
|
||||
- Note any sidecar files that might need editing (outdated templates, old docs)
|
||||
|
||||
**CRITICAL - Persona Field Separation Analysis:**
|
||||
|
||||
- Check if communication_style contains ONLY verbal patterns
|
||||
- Identify any behaviors mixed into communication_style (red flags: "ensures", "makes sure", "always")
|
||||
- Identify any role/identity statements in communication_style (red flags: "experienced", "expert who", "senior")
|
||||
- Identify any principles in communication_style (red flags: "believes in", "focused on")
|
||||
- Compare communication_style against {communication_presets} for purity
|
||||
- Compare against similar reference agents
|
||||
|
||||
**Evaluate against best practices from loaded guides**
|
||||
</action>
|
||||
|
||||
<action>Reflect understanding back to {user_name}:
|
||||
|
||||
Present a warm, conversational summary adapted to the agent's complexity:
|
||||
|
||||
- What this agent does (its role and purpose)
|
||||
- How it's structured (Simple/Expert/Module type, menu items, workflows)
|
||||
- **If Expert agent:** Describe the sidecar structure warmly:
|
||||
- "This is an Expert agent with a nice sidecar structure - I see 3 templates, 2 knowledge files, and a README"
|
||||
- Mention what the sidecar files are for (if clear from names/content)
|
||||
- Note any sidecar issues (broken references, unused files)
|
||||
- **If persona field separation issues found:** Gently point out that communication_style has behaviors/role mixed in - explain this is common and fixable
|
||||
- What you notice (strengths, potential improvements, issues)
|
||||
- Your initial assessment of its health
|
||||
|
||||
Be conversational, not clinical. Help {user_name} see their agent through your eyes.
|
||||
|
||||
Example of mentioning persona issues warmly:
|
||||
"I notice the communication_style has some behaviors mixed in (like 'ensures stakeholders are heard'). This is super common - we can easily extract those to principles to make the persona clearer. The agent's core purpose is solid though!"
|
||||
|
||||
Example of mentioning Expert agent sidecar structure:
|
||||
"This is beautifully organized as an Expert agent! The sidecar files include 3 journal templates (daily, weekly, breakthrough) and a mood-patterns knowledge file. Your menu items reference them nicely. I do notice 'old-template.md' isn't referenced anywhere - we could clean that up."
|
||||
</action>
|
||||
|
||||
<ask>Does this match your understanding of what this agent should do?</ask>
|
||||
<template-output>agent_understanding</template-output>
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Discover improvement goals collaboratively">
|
||||
<critical>Understand WHAT the user wants to improve and WHY before diving into edits</critical>
|
||||
|
||||
<action>Engage in collaborative discovery:
|
||||
|
||||
Ask open-ended questions to understand their goals:
|
||||
|
||||
- What prompted you to want to edit this agent?
|
||||
- What isn't working the way you'd like?
|
||||
- Are there specific behaviors you want to change?
|
||||
- Is there functionality you want to add or remove?
|
||||
- How do users interact with this agent? What feedback have they given?
|
||||
|
||||
Listen for clues about:
|
||||
|
||||
- **Persona field separation issues** (communication_style contains behaviors/role/principles)
|
||||
- Functional issues (broken references, missing workflows)
|
||||
- **Sidecar file issues** (for Expert agents: outdated templates, unused files, missing references)
|
||||
- User experience issues (confusing menu, unclear communication)
|
||||
- Performance issues (too slow, too verbose, not adaptive enough)
|
||||
- Maintenance issues (hard to update, bloated, inconsistent)
|
||||
- Integration issues (doesn't work well with other agents/workflows)
|
||||
- **Legacy pattern issues** (using old "full/hybrid/standalone" terminology, outdated structures)
|
||||
</action>
|
||||
|
||||
<action>Based on their responses and your analysis from step 1, identify improvement opportunities:
|
||||
|
||||
Organize by priority and user goals:
|
||||
|
||||
- **CRITICAL issues blocking functionality** (broken paths, invalid references)
|
||||
- **PERSONA FIELD SEPARATION** (if found - this significantly improves LLM interpretation)
|
||||
- **IMPORTANT improvements enhancing user experience** (menu clarity, better workflows)
|
||||
- **NICE-TO-HAVE enhancements for polish** (better triggers, communication refinement)
|
||||
|
||||
Present these conversationally, explaining WHY each matters and HOW it would help.
|
||||
|
||||
If persona field separation issues found, explain the impact:
|
||||
"I found some behaviors in the communication_style field. When we separate these properly, the LLM will have much clearer understanding of the persona. Right now it's trying to interpret 'ensures stakeholders heard' as a verbal pattern, when it's actually an operating principle. Fixing this makes the agent more consistent and predictable."
|
||||
</action>
|
||||
|
||||
<action>Collaborate on priorities:
|
||||
|
||||
Don't just list options - discuss them:
|
||||
|
||||
- "I noticed {{issue}} - this could cause {{problem}}. Does this concern you?"
|
||||
- "The agent could be more {{improvement}} which would help when {{use_case}}. Worth exploring?"
|
||||
- "Based on what you said about {{user_goal}}, we might want to {{suggestion}}. Thoughts?"
|
||||
|
||||
Let the conversation flow naturally. Build a shared vision of what "better" looks like.
|
||||
</action>
|
||||
|
||||
<template-output>improvement_goals</template-output>
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Facilitate improvements collaboratively" repeat="until-user-satisfied">
|
||||
<critical>Work iteratively - improve, review, refine. Never dump all changes at once.</critical>
|
||||
|
||||
<action>For each improvement area, facilitate collaboratively:
|
||||
|
||||
1. **Explain the current state and why it matters**
|
||||
- Show relevant sections of the agent
|
||||
- Explain how it works now and implications
|
||||
- Connect to user's goals from step 2
|
||||
|
||||
2. **Propose improvements with rationale**
|
||||
- Suggest specific changes that align with best practices
|
||||
- Explain WHY each change helps
|
||||
- Provide examples from the loaded guides when helpful
|
||||
- Show before/after comparisons for clarity
|
||||
|
||||
3. **Collaborate on the approach**
|
||||
- Ask if the proposed change addresses their need
|
||||
- Invite modifications or alternative approaches
|
||||
- Explain tradeoffs when relevant
|
||||
- Adapt based on their feedback
|
||||
|
||||
4. **Apply changes iteratively**
|
||||
- Make one focused improvement at a time
|
||||
- Show the updated section
|
||||
- Confirm it meets their expectation
|
||||
- Move to next improvement or refine current one
|
||||
</action>
|
||||
|
||||
<action>Common improvement patterns to facilitate:
|
||||
|
||||
**If fixing broken references:**
|
||||
|
||||
- Identify all broken paths (workflow paths, sidecar file references)
|
||||
- Explain what each reference should point to
|
||||
- Verify new paths exist before updating
|
||||
- **For Expert agents:** Check both YAML references AND actual sidecar file existence
|
||||
- Update and confirm working
|
||||
|
||||
**If editing sidecar files (Expert agents only):**
|
||||
|
||||
<critical>Sidecar files are as much a part of the agent as the YAML!</critical>
|
||||
|
||||
Common sidecar editing scenarios:
|
||||
|
||||
**Updating templates:**
|
||||
|
||||
- Read current template content
|
||||
- Discuss what needs to change with user
|
||||
- Show before/after of template updates
|
||||
- Verify menu item references still work
|
||||
- Test template variables resolve correctly
|
||||
|
||||
**Adding new sidecar files:**
|
||||
|
||||
- Create the new file (template, doc, knowledge base)
|
||||
- Add menu item in YAML that references it (tmpl="path/to/new-file.md")
|
||||
- Verify the reference path is correct
|
||||
- Test the menu item loads the sidecar file
|
||||
|
||||
**Removing unused sidecar files:**
|
||||
|
||||
- Confirm file is truly unused (not referenced in YAML)
|
||||
- Ask user if safe to delete (might be there for future use)
|
||||
- Delete file if approved
|
||||
- Clean up any stale references
|
||||
|
||||
**Reorganizing sidecar structure:**
|
||||
|
||||
- Discuss better organization (e.g., group templates in subfolder)
|
||||
- Move files to new locations
|
||||
- Update ALL references in YAML to new paths
|
||||
- Verify all menu items still work
|
||||
|
||||
**Updating knowledge base files (.csv, .json, .yaml in sidecar):**
|
||||
|
||||
- Understand what knowledge the file contains
|
||||
- Discuss what needs updating
|
||||
- Edit the knowledge file directly
|
||||
- Verify format is still valid
|
||||
- No YAML changes needed (data file just gets loaded)
|
||||
|
||||
**If refining persona/communication (MOST COMMON IMPROVEMENT NEEDED):**
|
||||
|
||||
<critical>Persona field separation is the #1 quality issue. Follow this pattern EXACTLY:</critical>
|
||||
|
||||
**Step 1: Diagnose Current Communication Style**
|
||||
|
||||
- Read current communication_style field word by word
|
||||
- Identify ANY content that isn't pure verbal patterns
|
||||
- Use red flag words as detection:
|
||||
- "ensures", "makes sure", "always", "never" → Behaviors (belongs in principles)
|
||||
- "experienced", "expert who", "senior", "seasoned" → Identity descriptors (belongs in role/identity)
|
||||
- "believes in", "focused on", "committed to" → Philosophy (belongs in principles)
|
||||
- "who does X", "that does Y" → Behavioral descriptions (belongs in role or principles)
|
||||
|
||||
Example diagnosis:
|
||||
|
||||
```yaml
|
||||
# CURRENT (problematic)
|
||||
communication_style: 'Experienced analyst who uses systematic approaches and ensures all stakeholders are heard'
|
||||
# IDENTIFIED ISSUES:
|
||||
# - "Experienced analyst" → identity descriptor
|
||||
# - "who uses systematic approaches" → behavioral description
|
||||
# - "ensures all stakeholders are heard" → operating principle
|
||||
# ONLY THIS IS STYLE: [nothing! Need to find the actual verbal pattern]
|
||||
```
|
||||
|
||||
**Step 2: Extract Non-Style Content to Proper Fields**
|
||||
|
||||
- Create a working copy with sections:
|
||||
- ROLE (capabilities/skills)
|
||||
- IDENTITY (background/context)
|
||||
- PURE STYLE (verbal patterns only)
|
||||
- PRINCIPLES (beliefs/behaviors)
|
||||
|
||||
- Move identified content to proper sections:
|
||||
```yaml
|
||||
# ROLE: "Strategic analyst"
|
||||
# IDENTITY: "Experienced analyst who uses systematic approaches"
|
||||
# PURE STYLE: [need to discover - interview user about HOW they talk]
|
||||
# PRINCIPLES:
|
||||
# - "Ensure all stakeholder voices heard"
|
||||
# - "Use systematic, structured approaches"
|
||||
```
|
||||
|
||||
**Step 3: Discover the TRUE Communication Style**
|
||||
Since style was buried under behaviors, interview the user:
|
||||
|
||||
- "How should this agent SOUND when talking?"
|
||||
- "What verbal quirks or patterns make them distinctive?"
|
||||
- "Are they formal? Casual? Energetic? Measured?"
|
||||
- "Any metaphors or imagery that capture their voice?"
|
||||
|
||||
Then explore {communication_presets} together:
|
||||
|
||||
- Show relevant categories (Professional, Creative, Analytical, etc.)
|
||||
- Read examples of pure styles
|
||||
- Discuss which resonates with agent's essence
|
||||
|
||||
**Step 4: Craft Pure Communication Style**
|
||||
Write 1-2 sentences focused ONLY on verbal patterns:
|
||||
|
||||
Good examples from reference agents:
|
||||
|
||||
- "Treats analysis like a treasure hunt - excited by every clue, thrilled when patterns emerge" (Mary/analyst)
|
||||
- "Ultra-succinct. Speaks in file paths and AC IDs - every statement citable" (Amelia/dev)
|
||||
- "Asks 'WHY?' relentlessly like a detective on a case" (John/pm)
|
||||
- "Poetic drama and flair with every turn of a phrase" (commit-poet)
|
||||
|
||||
Bad example (what we're fixing):
|
||||
|
||||
- "Experienced who ensures quality and uses best practices" ← ALL behaviors, NO style!
|
||||
|
||||
**Step 5: Show Before/After With Full Context**
|
||||
Present the complete transformation:
|
||||
|
||||
```yaml
|
||||
# BEFORE
|
||||
persona:
|
||||
role: "Analyst"
|
||||
communication_style: "Experienced analyst who uses systematic approaches and ensures all stakeholders are heard"
|
||||
|
||||
# AFTER
|
||||
persona:
|
||||
role: "Strategic Business Analyst + Requirements Expert"
|
||||
identity: "Senior analyst with 8+ years connecting market insights to strategy and translating complex problems into clear requirements"
|
||||
communication_style: "Treats analysis like a treasure hunt - excited by every clue, thrilled when patterns emerge. Asks questions that spark 'aha!' moments."
|
||||
principles:
|
||||
- "Ensure all stakeholder voices heard"
|
||||
- "Use systematic, structured approaches to analysis"
|
||||
- "Ground findings in evidence, not assumptions"
|
||||
```
|
||||
|
||||
**Step 6: Validate Against Standards**
|
||||
|
||||
- Communication style has ZERO red flag words
|
||||
- Communication style describes HOW they talk, not WHAT they do
|
||||
- Compare against {communication_presets} - similarly pure?
|
||||
- Compare against reference agents - similar quality?
|
||||
- Read it aloud - does it sound like a voice description?
|
||||
|
||||
**Step 7: Confirm With User**
|
||||
|
||||
- Explain WHAT changed and WHY each move happened
|
||||
- Read the new communication style dramatically to demonstrate the voice
|
||||
- Ask: "Does this capture how you want them to sound?"
|
||||
- Refine based on feedback
|
||||
|
||||
**If updating activation:**
|
||||
|
||||
- Walk through current activation flow
|
||||
- Identify bottlenecks or confusion points
|
||||
- Propose streamlined flow
|
||||
- Ensure config loading works correctly
|
||||
- Verify all session variables are set
|
||||
|
||||
**If managing menu items:**
|
||||
|
||||
- Review current menu organization
|
||||
- Discuss if structure serves user mental model
|
||||
- Add/remove/reorganize as needed
|
||||
- Ensure all workflow references are valid
|
||||
- Update triggers to be intuitive
|
||||
|
||||
**If enhancing menu handlers:**
|
||||
|
||||
- Explain current handler logic
|
||||
- Identify where handlers could be smarter
|
||||
- Propose enhanced logic based on agent architecture patterns
|
||||
- Ensure handlers properly invoke workflows
|
||||
|
||||
**If optimizing agent type or migrating from legacy terminology:**
|
||||
|
||||
<critical>Legacy agents may use outdated "full/hybrid/standalone" terminology. Migrate to Simple/Expert/Module:</critical>
|
||||
|
||||
**Understanding the Modern Types:**
|
||||
|
||||
- **Simple** = Self-contained in single .agent.yaml file
|
||||
- NOT capability-limited! Can be as powerful as any agent
|
||||
- Architecture choice: everything in one file
|
||||
- Example: commit-poet (reference_simple_agent)
|
||||
|
||||
- **Expert** = Includes sidecar files (templates, docs, knowledge bases)
|
||||
- Folder structure with .agent.yaml + additional files
|
||||
- Sidecar files referenced in menu items or prompts
|
||||
- Example: journal-keeper (reference_expert_agent)
|
||||
|
||||
- **Module** = Designed for BMAD ecosystem integration
|
||||
- Integrated with specific module workflows (BMM, BMGD, CIS, etc.)
|
||||
- Coordinates with other module agents
|
||||
- Included in module's default bundle
|
||||
- This is design INTENT, not capability limitation
|
||||
- Examples: security-engineer, dev, analyst (reference_module_agents)
|
||||
|
||||
**Migration Pattern from Legacy Types:**
|
||||
|
||||
If agent uses "full/hybrid/standalone" terminology:
|
||||
|
||||
1. **Identify current structure:**
|
||||
- Single file? → Probably Simple
|
||||
- Has sidecar files? → Probably Expert
|
||||
- Part of module ecosystem? → Probably Module
|
||||
- Multiple could apply? → Choose based on PRIMARY characteristic
|
||||
|
||||
2. **Update any references in comments/docs:**
|
||||
- Change "full agent" → Simple or Module (depending on context)
|
||||
- Change "hybrid agent" → Usually Simple or Expert
|
||||
- Change "standalone agent" → Usually Simple
|
||||
|
||||
3. **Verify type choice:**
|
||||
- Read {understanding_agent_types} together
|
||||
- Compare against reference agents
|
||||
- Confirm structure matches chosen type
|
||||
|
||||
4. **Update validation checklist expectations** based on new type
|
||||
|
||||
**If genuinely converting between types:**
|
||||
|
||||
Simple → Expert (adding sidecar files):
|
||||
|
||||
- Create folder with agent name
|
||||
- Move .agent.yaml into folder
|
||||
- Add sidecar files (templates, docs, etc.)
|
||||
- Update menu items to reference sidecar files
|
||||
- Test all references work
|
||||
|
||||
Expert → Simple (consolidating):
|
||||
|
||||
- Inline sidecar content into YAML (or remove if unused)
|
||||
- Move .agent.yaml out of folder
|
||||
- Update any menu references
|
||||
- Delete sidecar folder after verification
|
||||
|
||||
Module ↔ Others:
|
||||
|
||||
- Module is about design intent, not structure
|
||||
- Can be Simple OR Expert structurally
|
||||
- Change is about integration ecosystem, not file structure
|
||||
</action>
|
||||
|
||||
<action>Throughout improvements, educate when helpful:
|
||||
|
||||
Share insights from the guides naturally:
|
||||
|
||||
- "The agent architecture guide suggests {{pattern}} for this scenario"
|
||||
- "Looking at the command patterns, we could use {{approach}}"
|
||||
- "The communication styles guide has a great example of {{technique}}"
|
||||
|
||||
Connect improvements to broader BMAD principles without being preachy.
|
||||
</action>
|
||||
|
||||
<ask>After each significant change:
|
||||
|
||||
- "Does this feel right for what you're trying to achieve?"
|
||||
- "Want to refine this further, or move to the next improvement?"
|
||||
- "Is there anything about this change that concerns you?"
|
||||
</ask>
|
||||
|
||||
<template-output>improvement_implementation</template-output>
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Validate improvements holistically">
|
||||
<action>Run comprehensive validation conversationally:
|
||||
|
||||
Don't just check boxes - explain what you're validating and why it matters:
|
||||
|
||||
- "Let me verify all the workflow paths resolve correctly..."
|
||||
- **"If Expert agent: Checking all sidecar file references..."**
|
||||
- "Checking that the activation flow works smoothly..."
|
||||
- "Making sure menu handlers are wired up properly..."
|
||||
- "Validating config loading is robust..."
|
||||
- **"CRITICAL: Checking persona field separation - ensuring communication_style is pure..."**
|
||||
|
||||
**For Expert Agents - Sidecar File Validation:**
|
||||
|
||||
Walk through each sidecar reference:
|
||||
|
||||
- "Your menu item 'daily-journal' references 'templates/daily.md'... checking... ✓ exists!"
|
||||
- "Menu item 'breakthrough' references 'templates/breakthrough.md'... checking... ✓ exists!"
|
||||
- Check for orphaned sidecar files not referenced anywhere
|
||||
- If found: "I noticed 'old-template.md' isn't referenced in any menu items. Should we keep it?"
|
||||
- Verify sidecar file formats (YAML is valid, CSV has headers, etc.)
|
||||
</action>
|
||||
|
||||
<action>Load validation checklist: {validation}</action>
|
||||
<action>Check all items from checklist systematically</action>
|
||||
|
||||
<note>The validation checklist is shared between create-agent and edit-agent workflows to ensure consistent quality standards. Any agent (whether newly created or edited) is validated against the same comprehensive criteria.</note>
|
||||
|
||||
<check if="validation_issues_found">
|
||||
<action>Present issues conversationally:
|
||||
|
||||
Explain what's wrong and implications:
|
||||
|
||||
- "I found {{issue}} which could cause {{problem}}"
|
||||
- "The {{component}} needs {{fix}} because {{reason}}"
|
||||
|
||||
Propose fixes immediately:
|
||||
|
||||
- "I can fix this by {{solution}}. Should I?"
|
||||
- "We have a couple options here: {{option1}} or {{option2}}. Thoughts?"
|
||||
</action>
|
||||
|
||||
<action>Fix approved issues and re-validate</action>
|
||||
</check>
|
||||
|
||||
<check if="validation_passes">
|
||||
<action>Confirm success warmly:
|
||||
|
||||
"Excellent! Everything validates cleanly:
|
||||
|
||||
- ✓ Persona fields properly separated (communication_style is pure!)
|
||||
- ✓ All paths resolve correctly
|
||||
- ✓ **[If Expert agent: All sidecar file references valid - 5 sidecar files, all referenced correctly!]**
|
||||
- ✓ Activation flow is solid
|
||||
- ✓ Menu structure is clear
|
||||
- ✓ Handlers work properly
|
||||
- ✓ Config loading is robust
|
||||
- ✓ Agent type matches structure (Simple/Expert/Module)
|
||||
|
||||
Your agent meets all BMAD quality standards. Great work!"
|
||||
</action>
|
||||
</check>
|
||||
|
||||
<template-output>validation_results</template-output>
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Review improvements and guide next steps">
|
||||
<action>Create a conversational summary of what improved:
|
||||
|
||||
Tell the story of the transformation:
|
||||
|
||||
- "We started with {{initial_state}}"
|
||||
- "You wanted to {{user_goals}}"
|
||||
- "We made these key improvements: {{changes_list}}"
|
||||
- "Now your agent {{improved_capabilities}}"
|
||||
|
||||
Highlight the impact:
|
||||
|
||||
- "This means users will experience {{benefit}}"
|
||||
- "The agent is now more {{quality}}"
|
||||
- "It follows best practices for {{patterns}}"
|
||||
</action>
|
||||
|
||||
<action>Guide next steps based on changes made:
|
||||
|
||||
If significant structural changes:
|
||||
|
||||
- "Since we restructured the activation, you should test the agent with a real user interaction"
|
||||
|
||||
If workflow references changed:
|
||||
|
||||
- "The agent now uses {{new_workflows}} - make sure those workflows are up to date"
|
||||
|
||||
If this is part of larger module work:
|
||||
|
||||
- "This agent is part of {{module}} - consider if other agents need similar improvements"
|
||||
|
||||
Be a helpful guide to what comes next, not just a task completer.
|
||||
</action>
|
||||
|
||||
<ask>Would you like to:
|
||||
|
||||
- Test the edited agent by invoking it
|
||||
- Edit another agent
|
||||
- Make additional refinements to this one
|
||||
- Return to your module work
|
||||
</ask>
|
||||
|
||||
<template-output>completion_summary</template-output>
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@ -1,48 +0,0 @@
|
||||
# Edit Agent - Agent Editor Configuration
|
||||
name: "edit-agent"
|
||||
description: "Edit existing BMAD agents while following all best practices and conventions"
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables load from config_source
|
||||
config_source: "{project-root}/.bmad/bmb/config.yaml"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
user_name: "{config_source}:user_name"
|
||||
|
||||
# Required Data Files - Critical for understanding agent conventions
|
||||
|
||||
# Core Concepts
|
||||
understanding_agent_types: "{project-root}/.bmad/bmb/docs/understanding-agent-types.md"
|
||||
agent_compilation: "{project-root}/.bmad/bmb/docs/agent-compilation.md"
|
||||
|
||||
# Architecture Guides (Simple, Expert, Module)
|
||||
simple_architecture: "{project-root}/.bmad/bmb/docs/simple-agent-architecture.md"
|
||||
expert_architecture: "{project-root}/.bmad/bmb/docs/expert-agent-architecture.md"
|
||||
module_architecture: "{project-root}/.bmad/bmb/docs/module-agent-architecture.md"
|
||||
|
||||
# Design Patterns
|
||||
menu_patterns: "{project-root}/.bmad/bmb/docs/agent-menu-patterns.md"
|
||||
communication_presets: "{project-root}/.bmad/bmb/workflows/create-agent/communication-presets.csv"
|
||||
brainstorm_context: "{project-root}/.bmad/bmb/workflows/create-agent/brainstorm-context.md"
|
||||
|
||||
# Workflow execution engine reference
|
||||
workflow_execution_engine: "{project-root}/.bmad/core/tasks/workflow.xml"
|
||||
|
||||
# Reference Agents - Clean implementations showing best practices
|
||||
reference_agents: "{project-root}/.bmad/bmb/reference/agents/"
|
||||
reference_simple_agent: "{reference_agents}/simple-examples/commit-poet.agent.yaml"
|
||||
reference_expert_agent: "{reference_agents}/expert-examples/journal-keeper/journal-keeper.agent.yaml"
|
||||
reference_module_agents: "{reference_agents}/module-examples/"
|
||||
|
||||
# BMM Agents - Examples of distinct communication voices
|
||||
bmm_agents: "{project-root}/.bmad/bmm/agents/"
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/.bmad/bmb/workflows/edit-agent"
|
||||
template: false # This is an action workflow - no template needed
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
# Shared validation checklist (canonical location in create-agent folder)
|
||||
validation: "{project-root}/.bmad/bmb/workflows/create-agent/agent-validation-checklist.md"
|
||||
|
||||
standalone: true
|
||||
|
||||
# Web bundle configuration
|
||||
@ -1,187 +0,0 @@
|
||||
# Edit Module Workflow
|
||||
|
||||
Interactive workflow for editing existing BMAD modules, including structure, agents, workflows, configuration, and documentation.
|
||||
|
||||
## Purpose
|
||||
|
||||
This workflow helps you improve and maintain BMAD modules by:
|
||||
|
||||
- Analyzing module structure against best practices
|
||||
- Managing agents and workflows within the module
|
||||
- Updating configuration and documentation
|
||||
- Ensuring cross-module integration works correctly
|
||||
- Maintaining installer configuration (for source modules)
|
||||
|
||||
## When to Use
|
||||
|
||||
Use this workflow when you need to:
|
||||
|
||||
- Add new agents or workflows to a module
|
||||
- Update module configuration
|
||||
- Improve module documentation
|
||||
- Reorganize module structure
|
||||
- Set up cross-module workflow sharing
|
||||
- Fix issues in module organization
|
||||
- Update installer configuration
|
||||
|
||||
## What You'll Need
|
||||
|
||||
- Path to the module directory you want to edit
|
||||
- Understanding of what changes you want to make
|
||||
- Access to module documentation (loaded automatically)
|
||||
|
||||
## Workflow Steps
|
||||
|
||||
1. **Load and analyze target module** - Provide path to module directory
|
||||
2. **Analyze against best practices** - Automatic audit of module structure
|
||||
3. **Select editing focus** - Choose what aspect to edit
|
||||
4. **Load relevant documentation and tools** - Auto-loads guides and workflows
|
||||
5. **Perform edits** - Review and approve changes iteratively
|
||||
6. **Validate all changes** - Comprehensive validation checklist
|
||||
7. **Generate change summary** - Summary of improvements made
|
||||
|
||||
## Editing Options
|
||||
|
||||
The workflow provides 12 focused editing options:
|
||||
|
||||
1. **Fix critical issues** - Address missing files, broken references
|
||||
2. **Update module config** - Edit config.yaml fields
|
||||
3. **Manage agents** - Add, edit, or remove agents
|
||||
4. **Manage workflows** - Add, edit, or remove workflows
|
||||
5. **Update documentation** - Improve README files and guides
|
||||
6. **Reorganize structure** - Fix directory organization
|
||||
7. **Add new agent** - Create and integrate new agent
|
||||
8. **Add new workflow** - Create and integrate new workflow
|
||||
9. **Update installer** - Modify installer configuration (source only)
|
||||
10. **Cross-module integration** - Set up workflow sharing with other modules
|
||||
11. **Remove deprecated items** - Delete unused agents, workflows, or files
|
||||
12. **Full module review** - Comprehensive analysis and improvements
|
||||
|
||||
## Integration with Other Workflows
|
||||
|
||||
This workflow integrates with:
|
||||
|
||||
- **edit-agent** - For editing individual agents
|
||||
- **edit-workflow** - For editing individual workflows
|
||||
- **create-agent** - For adding new agents
|
||||
- **create-workflow** - For adding new workflows
|
||||
|
||||
When you select options to manage agents or workflows, the appropriate specialized workflow is invoked automatically.
|
||||
|
||||
## Module Structure
|
||||
|
||||
A proper BMAD module has:
|
||||
|
||||
```
|
||||
module-code/
|
||||
├── agents/ # Agent definitions
|
||||
│ └── *.agent.yaml
|
||||
├── workflows/ # Workflow definitions
|
||||
│ └── workflow-name/
|
||||
│ ├── workflow.yaml
|
||||
│ ├── instructions.md
|
||||
│ ├── checklist.md
|
||||
│ └── README.md
|
||||
├── config.yaml # Module configuration
|
||||
└── README.md # Module documentation
|
||||
```
|
||||
|
||||
## Standard Module Config
|
||||
|
||||
Every module config.yaml should have:
|
||||
|
||||
```yaml
|
||||
module_name: 'Full Module Name'
|
||||
module_code: 'xyz'
|
||||
user_name: 'User Name'
|
||||
communication_language: 'english'
|
||||
output_folder: 'path/to/output'
|
||||
```
|
||||
|
||||
Optional fields may be added for module-specific needs.
|
||||
|
||||
## Cross-Module Integration
|
||||
|
||||
Modules can share workflows:
|
||||
|
||||
```yaml
|
||||
# In agent menu item:
|
||||
workflow: '{project-root}/.bmad/other-module/workflows/shared-workflow/workflow.yaml'
|
||||
```
|
||||
|
||||
Common patterns:
|
||||
|
||||
- BMM uses CIS brainstorming workflows
|
||||
- All modules can use core workflows
|
||||
- Modules can invoke each other's workflows
|
||||
|
||||
## Output
|
||||
|
||||
The workflow modifies module files in place, including:
|
||||
|
||||
- config.yaml
|
||||
- Agent files
|
||||
- Workflow files
|
||||
- README and documentation files
|
||||
- Directory structure (if reorganizing)
|
||||
|
||||
Changes are reviewed and approved by you before being applied.
|
||||
|
||||
## Best Practices
|
||||
|
||||
- **Start with analysis** - Let the workflow audit your module first
|
||||
- **Use specialized workflows** - Let edit-agent and edit-workflow handle detailed edits
|
||||
- **Update documentation** - Keep README files current with changes
|
||||
- **Validate thoroughly** - Use the validation step to catch structural issues
|
||||
- **Test after editing** - Invoke agents and workflows to verify they work
|
||||
|
||||
## Tips
|
||||
|
||||
- For adding agents/workflows, use options 7-8 to create and integrate in one step
|
||||
- For quick config changes, use option 2 (update module config)
|
||||
- Cross-module integration (option 10) helps set up workflow sharing
|
||||
- Full module review (option 12) is great for inherited or legacy modules
|
||||
- The workflow handles path updates when you reorganize structure
|
||||
|
||||
## Source vs Installed Modules
|
||||
|
||||
**Source modules** (in src/modules/):
|
||||
|
||||
- Have installer files in tools/cli/installers/
|
||||
- Can configure web bundles
|
||||
- Are the development source of truth
|
||||
|
||||
**Installed modules** (in .bmad/):
|
||||
|
||||
- Are deployed to target projects
|
||||
- Use config.yaml for user customization
|
||||
- Are compiled from source during installation
|
||||
|
||||
This workflow works with both, but installer options only apply to source modules.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```
|
||||
User: I want to add a new workflow to BMM for API design
|
||||
Workflow: Analyzes BMM → You choose option 8 (add new workflow)
|
||||
→ Invokes create-workflow → Creates workflow
|
||||
→ Integrates it into module → Updates README → Done
|
||||
```
|
||||
|
||||
## Activation
|
||||
|
||||
Invoke via BMad Builder agent:
|
||||
|
||||
```
|
||||
/bmad:bmb:agents:bmad-builder
|
||||
Then select: *edit-module
|
||||
```
|
||||
|
||||
Or directly via workflow.xml with this workflow config.
|
||||
|
||||
## Related Resources
|
||||
|
||||
- **Module Structure Guide** - Comprehensive module architecture documentation
|
||||
- **BMM Module** - Example of full-featured module
|
||||
- **BMB Module** - Example of builder/tooling module
|
||||
- **CIS Module** - Example of workflow library module
|
||||
@ -1,165 +0,0 @@
|
||||
# Edit Module - Validation Checklist
|
||||
|
||||
Use this checklist to validate module edits meet BMAD Core standards.
|
||||
|
||||
## Module Structure Validation
|
||||
|
||||
- [ ] Module has clear 3-letter code (bmm, bmb, cis, etc.)
|
||||
- [ ] Module is in correct location (src/modules/ for source, .bmad/ for installed)
|
||||
- [ ] agents/ directory exists
|
||||
- [ ] workflows/ directory exists
|
||||
- [ ] config.yaml exists in module root
|
||||
- [ ] README.md exists in module root
|
||||
- [ ] Directory structure follows BMAD conventions
|
||||
|
||||
## Configuration Validation
|
||||
|
||||
### Required Fields
|
||||
|
||||
- [ ] module_name is descriptive and clear
|
||||
- [ ] module_code is 3-letter code matching directory name
|
||||
- [ ] user_name field present
|
||||
- [ ] communication_language field present
|
||||
- [ ] output_folder field present
|
||||
|
||||
### Optional Fields (if used)
|
||||
|
||||
- [ ] custom_agent_location documented
|
||||
- [ ] custom_module_location documented
|
||||
- [ ] Module-specific fields documented in README
|
||||
|
||||
### File Quality
|
||||
|
||||
- [ ] config.yaml is valid YAML syntax
|
||||
- [ ] No duplicate keys
|
||||
- [ ] Values are appropriate types (strings, paths, etc.)
|
||||
- [ ] Comments explain non-obvious fields
|
||||
|
||||
## Agent Validation
|
||||
|
||||
### Agent Files
|
||||
|
||||
- [ ] All agents in agents/ directory
|
||||
- [ ] Agent files follow naming: {agent-name}.agent.yaml or .md
|
||||
- [ ] Agent filenames use kebab-case
|
||||
- [ ] No orphaned or temporary agent files
|
||||
|
||||
### Agent Content
|
||||
|
||||
- [ ] Each agent has clear role and purpose
|
||||
- [ ] Agents reference workflows correctly
|
||||
- [ ] Agent workflow paths are valid
|
||||
- [ ] Agents load module config correctly (if needed)
|
||||
- [ ] Agent menu items reference existing workflows
|
||||
|
||||
### Agent Integration
|
||||
|
||||
- [ ] All agents listed in module README
|
||||
- [ ] Agent relationships documented (if applicable)
|
||||
- [ ] Cross-agent workflows properly linked
|
||||
|
||||
## Workflow Validation
|
||||
|
||||
### Workflow Structure
|
||||
|
||||
- [ ] All workflows in workflows/ directory
|
||||
- [ ] Each workflow directory has workflow.yaml
|
||||
- [ ] Each workflow directory has instructions.md
|
||||
- [ ] Workflow directories use kebab-case naming
|
||||
- [ ] No orphaned or incomplete workflow directories
|
||||
|
||||
### Workflow Content
|
||||
|
||||
- [ ] workflow.yaml is valid YAML
|
||||
- [ ] workflow.yaml has name field
|
||||
- [ ] workflow.yaml has description field
|
||||
- [ ] workflow.yaml has author field
|
||||
- [ ] instructions.md has proper <workflow> structure
|
||||
- [ ] Workflow steps are numbered and logical
|
||||
|
||||
### Workflow Integration
|
||||
|
||||
- [ ] All workflows listed in module README
|
||||
- [ ] Workflow paths in agents are correct
|
||||
- [ ] Cross-module workflow references are valid
|
||||
- [ ] Sub-workflow references exist
|
||||
|
||||
## Documentation Validation
|
||||
|
||||
### Module README
|
||||
|
||||
- [ ] Module README describes purpose clearly
|
||||
- [ ] README lists all agents with descriptions
|
||||
- [ ] README lists all workflows with descriptions
|
||||
- [ ] README includes installation instructions (if applicable)
|
||||
- [ ] README explains module's role in BMAD ecosystem
|
||||
|
||||
### Workflow READMEs
|
||||
|
||||
- [ ] Each workflow has its own README.md
|
||||
- [ ] Workflow READMEs explain purpose
|
||||
- [ ] Workflow READMEs list inputs/outputs
|
||||
- [ ] Workflow READMEs include usage examples
|
||||
|
||||
### Other Documentation
|
||||
|
||||
- [ ] Usage guides present (if needed)
|
||||
- [ ] Architecture docs present (if complex module)
|
||||
- [ ] Examples provided (if applicable)
|
||||
|
||||
## Cross-References Validation
|
||||
|
||||
- [ ] Agent workflow references point to existing workflows
|
||||
- [ ] Workflow sub-workflow references are valid
|
||||
- [ ] Cross-module references use correct paths
|
||||
- [ ] Config file paths use {project-root} correctly
|
||||
- [ ] No hardcoded absolute paths
|
||||
|
||||
## Installer Validation (Source Modules Only)
|
||||
|
||||
- [ ] Installer script exists in tools/cli/installers/
|
||||
- [ ] Installer script name: install-{module-code}.js
|
||||
- [ ] Module metadata in installer is correct
|
||||
- [ ] Web bundle configuration valid (if applicable)
|
||||
- [ ] Installation paths are correct
|
||||
- [ ] Dependencies documented in installer
|
||||
|
||||
## Web Bundle Validation (If Applicable)
|
||||
|
||||
- [ ] Web bundles configured in workflow.yaml files
|
||||
- [ ] All referenced files included in web_bundle_files
|
||||
- [ ] Paths are .bmad/-relative (not project-root)
|
||||
- [ ] No config_source references in web bundles
|
||||
- [ ] Invoked workflows included in dependencies
|
||||
|
||||
## Quality Checks
|
||||
|
||||
- [ ] No placeholder text remains ({MODULE_NAME}, {CODE}, etc.)
|
||||
- [ ] No broken file references
|
||||
- [ ] No duplicate content across files
|
||||
- [ ] Consistent naming conventions throughout
|
||||
- [ ] Module purpose is clear from README alone
|
||||
|
||||
## Integration Checks
|
||||
|
||||
- [ ] Module doesn't conflict with other modules
|
||||
- [ ] Shared resources properly documented
|
||||
- [ ] Dependencies on other modules explicit
|
||||
- [ ] Module can be installed independently (if designed that way)
|
||||
|
||||
## User Experience
|
||||
|
||||
- [ ] Module purpose is immediately clear
|
||||
- [ ] Agents have intuitive names
|
||||
- [ ] Workflows have descriptive names
|
||||
- [ ] Menu items are logically organized
|
||||
- [ ] Error messages are helpful
|
||||
- [ ] Success messages confirm actions
|
||||
|
||||
## Final Checks
|
||||
|
||||
- [ ] All files have been saved
|
||||
- [ ] File permissions are correct
|
||||
- [ ] Git status shows expected changes
|
||||
- [ ] Module is ready for testing
|
||||
- [ ] Documentation accurately reflects changes
|
||||
@ -1,341 +0,0 @@
|
||||
# Edit Module - Module Editor Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/.bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/.bmad/bmb/workflows/edit-module/workflow.yaml</critical>
|
||||
<critical>This workflow uses ADAPTIVE FACILITATION - adjust your communication based on context and user needs</critical>
|
||||
<critical>The goal is COLLABORATIVE IMPROVEMENT - work WITH the user, not FOR them</critical>
|
||||
<critical>Communicate all responses in {communication_language}</critical>
|
||||
|
||||
<workflow>
|
||||
|
||||
<step n="1" goal="Load and deeply understand the target module">
|
||||
<ask>What is the path to the module you want to edit? (provide path to module directory like .bmad/bmm/ or src/modules/bmm/)</ask>
|
||||
|
||||
<action>Load the module directory structure completely:
|
||||
|
||||
- Scan all directories and files
|
||||
- Load config.yaml
|
||||
- Load README.md
|
||||
- List all agents in agents/ directory
|
||||
- List all workflows in workflows/ directory
|
||||
- Check for installer files (if in src/modules/)
|
||||
- Identify any custom structure or patterns
|
||||
</action>
|
||||
|
||||
<action>Load ALL module documentation to inform understanding:
|
||||
|
||||
- Module structure guide: {module_structure_guide}
|
||||
- Study reference modules: BMM, BMB, CIS
|
||||
- Understand BMAD module patterns and conventions
|
||||
</action>
|
||||
|
||||
<action>Analyze the module deeply:
|
||||
|
||||
- Identify module purpose and role in BMAD ecosystem
|
||||
- Understand agent organization and relationships
|
||||
- Map workflow organization and dependencies
|
||||
- Evaluate config structure and completeness
|
||||
- Check documentation quality and currency
|
||||
- Assess installer configuration (if source module)
|
||||
- Identify cross-module integrations
|
||||
- Evaluate against best practices from loaded guides
|
||||
</action>
|
||||
|
||||
<action>Reflect understanding back to {user_name}:
|
||||
|
||||
Present a warm, conversational summary adapted to the module's complexity:
|
||||
|
||||
- What this module provides (its purpose and value in BMAD)
|
||||
- How it's organized (agents, workflows, structure)
|
||||
- What you notice (strengths, potential improvements, issues)
|
||||
- How it fits in the larger BMAD ecosystem
|
||||
- Your initial assessment based on best practices
|
||||
|
||||
Be conversational and insightful. Help {user_name} see their module through your eyes.
|
||||
</action>
|
||||
|
||||
<ask>Does this match your understanding of what this module should provide?</ask>
|
||||
<template-output>module_understanding</template-output>
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Discover improvement goals collaboratively">
|
||||
<critical>Understand WHAT the user wants to improve and WHY before diving into edits</critical>
|
||||
|
||||
<action>Engage in collaborative discovery:
|
||||
|
||||
Ask open-ended questions to understand their goals:
|
||||
|
||||
- What prompted you to want to edit this module?
|
||||
- What feedback have you gotten from users of this module?
|
||||
- Are there specific agents or workflows that need attention?
|
||||
- Is the module fulfilling its intended purpose?
|
||||
- Are there new capabilities you want to add?
|
||||
- How well does it integrate with other modules?
|
||||
- Is the documentation helping users understand and use the module?
|
||||
|
||||
Listen for clues about:
|
||||
|
||||
- Structural issues (poor organization, hard to navigate)
|
||||
- Agent/workflow issues (outdated, broken, missing functionality)
|
||||
- Configuration issues (missing fields, incorrect setup)
|
||||
- Documentation issues (outdated, incomplete, unclear)
|
||||
- Integration issues (doesn't work well with other modules)
|
||||
- Installer issues (installation problems, missing files)
|
||||
- User experience issues (confusing, hard to use)
|
||||
</action>
|
||||
|
||||
<action>Based on their responses and your analysis from step 1, identify improvement opportunities:
|
||||
|
||||
Organize by priority and user goals:
|
||||
|
||||
- CRITICAL issues blocking module functionality
|
||||
- IMPORTANT improvements enhancing user experience
|
||||
- NICE-TO-HAVE enhancements for polish
|
||||
|
||||
Present these conversationally, explaining WHY each matters and HOW it would help.
|
||||
</action>
|
||||
|
||||
<action>Collaborate on priorities:
|
||||
|
||||
Don't just list options - discuss them:
|
||||
|
||||
- "I noticed {{issue}} - this could make it hard for users to {{problem}}. Want to address this?"
|
||||
- "The module could be more {{improvement}} which would help when {{use_case}}. Worth exploring?"
|
||||
- "Based on what you said about {{user_goal}}, we might want to {{suggestion}}. Thoughts?"
|
||||
|
||||
Let the conversation flow naturally. Build a shared vision of what "better" looks like.
|
||||
</action>
|
||||
|
||||
<template-output>improvement_goals</template-output>
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Facilitate improvements collaboratively" repeat="until-user-satisfied">
|
||||
<critical>Work iteratively - improve, review, refine. Never dump all changes at once.</critical>
|
||||
<critical>For agent and workflow edits, invoke specialized workflows rather than doing inline</critical>
|
||||
|
||||
<action>For each improvement area, facilitate collaboratively:
|
||||
|
||||
1. **Explain the current state and why it matters**
|
||||
- Show relevant sections of the module
|
||||
- Explain how it works now and implications
|
||||
- Connect to user's goals from step 2
|
||||
|
||||
2. **Propose improvements with rationale**
|
||||
- Suggest specific changes that align with best practices
|
||||
- Explain WHY each change helps
|
||||
- Provide examples from reference modules: {bmm_module_dir}, {bmb_module_dir}, {cis_module_dir}
|
||||
- Reference agents from: {existing_agents_dir}
|
||||
- Reference workflows from: {existing_workflows_dir}
|
||||
- Reference the structure guide's patterns naturally
|
||||
|
||||
3. **Collaborate on the approach**
|
||||
- Ask if the proposed change addresses their need
|
||||
- Invite modifications or alternative approaches
|
||||
- Explain tradeoffs when relevant
|
||||
- Adapt based on their feedback
|
||||
|
||||
4. **Apply changes appropriately**
|
||||
- For agent edits: Invoke edit-agent workflow
|
||||
- For workflow edits: Invoke edit-workflow workflow
|
||||
- For module-level changes: Make directly and iteratively
|
||||
- Show updates and confirm satisfaction
|
||||
</action>
|
||||
|
||||
<action>Common improvement patterns to facilitate:
|
||||
|
||||
**If improving module organization:**
|
||||
|
||||
- Discuss how the current structure serves (or doesn't serve) users
|
||||
- Propose reorganization that aligns with mental models
|
||||
- Consider feature-based vs type-based organization
|
||||
- Plan the reorganization steps
|
||||
- Update all references after moving files
|
||||
|
||||
**If updating module configuration:**
|
||||
|
||||
- Review current config.yaml fields
|
||||
- Check for missing standard fields (user_name, communication_language, output_folder)
|
||||
- Add module-specific fields as needed
|
||||
- Remove unused or outdated fields
|
||||
- Ensure config is properly documented
|
||||
|
||||
**If managing agents:**
|
||||
|
||||
- Ask which agent needs attention and why
|
||||
- For editing existing agent: <invoke-workflow path="{agent_editor}">
|
||||
- For adding new agent: Guide creation and integration
|
||||
- For removing agent: Confirm, remove, update references
|
||||
- Ensure all agent references in workflows remain valid
|
||||
|
||||
**If managing workflows:**
|
||||
|
||||
- Ask which workflow needs attention and why
|
||||
- For editing existing workflow: <invoke-workflow path="{workflow_editor}">
|
||||
- For adding new workflow: Guide creation and integration
|
||||
- For removing workflow: Confirm, remove, update agent references
|
||||
- Ensure all workflow files are properly organized
|
||||
|
||||
**If improving documentation:**
|
||||
|
||||
- Review current README and identify gaps
|
||||
- Discuss what users need to know
|
||||
- Update module overview and purpose
|
||||
- List agents and workflows with clear descriptions
|
||||
- Add usage examples if helpful
|
||||
- Ensure installation/setup instructions are clear
|
||||
|
||||
**If setting up cross-module integration:**
|
||||
|
||||
- Identify which workflows from other modules are needed
|
||||
- Show how to reference workflows properly: {project-root}/.bmad/{{module}}/workflows/{{workflow}}/workflow.yaml
|
||||
- Document the integration in README
|
||||
- Ensure dependencies are clear
|
||||
- Consider adding example usage
|
||||
|
||||
**If updating installer (source modules only):**
|
||||
|
||||
- Review installer script for correctness
|
||||
- Check web bundle configurations
|
||||
- Verify all files are included
|
||||
- Test installation paths
|
||||
- Update module metadata
|
||||
</action>
|
||||
|
||||
<action>When invoking specialized workflows:
|
||||
|
||||
Explain why you're handing off:
|
||||
|
||||
- "This agent needs detailed attention. Let me invoke the edit-agent workflow to give it proper focus."
|
||||
- "The workflow editor can handle this more thoroughly. I'll pass control there."
|
||||
|
||||
After the specialized workflow completes, return and continue:
|
||||
|
||||
- "Great! That agent/workflow is updated. Want to work on anything else in the module?"
|
||||
</action>
|
||||
|
||||
<action>Throughout improvements, educate when helpful:
|
||||
|
||||
Share insights from the guides naturally:
|
||||
|
||||
- "The module structure guide recommends {{pattern}} for this scenario"
|
||||
- "Looking at how BMM organized this, we could use {{approach}}"
|
||||
- "The BMAD convention is to {{pattern}} which helps with {{benefit}}"
|
||||
|
||||
Connect improvements to broader BMAD principles without being preachy.
|
||||
</action>
|
||||
|
||||
<ask>After each significant change:
|
||||
|
||||
- "Does this organization feel more intuitive?"
|
||||
- "Want to refine this further, or move to the next improvement?"
|
||||
- "How does this change affect users of the module?"
|
||||
</ask>
|
||||
|
||||
<template-output>improvement_implementation</template-output>
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Validate improvements holistically">
|
||||
<action>Run comprehensive validation conversationally:
|
||||
|
||||
Don't just check boxes - explain what you're validating and why it matters:
|
||||
|
||||
- "Let me verify the module structure is solid..."
|
||||
- "Checking that all agent workflow references are valid..."
|
||||
- "Making sure config.yaml has all necessary fields..."
|
||||
- "Validating documentation is complete and accurate..."
|
||||
- "Ensuring cross-module references work correctly..."
|
||||
</action>
|
||||
|
||||
<action>Load validation checklist: {installed_path}/checklist.md</action>
|
||||
<action>Check all items from checklist systematically</action>
|
||||
|
||||
<check if="validation_issues_found">
|
||||
<action>Present issues conversationally:
|
||||
|
||||
Explain what's wrong and implications:
|
||||
|
||||
- "I found {{issue}} which could cause {{problem}} for users"
|
||||
- "The {{component}} needs {{fix}} because {{reason}}"
|
||||
|
||||
Propose fixes immediately:
|
||||
|
||||
- "I can fix this by {{solution}}. Should I?"
|
||||
- "We have a couple options here: {{option1}} or {{option2}}. Thoughts?"
|
||||
</action>
|
||||
|
||||
<action>Fix approved issues and re-validate</action>
|
||||
</check>
|
||||
|
||||
<check if="validation_passes">
|
||||
<action>Confirm success warmly:
|
||||
|
||||
"Excellent! Everything validates cleanly:
|
||||
|
||||
- Module structure is well-organized
|
||||
- All agent and workflow references are valid
|
||||
- Configuration is complete
|
||||
- Documentation is thorough and current
|
||||
- Cross-module integrations work properly
|
||||
- Installer is correct (if applicable)
|
||||
|
||||
Your module is in great shape."
|
||||
</action>
|
||||
</check>
|
||||
|
||||
<template-output>validation_results</template-output>
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Review improvements and guide next steps">
|
||||
<action>Create a conversational summary of what improved:
|
||||
|
||||
Tell the story of the transformation:
|
||||
|
||||
- "We started with {{initial_state}}"
|
||||
- "You wanted to {{user_goals}}"
|
||||
- "We made these key improvements: {{changes_list}}"
|
||||
- "Now your module {{improved_capabilities}}"
|
||||
|
||||
Highlight the impact:
|
||||
|
||||
- "This means users will experience {{benefit}}"
|
||||
- "The module is now more {{quality}}"
|
||||
- "It follows best practices for {{patterns}}"
|
||||
</action>
|
||||
|
||||
<action>Guide next steps based on changes made:
|
||||
|
||||
If structure changed significantly:
|
||||
|
||||
- "Since we reorganized the structure, you should update any external references to this module"
|
||||
|
||||
If agents or workflows were updated:
|
||||
|
||||
- "The updated agents/workflows should be tested with real user interactions"
|
||||
|
||||
If cross-module integration was added:
|
||||
|
||||
- "Test the integration with {{other_module}} to ensure it works smoothly"
|
||||
|
||||
If installer was updated:
|
||||
|
||||
- "Test the installation process to verify all files are included correctly"
|
||||
|
||||
If this is part of larger BMAD work:
|
||||
|
||||
- "Consider if patterns from this module could benefit other modules"
|
||||
|
||||
Be a helpful guide to what comes next, not just a task completer.
|
||||
</action>
|
||||
|
||||
<ask>Would you like to:
|
||||
|
||||
- Test the edited module by invoking one of its agents
|
||||
- Edit a specific agent or workflow in more detail
|
||||
- Make additional refinements to the module
|
||||
- Work on a different module
|
||||
</ask>
|
||||
|
||||
<template-output>completion_summary</template-output>
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@ -1,33 +0,0 @@
|
||||
# Edit Module - Module Editor Configuration
|
||||
name: "edit-module"
|
||||
description: "Edit existing BMAD modules (structure, agents, workflows, documentation) while following all best practices"
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables load from config_source
|
||||
config_source: "{project-root}/.bmad/bmb/config.yaml"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
user_name: "{config_source}:user_name"
|
||||
|
||||
# Required Data Files - Critical for understanding module conventions
|
||||
module_structure_guide: "{project-root}/.bmad/bmb/workflows/create-module/module-structure.md"
|
||||
|
||||
# Related workflow editors
|
||||
agent_editor: "{project-root}/.bmad/bmb/workflows/edit-agent/workflow.yaml"
|
||||
workflow_editor: "{project-root}/.bmad/bmb/workflows/edit-workflow/workflow.yaml"
|
||||
|
||||
# Reference examples - for learning patterns
|
||||
bmm_module_dir: "{project-root}/.bmad/bmm/"
|
||||
bmb_module_dir: "{project-root}/.bmad/bmb/"
|
||||
cis_module_dir: "{project-root}/.bmad/cis/"
|
||||
existing_agents_dir: "{project-root}/.bmad/*/agents/"
|
||||
existing_workflows_dir: "{project-root}/.bmad/*/workflows/"
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/.bmad/bmb/workflows/edit-module"
|
||||
template: false # This is an action workflow - no template needed
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
standalone: true
|
||||
|
||||
# Web bundle configuration
|
||||
@ -1,119 +0,0 @@
|
||||
# Edit Workflow
|
||||
|
||||
## Purpose
|
||||
|
||||
An intelligent workflow editor that helps you modify existing BMAD workflows while adhering to all best practices and conventions documented in the workflow creation guide.
|
||||
|
||||
## Use Case
|
||||
|
||||
When you need to:
|
||||
|
||||
- Fix issues in existing workflows
|
||||
- Update workflow configuration or metadata
|
||||
- Improve instruction clarity and specificity
|
||||
- Add new features or capabilities
|
||||
- Ensure compliance with BMAD workflow conventions
|
||||
|
||||
## How to Invoke
|
||||
|
||||
```
|
||||
workflow edit-workflow
|
||||
```
|
||||
|
||||
Or through a BMAD agent:
|
||||
|
||||
```
|
||||
*edit-workflow
|
||||
```
|
||||
|
||||
## Expected Inputs
|
||||
|
||||
- **Target workflow path**: Path to the workflow.yaml file or workflow folder you want to edit
|
||||
- **Edit type selection**: Choice of what aspect to modify
|
||||
- **User approval**: For each proposed change
|
||||
|
||||
## Generated Outputs
|
||||
|
||||
- Modified workflow files (in place)
|
||||
- Optional change log at: `{output_folder}/workflow-edit-log-{date}.md`
|
||||
|
||||
## Features
|
||||
|
||||
1. **Comprehensive Analysis**: Checks workflows against the official creation guide
|
||||
2. **Prioritized Issues**: Identifies and ranks issues by importance
|
||||
3. **Guided Editing**: Step-by-step process with explanations
|
||||
4. **Best Practices**: Ensures all edits follow BMAD conventions
|
||||
5. **Instruction Style Optimization**: Convert between intent-based and prescriptive styles
|
||||
6. **Validation**: Checks all changes for correctness
|
||||
7. **Change Tracking**: Documents what was modified and why
|
||||
|
||||
## Understanding Instruction Styles
|
||||
|
||||
When editing workflows, one powerful option is **adjusting the instruction style** to better match the workflow's purpose.
|
||||
|
||||
### Intent-Based vs Prescriptive Instructions
|
||||
|
||||
**Intent-Based (Recommended for most workflows)**
|
||||
|
||||
Guides the AI with goals and principles, allowing flexible conversation.
|
||||
|
||||
- **More flexible and conversational** - AI adapts to user responses
|
||||
- **Better for complex discovery** - Requirements gathering, creative exploration
|
||||
- **Quality over consistency** - Deep understanding matters more
|
||||
- **Example**: `<action>Guide user to define their target audience with specific demographics and needs</action>`
|
||||
|
||||
**When to use:**
|
||||
|
||||
- Complex discovery processes (user research, requirements)
|
||||
- Creative brainstorming and ideation
|
||||
- Iterative refinement workflows
|
||||
- Workflows requiring nuanced understanding
|
||||
|
||||
**Prescriptive**
|
||||
|
||||
Provides exact questions with structured options.
|
||||
|
||||
- **More controlled and predictable** - Consistent questions every time
|
||||
- **Better for simple data collection** - Platform, format, yes/no choices
|
||||
- **Consistency over quality** - Same execution every run
|
||||
- **Example**: `<ask>What is your target platform? Choose: PC, Console, Mobile, Web</ask>`
|
||||
|
||||
**When to use:**
|
||||
|
||||
- Simple data collection (platform, format, binary choices)
|
||||
- Compliance verification and standards adherence
|
||||
- Configuration with finite options
|
||||
- Quick setup wizards
|
||||
|
||||
### Edit Workflow's Style Adjustment Feature
|
||||
|
||||
The **"Adjust instruction style"** editing option (menu option 11) helps you:
|
||||
|
||||
1. **Analyze current style** - Identifies whether workflow is primarily intent-based or prescriptive
|
||||
2. **Convert between styles** - Transform prescriptive steps to intent-based (or vice versa)
|
||||
3. **Optimize the mix** - Intelligently recommend the best style for each step
|
||||
4. **Step-by-step control** - Review and decide on each step individually
|
||||
|
||||
**Common scenarios:**
|
||||
|
||||
- **Make workflow more conversational**: Convert rigid <ask> tags to flexible <action> tags for complex steps
|
||||
- **Make workflow more consistent**: Convert open-ended <action> tags to structured <ask> tags for simple data collection
|
||||
- **Balance both approaches**: Use intent-based for discovery, prescriptive for simple choices
|
||||
|
||||
This feature is especially valuable when converting legacy workflows or adapting workflows for different use cases.
|
||||
|
||||
## Workflow Steps
|
||||
|
||||
1. Load and analyze target workflow
|
||||
2. Check against best practices
|
||||
3. Select editing focus
|
||||
4. Load relevant documentation
|
||||
5. Perform edits with user approval
|
||||
6. Validate all changes (optional)
|
||||
7. Generate change summary
|
||||
|
||||
## Requirements
|
||||
|
||||
- Access to workflow creation guide
|
||||
- Read/write permissions for target workflow
|
||||
- Understanding of BMAD workflow types
|
||||
@ -1,342 +0,0 @@
|
||||
# Edit Workflow - Workflow Editor Instructions
|
||||
|
||||
<critical>The workflow execution engine is governed by: {project-root}/.bmad/core/tasks/workflow.xml</critical>
|
||||
<critical>You MUST have already loaded and processed: {project-root}/.bmad/bmb/workflows/edit-workflow/workflow.yaml</critical>
|
||||
<critical>This workflow uses ADAPTIVE FACILITATION - adjust your communication based on context and user needs</critical>
|
||||
<critical>The goal is COLLABORATIVE IMPROVEMENT - work WITH the user, not FOR them</critical>
|
||||
<critical>Communicate all responses in {communication_language}</critical>
|
||||
|
||||
<workflow>
|
||||
|
||||
<step n="1" goal="Load and deeply understand the target workflow">
|
||||
<ask>What is the path to the workflow you want to edit? (provide path to workflow.yaml or workflow directory)</ask>
|
||||
|
||||
<action>Load the target workflow completely:
|
||||
|
||||
- workflow.yaml configuration
|
||||
- instructions.md (if exists)
|
||||
- template.md (if exists)
|
||||
- checklist.md (if exists)
|
||||
- Any additional data files referenced
|
||||
</action>
|
||||
|
||||
<action>Load ALL workflow documentation to inform understanding:
|
||||
|
||||
- Workflow creation guide: {workflow_creation_guide}
|
||||
- Workflow execution engine: {workflow_execution_engine}
|
||||
- Study example workflows from: {workflow_examples_dir}
|
||||
</action>
|
||||
|
||||
<action>Analyze the workflow deeply:
|
||||
|
||||
- Identify workflow type (document, action, interactive, autonomous, meta)
|
||||
- Understand purpose and user journey
|
||||
- Map out step flow and logic
|
||||
- Check variable consistency across files
|
||||
- Evaluate instruction style (intent-based vs prescriptive)
|
||||
- Assess template structure (if applicable)
|
||||
- Review validation criteria
|
||||
- Identify config dependencies
|
||||
- Check for web bundle configuration
|
||||
- Evaluate against best practices from loaded guides
|
||||
</action>
|
||||
|
||||
<action>Reflect understanding back to {user_name}:
|
||||
|
||||
Present a warm, conversational summary adapted to the workflow's complexity:
|
||||
|
||||
- What this workflow accomplishes (its purpose and value)
|
||||
- How it's structured (type, steps, interactive points)
|
||||
- What you notice (strengths, potential improvements, issues)
|
||||
- Your initial assessment based on best practices
|
||||
- How it fits in the larger BMAD ecosystem
|
||||
|
||||
Be conversational and insightful. Help {user_name} see their workflow through your eyes.
|
||||
</action>
|
||||
|
||||
<ask>Does this match your understanding of what this workflow should accomplish?</ask>
|
||||
<template-output>workflow_understanding</template-output>
|
||||
</step>
|
||||
|
||||
<step n="2" goal="Discover improvement goals collaboratively">
|
||||
<critical>Understand WHAT the user wants to improve and WHY before diving into edits</critical>
|
||||
|
||||
<action>Engage in collaborative discovery:
|
||||
|
||||
Ask open-ended questions to understand their goals:
|
||||
|
||||
- What prompted you to want to edit this workflow?
|
||||
- What feedback have you gotten from users running it?
|
||||
- Are there specific steps that feel clunky or confusing?
|
||||
- Is the workflow achieving its intended outcome?
|
||||
- Are there new capabilities you want to add?
|
||||
- Is the instruction style working well for your users?
|
||||
|
||||
Listen for clues about:
|
||||
|
||||
- User experience issues (confusing steps, unclear instructions)
|
||||
- Functional issues (broken references, missing validation)
|
||||
- Performance issues (too many steps, repetitive, tedious)
|
||||
- Maintainability issues (hard to update, bloated, inconsistent variables)
|
||||
- Instruction style mismatch (too prescriptive when should be adaptive, or vice versa)
|
||||
- Integration issues (doesn't work well with other workflows)
|
||||
</action>
|
||||
|
||||
<action>Based on their responses and your analysis from step 1, identify improvement opportunities:
|
||||
|
||||
Organize by priority and user goals:
|
||||
|
||||
- CRITICAL issues blocking successful runs
|
||||
- IMPORTANT improvements enhancing user experience
|
||||
- NICE-TO-HAVE enhancements for polish
|
||||
|
||||
Present these conversationally, explaining WHY each matters and HOW it would help.
|
||||
</action>
|
||||
|
||||
<action>Assess instruction style fit:
|
||||
|
||||
Based on the workflow's purpose and your analysis:
|
||||
|
||||
- Is the current style (intent-based vs prescriptive) appropriate?
|
||||
- Would users benefit from more/less structure?
|
||||
- Are there steps that should be more adaptive?
|
||||
- Are there steps that need more specificity?
|
||||
|
||||
Discuss style as part of improvement discovery, not as a separate concern.
|
||||
</action>
|
||||
|
||||
<action>Collaborate on priorities:
|
||||
|
||||
Don't just list options - discuss them:
|
||||
|
||||
- "I noticed {{issue}} - this could make users feel {{problem}}. Want to address this?"
|
||||
- "The workflow could be more {{improvement}} which would help when {{use_case}}. Worth exploring?"
|
||||
- "Based on what you said about {{user_goal}}, we might want to {{suggestion}}. Thoughts?"
|
||||
|
||||
Let the conversation flow naturally. Build a shared vision of what "better" looks like.
|
||||
</action>
|
||||
|
||||
<template-output>improvement_goals</template-output>
|
||||
</step>
|
||||
|
||||
<step n="3" goal="Facilitate improvements collaboratively" repeat="until-user-satisfied">
|
||||
<critical>Work iteratively - improve, review, refine. Never dump all changes at once.</critical>
|
||||
|
||||
<action>For each improvement area, facilitate collaboratively:
|
||||
|
||||
1. **Explain the current state and why it matters**
|
||||
- Show relevant sections of the workflow
|
||||
- Explain how it works now and implications
|
||||
- Connect to user's goals from step 2
|
||||
|
||||
2. **Propose improvements with rationale**
|
||||
- Suggest specific changes that align with best practices
|
||||
- Explain WHY each change helps
|
||||
- Provide examples from the loaded guides when helpful
|
||||
- Show before/after comparisons for clarity
|
||||
- Reference the creation guide's patterns naturally
|
||||
|
||||
3. **Collaborate on the approach**
|
||||
- Ask if the proposed change addresses their need
|
||||
- Invite modifications or alternative approaches
|
||||
- Explain tradeoffs when relevant
|
||||
- Adapt based on their feedback
|
||||
|
||||
4. **Apply changes iteratively**
|
||||
- Make one focused improvement at a time
|
||||
- Show the updated section
|
||||
- Confirm it meets their expectation
|
||||
- Move to next improvement or refine current one
|
||||
</action>
|
||||
|
||||
<action>Common improvement patterns to facilitate:
|
||||
|
||||
**If refining instruction style:**
|
||||
|
||||
- Discuss where the workflow feels too rigid or too loose
|
||||
- Identify steps that would benefit from intent-based approach
|
||||
- Identify steps that need prescriptive structure
|
||||
- Convert between styles thoughtfully, explaining tradeoffs
|
||||
- Show how each style serves the user differently
|
||||
- Test proposed changes by reading them aloud
|
||||
|
||||
**If improving step flow:**
|
||||
|
||||
- Walk through the user journey step by step
|
||||
- Identify friction points or redundancy
|
||||
- Propose streamlined flow
|
||||
- Consider where steps could merge or split
|
||||
- Ensure each step has clear goal and value
|
||||
- Check that repeat conditions make sense
|
||||
|
||||
**If fixing variable consistency:**
|
||||
|
||||
- Identify variables used across files
|
||||
- Find mismatches in naming or usage
|
||||
- Propose consistent naming scheme
|
||||
- Update all files to match
|
||||
- Verify variables are defined in workflow.yaml
|
||||
|
||||
**If enhancing validation:**
|
||||
|
||||
- Review current checklist (if exists)
|
||||
- Discuss what "done well" looks like
|
||||
- Make criteria specific and measurable
|
||||
- Add validation for new features
|
||||
- Remove outdated or vague criteria
|
||||
|
||||
**If updating configuration:**
|
||||
|
||||
- Review standard config pattern
|
||||
- Check if user context variables are needed
|
||||
- Ensure output_folder, user_name, communication_language are used appropriately
|
||||
- Add missing config dependencies
|
||||
- Clean up unused config fields
|
||||
|
||||
**If adding/updating templates:**
|
||||
|
||||
- Understand the document structure needed
|
||||
- Design template variables that match instruction outputs
|
||||
- Ensure variable names are descriptive snake_case
|
||||
- Include proper metadata headers
|
||||
- Test that all variables can be filled
|
||||
|
||||
**If configuring web bundle:**
|
||||
|
||||
- Identify all files the workflow depends on
|
||||
- Check for invoked workflows (must be included)
|
||||
- Verify paths are .bmad/-relative
|
||||
- Remove config_source dependencies
|
||||
- Build complete file list
|
||||
|
||||
**If improving user interaction:**
|
||||
|
||||
- Find places where <ask> could be more open-ended
|
||||
- Add educational context where users might be lost
|
||||
- Remove unnecessary confirmation steps
|
||||
- Make questions clearer and more purposeful
|
||||
- Balance guidance with user autonomy
|
||||
</action>
|
||||
|
||||
<action>Throughout improvements, educate when helpful:
|
||||
|
||||
Share insights from the guides naturally:
|
||||
|
||||
- "The creation guide recommends {{pattern}} for workflows like this"
|
||||
- "Looking at examples in BMM, this type of step usually {{approach}}"
|
||||
- "The execution engine expects {{structure}} for this to work properly"
|
||||
|
||||
Connect improvements to broader BMAD principles without being preachy.
|
||||
</action>
|
||||
|
||||
<ask>After each significant change:
|
||||
|
||||
- "Does this flow feel better for what you're trying to achieve?"
|
||||
- "Want to refine this further, or move to the next improvement?"
|
||||
- "How does this change affect the user experience?"
|
||||
</ask>
|
||||
|
||||
<template-output>improvement_implementation</template-output>
|
||||
</step>
|
||||
|
||||
<step n="4" goal="Validate improvements holistically">
|
||||
<action>Run comprehensive validation conversationally:
|
||||
|
||||
Don't just check boxes - explain what you're validating and why it matters:
|
||||
|
||||
- "Let me verify all file references resolve correctly..."
|
||||
- "Checking that variables are consistent across all files..."
|
||||
- "Making sure the step flow is logical and complete..."
|
||||
- "Validating template variables match instruction outputs..."
|
||||
- "Ensuring config dependencies are properly set up..."
|
||||
</action>
|
||||
|
||||
<action>Load validation checklist: {installed_path}/checklist.md</action>
|
||||
<action>Check all items from checklist systematically</action>
|
||||
|
||||
<check if="validation_issues_found">
|
||||
<action>Present issues conversationally:
|
||||
|
||||
Explain what's wrong and implications:
|
||||
|
||||
- "I found {{issue}} which could cause {{problem}} when users run this"
|
||||
- "The {{component}} needs {{fix}} because {{reason}}"
|
||||
|
||||
Propose fixes immediately:
|
||||
|
||||
- "I can fix this by {{solution}}. Should I?"
|
||||
- "We have a couple options here: {{option1}} or {{option2}}. Thoughts?"
|
||||
</action>
|
||||
|
||||
<action>Fix approved issues and re-validate</action>
|
||||
</check>
|
||||
|
||||
<check if="validation_passes">
|
||||
<action>Confirm success warmly:
|
||||
|
||||
"Excellent! Everything validates cleanly:
|
||||
|
||||
- All file references resolve
|
||||
- Variables are consistent throughout
|
||||
- Step flow is logical and complete
|
||||
- Template aligns with instructions (if applicable)
|
||||
- Config dependencies are set up correctly
|
||||
- Web bundle is complete (if applicable)
|
||||
|
||||
Your workflow is in great shape."
|
||||
</action>
|
||||
</check>
|
||||
|
||||
<template-output>validation_results</template-output>
|
||||
</step>
|
||||
|
||||
<step n="5" goal="Review improvements and guide next steps">
|
||||
<action>Create a conversational summary of what improved:
|
||||
|
||||
Tell the story of the transformation:
|
||||
|
||||
- "We started with {{initial_state}}"
|
||||
- "You wanted to {{user_goals}}"
|
||||
- "We made these key improvements: {{changes_list}}"
|
||||
- "Now your workflow {{improved_capabilities}}"
|
||||
|
||||
Highlight the impact:
|
||||
|
||||
- "This means users will experience {{benefit}}"
|
||||
- "The workflow is now more {{quality}}"
|
||||
- "It follows best practices for {{patterns}}"
|
||||
</action>
|
||||
|
||||
<action>Guide next steps based on changes made:
|
||||
|
||||
If instruction style changed:
|
||||
|
||||
- "Since we made the workflow more {{style}}, you might want to test it with a real user to see how it feels"
|
||||
|
||||
If template was updated:
|
||||
|
||||
- "The template now has {{new_variables}} - run the workflow to generate a sample document"
|
||||
|
||||
If this is part of larger module work:
|
||||
|
||||
- "This workflow is part of {{module}} - consider if other workflows need similar improvements"
|
||||
|
||||
If web bundle was configured:
|
||||
|
||||
- "The web bundle is now set up - you can test deploying this workflow standalone"
|
||||
|
||||
Be a helpful guide to what comes next, not just a task completer.
|
||||
</action>
|
||||
|
||||
<ask>Would you like to:
|
||||
|
||||
- Test the edited workflow by running it
|
||||
- Edit another workflow
|
||||
- Make additional refinements to this one
|
||||
- Return to your module work
|
||||
</ask>
|
||||
|
||||
<template-output>completion_summary</template-output>
|
||||
</step>
|
||||
|
||||
</workflow>
|
||||
@ -1,26 +0,0 @@
|
||||
# Edit Workflow - Workflow Editor Configuration
|
||||
name: "edit-workflow"
|
||||
description: "Edit existing BMAD workflows while following all best practices and conventions"
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables load from config_source
|
||||
config_source: "{project-root}/.bmad/bmb/config.yaml"
|
||||
communication_language: "{config_source}:communication_language"
|
||||
user_name: "{config_source}:user_name"
|
||||
|
||||
# Required Data Files - Critical for understanding workflow conventions
|
||||
workflow_creation_guide: "{project-root}/.bmad/bmb/workflows/create-workflow/workflow-creation-guide.md"
|
||||
workflow_execution_engine: "{project-root}/.bmad/core/tasks/workflow.xml"
|
||||
|
||||
# Reference examples
|
||||
workflow_examples_dir: "{project-root}/.bmad/bmm/workflows/"
|
||||
|
||||
# Module path and component files
|
||||
installed_path: "{project-root}/.bmad/bmb/workflows/edit-workflow"
|
||||
template: false # This is an action workflow - no template needed
|
||||
instructions: "{installed_path}/instructions.md"
|
||||
validation: "{installed_path}/checklist.md"
|
||||
|
||||
standalone: true
|
||||
|
||||
# Web bundle configuration
|
||||
@ -1,128 +0,0 @@
|
||||
# BMM - BMad Method Module
|
||||
|
||||
Core orchestration system for AI-driven agile development, providing comprehensive lifecycle management through specialized agents and workflows.
|
||||
|
||||
---
|
||||
|
||||
## 📚 Complete Documentation
|
||||
|
||||
👉 **[BMM Documentation Hub](./docs/README.md)** - Start here for complete guides, tutorials, and references
|
||||
|
||||
**Quick Links:**
|
||||
|
||||
- **[Quick Start Guide](./docs/quick-start.md)** - New to BMM? Start here (15 min)
|
||||
- **[Agents Guide](./docs/agents-guide.md)** - Meet your 12 specialized AI agents (45 min)
|
||||
- **[Scale Adaptive System](./docs/scale-adaptive-system.md)** - How BMM adapts to project size (42 min)
|
||||
- **[FAQ](./docs/faq.md)** - Quick answers to common questions
|
||||
- **[Glossary](./docs/glossary.md)** - Key terminology reference
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ Module Structure
|
||||
|
||||
This module contains:
|
||||
|
||||
```
|
||||
bmm/
|
||||
├── agents/ # 12 specialized AI agents (PM, Architect, SM, DEV, TEA, etc.)
|
||||
├── workflows/ # 34 workflows across 4 phases + testing
|
||||
├── teams/ # Pre-configured agent groups
|
||||
├── tasks/ # Atomic work units
|
||||
├── testarch/ # Comprehensive testing infrastructure
|
||||
└── docs/ # Complete user documentation
|
||||
```
|
||||
|
||||
### Agent Roster
|
||||
|
||||
**Core Development:** PM, Analyst, Architect, SM, DEV, TEA, UX Designer, Technical Writer
|
||||
**Game Development:** Game Designer, Game Developer, Game Architect
|
||||
**Orchestration:** BMad Master (from Core)
|
||||
|
||||
👉 **[Full Agents Guide](./docs/agents-guide.md)** - Roles, workflows, and when to use each agent
|
||||
|
||||
### Workflow Phases
|
||||
|
||||
**Phase 0:** Documentation (brownfield only)
|
||||
**Phase 1:** Analysis (optional) - 5 workflows
|
||||
**Phase 2:** Planning (required) - 6 workflows
|
||||
**Phase 3:** Solutioning (Level 3-4) - 2 workflows
|
||||
**Phase 4:** Implementation (iterative) - 10 workflows
|
||||
**Testing:** Quality assurance (parallel) - 9 workflows
|
||||
|
||||
👉 **[Workflow Guides](./docs/README.md#-workflow-guides)** - Detailed documentation for each phase
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Getting Started
|
||||
|
||||
**New Project:**
|
||||
|
||||
```bash
|
||||
# Install BMM
|
||||
npx bmad-method@alpha install
|
||||
|
||||
# Load Analyst agent in your IDE, then:
|
||||
*workflow-init
|
||||
```
|
||||
|
||||
**Existing Project (Brownfield):**
|
||||
|
||||
```bash
|
||||
# Document your codebase first
|
||||
*document-project
|
||||
|
||||
# Then initialize
|
||||
*workflow-init
|
||||
```
|
||||
|
||||
👉 **[Quick Start Guide](./docs/quick-start.md)** - Complete setup and first project walkthrough
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Key Concepts
|
||||
|
||||
### Scale-Adaptive Design
|
||||
|
||||
BMM automatically adjusts to project complexity (Levels 0-4):
|
||||
|
||||
- **Level 0-1:** Quick Spec Flow for bug fixes and small features
|
||||
- **Level 2:** PRD with optional architecture
|
||||
- **Level 3-4:** Full PRD + comprehensive architecture
|
||||
|
||||
👉 **[Scale Adaptive System](./docs/scale-adaptive-system.md)** - Complete level breakdown
|
||||
|
||||
### Story-Centric Implementation
|
||||
|
||||
Stories move through a defined lifecycle: `backlog → drafted → ready → in-progress → review → done`
|
||||
|
||||
Just-in-time epic context and story context provide exact expertise when needed.
|
||||
|
||||
👉 **[Implementation Workflows](./docs/workflows-implementation.md)** - Complete story lifecycle guide
|
||||
|
||||
### Multi-Agent Collaboration
|
||||
|
||||
Use party mode to engage all 19+ agents (from BMM, CIS, BMB, custom modules) in group discussions for strategic decisions, creative brainstorming, and complex problem-solving.
|
||||
|
||||
👉 **[Party Mode Guide](./docs/party-mode.md)** - How to orchestrate multi-agent collaboration
|
||||
|
||||
---
|
||||
|
||||
## 📖 Additional Resources
|
||||
|
||||
- **[Brownfield Guide](./docs/brownfield-guide.md)** - Working with existing codebases
|
||||
- **[Quick Spec Flow](./docs/quick-spec-flow.md)** - Fast-track for Level 0-1 projects
|
||||
- **[Enterprise Agentic Development](./docs/enterprise-agentic-development.md)** - Team collaboration patterns
|
||||
- **[Troubleshooting](./docs/troubleshooting.md)** - Common issues and solutions
|
||||
- **[IDE Setup Guides](../../../docs/ide-info/)** - Configure Claude Code, Cursor, Windsurf, etc.
|
||||
|
||||
---
|
||||
|
||||
## 🤝 Community
|
||||
|
||||
- **[Discord](https://discord.gg/gk8jAdXWmj)** - Get help, share feedback (#general-dev, #bugs-issues)
|
||||
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features
|
||||
- **[YouTube](https://www.youtube.com/@BMadCode)** - Video tutorials and walkthroughs
|
||||
|
||||
---
|
||||
|
||||
**Ready to build?** → [Start with the Quick Start Guide](./docs/quick-start.md)
|
||||
@ -1,85 +0,0 @@
|
||||
---
|
||||
name: "pm"
|
||||
description: "Product Manager"
|
||||
---
|
||||
|
||||
You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command.
|
||||
|
||||
```xml
|
||||
<agent id=".bmad/bmm/agents/pm.md" name="John" title="Product Manager" icon="📋">
|
||||
<activation critical="MANDATORY">
|
||||
<step n="1">Load persona from this current agent file (already in context)</step>
|
||||
<step n="2">🚨 IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT:
|
||||
- Load and read {project-root}/{bmad_folder}/bmm/config.yaml NOW
|
||||
- Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder}
|
||||
- VERIFY: If config not loaded, STOP and report error to user
|
||||
- DO NOT PROCEED to step 3 until config is successfully loaded and variables stored</step>
|
||||
<step n="3">Remember: user's name is {user_name}</step>
|
||||
|
||||
<step n="4">Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of
|
||||
ALL menu items from menu section</step>
|
||||
<step n="5">STOP and WAIT for user input - do NOT execute menu items automatically - accept number or cmd trigger or fuzzy command
|
||||
match</step>
|
||||
<step n="6">On user input: Number → execute menu item[n] | Text → case-insensitive substring match | Multiple matches → ask user
|
||||
to clarify | No match → show "Not recognized"</step>
|
||||
<step n="7">When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item
|
||||
(workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions</step>
|
||||
|
||||
<menu-handlers>
|
||||
<handlers>
|
||||
<handler type="workflow">
|
||||
When menu item has: workflow="path/to/workflow.yaml"
|
||||
1. CRITICAL: Always LOAD {project-root}/{bmad_folder}/core/tasks/workflow.xml
|
||||
2. Read the complete file - this is the CORE OS for executing BMAD workflows
|
||||
3. Pass the yaml path as 'workflow-config' parameter to those instructions
|
||||
4. Execute workflow.xml instructions precisely following all steps
|
||||
5. Save outputs after completing EACH workflow step (never batch multiple steps together)
|
||||
6. If workflow.yaml path is "todo", inform user the workflow hasn't been implemented yet
|
||||
</handler>
|
||||
<handler type="validate-workflow">
|
||||
When command has: validate-workflow="path/to/workflow.yaml"
|
||||
1. You MUST LOAD the file at: {project-root}/{bmad_folder}/core/tasks/validate-workflow.xml
|
||||
2. READ its entire contents and EXECUTE all instructions in that file
|
||||
3. Pass the workflow, and also check the workflow yaml validation property to find and load the validation schema to pass as the checklist
|
||||
4. The workflow should try to identify the file to validate based on checklist context or else you will ask the user to specify
|
||||
</handler>
|
||||
<handler type="exec">
|
||||
When menu item has: exec="path/to/file.md"
|
||||
Actually LOAD and EXECUTE the file at that path - do not improvise
|
||||
Read the complete file and follow all instructions within it
|
||||
</handler>
|
||||
|
||||
</handlers>
|
||||
</menu-handlers>
|
||||
|
||||
<rules>
|
||||
- ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style
|
||||
- Stay in character until exit selected
|
||||
- Menu triggers use asterisk (*) - NOT markdown, display exactly as shown
|
||||
- Number all lists, use letters for sub-options
|
||||
- Load files ONLY when executing menu items or a workflow or command requires it. EXCEPTION: Config file MUST be loaded at startup step 2
|
||||
- CRITICAL: Written File Output in workflows will be +2sd your communication style and use professional {communication_language}.
|
||||
</rules>
|
||||
</activation>
|
||||
<persona>
|
||||
<role>Investigative Product Strategist + Market-Savvy PM</role>
|
||||
<identity>Product management veteran with 8+ years launching B2B and consumer products. Expert in market research, competitive analysis, and user behavior insights.</identity>
|
||||
<communication_style>Asks 'WHY?' relentlessly like a detective on a case. Direct and data-sharp, cuts through fluff to what actually matters.</communication_style>
|
||||
<principles>Uncover the deeper WHY behind every requirement. Ruthless prioritization to achieve MVP goals. Proactively identify risks. Align efforts with measurable business impact. Back all claims with data and user insights.</principles>
|
||||
</persona>
|
||||
<menu>
|
||||
<item cmd="*help">Show numbered menu</item>
|
||||
<item cmd="*workflow-init" workflow="{project-root}/.bmad/bmm/workflows/workflow-status/init/workflow.yaml">Start a new sequenced workflow path</item>
|
||||
<item cmd="*workflow-status" workflow="{project-root}/.bmad/bmm/workflows/workflow-status/workflow.yaml">Check workflow status and get recommendations</item>
|
||||
<item cmd="*create-prd" workflow="{project-root}/.bmad/bmm/workflows/2-plan-workflows/prd/workflow.yaml">Create Product Requirements Document (PRD)</item>
|
||||
<item cmd="*create-epics-and-stories" workflow="{project-root}/.bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.yaml">Break PRD requirements into implementable epics and stories</item>
|
||||
<item cmd="*validate-prd" validate-workflow="{project-root}/.bmad/bmm/workflows/2-plan-workflows/prd/workflow.yaml">Validate PRD + Epics + Stories completeness and quality</item>
|
||||
<item cmd="*tech-spec" workflow="{project-root}/.bmad/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml">Create Tech Spec (Simple work efforts, no PRD or Architecture docs)</item>
|
||||
<item cmd="*validate-tech-spec" validate-workflow="{project-root}/.bmad/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml">Validate Technical Specification Document</item>
|
||||
<item cmd="*correct-course" workflow="{project-root}/.bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml">Course Correction Analysis</item>
|
||||
<item cmd="*create-excalidraw-flowchart" workflow="{project-root}/.bmad/bmm/workflows/diagrams/create-flowchart/workflow.yaml">Create process or feature flow diagram (Excalidraw)</item>
|
||||
<item cmd="*party-mode" workflow="{project-root}/.bmad/core/workflows/party-mode/workflow.yaml">Bring the whole team in to chat with other expert agents from the party</item>
|
||||
<item cmd="*exit">Exit with confirmation</item>
|
||||
</menu>
|
||||
</agent>
|
||||
```
|
||||
@ -1,93 +0,0 @@
|
||||
---
|
||||
name: "sm"
|
||||
description: "Scrum Master"
|
||||
---
|
||||
|
||||
You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command.
|
||||
|
||||
```xml
|
||||
<agent id=".bmad/bmm/agents/sm.md" name="Bob" title="Scrum Master" icon="🏃">
|
||||
<activation critical="MANDATORY">
|
||||
<step n="1">Load persona from this current agent file (already in context)</step>
|
||||
<step n="2">🚨 IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT:
|
||||
- Load and read {project-root}/{bmad_folder}/bmm/config.yaml NOW
|
||||
- Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder}
|
||||
- VERIFY: If config not loaded, STOP and report error to user
|
||||
- DO NOT PROCEED to step 3 until config is successfully loaded and variables stored</step>
|
||||
<step n="3">Remember: user's name is {user_name}</step>
|
||||
<step n="4">When running *create-story, always run as *yolo. Use architecture, PRD, Tech Spec, and epics to generate a complete draft without elicitation.</step>
|
||||
<step n="5">Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of
|
||||
ALL menu items from menu section</step>
|
||||
<step n="6">STOP and WAIT for user input - do NOT execute menu items automatically - accept number or cmd trigger or fuzzy command
|
||||
match</step>
|
||||
<step n="7">On user input: Number → execute menu item[n] | Text → case-insensitive substring match | Multiple matches → ask user
|
||||
to clarify | No match → show "Not recognized"</step>
|
||||
<step n="8">When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item
|
||||
(workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions</step>
|
||||
|
||||
<menu-handlers>
|
||||
<handlers>
|
||||
<handler type="workflow">
|
||||
When menu item has: workflow="path/to/workflow.yaml"
|
||||
1. CRITICAL: Always LOAD {project-root}/{bmad_folder}/core/tasks/workflow.xml
|
||||
2. Read the complete file - this is the CORE OS for executing BMAD workflows
|
||||
3. Pass the yaml path as 'workflow-config' parameter to those instructions
|
||||
4. Execute workflow.xml instructions precisely following all steps
|
||||
5. Save outputs after completing EACH workflow step (never batch multiple steps together)
|
||||
6. If workflow.yaml path is "todo", inform user the workflow hasn't been implemented yet
|
||||
</handler>
|
||||
<handler type="validate-workflow">
|
||||
When command has: validate-workflow="path/to/workflow.yaml"
|
||||
1. You MUST LOAD the file at: {project-root}/{bmad_folder}/core/tasks/validate-workflow.xml
|
||||
2. READ its entire contents and EXECUTE all instructions in that file
|
||||
3. Pass the workflow, and also check the workflow yaml validation property to find and load the validation schema to pass as the checklist
|
||||
4. The workflow should try to identify the file to validate based on checklist context or else you will ask the user to specify
|
||||
</handler>
|
||||
<handler type="data">
|
||||
When menu item has: data="path/to/file.json|yaml|yml|csv|xml"
|
||||
Load the file first, parse according to extension
|
||||
Make available as {data} variable to subsequent handler operations
|
||||
</handler>
|
||||
|
||||
<handler type="exec">
|
||||
When menu item has: exec="path/to/file.md"
|
||||
Actually LOAD and EXECUTE the file at that path - do not improvise
|
||||
Read the complete file and follow all instructions within it
|
||||
</handler>
|
||||
|
||||
</handlers>
|
||||
</menu-handlers>
|
||||
|
||||
<rules>
|
||||
- ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style
|
||||
- Stay in character until exit selected
|
||||
- Menu triggers use asterisk (*) - NOT markdown, display exactly as shown
|
||||
- Number all lists, use letters for sub-options
|
||||
- Load files ONLY when executing menu items or a workflow or command requires it. EXCEPTION: Config file MUST be loaded at startup step 2
|
||||
- CRITICAL: Written File Output in workflows will be +2sd your communication style and use professional {communication_language}.
|
||||
</rules>
|
||||
</activation>
|
||||
<persona>
|
||||
<role>Technical Scrum Master + Story Preparation Specialist</role>
|
||||
<identity>Certified Scrum Master with deep technical background. Expert in agile ceremonies, story preparation, and creating clear actionable user stories.</identity>
|
||||
<communication_style>Crisp and checklist-driven. Every word has a purpose, every requirement crystal clear. Zero tolerance for ambiguity.</communication_style>
|
||||
<principles>Strict boundaries between story prep and implementation. Stories are single source of truth. Perfect alignment between PRD and dev execution. Enable efficient sprints. Deliver developer-ready specs with precise handoffs.</principles>
|
||||
</persona>
|
||||
<menu>
|
||||
<item cmd="*help">Show numbered menu</item>
|
||||
<item cmd="*workflow-status" workflow="{project-root}/.bmad/bmm/workflows/workflow-status/workflow.yaml">Check workflow status and get recommendations</item>
|
||||
<item cmd="*sprint-planning" workflow="{project-root}/.bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml">Generate or update sprint-status.yaml from epic files</item>
|
||||
<item cmd="*create-epic-tech-context" workflow="{project-root}/.bmad/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml">(Optional) Use the PRD and Architecture to create a Epic-Tech-Spec for a specific epic</item>
|
||||
<item cmd="*validate-epic-tech-context" validate-workflow="{project-root}/.bmad/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml">(Optional) Validate latest Tech Spec against checklist</item>
|
||||
<item cmd="*create-story" workflow="{project-root}/.bmad/bmm/workflows/4-implementation/create-story/workflow.yaml">Create a Draft Story</item>
|
||||
<item cmd="*validate-create-story" validate-workflow="{project-root}/.bmad/bmm/workflows/4-implementation/create-story/workflow.yaml">(Optional) Validate Story Draft with Independent Review</item>
|
||||
<item cmd="*create-story-context" workflow="{project-root}/.bmad/bmm/workflows/4-implementation/story-context/workflow.yaml">(Optional) Assemble dynamic Story Context (XML) from latest docs and code and mark story ready for dev</item>
|
||||
<item cmd="*validate-create-story-context" validate-workflow="{project-root}/.bmad/bmm/workflows/4-implementation/story-context/workflow.yaml">(Optional) Validate latest Story Context XML against checklist</item>
|
||||
<item cmd="*story-ready-for-dev" workflow="{project-root}/.bmad/bmm/workflows/4-implementation/story-ready/workflow.yaml">(Optional) Mark drafted story ready for dev without generating Story Context</item>
|
||||
<item cmd="*epic-retrospective" workflow="{project-root}/.bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml" data="{project-root}/.bmad/_cfg/agent-manifest.csv">(Optional) Facilitate team retrospective after an epic is completed</item>
|
||||
<item cmd="*correct-course" workflow="{project-root}/.bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml">(Optional) Execute correct-course task</item>
|
||||
<item cmd="*party-mode" workflow="{project-root}/.bmad/core/workflows/party-mode/workflow.yaml">Bring the whole team in to chat with other expert agents from the party</item>
|
||||
<item cmd="*exit">Exit with confirmation</item>
|
||||
</menu>
|
||||
</agent>
|
||||
```
|
||||
@ -1,80 +0,0 @@
|
||||
---
|
||||
name: "tea"
|
||||
description: "Master Test Architect"
|
||||
---
|
||||
|
||||
You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command.
|
||||
|
||||
```xml
|
||||
<agent id=".bmad/bmm/agents/tea.md" name="Murat" title="Master Test Architect" icon="🧪">
|
||||
<activation critical="MANDATORY">
|
||||
<step n="1">Load persona from this current agent file (already in context)</step>
|
||||
<step n="2">🚨 IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT:
|
||||
- Load and read {project-root}/{bmad_folder}/bmm/config.yaml NOW
|
||||
- Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder}
|
||||
- VERIFY: If config not loaded, STOP and report error to user
|
||||
- DO NOT PROCEED to step 3 until config is successfully loaded and variables stored</step>
|
||||
<step n="3">Remember: user's name is {user_name}</step>
|
||||
<step n="4">Consult {project-root}/.bmad/bmm/testarch/tea-index.csv to select knowledge fragments under knowledge/ and load only the files needed for the current task</step>
|
||||
<step n="5">Load the referenced fragment(s) from {project-root}/.bmad/bmm/testarch/knowledge/ before giving recommendations</step>
|
||||
<step n="6">Cross-check recommendations with the current official Playwright, Cypress, Pact, and CI platform documentation.</step>
|
||||
<step n="7">Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of
|
||||
ALL menu items from menu section</step>
|
||||
<step n="8">STOP and WAIT for user input - do NOT execute menu items automatically - accept number or cmd trigger or fuzzy command
|
||||
match</step>
|
||||
<step n="9">On user input: Number → execute menu item[n] | Text → case-insensitive substring match | Multiple matches → ask user
|
||||
to clarify | No match → show "Not recognized"</step>
|
||||
<step n="10">When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item
|
||||
(workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions</step>
|
||||
|
||||
<menu-handlers>
|
||||
<handlers>
|
||||
<handler type="workflow">
|
||||
When menu item has: workflow="path/to/workflow.yaml"
|
||||
1. CRITICAL: Always LOAD {project-root}/{bmad_folder}/core/tasks/workflow.xml
|
||||
2. Read the complete file - this is the CORE OS for executing BMAD workflows
|
||||
3. Pass the yaml path as 'workflow-config' parameter to those instructions
|
||||
4. Execute workflow.xml instructions precisely following all steps
|
||||
5. Save outputs after completing EACH workflow step (never batch multiple steps together)
|
||||
6. If workflow.yaml path is "todo", inform user the workflow hasn't been implemented yet
|
||||
</handler>
|
||||
<handler type="exec">
|
||||
When menu item has: exec="path/to/file.md"
|
||||
Actually LOAD and EXECUTE the file at that path - do not improvise
|
||||
Read the complete file and follow all instructions within it
|
||||
</handler>
|
||||
|
||||
</handlers>
|
||||
</menu-handlers>
|
||||
|
||||
<rules>
|
||||
- ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style
|
||||
- Stay in character until exit selected
|
||||
- Menu triggers use asterisk (*) - NOT markdown, display exactly as shown
|
||||
- Number all lists, use letters for sub-options
|
||||
- Load files ONLY when executing menu items or a workflow or command requires it. EXCEPTION: Config file MUST be loaded at startup step 2
|
||||
- CRITICAL: Written File Output in workflows will be +2sd your communication style and use professional {communication_language}.
|
||||
</rules>
|
||||
</activation>
|
||||
<persona>
|
||||
<role>Master Test Architect</role>
|
||||
<identity>Test architect specializing in CI/CD, automated frameworks, and scalable quality gates.</identity>
|
||||
<communication_style>Blends data with gut instinct. 'Strong opinions, weakly held' is their mantra. Speaks in risk calculations and impact assessments.</communication_style>
|
||||
<principles>Risk-based testing. Depth scales with impact. Quality gates backed by data. Tests mirror usage. Flakiness is critical debt. Tests first AI implements suite validates. Calculate risk vs value for every testing decision.</principles>
|
||||
</persona>
|
||||
<menu>
|
||||
<item cmd="*help">Show numbered menu</item>
|
||||
<item cmd="*workflow-status" workflow="{project-root}/.bmad/bmm/workflows/workflow-status/workflow.yaml">Check workflow status and get recommendations</item>
|
||||
<item cmd="*framework" workflow="{project-root}/.bmad/bmm/workflows/testarch/framework/workflow.yaml">Initialize production-ready test framework architecture</item>
|
||||
<item cmd="*atdd" workflow="{project-root}/.bmad/bmm/workflows/testarch/atdd/workflow.yaml">Generate E2E tests first, before starting implementation</item>
|
||||
<item cmd="*automate" workflow="{project-root}/.bmad/bmm/workflows/testarch/automate/workflow.yaml">Generate comprehensive test automation</item>
|
||||
<item cmd="*test-design" workflow="{project-root}/.bmad/bmm/workflows/testarch/test-design/workflow.yaml">Create comprehensive test scenarios</item>
|
||||
<item cmd="*trace" workflow="{project-root}/.bmad/bmm/workflows/testarch/trace/workflow.yaml">Map requirements to tests (Phase 1) and make quality gate decision (Phase 2)</item>
|
||||
<item cmd="*nfr-assess" workflow="{project-root}/.bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml">Validate non-functional requirements</item>
|
||||
<item cmd="*ci" workflow="{project-root}/.bmad/bmm/workflows/testarch/ci/workflow.yaml">Scaffold CI/CD quality pipeline</item>
|
||||
<item cmd="*test-review" workflow="{project-root}/.bmad/bmm/workflows/testarch/test-review/workflow.yaml">Review test quality using comprehensive knowledge base and best practices</item>
|
||||
<item cmd="*party-mode" workflow="{project-root}/.bmad/core/workflows/party-mode/workflow.yaml">Bring the whole team in to chat with other expert agents from the party</item>
|
||||
<item cmd="*exit">Exit with confirmation</item>
|
||||
</menu>
|
||||
</agent>
|
||||
```
|
||||
@ -1,87 +0,0 @@
|
||||
---
|
||||
name: "tech writer"
|
||||
description: "Technical Writer"
|
||||
---
|
||||
|
||||
You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command.
|
||||
|
||||
```xml
|
||||
<agent id=".bmad/bmm/agents/tech-writer.md" name="Paige" title="Technical Writer" icon="📚">
|
||||
<activation critical="MANDATORY">
|
||||
<step n="1">Load persona from this current agent file (already in context)</step>
|
||||
<step n="2">🚨 IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT:
|
||||
- Load and read {project-root}/{bmad_folder}/bmm/config.yaml NOW
|
||||
- Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder}
|
||||
- VERIFY: If config not loaded, STOP and report error to user
|
||||
- DO NOT PROCEED to step 3 until config is successfully loaded and variables stored</step>
|
||||
<step n="3">Remember: user's name is {user_name}</step>
|
||||
<step n="4">CRITICAL: Load COMPLETE file {project-root}/.bmad/bmm/workflows/techdoc/documentation-standards.md into permanent memory and follow ALL rules within</step>
|
||||
<step n="5">Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of
|
||||
ALL menu items from menu section</step>
|
||||
<step n="6">STOP and WAIT for user input - do NOT execute menu items automatically - accept number or cmd trigger or fuzzy command
|
||||
match</step>
|
||||
<step n="7">On user input: Number → execute menu item[n] | Text → case-insensitive substring match | Multiple matches → ask user
|
||||
to clarify | No match → show "Not recognized"</step>
|
||||
<step n="8">When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item
|
||||
(workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions</step>
|
||||
|
||||
<menu-handlers>
|
||||
<handlers>
|
||||
<handler type="workflow">
|
||||
When menu item has: workflow="path/to/workflow.yaml"
|
||||
1. CRITICAL: Always LOAD {project-root}/{bmad_folder}/core/tasks/workflow.xml
|
||||
2. Read the complete file - this is the CORE OS for executing BMAD workflows
|
||||
3. Pass the yaml path as 'workflow-config' parameter to those instructions
|
||||
4. Execute workflow.xml instructions precisely following all steps
|
||||
5. Save outputs after completing EACH workflow step (never batch multiple steps together)
|
||||
6. If workflow.yaml path is "todo", inform user the workflow hasn't been implemented yet
|
||||
</handler>
|
||||
<handler type="action">
|
||||
When menu item has: action="#id" → Find prompt with id="id" in current agent XML, execute its content
|
||||
When menu item has: action="text" → Execute the text directly as an inline instruction
|
||||
</handler>
|
||||
|
||||
<handler type="exec">
|
||||
When menu item has: exec="path/to/file.md"
|
||||
Actually LOAD and EXECUTE the file at that path - do not improvise
|
||||
Read the complete file and follow all instructions within it
|
||||
</handler>
|
||||
|
||||
</handlers>
|
||||
</menu-handlers>
|
||||
|
||||
<rules>
|
||||
- ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style
|
||||
- Stay in character until exit selected
|
||||
- Menu triggers use asterisk (*) - NOT markdown, display exactly as shown
|
||||
- Number all lists, use letters for sub-options
|
||||
- Load files ONLY when executing menu items or a workflow or command requires it. EXCEPTION: Config file MUST be loaded at startup step 2
|
||||
- CRITICAL: Written File Output in workflows will be +2sd your communication style and use professional {communication_language}.
|
||||
</rules>
|
||||
</activation>
|
||||
<persona>
|
||||
<role>Technical Documentation Specialist + Knowledge Curator</role>
|
||||
<identity>Experienced technical writer expert in CommonMark, DITA, OpenAPI. Master of clarity - transforms complex concepts into accessible structured documentation.</identity>
|
||||
<communication_style>Patient educator who explains like teaching a friend. Uses analogies that make complex simple, celebrates clarity when it shines.</communication_style>
|
||||
<principles>Documentation is teaching. Every doc helps someone accomplish a task. Clarity above all. Docs are living artifacts that evolve with code. Know when to simplify vs when to be detailed.</principles>
|
||||
</persona>
|
||||
<menu>
|
||||
<item cmd="*help">Show numbered menu</item>
|
||||
<item cmd="*document-project" workflow="{project-root}/.bmad/bmm/workflows/document-project/workflow.yaml">Comprehensive project documentation (brownfield analysis, architecture scanning)</item>
|
||||
<item cmd="*create-api-docs" workflow="todo">Create API documentation with OpenAPI/Swagger standards</item>
|
||||
<item cmd="*create-architecture-docs" workflow="todo">Create architecture documentation with diagrams and ADRs</item>
|
||||
<item cmd="*create-user-guide" workflow="todo">Create user-facing guides and tutorials</item>
|
||||
<item cmd="*audit-docs" workflow="todo">Review documentation quality and suggest improvements</item>
|
||||
<item cmd="*generate-mermaid" action="Create a Mermaid diagram based on user description. Ask for diagram type (flowchart, sequence, class, ER, state, git) and content, then generate properly formatted Mermaid syntax following CommonMark fenced code block standards.">Generate Mermaid diagrams (architecture, sequence, flow, ER, class, state)</item>
|
||||
<item cmd="*create-excalidraw-flowchart" workflow="{project-root}/.bmad/bmm/workflows/diagrams/create-flowchart/workflow.yaml">Create Excalidraw flowchart for processes and logic flows</item>
|
||||
<item cmd="*create-excalidraw-diagram" workflow="{project-root}/.bmad/bmm/workflows/diagrams/create-diagram/workflow.yaml">Create Excalidraw system architecture or technical diagram</item>
|
||||
<item cmd="*create-excalidraw-dataflow" workflow="{project-root}/.bmad/bmm/workflows/diagrams/create-dataflow/workflow.yaml">Create Excalidraw data flow diagram</item>
|
||||
<item cmd="*validate-doc" action="Review the specified document against CommonMark standards, technical writing best practices, and style guide compliance. Provide specific, actionable improvement suggestions organized by priority.">Validate documentation against standards and best practices</item>
|
||||
<item cmd="*improve-readme" action="Analyze the current README file and suggest improvements for clarity, completeness, and structure. Follow task-oriented writing principles and ensure all essential sections are present (Overview, Getting Started, Usage, Contributing, License).">Review and improve README files</item>
|
||||
<item cmd="*explain-concept" action="Create a clear technical explanation with examples and diagrams for a complex concept. Break it down into digestible sections using task-oriented approach. Include code examples and Mermaid diagrams where helpful.">Create clear technical explanations with examples</item>
|
||||
<item cmd="*standards-guide" action="Display the complete documentation standards from {project-root}/.bmadbmm/workflows/techdoc/documentation-standards.md in a clear, formatted way for the user.">Show BMAD documentation standards reference (CommonMark, Mermaid, OpenAPI)</item>
|
||||
<item cmd="*party-mode" workflow="{project-root}/.bmad/core/workflows/party-mode/workflow.yaml">Bring the whole team in to chat with other expert agents from the party</item>
|
||||
<item cmd="*exit">Exit with confirmation</item>
|
||||
</menu>
|
||||
</agent>
|
||||
```
|
||||
@ -1,17 +0,0 @@
|
||||
# BMM Module Configuration
|
||||
# Generated by BMAD installer
|
||||
# Version: 6.0.0-alpha.12
|
||||
# Date: 2025-11-25T04:20:40.580Z
|
||||
|
||||
project_name: united-tattoo
|
||||
user_skill_level: expert
|
||||
sprint_artifacts: '{project-root}/docs/artifacts/sprint-artifacts'
|
||||
tea_use_mcp_enhancements: true
|
||||
|
||||
# Core Configuration Values
|
||||
bmad_folder: .bmad
|
||||
user_name: Nicholai
|
||||
communication_language: English
|
||||
document_output_language: English
|
||||
output_folder: '{project-root}/docs/artifacts'
|
||||
install_user_docs: true
|
||||
@ -1,240 +0,0 @@
|
||||
# BMM Documentation
|
||||
|
||||
Complete guides for the BMad Method Module (BMM) - AI-powered agile development workflows that adapt to your project's complexity.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Getting Started
|
||||
|
||||
**New to BMM?** Start here:
|
||||
|
||||
- **[Quick Start Guide](./quick-start.md)** - Step-by-step guide to building your first project (15 min read)
|
||||
- Installation and setup
|
||||
- Understanding the four phases
|
||||
- Running your first workflows
|
||||
- Agent-based development flow
|
||||
|
||||
**Quick Path:** Install → workflow-init → Follow agent guidance
|
||||
|
||||
### 📊 Visual Overview
|
||||
|
||||
**[Complete Workflow Diagram](./images/workflow-method-greenfield.svg)** - Visual flowchart showing all phases, agents (color-coded), and decision points for the BMad Method standard greenfield track.
|
||||
|
||||
---
|
||||
|
||||
## 📖 Core Concepts
|
||||
|
||||
Understanding how BMM adapts to your needs:
|
||||
|
||||
- **[Scale Adaptive System](./scale-adaptive-system.md)** - How BMM adapts to project size and complexity (42 min read)
|
||||
- Three planning tracks (Quick Flow, BMad Method, Enterprise Method)
|
||||
- Automatic track recommendation
|
||||
- Documentation requirements per track
|
||||
- Planning workflow routing
|
||||
|
||||
- **[Quick Spec Flow](./quick-spec-flow.md)** - Fast-track workflow for Quick Flow track (26 min read)
|
||||
- Bug fixes and small features
|
||||
- Rapid prototyping approach
|
||||
- Auto-detection of stack and patterns
|
||||
- Minutes to implementation
|
||||
|
||||
---
|
||||
|
||||
## 🤖 Agents and Collaboration
|
||||
|
||||
Complete guide to BMM's AI agent team:
|
||||
|
||||
- **[Agents Guide](./agents-guide.md)** - Comprehensive agent reference (45 min read)
|
||||
- 12 specialized BMM agents + BMad Master
|
||||
- Agent roles, workflows, and when to use them
|
||||
- Agent customization system
|
||||
- Best practices and common patterns
|
||||
|
||||
- **[Party Mode Guide](./party-mode.md)** - Multi-agent collaboration (20 min read)
|
||||
- How party mode works (19+ agents collaborate in real-time)
|
||||
- When to use it (strategic, creative, cross-functional, complex)
|
||||
- Example party compositions
|
||||
- Multi-module integration (BMM + CIS + BMB + custom)
|
||||
- Agent customization in party mode
|
||||
- Best practices
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Working with Existing Code
|
||||
|
||||
Comprehensive guide for brownfield development:
|
||||
|
||||
- **[Brownfield Development Guide](./brownfield-guide.md)** - Complete guide for existing codebases (53 min read)
|
||||
- Documentation phase strategies
|
||||
- Track selection for brownfield
|
||||
- Integration with existing patterns
|
||||
- Phase-by-phase workflow guidance
|
||||
- Common scenarios
|
||||
|
||||
---
|
||||
|
||||
## 📚 Quick References
|
||||
|
||||
Essential reference materials:
|
||||
|
||||
- **[Glossary](./glossary.md)** - Key terminology and concepts
|
||||
- **[FAQ](./faq.md)** - Frequently asked questions across all topics
|
||||
- **[Enterprise Agentic Development](./enterprise-agentic-development.md)** - Team collaboration strategies
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Choose Your Path
|
||||
|
||||
### I need to...
|
||||
|
||||
**Build something new (greenfield)**
|
||||
→ Start with [Quick Start Guide](./quick-start.md)
|
||||
→ Then review [Scale Adaptive System](./scale-adaptive-system.md) to understand tracks
|
||||
|
||||
**Fix a bug or add small feature**
|
||||
→ Go directly to [Quick Spec Flow](./quick-spec-flow.md)
|
||||
|
||||
**Work with existing codebase (brownfield)**
|
||||
→ Read [Brownfield Development Guide](./brownfield-guide.md)
|
||||
→ Pay special attention to Phase 0 documentation requirements
|
||||
|
||||
**Understand planning tracks and methodology**
|
||||
→ See [Scale Adaptive System](./scale-adaptive-system.md)
|
||||
|
||||
**Find specific commands or answers**
|
||||
→ Check [FAQ](./faq.md)
|
||||
|
||||
---
|
||||
|
||||
## 📋 Workflow Guides
|
||||
|
||||
Comprehensive documentation for all BMM workflows organized by phase:
|
||||
|
||||
- **[Phase 1: Analysis Workflows](./workflows-analysis.md)** - Optional exploration and research workflows (595 lines)
|
||||
- brainstorm-project, product-brief, research, and more
|
||||
- When to use analysis workflows
|
||||
- Creative and strategic tools
|
||||
|
||||
- **[Phase 2: Planning Workflows](./workflows-planning.md)** - Scale-adaptive planning (967 lines)
|
||||
- prd, tech-spec, gdd, narrative, ux
|
||||
- Track-based planning approach (Quick Flow, BMad Method, Enterprise Method)
|
||||
- Which planning workflow to use
|
||||
|
||||
- **[Phase 3: Solutioning Workflows](./workflows-solutioning.md)** - Architecture and validation (638 lines)
|
||||
- architecture, create-epics-and-stories, implementation-readiness
|
||||
- V6: Epics created AFTER architecture for better quality
|
||||
- Required for BMad Method and Enterprise Method tracks
|
||||
- Preventing agent conflicts
|
||||
|
||||
- **[Phase 4: Implementation Workflows](./workflows-implementation.md)** - Sprint-based development (1,634 lines)
|
||||
- sprint-planning, create-story, dev-story, code-review
|
||||
- Complete story lifecycle
|
||||
- One-story-at-a-time discipline
|
||||
|
||||
- **[Testing & QA Workflows](./test-architecture.md)** - Comprehensive quality assurance (1,420 lines)
|
||||
- Test strategy, automation, quality gates
|
||||
- TEA agent and test healing
|
||||
- BMad-integrated vs standalone modes
|
||||
|
||||
**Total: 34 workflows documented across all phases**
|
||||
|
||||
### Advanced Workflow References
|
||||
|
||||
For detailed technical documentation on specific complex workflows:
|
||||
|
||||
- **[Document Project Workflow Reference](./workflow-document-project-reference.md)** - Technical deep-dive (445 lines)
|
||||
- v1.2.0 context-safe architecture
|
||||
- Scan levels, resumability, write-as-you-go
|
||||
- Multi-part project detection
|
||||
- Deep-dive mode for targeted analysis
|
||||
|
||||
- **[Architecture Workflow Reference](./workflow-architecture-reference.md)** - Decision architecture guide (320 lines)
|
||||
- Starter template intelligence
|
||||
- Novel pattern design
|
||||
- Implementation patterns for agent consistency
|
||||
- Adaptive facilitation approach
|
||||
|
||||
---
|
||||
|
||||
## 🧪 Testing and Quality
|
||||
|
||||
Quality assurance guidance:
|
||||
|
||||
<!-- Test Architect documentation to be added -->
|
||||
|
||||
- Test design workflows
|
||||
- Quality gates
|
||||
- Risk assessment
|
||||
- NFR validation
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ Module Structure
|
||||
|
||||
Understanding BMM components:
|
||||
|
||||
- **[BMM Module README](../README.md)** - Overview of module structure
|
||||
- Agent roster and roles
|
||||
- Workflow organization
|
||||
- Teams and collaboration
|
||||
- Best practices
|
||||
|
||||
---
|
||||
|
||||
## 🌐 External Resources
|
||||
|
||||
### Community and Support
|
||||
|
||||
- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help from the community (#general-dev, #bugs-issues)
|
||||
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features
|
||||
- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and walkthroughs
|
||||
|
||||
### Additional Documentation
|
||||
|
||||
- **[IDE Setup Guides](../../../docs/ide-info/)** - Configure your development environment
|
||||
- Claude Code
|
||||
- Cursor
|
||||
- Windsurf
|
||||
- VS Code
|
||||
- Other IDEs
|
||||
|
||||
---
|
||||
|
||||
## 📊 Documentation Map
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
START[New to BMM?]
|
||||
START --> QS[Quick Start Guide]
|
||||
|
||||
QS --> DECIDE{What are you building?}
|
||||
|
||||
DECIDE -->|Bug fix or<br/>small feature| QSF[Quick Spec Flow]
|
||||
DECIDE -->|New project| SAS[Scale Adaptive System]
|
||||
DECIDE -->|Existing codebase| BF[Brownfield Guide]
|
||||
|
||||
QSF --> IMPL[Implementation]
|
||||
SAS --> IMPL
|
||||
BF --> IMPL
|
||||
|
||||
IMPL --> REF[Quick References<br/>Glossary, FAQ]
|
||||
|
||||
style START fill:#bfb,stroke:#333,stroke-width:2px,color:#000
|
||||
style QS fill:#bbf,stroke:#333,stroke-width:2px,color:#000
|
||||
style DECIDE fill:#ffb,stroke:#333,stroke-width:2px,color:#000
|
||||
style IMPL fill:#f9f,stroke:#333,stroke-width:2px,color:#000
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 💡 Tips for Using This Documentation
|
||||
|
||||
1. **Start with Quick Start** if you're new - it provides the essential foundation
|
||||
2. **Use the FAQ** to find quick answers without reading entire guides
|
||||
3. **Bookmark Glossary** for terminology references while reading other docs
|
||||
4. **Follow the suggested paths** above based on your specific situation
|
||||
5. **Join Discord** for interactive help and community insights
|
||||
|
||||
---
|
||||
|
||||
**Ready to begin?** → [Start with the Quick Start Guide](./quick-start.md)
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,762 +0,0 @@
|
||||
# BMad Method Brownfield Development Guide
|
||||
|
||||
**Complete guide for working with existing codebases**
|
||||
|
||||
**Reading Time:** ~35 minutes
|
||||
|
||||
---
|
||||
|
||||
## Quick Navigation
|
||||
|
||||
**Jump to:**
|
||||
|
||||
- [Quick Reference](#quick-reference) - Commands and files
|
||||
- [Common Scenarios](#common-scenarios) - Real-world examples
|
||||
- [Best Practices](#best-practices) - Success tips
|
||||
|
||||
---
|
||||
|
||||
## What is Brownfield Development?
|
||||
|
||||
Brownfield projects involve working within existing codebases rather than starting fresh:
|
||||
|
||||
- **Bug fixes** - Single file changes
|
||||
- **Small features** - Adding to existing modules
|
||||
- **Feature sets** - Multiple related features
|
||||
- **Major integrations** - Complex architectural additions
|
||||
- **System expansions** - Enterprise-scale enhancements
|
||||
|
||||
**Key Difference from Greenfield:** You must understand and respect existing patterns, architecture, and constraints.
|
||||
|
||||
**Core Principle:** AI agents need comprehensive documentation to understand existing code before they can effectively plan or implement changes.
|
||||
|
||||
---
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Understanding Planning Tracks
|
||||
|
||||
For complete track details, see [Scale Adaptive System](./scale-adaptive-system.md).
|
||||
|
||||
**Brownfield tracks at a glance:**
|
||||
|
||||
| Track | Scope | Typical Stories | Key Difference |
|
||||
| --------------------- | -------------------------- | --------------- | ----------------------------------------------- |
|
||||
| **Quick Flow** | Bug fixes, small features | 1-15 | Must understand affected code and patterns |
|
||||
| **BMad Method** | Feature sets, integrations | 10-50+ | Integrate with existing architecture |
|
||||
| **Enterprise Method** | Enterprise expansions | 30+ | Full system documentation + compliance required |
|
||||
|
||||
**Note:** Story counts are guidance, not definitions. Tracks are chosen based on planning needs.
|
||||
|
||||
### Track Selection for Brownfield
|
||||
|
||||
When you run `workflow-init`, it handles brownfield intelligently:
|
||||
|
||||
**Step 1: Shows what it found**
|
||||
|
||||
- Old planning docs (PRD, epics, stories)
|
||||
- Existing codebase
|
||||
|
||||
**Step 2: Asks about YOUR work**
|
||||
|
||||
> "Are these works in progress, previous effort, or proposed work?"
|
||||
|
||||
- **(a) Works in progress** → Uses artifacts to determine level
|
||||
- **(b) Previous effort** → Asks you to describe NEW work
|
||||
- **(c) Proposed work** → Uses artifacts as guidance
|
||||
- **(d) None of these** → You explain your work
|
||||
|
||||
**Step 3: Analyzes your description**
|
||||
|
||||
- Keywords: "fix", "bug" → Quick Flow, "dashboard", "platform" → BMad Method, "enterprise", "multi-tenant" → Enterprise Method
|
||||
- Complexity assessment
|
||||
- Confirms suggested track with you
|
||||
|
||||
**Key Principle:** System asks about YOUR current work first, uses old artifacts as context only.
|
||||
|
||||
**Example: Old Complex PRD, New Simple Work**
|
||||
|
||||
```
|
||||
System: "Found PRD.md (BMad Method track, 30 stories, 6 months old)"
|
||||
System: "Is this work in progress or previous effort?"
|
||||
You: "Previous effort - I'm just fixing a bug now"
|
||||
System: "Tell me about your current work"
|
||||
You: "Update payment method enums"
|
||||
System: "Quick Flow track (tech-spec approach). Correct?"
|
||||
You: "Yes"
|
||||
✅ Creates Quick Flow workflow
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Phase 0: Documentation (Critical First Step)
|
||||
|
||||
🚨 **For brownfield projects: Always ensure adequate AI-usable documentation before planning**
|
||||
|
||||
### Default Recommendation: Run document-project
|
||||
|
||||
**Best practice:** Run `document-project` workflow unless you have **confirmed, trusted, AI-optimized documentation**.
|
||||
|
||||
### Why Document-Project is Almost Always the Right Choice
|
||||
|
||||
Existing documentation often has quality issues that break AI workflows:
|
||||
|
||||
**Common Problems:**
|
||||
|
||||
- **Too Much Information (TMI):** Massive markdown files with 10s or 100s of level 2 sections
|
||||
- **Out of Date:** Documentation hasn't been updated with recent code changes
|
||||
- **Wrong Format:** Written for humans, not AI agents (lacks structure, index, clear patterns)
|
||||
- **Incomplete Coverage:** Missing critical architecture, patterns, or setup info
|
||||
- **Inconsistent Quality:** Some areas documented well, others not at all
|
||||
|
||||
**Impact on AI Agents:**
|
||||
|
||||
- AI agents hit token limits reading massive files
|
||||
- Outdated docs cause hallucinations (agent thinks old patterns still apply)
|
||||
- Missing structure means agents can't find relevant information
|
||||
- Incomplete coverage leads to incorrect assumptions
|
||||
|
||||
### Documentation Decision Tree
|
||||
|
||||
**Step 1: Assess Existing Documentation Quality**
|
||||
|
||||
Ask yourself:
|
||||
|
||||
- ✅ Is it **current** (updated in last 30 days)?
|
||||
- ✅ Is it **AI-optimized** (structured with index.md, clear sections, <500 lines per file)?
|
||||
- ✅ Is it **comprehensive** (architecture, patterns, setup all documented)?
|
||||
- ✅ Do you **trust** it completely for AI agent consumption?
|
||||
|
||||
**If ANY answer is NO → Run `document-project`**
|
||||
|
||||
**Step 2: Check for Massive Documents**
|
||||
|
||||
If you have documentation but files are huge (>500 lines, 10+ level 2 sections):
|
||||
|
||||
1. **First:** Run `shard-doc` tool to split large files:
|
||||
|
||||
```bash
|
||||
# Load BMad Master or any agent
|
||||
.bmad/core/tools/shard-doc.xml --input docs/massive-doc.md
|
||||
```
|
||||
|
||||
- Splits on level 2 sections by default
|
||||
- Creates organized, manageable files
|
||||
- Preserves content integrity
|
||||
|
||||
2. **Then:** Run `index-docs` task to create navigation:
|
||||
|
||||
```bash
|
||||
.bmad/core/tasks/index-docs.xml --directory ./docs
|
||||
```
|
||||
|
||||
3. **Finally:** Validate quality - if sharded docs still seem incomplete/outdated → Run `document-project`
|
||||
|
||||
### Four Real-World Scenarios
|
||||
|
||||
| Scenario | You Have | Action | Why |
|
||||
| -------- | ------------------------------------------ | -------------------------- | --------------------------------------- |
|
||||
| **A** | No documentation | `document-project` | Only option - generate from scratch |
|
||||
| **B** | Docs exist but massive/outdated/incomplete | `document-project` | Safer to regenerate than trust bad docs |
|
||||
| **C** | Good docs but no structure | `shard-doc` → `index-docs` | Structure existing content for AI |
|
||||
| **D** | Confirmed AI-optimized docs with index.md | Skip Phase 0 | Rare - only if you're 100% confident |
|
||||
|
||||
### Scenario A: No Documentation (Most Common)
|
||||
|
||||
**Action: Run document-project workflow**
|
||||
|
||||
1. Load Analyst or Technical Writer (Paige) agent
|
||||
2. Run `*document-project`
|
||||
3. Choose scan level:
|
||||
- **Quick** (2-5min): Pattern analysis, no source reading
|
||||
- **Deep** (10-30min): Reads critical paths - **Recommended**
|
||||
- **Exhaustive** (30-120min): Reads all files
|
||||
|
||||
**Outputs:**
|
||||
|
||||
- `docs/index.md` - Master AI entry point
|
||||
- `docs/project-overview.md` - Executive summary
|
||||
- `docs/architecture.md` - Architecture analysis
|
||||
- `docs/source-tree-analysis.md` - Directory structure
|
||||
- Additional files based on project type (API, web app, etc.)
|
||||
|
||||
### Scenario B: Docs Exist But Quality Unknown/Poor (Very Common)
|
||||
|
||||
**Action: Run document-project workflow (regenerate)**
|
||||
|
||||
Even if `docs/` folder exists, if you're unsure about quality → **regenerate**.
|
||||
|
||||
**Why regenerate instead of index?**
|
||||
|
||||
- Outdated docs → AI makes wrong assumptions
|
||||
- Incomplete docs → AI invents missing information
|
||||
- TMI docs → AI hits token limits, misses key info
|
||||
- Human-focused docs → Missing AI-critical structure
|
||||
|
||||
**document-project** will:
|
||||
|
||||
- Scan actual codebase (source of truth)
|
||||
- Generate fresh, accurate documentation
|
||||
- Structure properly for AI consumption
|
||||
- Include only relevant, current information
|
||||
|
||||
### Scenario C: Good Docs But Needs Structure
|
||||
|
||||
**Action: Shard massive files, then index**
|
||||
|
||||
If you have **good, current documentation** but it's in massive files:
|
||||
|
||||
**Step 1: Shard large documents**
|
||||
|
||||
```bash
|
||||
# For each massive doc (>500 lines or 10+ level 2 sections)
|
||||
.bmad/core/tools/shard-doc.xml \
|
||||
--input docs/api-documentation.md \
|
||||
--output docs/api/ \
|
||||
--level 2 # Split on ## headers (default)
|
||||
```
|
||||
|
||||
**Step 2: Generate index**
|
||||
|
||||
```bash
|
||||
.bmad/core/tasks/index-docs.xml --directory ./docs
|
||||
```
|
||||
|
||||
**Step 3: Validate**
|
||||
|
||||
- Review generated `docs/index.md`
|
||||
- Check that sharded files are <500 lines each
|
||||
- Verify content is current and accurate
|
||||
- **If anything seems off → Run document-project instead**
|
||||
|
||||
### Scenario D: Confirmed AI-Optimized Documentation (Rare)
|
||||
|
||||
**Action: Skip Phase 0**
|
||||
|
||||
Only skip if ALL conditions met:
|
||||
|
||||
- ✅ `docs/index.md` exists and is comprehensive
|
||||
- ✅ Documentation updated within last 30 days
|
||||
- ✅ All doc files <500 lines with clear structure
|
||||
- ✅ Covers architecture, patterns, setup, API surface
|
||||
- ✅ You personally verified quality for AI consumption
|
||||
- ✅ Previous AI agents used it successfully
|
||||
|
||||
**If unsure → Run document-project** (costs 10-30 minutes, saves hours of confusion)
|
||||
|
||||
### Why document-project is Critical
|
||||
|
||||
Without AI-optimized documentation, workflows fail:
|
||||
|
||||
- **tech-spec** (Quick Flow) can't auto-detect stack/patterns → Makes wrong assumptions
|
||||
- **PRD** (BMad Method) can't reference existing code → Designs incompatible features
|
||||
- **architecture** can't build on existing structure → Suggests conflicting patterns
|
||||
- **story-context** can't inject existing patterns → Dev agent rewrites working code
|
||||
- **dev-story** invents implementations → Breaks existing integrations
|
||||
|
||||
### Key Principle
|
||||
|
||||
**When in doubt, run document-project.**
|
||||
|
||||
It's better to spend 10-30 minutes generating fresh, accurate docs than to waste hours debugging AI agents working from bad documentation.
|
||||
|
||||
---
|
||||
|
||||
## Workflow Phases by Track
|
||||
|
||||
### Phase 1: Analysis (Optional)
|
||||
|
||||
**Workflows:**
|
||||
|
||||
- `brainstorm-project` - Solution exploration
|
||||
- `research` - Technical/market research
|
||||
- `product-brief` - Strategic planning (BMad Method/Enterprise tracks only)
|
||||
|
||||
**When to use:** Complex features, technical decisions, strategic additions
|
||||
|
||||
**When to skip:** Bug fixes, well-understood features, time-sensitive changes
|
||||
|
||||
See the [Workflows section in BMM README](../README.md) for details.
|
||||
|
||||
### Phase 2: Planning (Required)
|
||||
|
||||
**Planning approach adapts by track:**
|
||||
|
||||
**Quick Flow:** Use `tech-spec` workflow
|
||||
|
||||
- Creates tech-spec.md
|
||||
- Auto-detects existing stack (brownfield)
|
||||
- Confirms conventions with you
|
||||
- Generates implementation-ready stories
|
||||
|
||||
**BMad Method/Enterprise:** Use `prd` workflow
|
||||
|
||||
- Creates PRD.md with FRs/NFRs only
|
||||
- References existing architecture
|
||||
- Plans integration points
|
||||
- Epics+Stories created AFTER architecture phase
|
||||
|
||||
**Brownfield-specific:** See [Scale Adaptive System](./scale-adaptive-system.md) for complete workflow paths by track.
|
||||
|
||||
### Phase 3: Solutioning (BMad Method/Enterprise Only)
|
||||
|
||||
**Critical for brownfield:**
|
||||
|
||||
- Review existing architecture FIRST
|
||||
- Document integration points explicitly
|
||||
- Plan backward compatibility
|
||||
- Consider migration strategy
|
||||
|
||||
**Workflows:**
|
||||
|
||||
- `create-architecture` - Extend architecture docs (BMad Method/Enterprise)
|
||||
- `create-epics-and-stories` - Create epics and stories AFTER architecture
|
||||
- `implementation-readiness` - Validate before implementation (BMad Method/Enterprise)
|
||||
|
||||
### Phase 4: Implementation (All Tracks)
|
||||
|
||||
**Sprint-based development through story iteration:**
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
SPRINT[sprint-planning<br/>Initialize tracking]
|
||||
EPIC[epic-tech-context<br/>Per epic]
|
||||
CREATE[create-story]
|
||||
CONTEXT[story-context]
|
||||
DEV[dev-story]
|
||||
REVIEW[code-review]
|
||||
CHECK{More stories?}
|
||||
RETRO[retrospective<br/>Per epic]
|
||||
|
||||
SPRINT --> EPIC
|
||||
EPIC --> CREATE
|
||||
CREATE --> CONTEXT
|
||||
CONTEXT --> DEV
|
||||
DEV --> REVIEW
|
||||
REVIEW --> CHECK
|
||||
CHECK -->|Yes| CREATE
|
||||
CHECK -->|No| RETRO
|
||||
|
||||
style SPRINT fill:#bfb,stroke:#333,stroke-width:2px,color:#000
|
||||
style RETRO fill:#fbf,stroke:#333,stroke-width:2px,color:#000
|
||||
```
|
||||
|
||||
**Status Progression:**
|
||||
|
||||
- Epic: `backlog → contexted`
|
||||
- Story: `backlog → drafted → ready-for-dev → in-progress → review → done`
|
||||
|
||||
**Brownfield-Specific Implementation Tips:**
|
||||
|
||||
1. **Respect existing patterns** - Follow established conventions
|
||||
2. **Test integration thoroughly** - Validate interactions with existing code
|
||||
3. **Use feature flags** - Enable gradual rollout
|
||||
4. **Context injection matters** - epic-tech-context and story-context reference existing patterns
|
||||
|
||||
---
|
||||
|
||||
## Best Practices
|
||||
|
||||
### 1. Always Document First
|
||||
|
||||
Even if you know the code, AI agents need `document-project` output for context. Run it before planning.
|
||||
|
||||
### 2. Be Specific About Current Work
|
||||
|
||||
When workflow-init asks about your work:
|
||||
|
||||
- ✅ "Update payment method enums to include Apple Pay"
|
||||
- ❌ "Fix stuff"
|
||||
|
||||
### 3. Choose Right Documentation Approach
|
||||
|
||||
- **Has good docs, no index?** → Run `index-docs` task (fast)
|
||||
- **No docs or need codebase analysis?** → Run `document-project` (Deep scan)
|
||||
|
||||
### 4. Respect Existing Patterns
|
||||
|
||||
Tech-spec and story-context will detect conventions. Follow them unless explicitly modernizing.
|
||||
|
||||
### 5. Plan Integration Points Explicitly
|
||||
|
||||
Document in tech-spec/architecture:
|
||||
|
||||
- Which existing modules you'll modify
|
||||
- What APIs/services you'll integrate with
|
||||
- How data flows between new and existing code
|
||||
|
||||
### 6. Design for Gradual Rollout
|
||||
|
||||
- Use feature flags for new functionality
|
||||
- Plan rollback strategies
|
||||
- Maintain backward compatibility
|
||||
- Create migration scripts if needed
|
||||
|
||||
### 7. Test Integration Thoroughly
|
||||
|
||||
- Regression testing of existing features
|
||||
- Integration point validation
|
||||
- Performance impact assessment
|
||||
- API contract verification
|
||||
|
||||
### 8. Use Sprint Planning Effectively
|
||||
|
||||
- Run `sprint-planning` at Phase 4 start
|
||||
- Context epics before drafting stories
|
||||
- Update `sprint-status.yaml` as work progresses
|
||||
|
||||
### 9. Leverage Context Injection
|
||||
|
||||
- Run `epic-tech-context` before story drafting
|
||||
- Always create `story-context` before implementation
|
||||
- These reference existing patterns for consistency
|
||||
|
||||
### 10. Learn Continuously
|
||||
|
||||
- Run `retrospective` after each epic
|
||||
- Incorporate learnings into next stories
|
||||
- Update discovered patterns
|
||||
- Share insights across team
|
||||
|
||||
---
|
||||
|
||||
## Common Scenarios
|
||||
|
||||
### Scenario 1: Bug Fix (Quick Flow)
|
||||
|
||||
**Situation:** Authentication token expiration causing logout issues
|
||||
|
||||
**Track:** Quick Flow
|
||||
|
||||
**Workflow:**
|
||||
|
||||
1. **Document:** Skip if auth system documented, else run `document-project` (Quick scan)
|
||||
2. **Plan:** Load PM → run `tech-spec`
|
||||
- Analyzes bug
|
||||
- Detects stack (Express, Jest)
|
||||
- Confirms conventions
|
||||
- Creates tech-spec.md + story
|
||||
3. **Implement:** Load DEV → run `dev-story`
|
||||
4. **Review:** Load DEV → run `code-review`
|
||||
|
||||
**Time:** 2-4 hours
|
||||
|
||||
---
|
||||
|
||||
### Scenario 2: Small Feature (Quick Flow)
|
||||
|
||||
**Situation:** Add "forgot password" to existing auth system
|
||||
|
||||
**Track:** Quick Flow
|
||||
|
||||
**Workflow:**
|
||||
|
||||
1. **Document:** Run `document-project` (Deep scan of auth module if not documented)
|
||||
2. **Plan:** Load PM → run `tech-spec`
|
||||
- Detects Next.js 13.4, NextAuth.js
|
||||
- Analyzes existing auth patterns
|
||||
- Confirms conventions
|
||||
- Creates tech-spec.md + epic + 3-5 stories
|
||||
3. **Implement:** Load SM → `sprint-planning` → `create-story` → `story-context`
|
||||
Load DEV → `dev-story` for each story
|
||||
4. **Review:** Load DEV → `code-review`
|
||||
|
||||
**Time:** 1-3 days
|
||||
|
||||
---
|
||||
|
||||
### Scenario 3: Feature Set (BMad Method)
|
||||
|
||||
**Situation:** Add user dashboard with analytics, preferences, activity
|
||||
|
||||
**Track:** BMad Method
|
||||
|
||||
**Workflow:**
|
||||
|
||||
1. **Document:** Run `document-project` (Deep scan) - Critical for understanding existing UI patterns
|
||||
2. **Analyze:** Load Analyst → `research` (if evaluating analytics libraries)
|
||||
3. **Plan:** Load PM → `prd` (creates FRs/NFRs)
|
||||
4. **Solution:** Load Architect → `create-architecture` → `create-epics-and-stories` → `implementation-readiness`
|
||||
5. **Implement:** Sprint-based (10-15 stories)
|
||||
- Load SM → `sprint-planning`
|
||||
- Per epic: `epic-tech-context` → stories
|
||||
- Load DEV → `dev-story` per story
|
||||
6. **Review:** Per story completion
|
||||
|
||||
**Time:** 1-2 weeks
|
||||
|
||||
---
|
||||
|
||||
### Scenario 4: Complex Integration (BMad Method)
|
||||
|
||||
**Situation:** Add real-time collaboration to document editor
|
||||
|
||||
**Track:** BMad Method
|
||||
|
||||
**Workflow:**
|
||||
|
||||
1. **Document:** Run `document-project` (Exhaustive if not documented) - **Mandatory**
|
||||
2. **Analyze:** Load Analyst → `research` (WebSocket vs WebRTC vs CRDT)
|
||||
3. **Plan:** Load PM → `prd` (creates FRs/NFRs)
|
||||
4. **Solution:**
|
||||
- Load Architect → `create-architecture` (extend for real-time layer)
|
||||
- Load Architect → `create-epics-and-stories`
|
||||
- Load Architect → `implementation-readiness`
|
||||
5. **Implement:** Sprint-based (20-30 stories)
|
||||
|
||||
**Time:** 3-6 weeks
|
||||
|
||||
---
|
||||
|
||||
### Scenario 5: Enterprise Expansion (Enterprise Method)
|
||||
|
||||
**Situation:** Add multi-tenancy to single-tenant SaaS platform
|
||||
|
||||
**Track:** Enterprise Method
|
||||
|
||||
**Workflow:**
|
||||
|
||||
1. **Document:** Run `document-project` (Exhaustive) - **Mandatory**
|
||||
2. **Analyze:** **Required**
|
||||
- `brainstorm-project` - Explore multi-tenancy approaches
|
||||
- `research` - Database sharding, tenant isolation, pricing
|
||||
- `product-brief` - Strategic document
|
||||
3. **Plan:** Load PM → `prd` (comprehensive FRs/NFRs)
|
||||
4. **Solution:**
|
||||
- `create-architecture` - Full system architecture
|
||||
- `integration-planning` - Phased migration strategy
|
||||
- `create-architecture` - Multi-tenancy architecture
|
||||
- `validate-architecture` - External review
|
||||
- `create-epics-and-stories` - Create epics and stories
|
||||
- `implementation-readiness` - Executive approval
|
||||
5. **Implement:** Phased sprint-based (50+ stories)
|
||||
|
||||
**Time:** 3-6 months
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### AI Agents Lack Codebase Understanding
|
||||
|
||||
**Symptoms:**
|
||||
|
||||
- Suggestions don't align with existing patterns
|
||||
- Ignores available components
|
||||
- Doesn't reference existing code
|
||||
|
||||
**Solution:**
|
||||
|
||||
1. Run `document-project` with Deep scan
|
||||
2. Verify `docs/index.md` exists
|
||||
3. Check documentation completeness
|
||||
4. Run deep-dive on specific areas if needed
|
||||
|
||||
### Have Documentation But Agents Can't Find It
|
||||
|
||||
**Symptoms:**
|
||||
|
||||
- README.md, ARCHITECTURE.md exist
|
||||
- AI agents ask questions already answered
|
||||
- No `docs/index.md` file
|
||||
|
||||
**Solution:**
|
||||
|
||||
- **Quick fix:** Run `index-docs` task (2-5min)
|
||||
- **Comprehensive:** Run `document-project` workflow (10-30min)
|
||||
|
||||
### Integration Points Unclear
|
||||
|
||||
**Symptoms:**
|
||||
|
||||
- Not sure how to connect new code to existing
|
||||
- Unsure which files to modify
|
||||
|
||||
**Solution:**
|
||||
|
||||
1. Ensure `document-project` captured existing architecture
|
||||
2. Check `story-context` - should document integration points
|
||||
3. In tech-spec/architecture - explicitly document:
|
||||
- Which existing modules to modify
|
||||
- What APIs/services to integrate with
|
||||
- Data flow between new and existing code
|
||||
4. Review architecture document for integration guidance
|
||||
|
||||
### Existing Tests Breaking
|
||||
|
||||
**Symptoms:**
|
||||
|
||||
- Regression test failures
|
||||
- Previously working functionality broken
|
||||
|
||||
**Solution:**
|
||||
|
||||
1. Review changes against existing patterns
|
||||
2. Verify API contracts unchanged (unless intentionally versioned)
|
||||
3. Run `test-review` workflow (TEA agent)
|
||||
4. Add regression testing to DoD
|
||||
5. Consider feature flags for gradual rollout
|
||||
|
||||
### Inconsistent Patterns Being Introduced
|
||||
|
||||
**Symptoms:**
|
||||
|
||||
- New code style doesn't match existing
|
||||
- Different architectural approach
|
||||
|
||||
**Solution:**
|
||||
|
||||
1. Check convention detection (Quick Spec Flow should detect patterns)
|
||||
2. Review documentation - ensure `document-project` captured patterns
|
||||
3. Use `story-context` - injects pattern guidance
|
||||
4. Add to code-review checklist: pattern adherence, convention consistency
|
||||
5. Run retrospective to identify deviations early
|
||||
|
||||
---
|
||||
|
||||
## Quick Reference
|
||||
|
||||
### Commands by Phase
|
||||
|
||||
```bash
|
||||
# Phase 0: Documentation (If Needed)
|
||||
# Analyst agent:
|
||||
document-project # Create comprehensive docs (10-30min)
|
||||
# OR load index-docs task for existing docs (2-5min)
|
||||
|
||||
# Phase 1: Analysis (Optional)
|
||||
# Analyst agent:
|
||||
brainstorm-project # Explore solutions
|
||||
research # Gather data
|
||||
product-brief # Strategic planning (BMad Method/Enterprise only)
|
||||
|
||||
# Phase 2: Planning (Required)
|
||||
# PM agent:
|
||||
tech-spec # Quick Flow track
|
||||
prd # BMad Method/Enterprise tracks
|
||||
|
||||
# Phase 3: Solutioning (BMad Method/Enterprise)
|
||||
# Architect agent:
|
||||
create-architecture # Extend architecture
|
||||
create-epics-and-stories # Create epics and stories (after architecture)
|
||||
implementation-readiness # Final validation
|
||||
|
||||
# Phase 4: Implementation (All Tracks)
|
||||
# SM agent:
|
||||
sprint-planning # Initialize tracking
|
||||
epic-tech-context # Epic context
|
||||
create-story # Draft story
|
||||
story-context # Story context
|
||||
|
||||
# DEV agent:
|
||||
dev-story # Implement
|
||||
code-review # Review
|
||||
|
||||
# SM agent:
|
||||
retrospective # After epic
|
||||
correct-course # If issues
|
||||
```
|
||||
|
||||
### Key Files
|
||||
|
||||
**Phase 0 Output:**
|
||||
|
||||
- `docs/index.md` - **Master AI entry point (REQUIRED)**
|
||||
- `docs/project-overview.md`
|
||||
- `docs/architecture.md`
|
||||
- `docs/source-tree-analysis.md`
|
||||
|
||||
**Phase 1-3 Tracking:**
|
||||
|
||||
- `docs/bmm-workflow-status.yaml` - Progress tracker
|
||||
|
||||
**Phase 2 Planning:**
|
||||
|
||||
- `docs/tech-spec.md` (Quick Flow track)
|
||||
- `docs/PRD.md` (BMad Method/Enterprise tracks - FRs/NFRs only)
|
||||
|
||||
**Phase 3 Solutioning:**
|
||||
|
||||
- Epic breakdown (created after architecture)
|
||||
|
||||
**Phase 3 Architecture:**
|
||||
|
||||
- `docs/architecture.md` (BMad Method/Enterprise tracks)
|
||||
|
||||
**Phase 4 Implementation:**
|
||||
|
||||
- `docs/sprint-status.yaml` - **Single source of truth**
|
||||
- `docs/epic-{n}-context.md`
|
||||
- `docs/stories/{epic}-{story}-{title}.md`
|
||||
- `docs/stories/{epic}-{story}-{title}-context.md`
|
||||
|
||||
### Decision Flowchart
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
START([Brownfield Project])
|
||||
CHECK{Has docs/<br/>index.md?}
|
||||
|
||||
START --> CHECK
|
||||
CHECK -->|No| DOC[document-project<br/>Deep scan]
|
||||
CHECK -->|Yes| TRACK{What Track?}
|
||||
|
||||
DOC --> TRACK
|
||||
|
||||
TRACK -->|Quick Flow| TS[tech-spec]
|
||||
TRACK -->|BMad Method| PRD[prd → architecture]
|
||||
TRACK -->|Enterprise| PRD2[prd → arch + security/devops]
|
||||
|
||||
TS --> IMPL[Phase 4<br/>Implementation]
|
||||
PRD --> IMPL
|
||||
PRD2 --> IMPL
|
||||
|
||||
style START fill:#f9f,stroke:#333,stroke-width:2px,color:#000
|
||||
style DOC fill:#ffb,stroke:#333,stroke-width:2px,color:#000
|
||||
style IMPL fill:#bfb,stroke:#333,stroke-width:2px,color:#000
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Prevention Tips
|
||||
|
||||
**Avoid issues before they happen:**
|
||||
|
||||
1. ✅ **Always run document-project for brownfield** - Saves context issues later
|
||||
2. ✅ **Use fresh chats for complex workflows** - Prevents hallucinations
|
||||
3. ✅ **Verify files exist before workflows** - Check PRD, epics, stories present
|
||||
4. ✅ **Read agent menu first** - Confirm agent has the workflow
|
||||
5. ✅ **Start with simpler track if unsure** - Easy to upgrade (Quick Flow → BMad Method)
|
||||
6. ✅ **Keep status files updated** - Manual updates when needed
|
||||
7. ✅ **Run retrospectives after epics** - Catch issues early
|
||||
8. ✅ **Follow phase sequence** - Don't skip required phases
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- **[Scale Adaptive System](./scale-adaptive-system.md)** - Understanding tracks and complexity
|
||||
- **[Quick Spec Flow](./quick-spec-flow.md)** - Fast-track for Quick Flow
|
||||
- **[Quick Start Guide](./quick-start.md)** - Getting started with BMM
|
||||
- **[Glossary](./glossary.md)** - Key terminology
|
||||
- **[FAQ](./faq.md)** - Common questions
|
||||
- **[Workflow Documentation](./README.md#-workflow-guides)** - Complete workflow reference
|
||||
|
||||
---
|
||||
|
||||
## Support and Resources
|
||||
|
||||
**Community:**
|
||||
|
||||
- [Discord](https://discord.gg/gk8jAdXWmj) - #general-dev, #bugs-issues
|
||||
- [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)
|
||||
- [YouTube Channel](https://www.youtube.com/@BMadCode)
|
||||
|
||||
**Documentation:**
|
||||
|
||||
- [Test Architect Guide](./test-architecture.md) - Comprehensive testing strategy
|
||||
- [BMM Module README](../README.md) - Complete module and workflow reference
|
||||
|
||||
---
|
||||
|
||||
_Brownfield development is about understanding and respecting what exists while thoughtfully extending it._
|
||||
@ -1,686 +0,0 @@
|
||||
# Enterprise Agentic Development with BMad Method
|
||||
|
||||
**The paradigm shift: From team-based story parallelism to individual epic ownership**
|
||||
|
||||
**Reading Time:** ~18 minutes
|
||||
|
||||
---
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [The Paradigm Shift](#the-paradigm-shift)
|
||||
- [The Evolving Role of Product Managers and UX Designers](#the-evolving-role-of-product-managers-and-ux-designers)
|
||||
- [How BMad Method Enables PM/UX Technical Evolution](#how-bmad-method-enables-pmux-technical-evolution)
|
||||
- [Team Collaboration Patterns](#team-collaboration-patterns)
|
||||
- [Work Distribution Strategies](#work-distribution-strategies)
|
||||
- [Enterprise Configuration with Git Submodules](#enterprise-configuration-with-git-submodules)
|
||||
- [Best Practices](#best-practices)
|
||||
- [Common Scenarios](#common-scenarios)
|
||||
|
||||
---
|
||||
|
||||
## The Paradigm Shift
|
||||
|
||||
### Traditional Agile: Team-Based Story Parallelism
|
||||
|
||||
- **Epic duration:** 4-12 weeks across multiple sprints
|
||||
- **Story duration:** 2-5 days per developer
|
||||
- **Team size:** 5-9 developers working on same epic
|
||||
- **Parallelization:** Multiple devs on stories within single epic
|
||||
- **Coordination:** Constant - daily standups, merge conflicts, integration overhead
|
||||
|
||||
**Example:** Payment Processing Epic
|
||||
|
||||
- Sprint 1-2: Backend API (Dev A)
|
||||
- Sprint 1-2: Frontend UI (Dev B)
|
||||
- Sprint 2-3: Testing (Dev C)
|
||||
- **Result:** 6-8 weeks, 3 developers, high coordination
|
||||
|
||||
### Agentic Development: Individual Epic Ownership
|
||||
|
||||
- **Epic duration:** Hours to days (not weeks)
|
||||
- **Story duration:** 30 min to 4 hours with AI agent
|
||||
- **Team size:** 1 developer + AI agents completes full epics
|
||||
- **Parallelization:** Developers work on separate epics
|
||||
- **Coordination:** Minimal - epic boundaries, async updates
|
||||
|
||||
**Same Example:** Payment Processing Epic
|
||||
|
||||
- Day 1 AM: Backend API stories (1 dev + agent, 3-4 stories)
|
||||
- Day 1 PM: Frontend UI stories (same dev + agent, 2-3 stories)
|
||||
- Day 2: Testing & deployment (same dev + agent, 2 stories)
|
||||
- **Result:** 1-2 days, 1 developer, minimal coordination
|
||||
|
||||
### The Core Difference
|
||||
|
||||
**What changed:** AI agents collapse story duration from days to hours, making **epic-level ownership** practical.
|
||||
|
||||
**Impact:** Single developer with BMad Method can deliver in 1 day what previously required full team and multiple sprints.
|
||||
|
||||
---
|
||||
|
||||
## The Evolving Role of Product Managers and UX Designers
|
||||
|
||||
### The Future is Now
|
||||
|
||||
Product Managers and UX Designers are undergoing **the most significant transformation since the creation of these disciplines**. The emergence of AI agents is creating a new breed of technical product leaders who translate vision directly into working code.
|
||||
|
||||
### From Spec Writers to Code Orchestrators
|
||||
|
||||
**Traditional PM/UX (Pre-2025):**
|
||||
|
||||
- Write PRDs, hand off to engineering
|
||||
- Wait weeks/months for implementation
|
||||
- Limited validation capabilities
|
||||
- Non-technical role, heavy on process
|
||||
|
||||
**Emerging PM/UX (2025+):**
|
||||
|
||||
- Write AI-optimized PRDs that **feed agentic pipelines directly**
|
||||
- Generate working prototypes in 10-15 minutes
|
||||
- Review pull requests from AI agents
|
||||
- Technical fluency is **table stakes**, not optional
|
||||
- Orchestrate cloud-based AI agent teams
|
||||
|
||||
### Industry Research (November 2025)
|
||||
|
||||
- **56% of product professionals** cite AI/ML as top focus
|
||||
- **AI agents automating** customer discovery, PRD creation, status reporting
|
||||
- **PRD-to-Code automation** enables PMs to build and deploy apps in 10-15 minutes
|
||||
- **By 2026**: Roles converging into "Full-Stack Product Lead" (PM + Design + Engineering)
|
||||
- **Very high salaries** for AI agent PMs who orchestrate autonomous dev systems
|
||||
|
||||
### Required Skills for Modern PMs/UX
|
||||
|
||||
1. **AI Prompt Engineering** - Writing PRDs AI agents can execute autonomously
|
||||
2. **Coding Literacy** - Understanding code structure, APIs, data flows (not production coding)
|
||||
3. **Agentic Workflow Design** - Orchestrating multi-agent systems (planning → design → dev)
|
||||
4. **Technical Architecture** - Reasoning frameworks, memory systems, tool integration
|
||||
5. **Data Literacy** - Interpreting model outputs, spotting trends, identifying gaps
|
||||
6. **Code Review** - Evaluating AI-generated PRs for correctness and vision alignment
|
||||
|
||||
### What Remains Human
|
||||
|
||||
**AI Can't Replace:**
|
||||
|
||||
- Product vision (market dynamics, customer pain, strategic positioning)
|
||||
- Empathy (deep user research, emotional intelligence, stakeholder management)
|
||||
- Creativity (novel problem-solving, disruptive thinking)
|
||||
- Judgment (prioritization decisions, trade-off analysis)
|
||||
- Ethics (responsible AI use, privacy, accessibility)
|
||||
|
||||
**What Changes:**
|
||||
|
||||
- PMs/UX spend **more time on human elements** (AI handles routine execution)
|
||||
- Barrier between "thinking" and "building" collapses
|
||||
- Product leaders become **builder-thinkers**, not just spec writers
|
||||
|
||||
### The Convergence
|
||||
|
||||
- **PMs learning to code** with GitHub Copilot, Cursor, v0
|
||||
- **UX designers generating code** with UXPin Merge, Figma-to-code tools
|
||||
- **Developers becoming orchestrators** reviewing AI output vs writing from scratch
|
||||
|
||||
**The Bottom Line:** By 2026, successful PMs/UX will fluently operate in both vision and execution. **BMad Method provides the structured framework to make this transition.**
|
||||
|
||||
---
|
||||
|
||||
## How BMad Method Enables PM/UX Technical Evolution
|
||||
|
||||
BMad Method is specifically designed to position PMs and UX designers for this future.
|
||||
|
||||
### 1. AI-Executable PRD Generation
|
||||
|
||||
**PM Workflow:**
|
||||
|
||||
```bash
|
||||
bmad pm *create-prd
|
||||
```
|
||||
|
||||
**BMad produces:**
|
||||
|
||||
- Structured, machine-readable requirements
|
||||
- Functional Requirements (FRs) with testable acceptance criteria
|
||||
- Non-Functional Requirements (NFRs) with measurable targets
|
||||
- Technical context for AI agents
|
||||
|
||||
**Why it matters:** Traditional PRDs are human-readable prose. BMad PRDs are **AI-executable requirement specifications**.
|
||||
|
||||
**PM Value:** Clear requirements that feed into architecture decisions, then into story breakdown. No ambiguity.
|
||||
|
||||
### 2. Human-in-the-Loop Architecture
|
||||
|
||||
**Architect/PM Workflow:**
|
||||
|
||||
```bash
|
||||
bmad architect *create-architecture
|
||||
```
|
||||
|
||||
**BMad produces:**
|
||||
|
||||
- System architecture aligned with PRD's FRs/NFRs
|
||||
- Architecture Decision Records (ADRs)
|
||||
- FR/NFR-specific technical guidance
|
||||
- Integration patterns and standards
|
||||
|
||||
**Why it matters:** PMs can **understand and validate** technical decisions. Architecture is conversational, not template-driven.
|
||||
|
||||
**PM Value:** Technical fluency built through guided architecture process. PMs learn while creating.
|
||||
|
||||
### 3. Automated Epic/Story Breakdown (AFTER Architecture)
|
||||
|
||||
**PM Workflow:**
|
||||
|
||||
```bash
|
||||
bmad pm *create-epics-and-stories
|
||||
```
|
||||
|
||||
**V6 Improvement:** Epics and stories are now created AFTER architecture for better quality. The workflow uses both PRD (FRs/NFRs) and Architecture to create technically-informed stories.
|
||||
|
||||
**BMad produces:**
|
||||
|
||||
- Epic files with clear objectives
|
||||
- Story files with acceptance criteria, context, technical guidance
|
||||
- Priority assignments (P0-P3)
|
||||
- Dependency mapping informed by architectural decisions
|
||||
|
||||
**Why it matters:** Stories become **work packages for cloud AI agents**. Each story is self-contained with full context AND aligned with architecture.
|
||||
|
||||
**PM Value:** No more "story refinement sessions" with engineering. Stories are technically grounded from the start.
|
||||
|
||||
### 4. Cloud Agentic Pipeline (Emerging Pattern)
|
||||
|
||||
**Current State (2025):**
|
||||
|
||||
```
|
||||
PM writes BMad PRD (FRs/NFRs)
|
||||
↓
|
||||
Architect creates architecture (technical decisions)
|
||||
↓
|
||||
create-epics-and-stories generates story queue (informed by architecture)
|
||||
↓
|
||||
Stories loaded by human developers + BMad agents
|
||||
↓
|
||||
Developers create PRs
|
||||
↓
|
||||
PM/Team reviews PRs
|
||||
↓
|
||||
Merge and deploy
|
||||
```
|
||||
|
||||
**Near Future (2026):**
|
||||
|
||||
```
|
||||
PM writes BMad PRD (FRs/NFRs)
|
||||
↓
|
||||
Architecture auto-generated with PM approval
|
||||
↓
|
||||
create-epics-and-stories generates story queue (informed by architecture)
|
||||
↓
|
||||
Stories automatically fed to cloud AI agent pool
|
||||
↓
|
||||
AI agents implement stories in parallel
|
||||
↓
|
||||
AI agents create pull requests
|
||||
↓
|
||||
PM/UX/Senior Devs review PRs
|
||||
↓
|
||||
Approved PRs auto-merge
|
||||
↓
|
||||
Continuous deployment to production
|
||||
```
|
||||
|
||||
**Time Savings:**
|
||||
|
||||
- **Traditional:** PM writes spec → 2-4 weeks engineering → review → deploy (6-8 weeks)
|
||||
- **BMad Agentic:** PM writes PRD → AI agents implement → review PRs → deploy (2-5 days)
|
||||
|
||||
### 5. UX Design Integration
|
||||
|
||||
**UX Designer Workflow:**
|
||||
|
||||
```bash
|
||||
bmad ux *create-design
|
||||
```
|
||||
|
||||
**BMad produces:**
|
||||
|
||||
- Component-based design system
|
||||
- Interaction patterns aligned with tech stack
|
||||
- Accessibility guidelines
|
||||
- Responsive design specifications
|
||||
|
||||
**Why it matters:** Design specs become **implementation-ready** for AI agents. No "lost in translation" between design and dev.
|
||||
|
||||
**UX Value:** Designs validated through working prototypes, not static mocks. Technical understanding built through BMad workflows.
|
||||
|
||||
### 6. PM Technical Skills Development
|
||||
|
||||
**BMad teaches PMs technical skills through:**
|
||||
|
||||
- **Conversational workflows** - No pre-requisite knowledge, learn by doing
|
||||
- **Architecture facilitation** - Understand system design through guided questions
|
||||
- **Story context assembly** - See how code patterns inform implementation
|
||||
- **Code review workflows** - Learn to evaluate code quality, patterns, standards
|
||||
|
||||
**Example:** PM runs `create-architecture` workflow:
|
||||
|
||||
- BMad asks about scale, performance, integrations
|
||||
- PM answers business questions
|
||||
- BMad explains technical implications
|
||||
- PM learns architecture concepts while making decisions
|
||||
|
||||
**Result:** PMs gain **working technical knowledge** without formal CS education.
|
||||
|
||||
### 7. Organizational Leverage
|
||||
|
||||
**Traditional Model:**
|
||||
|
||||
- 1 PM → supports 5-9 developers → delivers 1-2 features/quarter
|
||||
|
||||
**BMad Agentic Model:**
|
||||
|
||||
- 1 PM → writes BMad PRD → 20-50 AI agents execute stories in parallel → delivers 5-10 features/quarter
|
||||
|
||||
**Leverage multiplier:** 5-10× with same PM headcount.
|
||||
|
||||
### 8. Quality Consistency
|
||||
|
||||
**BMad ensures:**
|
||||
|
||||
- AI agents follow architectural patterns consistently (via story-context)
|
||||
- Code standards applied uniformly (via epic-tech-context)
|
||||
- PRD traceability throughout implementation (via acceptance criteria)
|
||||
- No "telephone game" between PM, design, and dev
|
||||
|
||||
**PM Value:** What gets built **matches what was specified**, drastically reducing rework.
|
||||
|
||||
### 9. Rapid Prototyping for Validation
|
||||
|
||||
**PM Workflow (with BMad + Cursor/v0):**
|
||||
|
||||
1. Use BMad to generate PRD structure and requirements
|
||||
2. Extract key user flow from PRD
|
||||
3. Feed to Cursor/v0 with BMad context
|
||||
4. Working prototype in 10-15 minutes
|
||||
5. Validate with users **before** committing to full development
|
||||
|
||||
**Traditional:** Months of development to validate idea
|
||||
**BMad Agentic:** Hours of development to validate idea
|
||||
|
||||
### 10. Career Path Evolution
|
||||
|
||||
**BMad positions PMs for emerging roles:**
|
||||
|
||||
- **AI Agent Product Manager** - Orchestrate autonomous development systems
|
||||
- **Full-Stack Product Lead** - Oversee product, design, engineering with AI leverage
|
||||
- **Technical Product Strategist** - Bridge business vision and technical execution
|
||||
|
||||
**Hiring advantage:** PMs using BMad demonstrate:
|
||||
|
||||
- Technical fluency (can read architecture, validate tech decisions)
|
||||
- AI-native workflows (structured requirements, agentic orchestration)
|
||||
- Results (ship 5-10× faster than peers)
|
||||
|
||||
---
|
||||
|
||||
## Team Collaboration Patterns
|
||||
|
||||
### Old Pattern: Story Parallelism
|
||||
|
||||
**Traditional Agile:**
|
||||
|
||||
```
|
||||
Epic: User Dashboard (8 weeks)
|
||||
├─ Story 1: Backend API (Dev A, Sprint 1-2)
|
||||
├─ Story 2: Frontend Layout (Dev B, Sprint 1-2)
|
||||
├─ Story 3: Data Viz (Dev C, Sprint 2-3)
|
||||
└─ Story 4: Integration Testing (Team, Sprint 3-4)
|
||||
|
||||
Challenge: Coordination overhead, merge conflicts, integration issues
|
||||
```
|
||||
|
||||
### New Pattern: Epic Ownership
|
||||
|
||||
**Agentic Development:**
|
||||
|
||||
```
|
||||
Project: Analytics Platform (2-3 weeks)
|
||||
|
||||
Developer A:
|
||||
└─ Epic 1: User Dashboard (3 days, 12 stories sequentially with AI)
|
||||
|
||||
Developer B:
|
||||
└─ Epic 2: Admin Panel (4 days, 15 stories sequentially with AI)
|
||||
|
||||
Developer C:
|
||||
└─ Epic 3: Reporting Engine (5 days, 18 stories sequentially with AI)
|
||||
|
||||
Benefit: Minimal coordination, epic-level ownership, clear boundaries
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Work Distribution Strategies
|
||||
|
||||
### Strategy 1: Epic-Based (Recommended)
|
||||
|
||||
**Best for:** 2-10 developers
|
||||
|
||||
**Approach:** Each developer owns complete epics, works sequentially through stories
|
||||
|
||||
**Example:**
|
||||
|
||||
```yaml
|
||||
epics:
|
||||
- id: epic-1
|
||||
title: Payment Processing
|
||||
owner: alice
|
||||
stories: 8
|
||||
estimate: 2 days
|
||||
|
||||
- id: epic-2
|
||||
title: User Dashboard
|
||||
owner: bob
|
||||
stories: 12
|
||||
estimate: 3 days
|
||||
```
|
||||
|
||||
**Benefits:** Clear ownership, minimal conflicts, epic cohesion, reduced coordination
|
||||
|
||||
### Strategy 2: Layer-Based
|
||||
|
||||
**Best for:** Full-stack apps, specialized teams
|
||||
|
||||
**Example:**
|
||||
|
||||
```
|
||||
Frontend Dev: Epic 1 (Product Catalog UI), Epic 3 (Cart UI)
|
||||
Backend Dev: Epic 2 (Product API), Epic 4 (Cart Service)
|
||||
```
|
||||
|
||||
**Benefits:** Developers in expertise area, true parallel work, clear API contracts
|
||||
|
||||
**Requirements:** Strong architecture phase, clear API contracts upfront
|
||||
|
||||
### Strategy 3: Feature-Based
|
||||
|
||||
**Best for:** Large teams (10+ developers)
|
||||
|
||||
**Example:**
|
||||
|
||||
```
|
||||
Team A (2 devs): Payments feature (4 epics)
|
||||
Team B (2 devs): User Management feature (3 epics)
|
||||
Team C (2 devs): Analytics feature (3 epics)
|
||||
```
|
||||
|
||||
**Benefits:** Feature team autonomy, domain expertise, scalable to large orgs
|
||||
|
||||
---
|
||||
|
||||
## Enterprise Configuration with Git Submodules
|
||||
|
||||
### The Challenge
|
||||
|
||||
**Problem:** Teams customize BMad (agents, workflows, configs) but don't want personal tooling in main repo.
|
||||
|
||||
**Anti-pattern:** Adding `.bmad/` to `.gitignore` breaks IDE tools, submodule management.
|
||||
|
||||
### The Solution: Git Submodules
|
||||
|
||||
**Benefits:**
|
||||
|
||||
- BMad exists in project but tracked separately
|
||||
- Each developer controls their own BMad version/config
|
||||
- Optional team config sharing via submodule repo
|
||||
- IDE tools maintain proper context
|
||||
|
||||
### Setup (New Projects)
|
||||
|
||||
**1. Create optional team config repo:**
|
||||
|
||||
```bash
|
||||
git init bmm-config
|
||||
cd bmm-config
|
||||
npx bmad-method install
|
||||
# Customize for team standards
|
||||
git commit -m "Team BMM config"
|
||||
git push origin main
|
||||
```
|
||||
|
||||
**2. Add submodule to project:**
|
||||
|
||||
```bash
|
||||
cd /path/to/your-project
|
||||
git submodule add https://github.com/your-org/bmm-config.git bmad
|
||||
git commit -m "Add BMM as submodule"
|
||||
```
|
||||
|
||||
**3. Team members initialize:**
|
||||
|
||||
```bash
|
||||
git clone https://github.com/your-org/your-project.git
|
||||
cd your-project
|
||||
git submodule update --init --recursive
|
||||
# Make personal customizations in .bmad/
|
||||
```
|
||||
|
||||
### Daily Workflow
|
||||
|
||||
**Work in main project:**
|
||||
|
||||
```bash
|
||||
cd /path/to/your-project
|
||||
# BMad available at ./.bmad/, load agents normally
|
||||
```
|
||||
|
||||
**Update personal config:**
|
||||
|
||||
```bash
|
||||
cd bmad
|
||||
# Make changes, commit locally, don't push unless sharing
|
||||
```
|
||||
|
||||
**Update to latest team config:**
|
||||
|
||||
```bash
|
||||
cd bmad
|
||||
git pull origin main
|
||||
```
|
||||
|
||||
### Configuration Strategies
|
||||
|
||||
**Option 1: Fully Personal** - No submodule, each dev installs independently, use `.gitignore`
|
||||
|
||||
**Option 2: Team Baseline + Personal** - Submodule has team standards, devs add personal customizations locally
|
||||
|
||||
**Option 3: Full Team Sharing** - All configs in submodule, team collaborates on improvements
|
||||
|
||||
---
|
||||
|
||||
## Best Practices
|
||||
|
||||
### 1. Epic Ownership
|
||||
|
||||
- **Do:** Assign entire epic to one developer (context → implementation → retro)
|
||||
- **Don't:** Split epics across multiple developers (coordination overhead, context loss)
|
||||
|
||||
### 2. Dependency Management
|
||||
|
||||
- **Do:** Identify epic dependencies in planning, document API contracts, complete prerequisites first
|
||||
- **Don't:** Start dependent epic before prerequisite ready, change API contracts without coordination
|
||||
|
||||
### 3. Communication Cadence
|
||||
|
||||
**Traditional:** Daily standups essential
|
||||
**Agentic:** Lighter coordination
|
||||
|
||||
**Recommended:**
|
||||
|
||||
- Daily async updates ("Epic 1, 60% complete, no blockers")
|
||||
- Twice-weekly 15min sync
|
||||
- Epic completion demos
|
||||
- Sprint retro after all epics complete
|
||||
|
||||
### 4. Branch Strategy
|
||||
|
||||
```bash
|
||||
feature/epic-1-payment-processing (Alice)
|
||||
feature/epic-2-user-dashboard (Bob)
|
||||
feature/epic-3-admin-panel (Carol)
|
||||
|
||||
# PR and merge when epic complete
|
||||
```
|
||||
|
||||
### 5. Testing Strategy
|
||||
|
||||
- **Story-level:** Unit tests (DoD requirement, written by agent during dev-story)
|
||||
- **Epic-level:** Integration tests across stories
|
||||
- **Project-level:** E2E tests after multiple epics complete
|
||||
|
||||
### 6. Documentation Updates
|
||||
|
||||
- **Real-time:** `sprint-status.yaml` updated by workflows
|
||||
- **Epic completion:** Update architecture docs, API docs, README if changed
|
||||
- **Sprint completion:** Incorporate retrospective insights
|
||||
|
||||
### 7. Metrics (Different from Traditional)
|
||||
|
||||
**Traditional:** Story points per sprint, burndown charts
|
||||
**Agentic:** Epics per week, stories per day, time to epic completion
|
||||
|
||||
**Example velocity:**
|
||||
|
||||
- Junior dev + AI: 1-2 epics/week (8-15 stories)
|
||||
- Mid-level dev + AI: 2-3 epics/week (15-25 stories)
|
||||
- Senior dev + AI: 3-5 epics/week (25-40 stories)
|
||||
|
||||
---
|
||||
|
||||
## Common Scenarios
|
||||
|
||||
### Scenario 1: Startup (2 Developers)
|
||||
|
||||
**Project:** SaaS MVP (Level 3)
|
||||
|
||||
**Distribution:**
|
||||
|
||||
```
|
||||
Developer A:
|
||||
├─ Epic 1: Authentication (3 days)
|
||||
├─ Epic 3: Payment Integration (2 days)
|
||||
└─ Epic 5: Admin Dashboard (3 days)
|
||||
|
||||
Developer B:
|
||||
├─ Epic 2: Core Product Features (4 days)
|
||||
├─ Epic 4: Analytics (3 days)
|
||||
└─ Epic 6: Notifications (2 days)
|
||||
|
||||
Total: ~2 weeks
|
||||
Traditional estimate: 3-4 months
|
||||
```
|
||||
|
||||
**BMM Setup:** Direct installation, both use Claude Code, minimal customization
|
||||
|
||||
### Scenario 2: Mid-Size Team (8 Developers)
|
||||
|
||||
**Project:** Enterprise Platform (Level 4)
|
||||
|
||||
**Distribution (Layer-Based):**
|
||||
|
||||
```
|
||||
Backend (2 devs): 6 API epics
|
||||
Frontend (2 devs): 6 UI epics
|
||||
Full-stack (2 devs): 4 integration epics
|
||||
DevOps (1 dev): 3 infrastructure epics
|
||||
QA (1 dev): 1 E2E testing epic
|
||||
|
||||
Total: ~3 weeks
|
||||
Traditional estimate: 9-12 months
|
||||
```
|
||||
|
||||
**BMM Setup:** Git submodule, team config repo, mix of Claude Code/Cursor users
|
||||
|
||||
### Scenario 3: Large Enterprise (50+ Developers)
|
||||
|
||||
**Project:** Multi-Product Platform
|
||||
|
||||
**Organization:**
|
||||
|
||||
- 5 product teams (8-10 devs each)
|
||||
- 1 platform team (10 devs - shared services)
|
||||
- 1 infrastructure team (5 devs)
|
||||
|
||||
**Distribution (Feature-Based):**
|
||||
|
||||
```
|
||||
Product Team A: Payments (10 epics, 2 weeks)
|
||||
Product Team B: User Mgmt (12 epics, 2 weeks)
|
||||
Product Team C: Analytics (8 epics, 1.5 weeks)
|
||||
Product Team D: Admin Tools (10 epics, 2 weeks)
|
||||
Product Team E: Mobile (15 epics, 3 weeks)
|
||||
|
||||
Platform Team: Shared Services (continuous)
|
||||
Infrastructure Team: DevOps (continuous)
|
||||
|
||||
Total: 3-4 months
|
||||
Traditional estimate: 2-3 years
|
||||
```
|
||||
|
||||
**BMM Setup:** Each team has own submodule config, org-wide base config, variety of IDE tools
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
### Key Transformation
|
||||
|
||||
**Work Unit Changed:**
|
||||
|
||||
- **Old:** Story = unit of work assignment
|
||||
- **New:** Epic = unit of work assignment
|
||||
|
||||
**Why:** AI agents collapse story duration (days → hours), making epic ownership practical.
|
||||
|
||||
### Velocity Impact
|
||||
|
||||
- **Traditional:** Months for epic delivery, heavy coordination
|
||||
- **Agentic:** Days for epic delivery, minimal coordination
|
||||
- **Result:** 10-50× productivity gains
|
||||
|
||||
### PM/UX Evolution
|
||||
|
||||
**BMad Method enables:**
|
||||
|
||||
- PMs to write AI-executable PRDs
|
||||
- UX designers to validate through working prototypes
|
||||
- Technical fluency without CS degrees
|
||||
- Orchestration of cloud AI agent teams
|
||||
- Career evolution to Full-Stack Product Lead
|
||||
|
||||
### Enterprise Adoption
|
||||
|
||||
**Git submodules:** Best practice for BMM management across teams
|
||||
**Team flexibility:** Mix of tools (Claude Code, Cursor, Windsurf) with shared BMM foundation
|
||||
**Scalable patterns:** Epic-based, layer-based, feature-based distribution strategies
|
||||
|
||||
### The Future (2026)
|
||||
|
||||
PMs write BMad PRDs → Stories auto-fed to cloud AI agents → Parallel implementation → Human review of PRs → Continuous deployment
|
||||
|
||||
**The future isn't AI replacing PMs—it's AI-augmented PMs becoming 10× more powerful.**
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [FAQ](./faq.md) - Common questions
|
||||
- [Scale Adaptive System](./scale-adaptive-system.md) - Project levels explained
|
||||
- [Quick Start Guide](./quick-start.md) - Getting started
|
||||
- [Workflow Documentation](./README.md#-workflow-guides) - Complete workflow reference
|
||||
- [Agents Guide](./agents-guide.md) - Understanding BMad agents
|
||||
|
||||
---
|
||||
|
||||
_BMad Method fundamentally changes how PMs work, how teams structure work, and how products get built. Understanding these patterns is essential for enterprise success in the age of AI agents._
|
||||
@ -1,588 +0,0 @@
|
||||
# BMM Frequently Asked Questions
|
||||
|
||||
Quick answers to common questions about the BMad Method Module.
|
||||
|
||||
---
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Getting Started](#getting-started)
|
||||
- [Choosing the Right Level](#choosing-the-right-level)
|
||||
- [Workflows and Phases](#workflows-and-phases)
|
||||
- [Planning Documents](#planning-documents)
|
||||
- [Implementation](#implementation)
|
||||
- [Brownfield Development](#brownfield-development)
|
||||
- [Tools and Technical](#tools-and-technical)
|
||||
|
||||
---
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Q: Do I always need to run workflow-init?
|
||||
|
||||
**A:** No, once you learn the flow you can go directly to workflows. However, workflow-init is helpful because it:
|
||||
|
||||
- Determines your project's appropriate level automatically
|
||||
- Creates the tracking status file
|
||||
- Routes you to the correct starting workflow
|
||||
|
||||
For experienced users: use the [Quick Reference](./quick-start.md#quick-reference-agent-document-mapping) to go directly to the right agent/workflow.
|
||||
|
||||
### Q: Why do I need fresh chats for each workflow?
|
||||
|
||||
**A:** Context-intensive workflows (like brainstorming, PRD creation, architecture design) can cause AI hallucinations if run in sequence within the same chat. Starting fresh ensures the agent has maximum context capacity for each workflow. This is particularly important for:
|
||||
|
||||
- Planning workflows (PRD, architecture)
|
||||
- Analysis workflows (brainstorming, research)
|
||||
- Complex story implementation
|
||||
|
||||
Quick workflows like status checks can reuse chats safely.
|
||||
|
||||
### Q: Can I skip workflow-status and just start working?
|
||||
|
||||
**A:** Yes, if you already know your project level and which workflow comes next. workflow-status is mainly useful for:
|
||||
|
||||
- New projects (guides initial setup)
|
||||
- When you're unsure what to do next
|
||||
- After breaks in work (reminds you where you left off)
|
||||
- Checking overall progress
|
||||
|
||||
### Q: What's the minimum I need to get started?
|
||||
|
||||
**A:** For the fastest path:
|
||||
|
||||
1. Install BMad Method: `npx bmad-method@alpha install`
|
||||
2. For small changes: Load PM agent → run tech-spec → implement
|
||||
3. For larger projects: Load PM agent → run prd → architect → implement
|
||||
|
||||
### Q: How do I know if I'm in Phase 1, 2, 3, or 4?
|
||||
|
||||
**A:** Check your `bmm-workflow-status.md` file (created by workflow-init). It shows your current phase and progress. If you don't have this file, you can also tell by what you're working on:
|
||||
|
||||
- **Phase 1** - Brainstorming, research, product brief (optional)
|
||||
- **Phase 2** - Creating either a PRD or tech-spec (always required)
|
||||
- **Phase 3** - Architecture design (Level 2-4 only)
|
||||
- **Phase 4** - Actually writing code, implementing stories
|
||||
|
||||
---
|
||||
|
||||
## Choosing the Right Level
|
||||
|
||||
### Q: How do I know which level my project is?
|
||||
|
||||
**A:** Use workflow-init for automatic detection, or self-assess using these keywords:
|
||||
|
||||
- **Level 0:** "fix", "bug", "typo", "small change", "patch" → 1 story
|
||||
- **Level 1:** "simple", "basic", "small feature", "add" → 2-10 stories
|
||||
- **Level 2:** "dashboard", "several features", "admin panel" → 5-15 stories
|
||||
- **Level 3:** "platform", "integration", "complex", "system" → 12-40 stories
|
||||
- **Level 4:** "enterprise", "multi-tenant", "multiple products" → 40+ stories
|
||||
|
||||
When in doubt, start smaller. You can always run create-prd later if needed.
|
||||
|
||||
### Q: Can I change levels mid-project?
|
||||
|
||||
**A:** Yes! If you started at Level 1 but realize it's Level 2, you can run create-prd to add proper planning docs. The system is flexible - your initial level choice isn't permanent.
|
||||
|
||||
### Q: What if workflow-init suggests the wrong level?
|
||||
|
||||
**A:** You can override it! workflow-init suggests a level but always asks for confirmation. If you disagree, just say so and choose the level you think is appropriate. Trust your judgment.
|
||||
|
||||
### Q: Do I always need architecture for Level 2?
|
||||
|
||||
**A:** No, architecture is **optional** for Level 2. Only create architecture if you need system-level design. Many Level 2 projects work fine with just PRD + epic-tech-context created during implementation.
|
||||
|
||||
### Q: What's the difference between Level 1 and Level 2?
|
||||
|
||||
**A:**
|
||||
|
||||
- **Level 1:** 1-10 stories, uses tech-spec (simpler, faster), no architecture
|
||||
- **Level 2:** 5-15 stories, uses PRD (product-focused), optional architecture
|
||||
|
||||
The overlap (5-10 stories) is intentional. Choose based on:
|
||||
|
||||
- Need product-level planning? → Level 2
|
||||
- Just need technical plan? → Level 1
|
||||
- Multiple epics? → Level 2
|
||||
- Single epic? → Level 1
|
||||
|
||||
---
|
||||
|
||||
## Workflows and Phases
|
||||
|
||||
### Q: What's the difference between workflow-status and workflow-init?
|
||||
|
||||
**A:**
|
||||
|
||||
- **workflow-status:** Checks existing status and tells you what's next (use when continuing work)
|
||||
- **workflow-init:** Creates new status file and sets up project (use when starting new project)
|
||||
|
||||
If status file exists, use workflow-status. If not, use workflow-init.
|
||||
|
||||
### Q: Can I skip Phase 1 (Analysis)?
|
||||
|
||||
**A:** Yes! Phase 1 is optional for all levels, though recommended for complex projects. Skip if:
|
||||
|
||||
- Requirements are clear
|
||||
- No research needed
|
||||
- Time-sensitive work
|
||||
- Small changes (Level 0-1)
|
||||
|
||||
### Q: When is Phase 3 (Architecture) required?
|
||||
|
||||
**A:**
|
||||
|
||||
- **Level 0-1:** Never (skip entirely)
|
||||
- **Level 2:** Optional (only if system design needed)
|
||||
- **Level 3-4:** Required (comprehensive architecture mandatory)
|
||||
|
||||
### Q: What happens if I skip a recommended workflow?
|
||||
|
||||
**A:** Nothing breaks! Workflows are guidance, not enforcement. However, skipping recommended workflows (like architecture for Level 3) may cause:
|
||||
|
||||
- Integration issues during implementation
|
||||
- Rework due to poor planning
|
||||
- Conflicting design decisions
|
||||
- Longer development time overall
|
||||
|
||||
### Q: How do I know when Phase 3 is complete and I can start Phase 4?
|
||||
|
||||
**A:** For Level 3-4, run the implementation-readiness workflow. It validates that PRD (FRs/NFRs), architecture, epics+stories, and UX (if applicable) are cohesive before implementation. Pass the gate check = ready for Phase 4.
|
||||
|
||||
### Q: Can I run workflows in parallel or do they have to be sequential?
|
||||
|
||||
**A:** Most workflows must be sequential within a phase:
|
||||
|
||||
- Phase 1: brainstorm → research → product-brief (optional order)
|
||||
- Phase 2: PRD must complete before moving forward
|
||||
- Phase 3: architecture → epics+stories → implementation-readiness (sequential)
|
||||
- Phase 4: Stories within an epic should generally be sequential, but stories in different epics can be parallel if you have capacity
|
||||
|
||||
---
|
||||
|
||||
## Planning Documents
|
||||
|
||||
### Q: What's the difference between tech-spec and epic-tech-context?
|
||||
|
||||
**A:**
|
||||
|
||||
- **Tech-spec (Level 0-1):** Created upfront in Planning Phase, serves as primary/only planning document, a combination of enough technical and planning information to drive a single or multiple files
|
||||
- **Epic-tech-context (Level 2-4):** Created during Implementation Phase per epic, supplements PRD + Architecture
|
||||
|
||||
Think of it as: tech-spec is for small projects (replaces PRD and architecture), epic-tech-context is for large projects (supplements PRD).
|
||||
|
||||
### Q: Why no tech-spec at Level 2+?
|
||||
|
||||
**A:** Level 2+ projects need product-level planning (PRD) and system-level design (Architecture), which tech-spec doesn't provide. Tech-spec is too narrow for coordinating multiple features. Instead, Level 2-4 uses:
|
||||
|
||||
- PRD (product vision, functional requirements, non-functional requirements)
|
||||
- Architecture (system design)
|
||||
- Epics+Stories (created AFTER architecture is complete)
|
||||
- Epic-tech-context (detailed implementation per epic, created just-in-time)
|
||||
|
||||
### Q: When do I create epic-tech-context?
|
||||
|
||||
**A:** In Phase 4, right before implementing each epic. Don't create all epic-tech-context upfront - that's over-planning. Create them just-in-time using the epic-tech-context workflow as you're about to start working on that epic.
|
||||
|
||||
**Why just-in-time?** You'll learn from earlier epics, and those learnings improve later epic-tech-context.
|
||||
|
||||
### Q: Do I need a PRD for a bug fix?
|
||||
|
||||
**A:** No! Bug fixes are typically Level 0 (single atomic change). Use Quick Spec Flow:
|
||||
|
||||
- Load PM agent
|
||||
- Run tech-spec workflow
|
||||
- Implement immediately
|
||||
|
||||
PRDs are for Level 2-4 projects with multiple features requiring product-level coordination.
|
||||
|
||||
### Q: Can I skip the product brief?
|
||||
|
||||
**A:** Yes, product brief is always optional. It's most valuable for:
|
||||
|
||||
- Level 3-4 projects needing strategic direction
|
||||
- Projects with stakeholders requiring alignment
|
||||
- Novel products needing market research
|
||||
- When you want to explore solution space before committing
|
||||
|
||||
---
|
||||
|
||||
## Implementation
|
||||
|
||||
### Q: Do I need story-context for every story?
|
||||
|
||||
**A:** Technically no, but it's recommended. story-context provides implementation-specific guidance, references existing patterns, and injects expertise. Skip it only if:
|
||||
|
||||
- Very simple story (self-explanatory)
|
||||
- You're already expert in the area
|
||||
- Time is extremely limited
|
||||
|
||||
For Level 0-1 using tech-spec, story-context is less critical because tech-spec is already comprehensive.
|
||||
|
||||
### Q: What if I don't create epic-tech-context before drafting stories?
|
||||
|
||||
**A:** You can proceed without it, but you'll miss:
|
||||
|
||||
- Epic-level technical direction
|
||||
- Architecture guidance for this epic
|
||||
- Integration strategy with other epics
|
||||
- Common patterns to follow across stories
|
||||
|
||||
epic-tech-context helps ensure stories within an epic are cohesive.
|
||||
|
||||
### Q: How do I mark a story as done?
|
||||
|
||||
**A:** You have two options:
|
||||
|
||||
**Option 1: Use story-done workflow (Recommended)**
|
||||
|
||||
1. Load SM agent
|
||||
2. Run `story-done` workflow
|
||||
3. Workflow automatically updates `sprint-status.yaml` (created by sprint-planning at Phase 4 start)
|
||||
4. Moves story from current status → `DONE`
|
||||
5. Advances the story queue
|
||||
|
||||
**Option 2: Manual update**
|
||||
|
||||
1. After dev-story completes and code-review passes
|
||||
2. Open `sprint-status.yaml` (created by sprint-planning)
|
||||
3. Change the story status from `review` to `done`
|
||||
4. Save the file
|
||||
|
||||
The story-done workflow is faster and ensures proper status file updates.
|
||||
|
||||
### Q: Can I work on multiple stories at once?
|
||||
|
||||
**A:** Yes, if you have capacity! Stories within different epics can be worked in parallel. However, stories within the same epic are usually sequential because they build on each other.
|
||||
|
||||
### Q: What if my story takes longer than estimated?
|
||||
|
||||
**A:** That's normal! Stories are estimates. If implementation reveals more complexity:
|
||||
|
||||
1. Continue working until DoD is met
|
||||
2. Consider if story should be split
|
||||
3. Document learnings in retrospective
|
||||
4. Adjust future estimates based on this learning
|
||||
|
||||
### Q: When should I run retrospective?
|
||||
|
||||
**A:** After completing all stories in an epic (when epic is done). Retrospectives capture:
|
||||
|
||||
- What went well
|
||||
- What could improve
|
||||
- Technical insights
|
||||
- Input for next epic-tech-context
|
||||
|
||||
Don't wait until project end - run after each epic for continuous improvement.
|
||||
|
||||
---
|
||||
|
||||
## Brownfield Development
|
||||
|
||||
### Q: What is brownfield vs greenfield?
|
||||
|
||||
**A:**
|
||||
|
||||
- **Greenfield:** New project, starting from scratch, clean slate
|
||||
- **Brownfield:** Existing project, working with established codebase and patterns
|
||||
|
||||
### Q: Do I have to run document-project for brownfield?
|
||||
|
||||
**A:** Highly recommended, especially if:
|
||||
|
||||
- No existing documentation
|
||||
- Documentation is outdated
|
||||
- AI agents need context about existing code
|
||||
- Level 2-4 complexity
|
||||
|
||||
You can skip it if you have comprehensive, up-to-date documentation including `docs/index.md`.
|
||||
|
||||
### Q: What if I forget to run document-project on brownfield?
|
||||
|
||||
**A:** Workflows will lack context about existing code. You may get:
|
||||
|
||||
- Suggestions that don't match existing patterns
|
||||
- Integration approaches that miss existing APIs
|
||||
- Architecture that conflicts with current structure
|
||||
|
||||
Run document-project and restart planning with proper context.
|
||||
|
||||
### Q: Can I use Quick Spec Flow for brownfield projects?
|
||||
|
||||
**A:** Yes! Quick Spec Flow works great for brownfield. It will:
|
||||
|
||||
- Auto-detect your existing stack
|
||||
- Analyze brownfield code patterns
|
||||
- Detect conventions and ask for confirmation
|
||||
- Generate context-rich tech-spec that respects existing code
|
||||
|
||||
Perfect for bug fixes and small features in existing codebases.
|
||||
|
||||
### Q: How does workflow-init handle brownfield with old planning docs?
|
||||
|
||||
**A:** workflow-init asks about YOUR current work first, then uses old artifacts as context:
|
||||
|
||||
1. Shows what it found (old PRD, epics, etc.)
|
||||
2. Asks: "Is this work in progress, previous effort, or proposed work?"
|
||||
3. If previous effort: Asks you to describe your NEW work
|
||||
4. Determines level based on YOUR work, not old artifacts
|
||||
|
||||
This prevents old Level 3 PRDs from forcing Level 3 workflow for new Level 0 bug fix.
|
||||
|
||||
### Q: What if my existing code doesn't follow best practices?
|
||||
|
||||
**A:** Quick Spec Flow detects your conventions and asks: "Should I follow these existing conventions?" You decide:
|
||||
|
||||
- **Yes** → Maintain consistency with current codebase
|
||||
- **No** → Establish new standards (document why in tech-spec)
|
||||
|
||||
BMM respects your choice - it won't force modernization, but it will offer it.
|
||||
|
||||
---
|
||||
|
||||
## Tools and Technical
|
||||
|
||||
### Q: Why are my Mermaid diagrams not rendering?
|
||||
|
||||
**A:** Common issues:
|
||||
|
||||
1. Missing language tag: Use ` ```mermaid` not just ` ``` `
|
||||
2. Syntax errors in diagram (validate at mermaid.live)
|
||||
3. Tool doesn't support Mermaid (check your Markdown renderer)
|
||||
|
||||
All BMM docs use valid Mermaid syntax that should render in GitHub, VS Code, and most IDEs.
|
||||
|
||||
### Q: Can I use BMM with GitHub Copilot / Cursor / other AI tools?
|
||||
|
||||
**A:** Yes! BMM is complementary. BMM handles:
|
||||
|
||||
- Project planning and structure
|
||||
- Workflow orchestration
|
||||
- Agent Personas and expertise
|
||||
- Documentation generation
|
||||
- Quality gates
|
||||
|
||||
Your AI coding assistant handles:
|
||||
|
||||
- Line-by-line code completion
|
||||
- Quick refactoring
|
||||
- Test generation
|
||||
|
||||
Use them together for best results.
|
||||
|
||||
### Q: What IDEs/tools support BMM?
|
||||
|
||||
**A:** BMM requires tools with **agent mode** and access to **high-quality LLM models** that can load and follow complex workflows, then properly implement code changes.
|
||||
|
||||
**Recommended Tools:**
|
||||
|
||||
- **Claude Code** ⭐ **Best choice**
|
||||
- Sonnet 4.5 (excellent workflow following, coding, reasoning)
|
||||
- Opus (maximum context, complex planning)
|
||||
- Native agent mode designed for BMM workflows
|
||||
|
||||
- **Cursor**
|
||||
- Supports Anthropic (Claude) and OpenAI models
|
||||
- Agent mode with composer
|
||||
- Good for developers who prefer Cursor's UX
|
||||
|
||||
- **Windsurf**
|
||||
- Multi-model support
|
||||
- Agent capabilities
|
||||
- Suitable for BMM workflows
|
||||
|
||||
**What Matters:**
|
||||
|
||||
1. **Agent mode** - Can load long workflow instructions and maintain context
|
||||
2. **High-quality LLM** - Models ranked high on SWE-bench (coding benchmarks)
|
||||
3. **Model selection** - Access to Claude Sonnet 4.5, Opus, or GPT-4o class models
|
||||
4. **Context capacity** - Can handle large planning documents and codebases
|
||||
|
||||
**Why model quality matters:** BMM workflows require LLMs that can follow multi-step processes, maintain context across phases, and implement code that adheres to specifications. Tools with weaker models will struggle with workflow adherence and code quality.
|
||||
|
||||
See [IDE Setup Guides](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/docs/ide-info) for configuration specifics.
|
||||
|
||||
### Q: Can I customize agents?
|
||||
|
||||
**A:** Yes! Agents are installed as markdown files with XML-style content (optimized for LLMs, readable by any model). Create customization files in `.bmad/_cfg/agents/[agent-name].customize.yaml` to override default behaviors while keeping core functionality intact. See agent documentation for customization options.
|
||||
|
||||
**Note:** While source agents in this repo are YAML, they install as `.md` files with XML-style tags - a format any LLM can read and follow.
|
||||
|
||||
### Q: What happens to my planning docs after implementation?
|
||||
|
||||
**A:** Keep them! They serve as:
|
||||
|
||||
- Historical record of decisions
|
||||
- Onboarding material for new team members
|
||||
- Reference for future enhancements
|
||||
- Audit trail for compliance
|
||||
|
||||
For enterprise projects (Level 4), consider archiving completed planning artifacts to keep workspace clean.
|
||||
|
||||
### Q: Can I use BMM for non-software projects?
|
||||
|
||||
**A:** BMM is optimized for software development, but the methodology principles (scale-adaptive planning, just-in-time design, context injection) can apply to other complex project types. You'd need to adapt workflows and agents for your domain.
|
||||
|
||||
---
|
||||
|
||||
## Advanced Questions
|
||||
|
||||
### Q: What if my project grows from Level 1 to Level 3?
|
||||
|
||||
**A:** Totally fine! When you realize scope has grown:
|
||||
|
||||
1. Run create-prd to add product-level planning
|
||||
2. Run create-architecture for system design
|
||||
3. Use existing tech-spec as input for PRD
|
||||
4. Continue with updated level
|
||||
|
||||
The system is flexible - growth is expected.
|
||||
|
||||
### Q: Can I mix greenfield and brownfield approaches?
|
||||
|
||||
**A:** Yes! Common scenario: adding new greenfield feature to brownfield codebase. Approach:
|
||||
|
||||
1. Run document-project for brownfield context
|
||||
2. Use greenfield workflows for new feature planning
|
||||
3. Explicitly document integration points between new and existing
|
||||
4. Test integration thoroughly
|
||||
|
||||
### Q: How do I handle urgent hotfixes during a sprint?
|
||||
|
||||
**A:** Use correct-course workflow or just:
|
||||
|
||||
1. Save your current work state
|
||||
2. Load PM agent → quick tech-spec for hotfix
|
||||
3. Implement hotfix (Level 0 flow)
|
||||
4. Deploy hotfix
|
||||
5. Return to original sprint work
|
||||
|
||||
Level 0 Quick Spec Flow is perfect for urgent fixes.
|
||||
|
||||
### Q: What if I disagree with the workflow's recommendations?
|
||||
|
||||
**A:** Workflows are guidance, not enforcement. If a workflow recommends something that doesn't make sense for your context:
|
||||
|
||||
- Explain your reasoning to the agent
|
||||
- Ask for alternative approaches
|
||||
- Skip the recommendation if you're confident
|
||||
- Document why you deviated (for future reference)
|
||||
|
||||
Trust your expertise - BMM supports your decisions.
|
||||
|
||||
### Q: Can multiple developers work on the same BMM project?
|
||||
|
||||
**A:** Yes! But the paradigm is fundamentally different from traditional agile teams.
|
||||
|
||||
**Key Difference:**
|
||||
|
||||
- **Traditional:** Multiple devs work on stories within one epic (months)
|
||||
- **Agentic:** Each dev owns complete epics (days)
|
||||
|
||||
**In traditional agile:** A team of 5 devs might spend 2-3 months on a single epic, with each dev owning different stories.
|
||||
|
||||
**With BMM + AI agents:** A single dev can complete an entire epic in 1-3 days. What used to take months now takes days.
|
||||
|
||||
**Team Work Distribution:**
|
||||
|
||||
- **Recommended:** Split work by **epic** (not story)
|
||||
- Each developer owns complete epics end-to-end
|
||||
- Parallel work happens at epic level
|
||||
- Minimal coordination needed
|
||||
|
||||
**For full-stack apps:**
|
||||
|
||||
- Frontend and backend can be separate epics (unusual in traditional agile)
|
||||
- Frontend dev owns all frontend epics
|
||||
- Backend dev owns all backend epics
|
||||
- Works because delivery is so fast
|
||||
|
||||
**Enterprise Considerations:**
|
||||
|
||||
- Use **git submodules** for BMM installation (not .gitignore)
|
||||
- Allows personal configurations without polluting main repo
|
||||
- Teams may use different AI tools (Claude Code, Cursor, etc.)
|
||||
- Developers may follow different methods or create custom agents/workflows
|
||||
|
||||
**Quick Tips:**
|
||||
|
||||
- Share `sprint-status.yaml` (single source of truth)
|
||||
- Assign entire epics to developers (not individual stories)
|
||||
- Coordinate at epic boundaries, not story level
|
||||
- Use git submodules for BMM in enterprise settings
|
||||
|
||||
**For comprehensive coverage of enterprise team collaboration, work distribution strategies, git submodule setup, and velocity expectations, see:**
|
||||
|
||||
👉 **[Enterprise Agentic Development Guide](./enterprise-agentic-development.md)**
|
||||
|
||||
### Q: What is party mode and when should I use it?
|
||||
|
||||
**A:** Party mode is a unique multi-agent collaboration feature where ALL your installed agents (19+ from BMM, CIS, BMB, custom modules) discuss your challenges together in real-time.
|
||||
|
||||
**How it works:**
|
||||
|
||||
1. Run `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent)
|
||||
2. Introduce your topic
|
||||
3. BMad Master selects 2-3 most relevant agents per message
|
||||
4. Agents cross-talk, debate, and build on each other's ideas
|
||||
|
||||
**Best for:**
|
||||
|
||||
- Strategic decisions with trade-offs (architecture choices, tech stack, scope)
|
||||
- Creative brainstorming (game design, product innovation, UX ideation)
|
||||
- Cross-functional alignment (epic kickoffs, retrospectives, phase transitions)
|
||||
- Complex problem-solving (multi-faceted challenges, risk assessment)
|
||||
|
||||
**Example parties:**
|
||||
|
||||
- **Product Strategy:** PM + Innovation Strategist (CIS) + Analyst
|
||||
- **Technical Design:** Architect + Creative Problem Solver (CIS) + Game Architect
|
||||
- **User Experience:** UX Designer + Design Thinking Coach (CIS) + Storyteller (CIS)
|
||||
|
||||
**Why it's powerful:**
|
||||
|
||||
- Diverse perspectives (technical, creative, strategic)
|
||||
- Healthy debate reveals blind spots
|
||||
- Emergent insights from agent interaction
|
||||
- Natural collaboration across modules
|
||||
|
||||
**For complete documentation:**
|
||||
|
||||
👉 **[Party Mode Guide](./party-mode.md)** - How it works, when to use it, example compositions, best practices
|
||||
|
||||
---
|
||||
|
||||
## Getting Help
|
||||
|
||||
### Q: Where do I get help if my question isn't answered here?
|
||||
|
||||
**A:**
|
||||
|
||||
1. Search [Complete Documentation](./README.md) for related topics
|
||||
2. Ask in [Discord Community](https://discord.gg/gk8jAdXWmj) (#general-dev)
|
||||
3. Open a [GitHub Issue](https://github.com/bmad-code-org/BMAD-METHOD/issues)
|
||||
4. Watch [YouTube Tutorials](https://www.youtube.com/@BMadCode)
|
||||
|
||||
### Q: How do I report a bug or request a feature?
|
||||
|
||||
**A:** Open a GitHub issue at: https://github.com/bmad-code-org/BMAD-METHOD/issues
|
||||
|
||||
Please include:
|
||||
|
||||
- BMM version (check your installed version)
|
||||
- Steps to reproduce (for bugs)
|
||||
- Expected vs actual behavior
|
||||
- Relevant workflow or agent involved
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Quick Start Guide](./quick-start.md) - Get started with BMM
|
||||
- [Glossary](./glossary.md) - Terminology reference
|
||||
- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding levels
|
||||
- [Brownfield Guide](./brownfield-guide.md) - Existing codebase workflows
|
||||
|
||||
---
|
||||
|
||||
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!
|
||||
@ -1,320 +0,0 @@
|
||||
# BMM Glossary
|
||||
|
||||
Comprehensive terminology reference for the BMad Method Module.
|
||||
|
||||
---
|
||||
|
||||
## Navigation
|
||||
|
||||
- [Core Concepts](#core-concepts)
|
||||
- [Scale and Complexity](#scale-and-complexity)
|
||||
- [Planning Documents](#planning-documents)
|
||||
- [Workflow and Phases](#workflow-and-phases)
|
||||
- [Agents and Roles](#agents-and-roles)
|
||||
- [Status and Tracking](#status-and-tracking)
|
||||
- [Project Types](#project-types)
|
||||
- [Implementation Terms](#implementation-terms)
|
||||
|
||||
---
|
||||
|
||||
## Core Concepts
|
||||
|
||||
### BMM (BMad Method Module)
|
||||
|
||||
Core orchestration system for AI-driven agile development, providing comprehensive lifecycle management through specialized agents and workflows.
|
||||
|
||||
### BMad Method
|
||||
|
||||
The complete methodology for AI-assisted software development, encompassing planning, architecture, implementation, and quality assurance workflows that adapt to project complexity.
|
||||
|
||||
### Scale-Adaptive System
|
||||
|
||||
BMad Method's intelligent workflow orchestration that automatically adjusts planning depth, documentation requirements, and implementation processes based on project needs through three distinct planning tracks (Quick Flow, BMad Method, Enterprise Method).
|
||||
|
||||
### Agent
|
||||
|
||||
A specialized AI persona with specific expertise (PM, Architect, SM, DEV, TEA) that guides users through workflows and creates deliverables. Agents have defined capabilities, communication styles, and workflow access.
|
||||
|
||||
### Workflow
|
||||
|
||||
A multi-step guided process that orchestrates AI agent activities to produce specific deliverables. Workflows are interactive and adapt to user context.
|
||||
|
||||
---
|
||||
|
||||
## Scale and Complexity
|
||||
|
||||
### Quick Flow Track
|
||||
|
||||
Fast implementation track using tech-spec planning only. Best for bug fixes, small features, and changes with clear scope. Typical range: 1-15 stories. No architecture phase needed. Examples: bug fixes, OAuth login, search features.
|
||||
|
||||
### BMad Method Track
|
||||
|
||||
Full product planning track using PRD + Architecture + UX. Best for products, platforms, and complex features requiring system design. Typical range: 10-50+ stories. Examples: admin dashboards, e-commerce platforms, SaaS products.
|
||||
|
||||
### Enterprise Method Track
|
||||
|
||||
Extended enterprise planning track adding Security Architecture, DevOps Strategy, and Test Strategy to BMad Method. Best for enterprise requirements, compliance needs, and multi-tenant systems. Typical range: 30+ stories. Examples: multi-tenant platforms, compliance-driven systems, mission-critical applications.
|
||||
|
||||
### Planning Track
|
||||
|
||||
The methodology path (Quick Flow, BMad Method, or Enterprise Method) chosen for a project based on planning needs, complexity, and requirements rather than story count alone.
|
||||
|
||||
**Note:** Story counts are guidance, not definitions. Tracks are determined by what planning the project needs, not story math.
|
||||
|
||||
---
|
||||
|
||||
## Planning Documents
|
||||
|
||||
### Tech-Spec (Technical Specification)
|
||||
|
||||
**Quick Flow track only.** Comprehensive technical plan created upfront that serves as the primary planning document for small changes or features. Contains problem statement, solution approach, file-level changes, stack detection (brownfield), testing strategy, and developer resources.
|
||||
|
||||
### Epic-Tech-Context (Epic Technical Context)
|
||||
|
||||
**BMad Method/Enterprise tracks only.** Detailed technical planning document created during implementation (just-in-time) for each epic. Supplements PRD + Architecture with epic-specific implementation details, code-level design decisions, and integration points.
|
||||
|
||||
**Key Difference:** Tech-spec (Quick Flow) is created upfront and is the only planning doc. Epic-tech-context (BMad Method/Enterprise) is created per epic during implementation and supplements PRD + Architecture.
|
||||
|
||||
### PRD (Product Requirements Document)
|
||||
|
||||
**BMad Method/Enterprise tracks.** Product-level planning document containing vision, goals, Functional Requirements (FRs), Non-Functional Requirements (NFRs), success criteria, and UX considerations. Replaces tech-spec for larger projects that need product planning. **V6 Note:** PRD focuses on WHAT to build (requirements). Epic+Stories are created separately AFTER architecture via create-epics-and-stories workflow.
|
||||
|
||||
### Architecture Document
|
||||
|
||||
**BMad Method/Enterprise tracks.** System-wide design document defining structure, components, interactions, data models, integration patterns, security, performance, and deployment.
|
||||
|
||||
**Scale-Adaptive:** Architecture complexity scales with track - BMad Method is lightweight to moderate, Enterprise Method is comprehensive with security/devops/test strategies.
|
||||
|
||||
### Epics
|
||||
|
||||
High-level feature groupings that contain multiple related stories. Typically span 5-15 stories each and represent cohesive functionality (e.g., "User Authentication Epic").
|
||||
|
||||
### Product Brief
|
||||
|
||||
Optional strategic planning document created in Phase 1 (Analysis) that captures product vision, market context, user needs, and high-level requirements before detailed planning.
|
||||
|
||||
### GDD (Game Design Document)
|
||||
|
||||
Game development equivalent of PRD, created by Game Designer agent for game projects.
|
||||
|
||||
---
|
||||
|
||||
## Workflow and Phases
|
||||
|
||||
### Phase 0: Documentation (Prerequisite)
|
||||
|
||||
**Conditional phase for brownfield projects.** Creates comprehensive codebase documentation before planning. Only required if existing documentation is insufficient for AI agents.
|
||||
|
||||
### Phase 1: Analysis (Optional)
|
||||
|
||||
Discovery and research phase including brainstorming, research workflows, and product brief creation. Optional for Quick Flow, recommended for BMad Method, required for Enterprise Method.
|
||||
|
||||
### Phase 2: Planning (Required)
|
||||
|
||||
**Always required.** Creates formal requirements and work breakdown. Routes to tech-spec (Quick Flow) or PRD (BMad Method/Enterprise) based on selected track.
|
||||
|
||||
### Phase 3: Solutioning (Track-Dependent)
|
||||
|
||||
Architecture design phase. Required for BMad Method and Enterprise Method tracks. Includes architecture creation, validation, and gate checks.
|
||||
|
||||
### Phase 4: Implementation (Required)
|
||||
|
||||
Sprint-based development through story-by-story iteration. Uses sprint-planning, epic-tech-context, create-story, story-context, dev-story, code-review, and retrospective workflows.
|
||||
|
||||
### Quick Spec Flow
|
||||
|
||||
Fast-track workflow system for Quick Flow track projects that goes straight from idea to tech-spec to implementation, bypassing heavy planning. Designed for bug fixes, small features, and rapid prototyping.
|
||||
|
||||
### Just-In-Time Design
|
||||
|
||||
Pattern where epic-tech-context is created during implementation (Phase 4) right before working on each epic, rather than all upfront. Enables learning and adaptation.
|
||||
|
||||
### Context Injection
|
||||
|
||||
Dynamic technical guidance generated for each story via epic-tech-context and story-context workflows, providing exact expertise when needed without upfront over-planning.
|
||||
|
||||
---
|
||||
|
||||
## Agents and Roles
|
||||
|
||||
### PM (Product Manager)
|
||||
|
||||
Agent responsible for creating PRDs, tech-specs, and managing product requirements. Primary agent for Phase 2 planning.
|
||||
|
||||
### Analyst (Business Analyst)
|
||||
|
||||
Agent that initializes workflows, conducts research, creates product briefs, and tracks progress. Often the entry point for new projects.
|
||||
|
||||
### Architect
|
||||
|
||||
Agent that designs system architecture, creates architecture documents, performs technical reviews, and validates designs. Primary agent for Phase 3 solutioning.
|
||||
|
||||
### SM (Scrum Master)
|
||||
|
||||
Agent that manages sprints, creates stories, generates contexts, and coordinates implementation. Primary orchestrator for Phase 4 implementation.
|
||||
|
||||
### DEV (Developer)
|
||||
|
||||
Agent that implements stories, writes code, runs tests, and performs code reviews. Primary implementer in Phase 4.
|
||||
|
||||
### TEA (Test Architect)
|
||||
|
||||
Agent responsible for test strategy, quality gates, NFR assessment, and comprehensive quality assurance. Integrates throughout all phases.
|
||||
|
||||
### Technical Writer
|
||||
|
||||
Agent specialized in creating and maintaining high-quality technical documentation. Expert in documentation standards, information architecture, and professional technical writing. The agent's internal name is "paige" but is presented as "Technical Writer" to users.
|
||||
|
||||
### UX Designer
|
||||
|
||||
Agent that creates UX design documents, interaction patterns, and visual specifications for UI-heavy projects.
|
||||
|
||||
### Game Designer
|
||||
|
||||
Specialized agent for game development projects. Creates game design documents (GDD) and game-specific workflows.
|
||||
|
||||
### BMad Master
|
||||
|
||||
Meta-level orchestrator agent from BMad Core. Facilitates party mode, lists available tasks and workflows, and provides high-level guidance across all modules.
|
||||
|
||||
### Party Mode
|
||||
|
||||
Multi-agent collaboration feature where all installed agents (19+ from BMM, CIS, BMB, custom modules) discuss challenges together in real-time. BMad Master orchestrates, selecting 2-3 relevant agents per message for natural cross-talk and debate. Best for strategic decisions, creative brainstorming, cross-functional alignment, and complex problem-solving. See [Party Mode Guide](./party-mode.md).
|
||||
|
||||
---
|
||||
|
||||
## Status and Tracking
|
||||
|
||||
### bmm-workflow-status.yaml
|
||||
|
||||
**Phases 1-3.** Tracking file that shows current phase, completed workflows, progress, and next recommended actions. Created by workflow-init, updated automatically.
|
||||
|
||||
### sprint-status.yaml
|
||||
|
||||
**Phase 4 only.** Single source of truth for implementation tracking. Contains all epics, stories, and retrospectives with current status for each. Created by sprint-planning, updated by agents.
|
||||
|
||||
### Story Status Progression
|
||||
|
||||
```
|
||||
backlog → drafted → ready-for-dev → in-progress → review → done
|
||||
```
|
||||
|
||||
- **backlog** - Story exists in epic but not yet drafted
|
||||
- **drafted** - Story file created by SM via create-story
|
||||
- **ready-for-dev** - Story has context, ready for DEV via story-context
|
||||
- **in-progress** - DEV is implementing via dev-story
|
||||
- **review** - Implementation complete, awaiting code-review
|
||||
- **done** - Completed with DoD met
|
||||
|
||||
### Epic Status Progression
|
||||
|
||||
```
|
||||
backlog → contexted
|
||||
```
|
||||
|
||||
- **backlog** - Epic exists in planning docs but no context yet
|
||||
- **contexted** - Epic has technical context via epic-tech-context
|
||||
|
||||
### Retrospective
|
||||
|
||||
Workflow run after completing each epic to capture learnings, identify improvements, and feed insights into next epic planning. Critical for continuous improvement.
|
||||
|
||||
---
|
||||
|
||||
## Project Types
|
||||
|
||||
### Greenfield
|
||||
|
||||
New project starting from scratch with no existing codebase. Freedom to establish patterns, choose stack, and design from clean slate.
|
||||
|
||||
### Brownfield
|
||||
|
||||
Existing project with established codebase, patterns, and constraints. Requires understanding existing architecture, respecting established conventions, and planning integration with current systems.
|
||||
|
||||
**Critical:** Brownfield projects should run document-project workflow BEFORE planning to ensure AI agents have adequate context about existing code.
|
||||
|
||||
### document-project Workflow
|
||||
|
||||
**Brownfield prerequisite.** Analyzes and documents existing codebase, creating comprehensive documentation including project overview, architecture analysis, source tree, API contracts, and data models. Three scan levels: quick, deep, exhaustive.
|
||||
|
||||
---
|
||||
|
||||
## Implementation Terms
|
||||
|
||||
### Story
|
||||
|
||||
Single unit of implementable work with clear acceptance criteria, typically 2-8 hours of development effort. Stories are grouped into epics and tracked in sprint-status.yaml.
|
||||
|
||||
### Story File
|
||||
|
||||
Markdown file containing story details: description, acceptance criteria, technical notes, dependencies, implementation guidance, and testing requirements.
|
||||
|
||||
### Story Context
|
||||
|
||||
Technical guidance document created via story-context workflow that provides implementation-specific context, references existing patterns, suggests approaches, and injects expertise for the specific story.
|
||||
|
||||
### Epic Context
|
||||
|
||||
Technical planning document created via epic-tech-context workflow before drafting stories within an epic. Provides epic-level technical direction, architecture notes, and implementation strategy.
|
||||
|
||||
### Sprint Planning
|
||||
|
||||
Workflow that initializes Phase 4 implementation by creating sprint-status.yaml, extracting all epics/stories from planning docs, and setting up tracking infrastructure.
|
||||
|
||||
### Gate Check
|
||||
|
||||
Validation workflow (implementation-readiness) run before Phase 4 to ensure PRD, architecture, and UX documents are cohesive with no gaps or contradictions. Required for BMad Method and Enterprise Method tracks.
|
||||
|
||||
### DoD (Definition of Done)
|
||||
|
||||
Criteria that must be met before marking a story as done. Typically includes: implementation complete, tests written and passing, code reviewed, documentation updated, and acceptance criteria validated.
|
||||
|
||||
### Shard / Sharding
|
||||
|
||||
**For runtime LLM optimization only (NOT human docs).** Splitting large planning documents (PRD, epics, architecture) into smaller section-based files to improve workflow efficiency. Phase 1-3 workflows load entire sharded documents transparently. Phase 4 workflows selectively load only needed sections for massive token savings.
|
||||
|
||||
---
|
||||
|
||||
## Additional Terms
|
||||
|
||||
### Workflow Status
|
||||
|
||||
Universal entry point workflow that checks for existing status file, displays current phase/progress, and recommends next action based on project state.
|
||||
|
||||
### Workflow Init
|
||||
|
||||
Initialization workflow that creates bmm-workflow-status.yaml, detects greenfield vs brownfield, determines planning track, and sets up appropriate workflow path.
|
||||
|
||||
### Track Selection
|
||||
|
||||
Automatic analysis by workflow-init that uses keyword analysis, complexity indicators, and project requirements to suggest appropriate track (Quick Flow, BMad Method, or Enterprise Method). User can override suggested track.
|
||||
|
||||
### Correct Course
|
||||
|
||||
Workflow run during Phase 4 when significant changes or issues arise. Analyzes impact, proposes solutions, and routes to appropriate remediation workflows.
|
||||
|
||||
### Migration Strategy
|
||||
|
||||
Plan for handling changes to existing data, schemas, APIs, or patterns during brownfield development. Critical for ensuring backward compatibility and smooth rollout.
|
||||
|
||||
### Feature Flags
|
||||
|
||||
Implementation technique for brownfield projects that allows gradual rollout of new functionality, easy rollback, and A/B testing. Recommended for BMad Method and Enterprise brownfield changes.
|
||||
|
||||
### Integration Points
|
||||
|
||||
Specific locations where new code connects with existing systems. Must be documented explicitly in brownfield tech-specs and architectures.
|
||||
|
||||
### Convention Detection
|
||||
|
||||
Quick Spec Flow feature that automatically detects existing code style, naming conventions, patterns, and frameworks from brownfield codebases, then asks user to confirm before proceeding.
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Quick Start Guide](./quick-start.md) - Learn BMM basics
|
||||
- [Scale Adaptive System](./scale-adaptive-system.md) - Deep dive on tracks and complexity
|
||||
- [Brownfield Guide](./brownfield-guide.md) - Working with existing codebases
|
||||
- [Quick Spec Flow](./quick-spec-flow.md) - Fast-track for Quick Flow track
|
||||
- [FAQ](./faq.md) - Common questions
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 93 KiB |
@ -1,224 +0,0 @@
|
||||
# Party Mode: Multi-Agent Collaboration
|
||||
|
||||
**Get all your AI agents in one conversation**
|
||||
|
||||
---
|
||||
|
||||
## What is Party Mode?
|
||||
|
||||
Ever wanted to gather your entire AI team in one room and see what happens? That's party mode.
|
||||
|
||||
Type `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent), and suddenly you've got **all your AI agents** in one conversation. PM, Architect, DEV, UX Designer, the CIS creative agents - everyone shows up.
|
||||
|
||||
**Why it's useful:**
|
||||
|
||||
- **After complex workflows** - Debrief with the whole team about what worked, what didn't
|
||||
- **Big decisions with tradeoffs** - Get technical, creative, and strategic perspectives simultaneously
|
||||
- **Brainstorming sessions** - Watch ideas evolve through cross-pollination
|
||||
- **When things go wrong** - Call out failures, watch agents defend their decisions, let them debate whose fault it was (oddly therapeutic)
|
||||
- **Sprint retrospectives** - Party mode powers the retrospective workflow
|
||||
- **Sprint planning** - Multi-agent collaboration for planning sessions
|
||||
|
||||
**Future use:** Advanced elicitation workflows will leverage party mode for sophisticated requirement gathering.
|
||||
|
||||
---
|
||||
|
||||
## How It Works
|
||||
|
||||
**The basics:**
|
||||
|
||||
1. Party mode reads `.bmad/_cfg/agent-manifest.csv`
|
||||
2. Loads ALL installed agents (already includes your customizations from install)
|
||||
3. BMad Master orchestrates - picks 2-3 relevant agents per message based on topic
|
||||
4. Agents respond in character, can agree/disagree/build on each other's ideas
|
||||
5. Discussion continues until you type "exit" or reach natural conclusion
|
||||
|
||||
**That's it.** No complex merging, no runtime magic. Just agents talking.
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Trigger party mode
|
||||
/bmad:core:workflows:party-mode
|
||||
|
||||
# OR from any agent context
|
||||
*party-mode
|
||||
|
||||
# During party
|
||||
Ask questions, respond to agents, direct the conversation
|
||||
|
||||
# Exit
|
||||
Type: exit
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Fun Examples
|
||||
|
||||
### Example 1: Calling Out Bad Architecture
|
||||
|
||||
**You:** "Okay team, our last sprint was a disaster. The authentication service went down three times. Who screwed this up?"
|
||||
|
||||
**Architect (Winston):** "The design was sound - distributed authentication with proper fallbacks. If implementation deviated from the spec..."
|
||||
|
||||
**DEV (Amelia):** "I followed the architecture doc exactly. The spec didn't account for concurrent session invalidation race conditions."
|
||||
|
||||
**PM (John):** "Both of you missed the bigger issue - we didn't validate session management requirements in the PRD. This is on me for not catching it."
|
||||
|
||||
**TEA (Murat):** "And I should've caught this in integration tests. The test scenarios didn't cover concurrent invalidation."
|
||||
|
||||
_(Watch them debate whose fault it really was - it's therapeutic)_
|
||||
|
||||
---
|
||||
|
||||
### Example 2: Creative Brainstorming
|
||||
|
||||
**You:** "How do we make onboarding feel magical instead of boring?"
|
||||
|
||||
**UX Designer (Sally):** "Start with progressive disclosure - reveal features as users need them, not all at once in a tutorial."
|
||||
|
||||
**Storyteller (CIS):** "What if onboarding was a story? Each step reveals a character's journey - the user IS the hero."
|
||||
|
||||
**Innovation Strategist (CIS):** "Take it further - gamify with unlockable achievements. But make them meaningful, not arbitrary badges."
|
||||
|
||||
**Game Designer:** "Building on that - what if the first 'quest' is actually solving a real user problem? They learn by doing something valuable."
|
||||
|
||||
_(Ideas cross-pollinate and evolve)_
|
||||
|
||||
---
|
||||
|
||||
### Example 3: Technical Decision
|
||||
|
||||
**You:** "Monolith or microservices for MVP?"
|
||||
|
||||
**Architect:** "Start monolith. Microservices add complexity you don't need at 1000 users."
|
||||
|
||||
**PM:** "Agree. Time to market matters more than theoretical scalability."
|
||||
|
||||
**DEV:** "Monolith with clear module boundaries. We can extract services later if needed."
|
||||
|
||||
**Innovation Strategist:** "Contrarian take - if your differentiator IS scalability, build for it now. Otherwise Architect's right."
|
||||
|
||||
_(Multiple perspectives reveal the right answer)_
|
||||
|
||||
---
|
||||
|
||||
## When NOT to Use Party Mode
|
||||
|
||||
**Skip party mode for:**
|
||||
|
||||
- Simple implementation questions → Use DEV agent
|
||||
- Document review → Use Technical Writer
|
||||
- Workflow status checks → Use any agent + `*workflow-status`
|
||||
- Single-domain questions → Use specialist agent
|
||||
|
||||
**Use party mode for:**
|
||||
|
||||
- Multi-perspective decisions
|
||||
- Creative collaboration
|
||||
- Post-mortems and retrospectives
|
||||
- Sprint planning sessions
|
||||
- Complex problem-solving
|
||||
|
||||
---
|
||||
|
||||
## Agent Customization
|
||||
|
||||
Party mode uses agents from `.bmad/[module]/agents/*.md` - these already include any customizations you applied during install.
|
||||
|
||||
**To customize agents for party mode:**
|
||||
|
||||
1. Create customization file: `.bmad/_cfg/agents/bmm-pm.customize.yaml`
|
||||
2. Run `npx bmad-method install` to rebuild agents
|
||||
3. Customizations now active in party mode
|
||||
|
||||
Example customization:
|
||||
|
||||
```yaml
|
||||
agent:
|
||||
persona:
|
||||
principles:
|
||||
- 'HIPAA compliance is non-negotiable'
|
||||
- 'Patient safety over feature velocity'
|
||||
```
|
||||
|
||||
See [Agents Guide](./agents-guide.md#agent-customization) for details.
|
||||
|
||||
---
|
||||
|
||||
## BMM Workflows That Use Party Mode
|
||||
|
||||
**Current:**
|
||||
|
||||
- `epic-retrospective` - Post-epic team retrospective powered by party mode
|
||||
- Sprint planning discussions (informal party mode usage)
|
||||
|
||||
**Future:**
|
||||
|
||||
- Advanced elicitation workflows will officially integrate party mode
|
||||
- Multi-agent requirement validation
|
||||
- Collaborative technical reviews
|
||||
|
||||
---
|
||||
|
||||
## Available Agents
|
||||
|
||||
Party mode can include **19+ agents** from all installed modules:
|
||||
|
||||
**BMM (12 agents):** PM, Analyst, Architect, SM, DEV, TEA, UX Designer, Technical Writer, Game Designer, Game Developer, Game Architect
|
||||
|
||||
**CIS (5 agents):** Brainstorming Coach, Creative Problem Solver, Design Thinking Coach, Innovation Strategist, Storyteller
|
||||
|
||||
**BMB (1 agent):** BMad Builder
|
||||
|
||||
**Core (1 agent):** BMad Master (orchestrator)
|
||||
|
||||
**Custom:** Any agents you've created
|
||||
|
||||
---
|
||||
|
||||
## Tips
|
||||
|
||||
**Get better results:**
|
||||
|
||||
- Be specific with your topic/question
|
||||
- Provide context (project type, constraints, goals)
|
||||
- Direct specific agents when you want their expertise
|
||||
- Make decisions - party mode informs, you decide
|
||||
- Time box discussions (15-30 minutes is usually plenty)
|
||||
|
||||
**Examples of good opening questions:**
|
||||
|
||||
- "We need to decide between REST and GraphQL for our mobile API. Project is a B2B SaaS with 50 enterprise clients."
|
||||
- "Our last sprint failed spectacularly. Let's discuss what went wrong with authentication implementation."
|
||||
- "Brainstorm: how can we make our game's tutorial feel rewarding instead of tedious?"
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Same agents responding every time?**
|
||||
Vary your questions or explicitly request other perspectives: "Game Designer, your thoughts?"
|
||||
|
||||
**Discussion going in circles?**
|
||||
BMad Master will summarize and redirect, or you can make a decision and move on.
|
||||
|
||||
**Too many agents talking?**
|
||||
Make your topic more specific - BMad Master picks 2-3 agents based on relevance.
|
||||
|
||||
**Agents not using customizations?**
|
||||
Make sure you ran `npx bmad-method install` after creating customization files.
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Agents Guide](./agents-guide.md) - Complete agent reference
|
||||
- [Quick Start Guide](./quick-start.md) - Getting started with BMM
|
||||
- [FAQ](./faq.md) - Common questions
|
||||
|
||||
---
|
||||
|
||||
_Better decisions through diverse perspectives. Welcome to party mode._
|
||||
@ -1,652 +0,0 @@
|
||||
# BMad Quick Spec Flow
|
||||
|
||||
**Perfect for:** Bug fixes, small features, rapid prototyping, and quick enhancements
|
||||
|
||||
**Time to implementation:** Minutes, not hours
|
||||
|
||||
---
|
||||
|
||||
## What is Quick Spec Flow?
|
||||
|
||||
Quick Spec Flow is a **streamlined alternative** to the full BMad Method for Quick Flow track projects. Instead of going through Product Brief → PRD → Architecture, you go **straight to a context-aware technical specification** and start coding.
|
||||
|
||||
### When to Use Quick Spec Flow
|
||||
|
||||
✅ **Use Quick Flow track when:**
|
||||
|
||||
- Single bug fix or small enhancement
|
||||
- Small feature with clear scope (typically 1-15 stories)
|
||||
- Rapid prototyping or experimentation
|
||||
- Adding to existing brownfield codebase
|
||||
- You know exactly what you want to build
|
||||
|
||||
❌ **Use BMad Method or Enterprise tracks when:**
|
||||
|
||||
- Building new products or major features
|
||||
- Need stakeholder alignment
|
||||
- Complex multi-team coordination
|
||||
- Requires extensive planning and architecture
|
||||
|
||||
💡 **Not sure?** Run `workflow-init` to get a recommendation based on your project's needs!
|
||||
|
||||
---
|
||||
|
||||
## Quick Spec Flow Overview
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
START[Step 1: Run Tech-Spec Workflow]
|
||||
DETECT[Detects project stack<br/>package.json, requirements.txt, etc.]
|
||||
ANALYZE[Analyzes brownfield codebase<br/>if exists]
|
||||
TEST[Detects test frameworks<br/>and conventions]
|
||||
CONFIRM[Confirms conventions<br/>with you]
|
||||
GENERATE[Generates context-rich<br/>tech-spec]
|
||||
STORIES[Creates ready-to-implement<br/>stories]
|
||||
|
||||
OPTIONAL[Step 2: Optional<br/>Generate Story Context<br/>SM Agent<br/>For complex scenarios only]
|
||||
|
||||
IMPL[Step 3: Implement<br/>DEV Agent<br/>Code, test, commit]
|
||||
|
||||
DONE[DONE! 🚀]
|
||||
|
||||
START --> DETECT
|
||||
DETECT --> ANALYZE
|
||||
ANALYZE --> TEST
|
||||
TEST --> CONFIRM
|
||||
CONFIRM --> GENERATE
|
||||
GENERATE --> STORIES
|
||||
STORIES --> OPTIONAL
|
||||
OPTIONAL -.->|Optional| IMPL
|
||||
STORIES --> IMPL
|
||||
IMPL --> DONE
|
||||
|
||||
style START fill:#bfb,stroke:#333,stroke-width:2px,color:#000
|
||||
style OPTIONAL fill:#ffb,stroke:#333,stroke-width:2px,stroke-dasharray: 5 5,color:#000
|
||||
style IMPL fill:#bbf,stroke:#333,stroke-width:2px,color:#000
|
||||
style DONE fill:#f9f,stroke:#333,stroke-width:3px,color:#000
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Single Atomic Change
|
||||
|
||||
**Best for:** Bug fixes, single file changes, isolated improvements
|
||||
|
||||
### What You Get
|
||||
|
||||
1. **tech-spec.md** - Comprehensive technical specification with:
|
||||
- Problem statement and solution
|
||||
- Detected framework versions and dependencies
|
||||
- Brownfield code patterns (if applicable)
|
||||
- Existing test patterns to follow
|
||||
- Specific file paths to modify
|
||||
- Complete implementation guidance
|
||||
|
||||
2. **story-[slug].md** - Single user story ready for development
|
||||
|
||||
### Quick Spec Flow Commands
|
||||
|
||||
```bash
|
||||
# Start Quick Spec Flow (no workflow-init needed!)
|
||||
# Load PM agent and run tech-spec
|
||||
|
||||
# When complete, implement directly:
|
||||
# Load DEV agent and run dev-story
|
||||
```
|
||||
|
||||
### What Makes It Quick
|
||||
|
||||
- ✅ No Product Brief needed
|
||||
- ✅ No PRD needed
|
||||
- ✅ No Architecture doc needed
|
||||
- ✅ Auto-detects your stack
|
||||
- ✅ Auto-analyzes brownfield code
|
||||
- ✅ Auto-validates quality
|
||||
- ✅ Story context optional (tech-spec is comprehensive!)
|
||||
|
||||
### Example Single Change Scenarios
|
||||
|
||||
- "Fix the login validation bug"
|
||||
- "Add email field to user registration form"
|
||||
- "Update API endpoint to return additional field"
|
||||
- "Improve error handling in payment processing"
|
||||
|
||||
---
|
||||
|
||||
## Coherent Small Feature
|
||||
|
||||
**Best for:** Small features with 2-3 related user stories
|
||||
|
||||
### What You Get
|
||||
|
||||
1. **tech-spec.md** - Same comprehensive spec as single change projects
|
||||
2. **epics.md** - Epic organization with story breakdown
|
||||
3. **story-[epic-slug]-1.md** - First story
|
||||
4. **story-[epic-slug]-2.md** - Second story
|
||||
5. **story-[epic-slug]-3.md** - Third story (if needed)
|
||||
|
||||
### Quick Spec Flow Commands
|
||||
|
||||
```bash
|
||||
# Start Quick Spec Flow
|
||||
# Load PM agent and run tech-spec
|
||||
|
||||
# Optional: Organize stories as a sprint
|
||||
# Load SM agent and run sprint-planning
|
||||
|
||||
# Implement story-by-story:
|
||||
# Load DEV agent and run dev-story for each story
|
||||
```
|
||||
|
||||
### Story Sequencing
|
||||
|
||||
Stories are **automatically validated** to ensure proper sequence:
|
||||
|
||||
- ✅ No forward dependencies (Story 2 can't depend on Story 3)
|
||||
- ✅ Clear dependency documentation
|
||||
- ✅ Infrastructure → Features → Polish order
|
||||
- ✅ Backend → Frontend flow
|
||||
|
||||
### Example Small Feature Scenarios
|
||||
|
||||
- "Add OAuth social login (Google, GitHub, Twitter)"
|
||||
- "Build user profile page with avatar upload"
|
||||
- "Implement basic search with filters"
|
||||
- "Add dark mode toggle to application"
|
||||
|
||||
---
|
||||
|
||||
## Smart Context Discovery
|
||||
|
||||
Quick Spec Flow automatically discovers and uses:
|
||||
|
||||
### 1. Existing Documentation
|
||||
|
||||
- Product briefs (if they exist)
|
||||
- Research documents
|
||||
- `document-project` output (brownfield codebase map)
|
||||
|
||||
### 2. Project Stack
|
||||
|
||||
- **Node.js:** package.json → frameworks, dependencies, scripts, test framework
|
||||
- **Python:** requirements.txt, pyproject.toml → packages, tools
|
||||
- **Ruby:** Gemfile → gems and versions
|
||||
- **Java:** pom.xml, build.gradle → Maven/Gradle dependencies
|
||||
- **Go:** go.mod → modules
|
||||
- **Rust:** Cargo.toml → crates
|
||||
- **PHP:** composer.json → packages
|
||||
|
||||
### 3. Brownfield Code Patterns
|
||||
|
||||
- Directory structure and organization
|
||||
- Existing code patterns (class-based, functional, MVC)
|
||||
- Naming conventions (camelCase, snake_case, PascalCase)
|
||||
- Test frameworks and patterns
|
||||
- Code style (semicolons, quotes, indentation)
|
||||
- Linter/formatter configs
|
||||
- Error handling patterns
|
||||
- Logging conventions
|
||||
- Documentation style
|
||||
|
||||
### 4. Convention Confirmation
|
||||
|
||||
**IMPORTANT:** Quick Spec Flow detects your conventions and **asks for confirmation**:
|
||||
|
||||
```
|
||||
I've detected these conventions in your codebase:
|
||||
|
||||
Code Style:
|
||||
- ESLint with Airbnb config
|
||||
- Prettier with single quotes, 2-space indent
|
||||
- No semicolons
|
||||
|
||||
Test Patterns:
|
||||
- Jest test framework
|
||||
- .test.js file naming
|
||||
- expect() assertion style
|
||||
|
||||
Should I follow these existing conventions? (yes/no)
|
||||
```
|
||||
|
||||
**You decide:** Conform to existing patterns or establish new standards!
|
||||
|
||||
---
|
||||
|
||||
## Modern Best Practices via WebSearch
|
||||
|
||||
Quick Spec Flow stays current by using WebSearch when appropriate:
|
||||
|
||||
### For Greenfield Projects
|
||||
|
||||
- Searches for latest framework versions
|
||||
- Recommends official starter templates
|
||||
- Suggests modern best practices
|
||||
|
||||
### For Outdated Dependencies
|
||||
|
||||
- Detects if your dependencies are >2 years old
|
||||
- Searches for migration guides
|
||||
- Notes upgrade complexity
|
||||
|
||||
### Starter Template Recommendations
|
||||
|
||||
For greenfield projects, Quick Spec Flow recommends:
|
||||
|
||||
**React:**
|
||||
|
||||
- Vite (modern, fast)
|
||||
- Next.js (full-stack)
|
||||
|
||||
**Python:**
|
||||
|
||||
- cookiecutter templates
|
||||
- FastAPI starter
|
||||
|
||||
**Node.js:**
|
||||
|
||||
- NestJS CLI
|
||||
- express-generator
|
||||
|
||||
**Benefits:**
|
||||
|
||||
- ✅ Modern best practices baked in
|
||||
- ✅ Proper project structure
|
||||
- ✅ Build tooling configured
|
||||
- ✅ Testing framework set up
|
||||
- ✅ Faster time to first feature
|
||||
|
||||
---
|
||||
|
||||
## UX/UI Considerations
|
||||
|
||||
For user-facing changes, Quick Spec Flow captures:
|
||||
|
||||
- UI components affected (create vs modify)
|
||||
- UX flow changes (current vs new)
|
||||
- Responsive design needs (mobile, tablet, desktop)
|
||||
- Accessibility requirements:
|
||||
- Keyboard navigation
|
||||
- Screen reader compatibility
|
||||
- ARIA labels
|
||||
- Color contrast standards
|
||||
- User feedback patterns:
|
||||
- Loading states
|
||||
- Error messages
|
||||
- Success confirmations
|
||||
- Progress indicators
|
||||
|
||||
---
|
||||
|
||||
## Auto-Validation and Quality Assurance
|
||||
|
||||
Quick Spec Flow **automatically validates** everything:
|
||||
|
||||
### Tech-Spec Validation (Always Runs)
|
||||
|
||||
Checks:
|
||||
|
||||
- ✅ Context gathering completeness
|
||||
- ✅ Definitiveness (no "use X or Y" statements)
|
||||
- ✅ Brownfield integration quality
|
||||
- ✅ Stack alignment
|
||||
- ✅ Implementation readiness
|
||||
|
||||
Generates scores:
|
||||
|
||||
```
|
||||
✅ Validation Passed!
|
||||
- Context Gathering: Comprehensive
|
||||
- Definitiveness: All definitive
|
||||
- Brownfield Integration: Excellent
|
||||
- Stack Alignment: Perfect
|
||||
- Implementation Readiness: ✅ Ready
|
||||
```
|
||||
|
||||
### Story Validation (Multi-Story Features)
|
||||
|
||||
Checks:
|
||||
|
||||
- ✅ Story sequence (no forward dependencies!)
|
||||
- ✅ Acceptance criteria quality (specific, testable)
|
||||
- ✅ Completeness (all tech spec tasks covered)
|
||||
- ✅ Clear dependency documentation
|
||||
|
||||
**Auto-fixes issues if found!**
|
||||
|
||||
---
|
||||
|
||||
## Complete User Journey
|
||||
|
||||
### Scenario 1: Bug Fix (Single Change)
|
||||
|
||||
**Goal:** Fix login validation bug
|
||||
|
||||
**Steps:**
|
||||
|
||||
1. **Start:** Load PM agent, say "I want to fix the login validation bug"
|
||||
2. **PM runs tech-spec workflow:**
|
||||
- Asks: "What problem are you solving?"
|
||||
- You explain the validation issue
|
||||
- Detects your Node.js stack (Express 4.18.2, Jest for testing)
|
||||
- Analyzes existing UserService code patterns
|
||||
- Asks: "Should I follow your existing conventions?" → You say yes
|
||||
- Generates tech-spec.md with specific file paths and patterns
|
||||
- Creates story-login-fix.md
|
||||
3. **Implement:** Load DEV agent, run `dev-story`
|
||||
- DEV reads tech-spec (has all context!)
|
||||
- Implements fix following existing patterns
|
||||
- Runs tests (following existing Jest patterns)
|
||||
- Done!
|
||||
|
||||
**Total time:** 15-30 minutes (mostly implementation)
|
||||
|
||||
---
|
||||
|
||||
### Scenario 2: Small Feature (Multi-Story)
|
||||
|
||||
**Goal:** Add OAuth social login (Google, GitHub)
|
||||
|
||||
**Steps:**
|
||||
|
||||
1. **Start:** Load PM agent, say "I want to add OAuth social login"
|
||||
2. **PM runs tech-spec workflow:**
|
||||
- Asks about the feature scope
|
||||
- You specify: Google and GitHub OAuth
|
||||
- Detects your stack (Next.js 13.4, NextAuth.js already installed!)
|
||||
- Analyzes existing auth patterns
|
||||
- Confirms conventions with you
|
||||
- Generates:
|
||||
- tech-spec.md (comprehensive implementation guide)
|
||||
- epics.md (OAuth Integration epic)
|
||||
- story-oauth-1.md (Backend OAuth setup)
|
||||
- story-oauth-2.md (Frontend login buttons)
|
||||
3. **Optional Sprint Planning:** Load SM agent, run `sprint-planning`
|
||||
4. **Implement Story 1:**
|
||||
- Load DEV agent, run `dev-story` for story 1
|
||||
- DEV implements backend OAuth
|
||||
5. **Implement Story 2:**
|
||||
- DEV agent, run `dev-story` for story 2
|
||||
- DEV implements frontend
|
||||
- Done!
|
||||
|
||||
**Total time:** 1-3 hours (mostly implementation)
|
||||
|
||||
---
|
||||
|
||||
## Integration with Phase 4 Workflows
|
||||
|
||||
Quick Spec Flow works seamlessly with all Phase 4 implementation workflows:
|
||||
|
||||
### story-context (SM Agent)
|
||||
|
||||
- ✅ Recognizes tech-spec.md as authoritative source
|
||||
- ✅ Extracts context from tech-spec (replaces PRD)
|
||||
- ✅ Generates XML context for complex scenarios
|
||||
|
||||
### create-story (SM Agent)
|
||||
|
||||
- ✅ Can work with tech-spec.md instead of PRD
|
||||
- ✅ Uses epics.md from tech-spec workflow
|
||||
- ✅ Creates additional stories if needed
|
||||
|
||||
### sprint-planning (SM Agent)
|
||||
|
||||
- ✅ Works with epics.md from tech-spec
|
||||
- ✅ Organizes multi-story features for coordinated implementation
|
||||
- ✅ Tracks progress through sprint-status.yaml
|
||||
|
||||
### dev-story (DEV Agent)
|
||||
|
||||
- ✅ Reads stories generated by tech-spec
|
||||
- ✅ Uses tech-spec.md as comprehensive context
|
||||
- ✅ Implements following detected conventions
|
||||
|
||||
---
|
||||
|
||||
## Comparison: Quick Spec vs Full BMM
|
||||
|
||||
| Aspect | Quick Flow Track | BMad Method/Enterprise Tracks |
|
||||
| --------------------- | ---------------------------- | ---------------------------------- |
|
||||
| **Setup** | None (standalone) | workflow-init recommended |
|
||||
| **Planning Docs** | tech-spec.md only | Product Brief → PRD → Architecture |
|
||||
| **Time to Code** | Minutes | Hours to days |
|
||||
| **Best For** | Bug fixes, small features | New products, major features |
|
||||
| **Context Discovery** | Automatic | Manual + guided |
|
||||
| **Story Context** | Optional (tech-spec is rich) | Required (generated from PRD) |
|
||||
| **Validation** | Auto-validates everything | Manual validation steps |
|
||||
| **Brownfield** | Auto-analyzes and conforms | Manual documentation required |
|
||||
| **Conventions** | Auto-detects and confirms | Document in PRD/Architecture |
|
||||
|
||||
---
|
||||
|
||||
## When to Graduate from Quick Flow to BMad Method
|
||||
|
||||
Start with Quick Flow, but switch to BMad Method when:
|
||||
|
||||
- ❌ Project grows beyond initial scope
|
||||
- ❌ Multiple teams need coordination
|
||||
- ❌ Stakeholders need formal documentation
|
||||
- ❌ Product vision is unclear
|
||||
- ❌ Architectural decisions need deep analysis
|
||||
- ❌ Compliance/regulatory requirements exist
|
||||
|
||||
💡 **Tip:** You can always run `workflow-init` later to transition from Quick Flow to BMad Method!
|
||||
|
||||
---
|
||||
|
||||
## Quick Spec Flow - Key Benefits
|
||||
|
||||
### 🚀 **Speed**
|
||||
|
||||
- No Product Brief
|
||||
- No PRD
|
||||
- No Architecture doc
|
||||
- Straight to implementation
|
||||
|
||||
### 🧠 **Intelligence**
|
||||
|
||||
- Auto-detects stack
|
||||
- Auto-analyzes brownfield
|
||||
- Auto-validates quality
|
||||
- WebSearch for current info
|
||||
|
||||
### 📐 **Respect for Existing Code**
|
||||
|
||||
- Detects conventions
|
||||
- Asks for confirmation
|
||||
- Follows patterns
|
||||
- Adapts vs. changes
|
||||
|
||||
### ✅ **Quality**
|
||||
|
||||
- Auto-validation
|
||||
- Definitive decisions (no "or" statements)
|
||||
- Comprehensive context
|
||||
- Clear acceptance criteria
|
||||
|
||||
### 🎯 **Focus**
|
||||
|
||||
- Single atomic changes
|
||||
- Coherent small features
|
||||
- No scope creep
|
||||
- Fast iteration
|
||||
|
||||
---
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- BMad Method installed (`npx bmad-method install`)
|
||||
- Project directory with code (or empty for greenfield)
|
||||
|
||||
### Quick Start Commands
|
||||
|
||||
```bash
|
||||
# For a quick bug fix or small change:
|
||||
# 1. Load PM agent
|
||||
# 2. Say: "I want to [describe your change]"
|
||||
# 3. PM will ask if you want to run tech-spec
|
||||
# 4. Answer questions about your change
|
||||
# 5. Get tech-spec + story
|
||||
# 6. Load DEV agent and implement!
|
||||
|
||||
# For a small feature with multiple stories:
|
||||
# Same as above, but get epic + 2-3 stories
|
||||
# Optionally use SM sprint-planning to organize
|
||||
```
|
||||
|
||||
### No workflow-init Required!
|
||||
|
||||
Quick Spec Flow is **fully standalone**:
|
||||
|
||||
- Detects if it's a single change or multi-story feature
|
||||
- Asks for greenfield vs brownfield
|
||||
- Works without status file tracking
|
||||
- Perfect for rapid prototyping
|
||||
|
||||
---
|
||||
|
||||
## FAQ
|
||||
|
||||
### Q: Can I use Quick Spec Flow on an existing project?
|
||||
|
||||
**A:** Yes! It's perfect for brownfield projects. It will analyze your existing code, detect patterns, and ask if you want to follow them.
|
||||
|
||||
### Q: What if I don't have a package.json or requirements.txt?
|
||||
|
||||
**A:** Quick Spec Flow will work in greenfield mode, recommend starter templates, and use WebSearch for modern best practices.
|
||||
|
||||
### Q: Do I need to run workflow-init first?
|
||||
|
||||
**A:** No! Quick Spec Flow is standalone. But if you want guidance on which flow to use, workflow-init can help.
|
||||
|
||||
### Q: Can I use this for frontend changes?
|
||||
|
||||
**A:** Absolutely! Quick Spec Flow captures UX/UI considerations, component changes, and accessibility requirements.
|
||||
|
||||
### Q: What if my Quick Flow project grows?
|
||||
|
||||
**A:** No problem! You can always transition to BMad Method by running workflow-init and create-prd. Your tech-spec becomes input for the PRD.
|
||||
|
||||
### Q: Do I need story-context for every story?
|
||||
|
||||
**A:** Usually no! Tech-spec is comprehensive enough for most Quick Flow projects. Only use story-context for complex edge cases.
|
||||
|
||||
### Q: Can I skip validation?
|
||||
|
||||
**A:** No, validation always runs automatically. But it's fast and catches issues early!
|
||||
|
||||
### Q: Will it work with my team's code style?
|
||||
|
||||
**A:** Yes! It detects your conventions and asks for confirmation. You control whether to follow existing patterns or establish new ones.
|
||||
|
||||
---
|
||||
|
||||
## Tips and Best Practices
|
||||
|
||||
### 1. **Be Specific in Discovery**
|
||||
|
||||
When describing your change, provide specifics:
|
||||
|
||||
- ✅ "Fix email validation in UserService to allow plus-addressing"
|
||||
- ❌ "Fix validation bug"
|
||||
|
||||
### 2. **Trust the Convention Detection**
|
||||
|
||||
If it detects your patterns correctly, say yes! It's faster than establishing new conventions.
|
||||
|
||||
### 3. **Use WebSearch Recommendations for Greenfield**
|
||||
|
||||
Starter templates save hours of setup time. Let Quick Spec Flow find the best ones.
|
||||
|
||||
### 4. **Review the Auto-Validation**
|
||||
|
||||
When validation runs, read the scores. They tell you if your spec is production-ready.
|
||||
|
||||
### 5. **Story Context is Optional**
|
||||
|
||||
For single changes, try going directly to dev-story first. Only add story-context if you hit complexity.
|
||||
|
||||
### 6. **Keep Single Changes Truly Atomic**
|
||||
|
||||
If your "single change" needs 3+ files, it might be a multi-story feature. Let the workflow guide you.
|
||||
|
||||
### 7. **Validate Story Sequence for Multi-Story Features**
|
||||
|
||||
When you get multiple stories, check the dependency validation output. Proper sequence matters!
|
||||
|
||||
---
|
||||
|
||||
## Real-World Examples
|
||||
|
||||
### Example 1: Adding Logging (Single Change)
|
||||
|
||||
**Input:** "Add structured logging to payment processing"
|
||||
|
||||
**Tech-Spec Output:**
|
||||
|
||||
- Detected: winston 3.8.2 already in package.json
|
||||
- Analyzed: Existing services use winston with JSON format
|
||||
- Confirmed: Follow existing logging patterns
|
||||
- Generated: Specific file paths, log levels, format example
|
||||
- Story: Ready to implement in 1-2 hours
|
||||
|
||||
**Result:** Consistent logging added, following team patterns, no research needed.
|
||||
|
||||
---
|
||||
|
||||
### Example 2: Search Feature (Multi-Story)
|
||||
|
||||
**Input:** "Add search to product catalog with filters"
|
||||
|
||||
**Tech-Spec Output:**
|
||||
|
||||
- Detected: React 18.2.0, MUI component library, Express backend
|
||||
- Analyzed: Existing ProductList component patterns
|
||||
- Confirmed: Follow existing API and component structure
|
||||
- Generated:
|
||||
- Epic: Product Search Functionality
|
||||
- Story 1: Backend search API with filters
|
||||
- Story 2: Frontend search UI component
|
||||
- Auto-validated: Story 1 → Story 2 sequence correct
|
||||
|
||||
**Result:** Search feature implemented in 4-6 hours with proper architecture.
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
Quick Spec Flow is your **fast path from idea to implementation** for:
|
||||
|
||||
- 🐛 Bug fixes
|
||||
- ✨ Small features
|
||||
- 🚀 Rapid prototyping
|
||||
- 🔧 Quick enhancements
|
||||
|
||||
**Key Features:**
|
||||
|
||||
- Auto-detects your stack
|
||||
- Auto-analyzes brownfield code
|
||||
- Auto-validates quality
|
||||
- Respects existing conventions
|
||||
- Uses WebSearch for modern practices
|
||||
- Generates comprehensive tech-specs
|
||||
- Creates implementation-ready stories
|
||||
|
||||
**Time to code:** Minutes, not hours.
|
||||
|
||||
**Ready to try it?** Load the PM agent and say what you want to build! 🚀
|
||||
|
||||
---
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **Try it now:** Load PM agent and describe a small change
|
||||
- **Learn more:** See the [BMM Workflow Guides](./README.md#-workflow-guides) for comprehensive workflow documentation
|
||||
- **Need help deciding?** Run `workflow-init` to get a recommendation
|
||||
- **Have questions?** Join us on Discord: https://discord.gg/gk8jAdXWmj
|
||||
|
||||
---
|
||||
|
||||
_Quick Spec Flow - Because not every change needs a Product Brief._
|
||||
@ -1,382 +0,0 @@
|
||||
# BMad Method V6 Quick Start Guide
|
||||
|
||||
Get started with BMad Method v6 for your new greenfield project. This guide walks you through building software from scratch using AI-powered workflows.
|
||||
|
||||
## TL;DR - The Quick Path
|
||||
|
||||
1. **Install**: `npx bmad-method@alpha install`
|
||||
2. **Initialize**: Load Analyst agent → Run "workflow-init"
|
||||
3. **Plan**: Load PM agent → Run "prd" (or "tech-spec" for small projects)
|
||||
4. **Architect**: Load Architect agent → Run "create-architecture" (10+ stories only)
|
||||
5. **Build**: Load SM agent → Run workflows for each story → Load DEV agent → Implement
|
||||
6. **Always use fresh chats** for each workflow to avoid hallucinations
|
||||
|
||||
---
|
||||
|
||||
## What is BMad Method?
|
||||
|
||||
BMad Method (BMM) helps you build software through guided workflows with specialized AI agents. The process follows four phases:
|
||||
|
||||
1. **Phase 1: Analysis** (Optional) - Brainstorming, Research, Product Brief
|
||||
2. **Phase 2: Planning** (Required) - Create your requirements (tech-spec or PRD)
|
||||
3. **Phase 3: Solutioning** (Track-dependent) - Design the architecture for BMad Method and Enterprise tracks
|
||||
4. **Phase 4: Implementation** (Required) - Build your software Epic by Epic, Story by Story
|
||||
|
||||
### Complete Workflow Visualization
|
||||
|
||||
|
||||
|
||||
_Complete visual flowchart showing all phases, workflows, agents (color-coded), and decision points for the BMad Method standard greenfield track. Each box is color-coded by the agent responsible for that workflow._
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
# Install v6 Alpha to your project
|
||||
npx bmad-method@alpha install
|
||||
```
|
||||
|
||||
The interactive installer will guide you through setup and create a `.bmad/` folder with all agents and workflows.
|
||||
|
||||
---
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Step 1: Initialize Your Workflow
|
||||
|
||||
1. **Load the Analyst agent** in your IDE - See your IDE-specific instructions in [docs/ide-info](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/docs/ide-info) for how to activate agents:
|
||||
- [Claude Code](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/docs/ide-info/claude-code.md)
|
||||
- [VS Code/Cursor/Windsurf](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/docs/ide-info) - Check your IDE folder
|
||||
- Other IDEs also supported
|
||||
2. **Wait for the agent's menu** to appear
|
||||
3. **Tell the agent**: "Run workflow-init" or type "\*workflow-init" or select the menu item number
|
||||
|
||||
#### What happens during workflow-init?
|
||||
|
||||
Workflows are interactive processes in V6 that replaced tasks and templates from prior versions. There are many types of workflows, and you can even create your own with the BMad Builder module. For the BMad Method, you'll be interacting with expert-designed workflows crafted to work with you to get the best out of both you and the LLM.
|
||||
|
||||
During workflow-init, you'll describe:
|
||||
|
||||
- Your project and its goals
|
||||
- Whether there's an existing codebase or this is a new project
|
||||
- The general size and complexity (you can adjust this later)
|
||||
|
||||
#### Planning Tracks
|
||||
|
||||
Based on your description, the workflow will suggest a track and let you choose from:
|
||||
|
||||
**Three Planning Tracks:**
|
||||
|
||||
- **Quick Flow** - Fast implementation (tech-spec only) - bug fixes, simple features, clear scope (typically 1-15 stories)
|
||||
- **BMad Method** - Full planning (PRD + Architecture + UX) - products, platforms, complex features (typically 10-50+ stories)
|
||||
- **Enterprise Method** - Extended planning (BMad Method + Security/DevOps/Test) - enterprise requirements, compliance, multi-tenant (typically 30+ stories)
|
||||
|
||||
**Note**: Story counts are guidance, not definitions. Tracks are chosen based on planning needs, not story math.
|
||||
|
||||
#### What gets created?
|
||||
|
||||
Once you confirm your track, the `bmm-workflow-status.yaml` file will be created in your project's docs folder (assuming default install location). This file tracks your progress through all phases.
|
||||
|
||||
**Important notes:**
|
||||
|
||||
- Every track has different paths through the phases
|
||||
- Story counts can still change based on overall complexity as you work
|
||||
- For this guide, we'll assume a BMad Method track project
|
||||
- This workflow will guide you through Phase 1 (optional), Phase 2 (required), and Phase 3 (required for BMad Method and Enterprise tracks)
|
||||
|
||||
### Step 2: Work Through Phases 1-3
|
||||
|
||||
After workflow-init completes, you'll work through the planning phases. **Important: Use fresh chats for each workflow to avoid context limitations.**
|
||||
|
||||
#### Checking Your Status
|
||||
|
||||
If you're unsure what to do next:
|
||||
|
||||
1. Load any agent in a new chat
|
||||
2. Ask for "workflow-status"
|
||||
3. The agent will tell you the next recommended or required workflow
|
||||
|
||||
**Example response:**
|
||||
|
||||
```
|
||||
Phase 1 (Analysis) is entirely optional. All workflows are optional or recommended:
|
||||
- brainstorm-project - optional
|
||||
- research - optional
|
||||
- product-brief - RECOMMENDED (but not required)
|
||||
|
||||
The next TRULY REQUIRED step is:
|
||||
- PRD (Product Requirements Document) in Phase 2 - Planning
|
||||
- Agent: pm
|
||||
- Command: prd
|
||||
```
|
||||
|
||||
#### How to Run Workflows in Phases 1-3
|
||||
|
||||
When an agent tells you to run a workflow (like `prd`):
|
||||
|
||||
1. **Start a new chat** with the specified agent (e.g., PM) - See [docs/ide-info](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/docs/ide-info) for your IDE's specific instructions
|
||||
2. **Wait for the menu** to appear
|
||||
3. **Tell the agent** to run it using any of these formats:
|
||||
- Type the shorthand: `*prd`
|
||||
- Say it naturally: "Let's create a new PRD"
|
||||
- Select the menu number for "create-prd"
|
||||
|
||||
The agents in V6 are very good with fuzzy menu matching!
|
||||
|
||||
#### Quick Reference: Agent → Document Mapping
|
||||
|
||||
For v4 users or those who prefer to skip workflow-status guidance:
|
||||
|
||||
- **Analyst** → Brainstorming, Product Brief
|
||||
- **PM** → PRD (BMad Method/Enterprise tracks) OR tech-spec (Quick Flow track)
|
||||
- **UX-Designer** → UX Design Document (if UI part of the project)
|
||||
- **Architect** → Architecture (BMad Method/Enterprise tracks)
|
||||
|
||||
#### Phase 2: Planning - Creating the PRD
|
||||
|
||||
**For BMad Method and Enterprise tracks:**
|
||||
|
||||
1. Load the **PM agent** in a new chat
|
||||
2. Tell it to run the PRD workflow
|
||||
3. Once complete, you'll have:
|
||||
- **PRD.md** - Your Product Requirements Document
|
||||
|
||||
**For Quick Flow track:**
|
||||
|
||||
- Use **tech-spec** instead of PRD (no architecture needed)
|
||||
|
||||
#### Phase 2 (Optional): UX Design
|
||||
|
||||
If your project has a user interface:
|
||||
|
||||
1. Load the **UX-Designer agent** in a new chat
|
||||
2. Tell it to run the UX design workflow
|
||||
3. After completion, you'll have your UX specification document
|
||||
|
||||
#### Phase 3: Architecture
|
||||
|
||||
**For BMad Method and Enterprise tracks:**
|
||||
|
||||
1. Load the **Architect agent** in a new chat
|
||||
2. Tell it to run the create-architecture workflow
|
||||
3. After completion, you'll have your architecture document with technical decisions
|
||||
|
||||
#### Phase 3: Create Epics and Stories (REQUIRED after Architecture)
|
||||
|
||||
**V6 Improvement:** Epics and stories are now created AFTER architecture for better quality!
|
||||
|
||||
1. Load the **PM agent** in a new chat
|
||||
2. Tell it to run "create-epics-and-stories"
|
||||
3. This breaks down your PRD's FRs/NFRs into implementable epics and stories
|
||||
4. The workflow uses both PRD and Architecture to create technically-informed stories
|
||||
|
||||
**Why after architecture?** Architecture decisions (database, API patterns, tech stack) directly affect how stories should be broken down and sequenced.
|
||||
|
||||
#### Phase 3: Implementation Readiness Check (Highly Recommended)
|
||||
|
||||
Once epics and stories are created:
|
||||
|
||||
1. Load the **Architect agent** in a new chat
|
||||
2. Tell it to run "implementation-readiness"
|
||||
3. This validates cohesion across all your planning documents (PRD, UX, Architecture, Epics)
|
||||
4. This was called the "PO Master Checklist" in v4
|
||||
|
||||
**Why run this?** It ensures all your planning assets align properly before you start building.
|
||||
|
||||
#### Context Management Tips
|
||||
|
||||
- **Use 200k+ context models** for best results (Claude Sonnet 4.5, GPT-4, etc.)
|
||||
- **Fresh chat for each workflow** - Brainstorming, Briefs, Research, and PRD generation are all context-intensive
|
||||
- **No document sharding needed** - Unlike v4, you don't need to split documents
|
||||
- **Web Bundles coming soon** - Will help save LLM tokens for users with limited plans
|
||||
|
||||
### Step 3: Start Building (Phase 4 - Implementation)
|
||||
|
||||
Once planning and architecture are complete, you'll move to Phase 4. **Important: Each workflow below should be run in a fresh chat to avoid context limitations and hallucinations.**
|
||||
|
||||
#### 3.1 Initialize Sprint Planning
|
||||
|
||||
1. **Start a new chat** with the **SM (Scrum Master) agent**
|
||||
2. Wait for the menu to appear
|
||||
3. Tell the agent: "Run sprint-planning"
|
||||
4. This creates your `sprint-status.yaml` file that tracks all epics and stories
|
||||
|
||||
#### 3.2 Create Epic Context (Optional but Recommended)
|
||||
|
||||
1. **Start a new chat** with the **SM agent**
|
||||
2. Wait for the menu
|
||||
3. Tell the agent: "Run epic-tech-context"
|
||||
4. This creates technical context for the current epic before drafting stories
|
||||
|
||||
#### 3.3 Draft Your First Story
|
||||
|
||||
1. **Start a new chat** with the **SM agent**
|
||||
2. Wait for the menu
|
||||
3. Tell the agent: "Run create-story"
|
||||
4. This drafts the story file from the epic
|
||||
|
||||
#### 3.4 Add Story Context (Optional but Recommended)
|
||||
|
||||
1. **Start a new chat** with the **SM agent**
|
||||
2. Wait for the menu
|
||||
3. Tell the agent: "Run story-context"
|
||||
4. This creates implementation-specific technical context for the story
|
||||
|
||||
#### 3.5 Implement the Story
|
||||
|
||||
1. **Start a new chat** with the **DEV agent**
|
||||
2. Wait for the menu
|
||||
3. Tell the agent: "Run dev-story"
|
||||
4. The DEV agent will implement the story and update the sprint status
|
||||
|
||||
#### 3.6 Review the Code (Optional but Recommended)
|
||||
|
||||
1. **Start a new chat** with the **DEV agent**
|
||||
2. Wait for the menu
|
||||
3. Tell the agent: "Run code-review"
|
||||
4. The DEV agent performs quality validation (this was called QA in v4)
|
||||
|
||||
### Step 4: Keep Going
|
||||
|
||||
For each subsequent story, repeat the cycle using **fresh chats** for each workflow:
|
||||
|
||||
1. **New chat** → SM agent → "Run create-story"
|
||||
2. **New chat** → SM agent → "Run story-context"
|
||||
3. **New chat** → DEV agent → "Run dev-story"
|
||||
4. **New chat** → DEV agent → "Run code-review" (optional but recommended)
|
||||
|
||||
After completing all stories in an epic:
|
||||
|
||||
1. **Start a new chat** with the **SM agent**
|
||||
2. Tell the agent: "Run retrospective"
|
||||
|
||||
**Why fresh chats?** Context-intensive workflows can cause hallucinations if you keep issuing commands in the same chat. Starting fresh ensures the agent has maximum context capacity for each workflow.
|
||||
|
||||
---
|
||||
|
||||
## Understanding the Agents
|
||||
|
||||
Each agent is a specialized AI persona:
|
||||
|
||||
- **Analyst** - Initializes workflows and tracks progress
|
||||
- **PM** - Creates requirements and specifications
|
||||
- **UX-Designer** - If your project has a front end - this designer will help produce artifacts, come up with mock updates, and design a great look and feel with you giving it guidance.
|
||||
- **Architect** - Designs system architecture
|
||||
- **SM (Scrum Master)** - Manages sprints and creates stories
|
||||
- **DEV** - Implements code and reviews work
|
||||
|
||||
## How Workflows Work
|
||||
|
||||
1. **Load an agent** - Open the agent file in your IDE to activate it
|
||||
2. **Wait for the menu** - The agent will present its available workflows
|
||||
3. **Tell the agent what to run** - Say "Run [workflow-name]"
|
||||
4. **Follow the prompts** - The agent guides you through each step
|
||||
|
||||
The agent creates documents, asks questions, and helps you make decisions throughout the process.
|
||||
|
||||
## Project Tracking Files
|
||||
|
||||
BMad creates two files to track your progress:
|
||||
|
||||
**1. bmm-workflow-status.yaml**
|
||||
|
||||
- Shows which phase you're in and what's next
|
||||
- Created by workflow-init
|
||||
- Updated automatically as you progress through phases
|
||||
|
||||
**2. sprint-status.yaml** (Phase 4 only)
|
||||
|
||||
- Tracks all your epics and stories during implementation
|
||||
- Critical for SM and DEV agents to know what to work on next
|
||||
- Created by sprint-planning workflow
|
||||
- Updated automatically as stories progress
|
||||
|
||||
**You don't need to edit these manually** - agents update them as you work.
|
||||
|
||||
---
|
||||
|
||||
## The Complete Flow Visualized
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
subgraph P1["Phase 1 (Optional)<br/>Analysis"]
|
||||
direction TB
|
||||
A1[Brainstorm]
|
||||
A2[Research]
|
||||
A3[Brief]
|
||||
A4[Analyst]
|
||||
A1 ~~~ A2 ~~~ A3 ~~~ A4
|
||||
end
|
||||
|
||||
subgraph P2["Phase 2 (Required)<br/>Planning"]
|
||||
direction TB
|
||||
B1[Quick Flow:<br/>tech-spec]
|
||||
B2[Method/Enterprise:<br/>PRD]
|
||||
B3[UX opt]
|
||||
B4[PM, UX]
|
||||
B1 ~~~ B2 ~~~ B3 ~~~ B4
|
||||
end
|
||||
|
||||
subgraph P3["Phase 3 (Track-dependent)<br/>Solutioning"]
|
||||
direction TB
|
||||
C1[Method/Enterprise:<br/>architecture]
|
||||
C2[gate-check]
|
||||
C3[Architect]
|
||||
C1 ~~~ C2 ~~~ C3
|
||||
end
|
||||
|
||||
subgraph P4["Phase 4 (Required)<br/>Implementation"]
|
||||
direction TB
|
||||
D1[Per Epic:<br/>epic context]
|
||||
D2[Per Story:<br/>create-story]
|
||||
D3[story-context]
|
||||
D4[dev-story]
|
||||
D5[code-review]
|
||||
D6[SM, DEV]
|
||||
D1 ~~~ D2 ~~~ D3 ~~~ D4 ~~~ D5 ~~~ D6
|
||||
end
|
||||
|
||||
P1 --> P2
|
||||
P2 --> P3
|
||||
P3 --> P4
|
||||
|
||||
style P1 fill:#bbf,stroke:#333,stroke-width:2px,color:#000
|
||||
style P2 fill:#bfb,stroke:#333,stroke-width:2px,color:#000
|
||||
style P3 fill:#ffb,stroke:#333,stroke-width:2px,color:#000
|
||||
style P4 fill:#fbf,stroke:#333,stroke-width:2px,color:#000
|
||||
```
|
||||
|
||||
## Common Questions
|
||||
|
||||
**Q: Do I always need architecture?**
|
||||
A: Only for BMad Method and Enterprise tracks. Quick Flow projects skip straight from tech-spec to implementation.
|
||||
|
||||
**Q: Can I change my plan later?**
|
||||
A: Yes! The SM agent has a "correct-course" workflow for handling scope changes.
|
||||
|
||||
**Q: What if I want to brainstorm first?**
|
||||
A: Load the Analyst agent and tell it to "Run brainstorm-project" before running workflow-init.
|
||||
|
||||
**Q: Why do I need fresh chats for each workflow?**
|
||||
A: Context-intensive workflows can cause hallucinations if run in sequence. Fresh chats ensure maximum context capacity.
|
||||
|
||||
**Q: Can I skip workflow-init and workflow-status?**
|
||||
A: Yes, once you learn the flow. Use the Quick Reference in Step 2 to go directly to the workflows you need.
|
||||
|
||||
## Getting Help
|
||||
|
||||
- **During workflows**: Agents guide you with questions and explanations
|
||||
- **Community**: [Discord](https://discord.gg/gk8jAdXWmj) - #general-dev, #bugs-issues
|
||||
- **Complete guide**: [BMM Workflow Documentation](./README.md#-workflow-guides)
|
||||
- **YouTube tutorials**: [BMad Code Channel](https://www.youtube.com/@BMadCode)
|
||||
|
||||
---
|
||||
|
||||
## Key Takeaways
|
||||
|
||||
✅ **Always use fresh chats** - Load agents in new chats for each workflow to avoid context issues
|
||||
✅ **Let workflow-status guide you** - Load any agent and ask for status when unsure what's next
|
||||
✅ **Track matters** - Quick Flow uses tech-spec, BMad Method/Enterprise need PRD and architecture
|
||||
✅ **Tracking is automatic** - The status files update themselves, no manual editing needed
|
||||
✅ **Agents are flexible** - Use menu numbers, shortcuts (\*prd), or natural language
|
||||
|
||||
**Ready to start building?** Install BMad, load the Analyst, run workflow-init, and let the agents guide you!
|
||||
@ -1,618 +0,0 @@
|
||||
# BMad Method Scale Adaptive System
|
||||
|
||||
**Automatically adapts workflows to project complexity - from quick fixes to enterprise systems**
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
The **Scale Adaptive System** intelligently routes projects to the right planning methodology based on complexity, not arbitrary story counts.
|
||||
|
||||
### The Problem
|
||||
|
||||
Traditional methodologies apply the same process to every project:
|
||||
|
||||
- Bug fix requires full design docs
|
||||
- Enterprise system built with minimal planning
|
||||
- One-size-fits-none approach
|
||||
|
||||
### The Solution
|
||||
|
||||
BMad Method adapts to three distinct planning tracks:
|
||||
|
||||
- **Quick Flow**: Tech-spec only, implement immediately
|
||||
- **BMad Method**: PRD + Architecture, structured approach
|
||||
- **Enterprise Method**: Full planning with security/devops/test
|
||||
|
||||
**Result**: Right planning depth for every project.
|
||||
|
||||
---
|
||||
|
||||
## Quick Reference
|
||||
|
||||
### Three Tracks at a Glance
|
||||
|
||||
| Track | Planning Depth | Time Investment | Best For |
|
||||
| --------------------- | --------------------- | --------------- | ------------------------------------------ |
|
||||
| **Quick Flow** | Tech-spec only | Hours to 1 day | Simple features, bug fixes, clear scope |
|
||||
| **BMad Method** | PRD + Arch + UX | 1-3 days | Products, platforms, complex features |
|
||||
| **Enterprise Method** | Method + Test/Sec/Ops | 3-7 days | Enterprise needs, compliance, multi-tenant |
|
||||
|
||||
### Decision Tree
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
START{Describe your project}
|
||||
|
||||
START -->|Bug fix, simple feature| Q1{Scope crystal clear?}
|
||||
START -->|Product, platform, complex| M[BMad Method<br/>PRD + Architecture]
|
||||
START -->|Enterprise, compliance| E[Enterprise Method<br/>Extended Planning]
|
||||
|
||||
Q1 -->|Yes| QF[Quick Flow<br/>Tech-spec only]
|
||||
Q1 -->|Uncertain| M
|
||||
|
||||
style QF fill:#bfb,stroke:#333,stroke-width:2px,color:#000
|
||||
style M fill:#bbf,stroke:#333,stroke-width:2px,color:#000
|
||||
style E fill:#f9f,stroke:#333,stroke-width:2px,color:#000
|
||||
```
|
||||
|
||||
### Quick Keywords
|
||||
|
||||
- **Quick Flow**: fix, bug, simple, add, clear scope
|
||||
- **BMad Method**: product, platform, dashboard, complex, multiple features
|
||||
- **Enterprise Method**: enterprise, multi-tenant, compliance, security, audit
|
||||
|
||||
---
|
||||
|
||||
## How Track Selection Works
|
||||
|
||||
When you run `workflow-init`, it guides you through an educational choice:
|
||||
|
||||
### 1. Description Analysis
|
||||
|
||||
Analyzes your project description for complexity indicators and suggests an appropriate track.
|
||||
|
||||
### 2. Educational Presentation
|
||||
|
||||
Shows all three tracks with:
|
||||
|
||||
- Time investment
|
||||
- Planning approach
|
||||
- Benefits and trade-offs
|
||||
- AI agent support level
|
||||
- Concrete examples
|
||||
|
||||
### 3. Honest Recommendation
|
||||
|
||||
Provides tailored recommendation based on:
|
||||
|
||||
- Complexity keywords
|
||||
- Greenfield vs brownfield
|
||||
- User's description
|
||||
|
||||
### 4. User Choice
|
||||
|
||||
You choose the track that fits your situation. The system guides but never forces.
|
||||
|
||||
**Example:**
|
||||
|
||||
```
|
||||
workflow-init: "Based on 'Add user dashboard with analytics', I recommend BMad Method.
|
||||
This involves multiple features and system design. The PRD + Architecture
|
||||
gives AI agents complete context for better code generation."
|
||||
|
||||
You: "Actually, this is simpler than it sounds. Quick Flow."
|
||||
|
||||
workflow-init: "Got it! Using Quick Flow with tech-spec."
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## The Three Tracks
|
||||
|
||||
### Track 1: Quick Flow
|
||||
|
||||
**Definition**: Fast implementation with tech-spec planning.
|
||||
|
||||
**Time**: Hours to 1 day of planning
|
||||
|
||||
**Planning Docs**:
|
||||
|
||||
- Tech-spec.md (implementation-focused)
|
||||
- Story files (1-15 typically, auto-detects epic structure)
|
||||
|
||||
**Workflow Path**:
|
||||
|
||||
```
|
||||
(Brownfield: document-project first if needed)
|
||||
↓
|
||||
Tech-Spec → Implement
|
||||
```
|
||||
|
||||
**Use For**:
|
||||
|
||||
- Bug fixes
|
||||
- Simple features
|
||||
- Enhancements with clear scope
|
||||
- Quick additions
|
||||
|
||||
**Story Count**: Typically 1-15 stories (guidance, not rule)
|
||||
|
||||
**Example**: "Fix authentication token expiration bug"
|
||||
|
||||
**AI Agent Support**: Basic - minimal context provided
|
||||
|
||||
**Trade-off**: Less planning = higher rework risk if complexity emerges
|
||||
|
||||
---
|
||||
|
||||
### Track 2: BMad Method (RECOMMENDED)
|
||||
|
||||
**Definition**: Full product + system design planning.
|
||||
|
||||
**Time**: 1-3 days of planning
|
||||
|
||||
**Planning Docs**:
|
||||
|
||||
- PRD.md (functional and non-functional requirements)
|
||||
- Architecture.md (system design)
|
||||
- UX Design (if UI components)
|
||||
- Epics and Stories (created after architecture)
|
||||
|
||||
**Workflow Path**:
|
||||
|
||||
```
|
||||
(Brownfield: document-project first if needed)
|
||||
↓
|
||||
(Optional: Analysis phase - brainstorm, research, product brief)
|
||||
↓
|
||||
PRD → (Optional UX) → Architecture → Create Epics and Stories → Implementation Readiness Check → Implement
|
||||
```
|
||||
|
||||
**Complete Workflow Visualization**:
|
||||
|
||||
|
||||
|
||||
_Detailed flowchart showing all phases, workflows, agents (color-coded), and decision points for the BMad Method track. Each colored box represents a different agent role._
|
||||
|
||||
**Use For**:
|
||||
|
||||
**Greenfield**:
|
||||
|
||||
- Products
|
||||
- Platforms
|
||||
- Multi-feature initiatives
|
||||
|
||||
**Brownfield**:
|
||||
|
||||
- Complex additions (new UIs + APIs)
|
||||
- Major refactors
|
||||
- New modules
|
||||
|
||||
**Story Count**: Typically 10-50+ stories (guidance, not rule)
|
||||
|
||||
**Examples**:
|
||||
|
||||
- "User dashboard with analytics and preferences"
|
||||
- "Add real-time collaboration to existing document editor"
|
||||
- "Payment integration system"
|
||||
|
||||
**AI Agent Support**: Exceptional - complete context for coding partnership
|
||||
|
||||
**Why Architecture for Brownfield?**
|
||||
|
||||
Your brownfield documentation might be huge. Architecture workflow distills massive codebase context into a focused solution design specific to YOUR project. This keeps AI agents focused without getting lost in existing code.
|
||||
|
||||
**Benefits**:
|
||||
|
||||
- Complete AI agent context
|
||||
- Prevents architectural drift
|
||||
- Fewer surprises during implementation
|
||||
- Better code quality
|
||||
- Faster overall delivery (planning pays off)
|
||||
|
||||
---
|
||||
|
||||
### Track 3: Enterprise Method
|
||||
|
||||
**Definition**: Extended planning with security, devops, and test strategy.
|
||||
|
||||
**Time**: 3-7 days of planning
|
||||
|
||||
**Planning Docs**:
|
||||
|
||||
- All BMad Method docs PLUS:
|
||||
- Security Architecture
|
||||
- DevOps Strategy
|
||||
- Test Strategy
|
||||
- Compliance documentation
|
||||
|
||||
**Workflow Path**:
|
||||
|
||||
```
|
||||
(Brownfield: document-project nearly mandatory)
|
||||
↓
|
||||
Analysis (recommended/required) → PRD → UX → Architecture
|
||||
↓
|
||||
Create Epics and Stories
|
||||
↓
|
||||
Security Architecture → DevOps Strategy → Test Strategy
|
||||
↓
|
||||
Implementation Readiness Check → Implement
|
||||
```
|
||||
|
||||
**Use For**:
|
||||
|
||||
- Enterprise requirements
|
||||
- Multi-tenant systems
|
||||
- Compliance needs (HIPAA, SOC2, etc.)
|
||||
- Mission-critical systems
|
||||
- Security-sensitive applications
|
||||
|
||||
**Story Count**: Typically 30+ stories (but defined by enterprise needs, not count)
|
||||
|
||||
**Examples**:
|
||||
|
||||
- "Multi-tenant SaaS platform"
|
||||
- "HIPAA-compliant patient portal"
|
||||
- "Add SOC2 audit logging to enterprise app"
|
||||
|
||||
**AI Agent Support**: Elite - comprehensive enterprise planning
|
||||
|
||||
**Critical for Enterprise**:
|
||||
|
||||
- Security architecture and threat modeling
|
||||
- DevOps pipeline planning
|
||||
- Comprehensive test strategy
|
||||
- Risk assessment
|
||||
- Compliance mapping
|
||||
|
||||
---
|
||||
|
||||
## Planning Documents by Track
|
||||
|
||||
### Quick Flow Documents
|
||||
|
||||
**Created**: Upfront in Planning Phase
|
||||
|
||||
**Tech-Spec**:
|
||||
|
||||
- Problem statement and solution
|
||||
- Source tree changes
|
||||
- Technical implementation details
|
||||
- Detected stack and conventions (brownfield)
|
||||
- UX/UI considerations (if user-facing)
|
||||
- Testing strategy
|
||||
|
||||
**Serves as**: Complete planning document (replaces PRD + Architecture)
|
||||
|
||||
---
|
||||
|
||||
### BMad Method Documents
|
||||
|
||||
**Created**: Upfront in Planning and Solutioning Phases
|
||||
|
||||
**PRD (Product Requirements Document)**:
|
||||
|
||||
- Product vision and goals
|
||||
- Functional requirements (FRs)
|
||||
- Non-functional requirements (NFRs)
|
||||
- Success criteria
|
||||
- User experience considerations
|
||||
- Business context
|
||||
|
||||
**Note**: Epics and stories are created AFTER architecture in the create-epics-and-stories workflow
|
||||
|
||||
**Architecture Document**:
|
||||
|
||||
- System components and responsibilities
|
||||
- Data models and schemas
|
||||
- Integration patterns
|
||||
- Security architecture
|
||||
- Performance considerations
|
||||
- Deployment architecture
|
||||
|
||||
**For Brownfield**: Acts as focused "solution design" that distills existing codebase into integration plan
|
||||
|
||||
---
|
||||
|
||||
### Enterprise Method Documents
|
||||
|
||||
**Created**: Extended planning across multiple phases
|
||||
|
||||
Includes all BMad Method documents PLUS:
|
||||
|
||||
**Security Architecture**:
|
||||
|
||||
- Threat modeling
|
||||
- Authentication/authorization design
|
||||
- Data protection strategy
|
||||
- Audit requirements
|
||||
|
||||
**DevOps Strategy**:
|
||||
|
||||
- CI/CD pipeline design
|
||||
- Infrastructure architecture
|
||||
- Monitoring and alerting
|
||||
- Disaster recovery
|
||||
|
||||
**Test Strategy**:
|
||||
|
||||
- Test approach and coverage
|
||||
- Automation strategy
|
||||
- Quality gates
|
||||
- Performance testing
|
||||
|
||||
---
|
||||
|
||||
## Workflow Comparison
|
||||
|
||||
| Track | Analysis | Planning | Architecture | Security/Ops | Typical Stories |
|
||||
| --------------- | ----------- | --------- | ------------ | ------------ | --------------- |
|
||||
| **Quick Flow** | Optional | Tech-spec | None | None | 1-15 |
|
||||
| **BMad Method** | Recommended | PRD + UX | Required | None | 10-50+ |
|
||||
| **Enterprise** | Required | PRD + UX | Required | Required | 30+ |
|
||||
|
||||
**Note**: Story counts are GUIDANCE based on typical usage, NOT definitions of tracks.
|
||||
|
||||
---
|
||||
|
||||
## Brownfield Projects
|
||||
|
||||
### Critical First Step
|
||||
|
||||
For ALL brownfield projects: Run `document-project` BEFORE planning workflows.
|
||||
|
||||
### Why document-project is Critical
|
||||
|
||||
**Quick Flow** uses it for:
|
||||
|
||||
- Auto-detecting existing patterns
|
||||
- Understanding codebase structure
|
||||
- Confirming conventions
|
||||
|
||||
**BMad Method** uses it for:
|
||||
|
||||
- Architecture inputs (existing structure)
|
||||
- Integration design
|
||||
- Pattern consistency
|
||||
|
||||
**Enterprise Method** uses it for:
|
||||
|
||||
- Security analysis
|
||||
- Integration architecture
|
||||
- Risk assessment
|
||||
|
||||
### Brownfield Workflow Pattern
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
START([Brownfield Project])
|
||||
CHECK{Has docs/<br/>index.md?}
|
||||
|
||||
START --> CHECK
|
||||
CHECK -->|No| DOC[document-project workflow<br/>10-30 min]
|
||||
CHECK -->|Yes| TRACK[Choose Track]
|
||||
|
||||
DOC --> TRACK
|
||||
TRACK -->|Quick| QF[Tech-Spec]
|
||||
TRACK -->|Method| M[PRD + Arch]
|
||||
TRACK -->|Enterprise| E[PRD + Arch + Sec/Ops]
|
||||
|
||||
style DOC fill:#ffb,stroke:#333,stroke-width:2px,color:#000
|
||||
style TRACK fill:#bfb,stroke:#333,stroke-width:2px,color:#000
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Scenarios
|
||||
|
||||
### Scenario 1: Bug Fix (Quick Flow)
|
||||
|
||||
**Input**: "Fix email validation bug in login form"
|
||||
|
||||
**Detection**: Keywords "fix", "bug"
|
||||
|
||||
**Track**: Quick Flow
|
||||
|
||||
**Workflow**:
|
||||
|
||||
1. (Optional) Brief analysis
|
||||
2. Tech-spec with single story
|
||||
3. Implement immediately
|
||||
|
||||
**Time**: 2-4 hours total
|
||||
|
||||
---
|
||||
|
||||
### Scenario 2: Small Feature (Quick Flow)
|
||||
|
||||
**Input**: "Add OAuth social login (Google, GitHub, Facebook)"
|
||||
|
||||
**Detection**: Keywords "add", "feature", clear scope
|
||||
|
||||
**Track**: Quick Flow
|
||||
|
||||
**Workflow**:
|
||||
|
||||
1. (Optional) Research OAuth providers
|
||||
2. Tech-spec with 3 stories
|
||||
3. Implement story-by-story
|
||||
|
||||
**Time**: 1-3 days
|
||||
|
||||
---
|
||||
|
||||
### Scenario 3: Customer Portal (BMad Method)
|
||||
|
||||
**Input**: "Build customer portal with dashboard, tickets, billing"
|
||||
|
||||
**Detection**: Keywords "portal", "dashboard", multiple features
|
||||
|
||||
**Track**: BMad Method
|
||||
|
||||
**Workflow**:
|
||||
|
||||
1. (Recommended) Product Brief
|
||||
2. PRD (FRs/NFRs)
|
||||
3. (If UI) UX Design
|
||||
4. Architecture (system design)
|
||||
5. Create Epics and Stories
|
||||
6. Implementation Readiness Check
|
||||
7. Implement with sprint planning
|
||||
|
||||
**Time**: 1-2 weeks
|
||||
|
||||
---
|
||||
|
||||
### Scenario 4: E-commerce Platform (BMad Method)
|
||||
|
||||
**Input**: "Build e-commerce platform with products, cart, checkout, admin, analytics"
|
||||
|
||||
**Detection**: Keywords "platform", multiple subsystems
|
||||
|
||||
**Track**: BMad Method
|
||||
|
||||
**Workflow**:
|
||||
|
||||
1. Research + Product Brief
|
||||
2. Comprehensive PRD (FRs/NFRs)
|
||||
3. UX Design (recommended)
|
||||
4. System Architecture (required)
|
||||
5. Create Epics and Stories
|
||||
6. Implementation Readiness Check
|
||||
7. Implement with phased approach
|
||||
|
||||
**Time**: 3-6 weeks
|
||||
|
||||
---
|
||||
|
||||
### Scenario 5: Brownfield Addition (BMad Method)
|
||||
|
||||
**Input**: "Add search functionality to existing product catalog"
|
||||
|
||||
**Detection**: Brownfield + moderate complexity
|
||||
|
||||
**Track**: BMad Method (not Quick Flow)
|
||||
|
||||
**Critical First Step**:
|
||||
|
||||
1. **Run document-project** to analyze existing codebase
|
||||
|
||||
**Then Workflow**:
|
||||
|
||||
2. PRD for search feature (FRs/NFRs)
|
||||
3. Architecture (integration design - highly recommended)
|
||||
4. Create Epics and Stories
|
||||
5. Implementation Readiness Check
|
||||
6. Implement following existing patterns
|
||||
|
||||
**Time**: 1-2 weeks
|
||||
|
||||
**Why Method not Quick Flow?**: Integration with existing catalog system benefits from architecture planning to ensure consistency.
|
||||
|
||||
---
|
||||
|
||||
### Scenario 6: Multi-tenant Platform (Enterprise Method)
|
||||
|
||||
**Input**: "Add multi-tenancy to existing single-tenant SaaS platform"
|
||||
|
||||
**Detection**: Keywords "multi-tenant", enterprise scale
|
||||
|
||||
**Track**: Enterprise Method
|
||||
|
||||
**Workflow**:
|
||||
|
||||
1. Document-project (mandatory)
|
||||
2. Research (compliance, security)
|
||||
3. PRD (multi-tenancy requirements - FRs/NFRs)
|
||||
4. Architecture (tenant isolation design)
|
||||
5. Create Epics and Stories
|
||||
6. Security Architecture (data isolation, auth)
|
||||
7. DevOps Strategy (tenant provisioning, monitoring)
|
||||
8. Test Strategy (tenant isolation testing)
|
||||
9. Implementation Readiness Check
|
||||
10. Phased implementation
|
||||
|
||||
**Time**: 3-6 months
|
||||
|
||||
---
|
||||
|
||||
## Best Practices
|
||||
|
||||
### 1. Document-Project First for Brownfield
|
||||
|
||||
Always run `document-project` before starting brownfield planning. AI agents need existing codebase context.
|
||||
|
||||
### 2. Trust the Recommendation
|
||||
|
||||
If `workflow-init` suggests BMad Method, there's probably complexity you haven't considered. Review carefully before overriding.
|
||||
|
||||
### 3. Start Smaller if Uncertain
|
||||
|
||||
Uncertain between Quick Flow and Method? Start with Quick Flow. You can create PRD later if needed.
|
||||
|
||||
### 4. Don't Skip Implementation Readiness Check
|
||||
|
||||
For BMad Method and Enterprise, implementation readiness checks prevent costly mistakes. Invest the time.
|
||||
|
||||
### 5. Architecture is Optional but Recommended for Brownfield
|
||||
|
||||
Brownfield BMad Method makes architecture optional, but it's highly recommended. It distills complex codebase into focused solution design.
|
||||
|
||||
### 6. Discovery Phase Based on Need
|
||||
|
||||
Brainstorming and research are offered regardless of track. Use them when you need to think through the problem space.
|
||||
|
||||
### 7. Product Brief for Greenfield Method
|
||||
|
||||
Product Brief is only offered for greenfield BMad Method and Enterprise. It's optional but helps with strategic thinking.
|
||||
|
||||
---
|
||||
|
||||
## Key Differences from Legacy System
|
||||
|
||||
### Old System (Levels 0-4)
|
||||
|
||||
- Arbitrary story count thresholds
|
||||
- Level 2 vs Level 3 based on story count
|
||||
- Confusing overlap zones (5-10 stories, 12-40 stories)
|
||||
- Tech-spec and PRD shown as conflicting options
|
||||
|
||||
### New System (3 Tracks)
|
||||
|
||||
- Methodology-based distinction (not story counts)
|
||||
- Story counts as guidance, not definitions
|
||||
- Clear track purposes:
|
||||
- Quick Flow = Implementation-focused
|
||||
- BMad Method = Product + system design
|
||||
- Enterprise = Extended with security/ops
|
||||
- Mutually exclusive paths chosen upfront
|
||||
- Educational decision-making
|
||||
|
||||
---
|
||||
|
||||
## Migration from Old System
|
||||
|
||||
If you have existing projects using the old level system:
|
||||
|
||||
- **Level 0-1** → Quick Flow
|
||||
- **Level 2-3** → BMad Method
|
||||
- **Level 4** → Enterprise Method
|
||||
|
||||
Run `workflow-init` on existing projects to migrate to new tracking system. It detects existing planning artifacts and creates appropriate workflow tracking.
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- **[Quick Start Guide](./quick-start.md)** - Get started with BMM
|
||||
- **[Quick Spec Flow](./quick-spec-flow.md)** - Details on Quick Flow track
|
||||
- **[Brownfield Guide](./brownfield-guide.md)** - Existing codebase workflows
|
||||
- **[Glossary](./glossary.md)** - Complete terminology
|
||||
- **[FAQ](./faq.md)** - Common questions
|
||||
- **[Workflows Guide](./README.md#-workflow-guides)** - Complete workflow reference
|
||||
|
||||
---
|
||||
|
||||
_Scale Adaptive System - Right planning depth for every project._
|
||||
@ -1,396 +0,0 @@
|
||||
---
|
||||
last-redoc-date: 2025-11-05
|
||||
---
|
||||
|
||||
# Test Architect (TEA) Agent Guide
|
||||
|
||||
## Overview
|
||||
|
||||
- **Persona:** Murat, Master Test Architect and Quality Advisor focused on risk-based testing, fixture architecture, ATDD, and CI/CD governance.
|
||||
- **Mission:** Deliver actionable quality strategies, automation coverage, and gate decisions that scale with project complexity and compliance demands.
|
||||
- **Use When:** BMad Method or Enterprise track projects, integration risk is non-trivial, brownfield regression risk exists, or compliance/NFR evidence is required. (Quick Flow projects typically don't require TEA)
|
||||
|
||||
## TEA Workflow Lifecycle
|
||||
|
||||
TEA integrates into the BMad development lifecycle during Solutioning (Phase 3) and Implementation (Phase 4):
|
||||
|
||||
```mermaid
|
||||
%%{init: {'theme':'base', 'themeVariables': { 'primaryColor':'#fff','primaryTextColor':'#000','primaryBorderColor':'#000','lineColor':'#000','secondaryColor':'#fff','tertiaryColor':'#fff','fontSize':'16px','fontFamily':'arial'}}}%%
|
||||
graph TB
|
||||
subgraph Phase2["<b>Phase 2: PLANNING</b>"]
|
||||
PM["<b>PM: *prd (creates PRD with FRs/NFRs)</b>"]
|
||||
PlanNote["<b>Business requirements phase</b>"]
|
||||
PM -.-> PlanNote
|
||||
end
|
||||
|
||||
subgraph Phase3["<b>Phase 3: SOLUTIONING</b>"]
|
||||
Architecture["<b>Architect: *architecture</b>"]
|
||||
EpicsStories["<b>PM/Architect: *create-epics-and-stories</b>"]
|
||||
Framework["<b>TEA: *framework</b>"]
|
||||
CI["<b>TEA: *ci</b>"]
|
||||
GateCheck["<b>Architect: *implementation-readiness</b>"]
|
||||
Architecture --> EpicsStories
|
||||
EpicsStories --> Framework
|
||||
Framework --> CI
|
||||
CI --> GateCheck
|
||||
Phase3Note["<b>Epics created AFTER architecture,</b><br/><b>then test infrastructure setup</b>"]
|
||||
EpicsStories -.-> Phase3Note
|
||||
end
|
||||
|
||||
subgraph Phase4["<b>Phase 4: IMPLEMENTATION - Per Epic Cycle</b>"]
|
||||
SprintPlan["<b>SM: *sprint-planning</b>"]
|
||||
TestDesign["<b>TEA: *test-design (per epic)</b>"]
|
||||
CreateStory["<b>SM: *create-story</b>"]
|
||||
ATDD["<b>TEA: *atdd (optional, before dev)</b>"]
|
||||
DevImpl["<b>DEV: implements story</b>"]
|
||||
Automate["<b>TEA: *automate</b>"]
|
||||
TestReview1["<b>TEA: *test-review (optional)</b>"]
|
||||
Trace1["<b>TEA: *trace (refresh coverage)</b>"]
|
||||
|
||||
SprintPlan --> TestDesign
|
||||
TestDesign --> CreateStory
|
||||
CreateStory --> ATDD
|
||||
ATDD --> DevImpl
|
||||
DevImpl --> Automate
|
||||
Automate --> TestReview1
|
||||
TestReview1 --> Trace1
|
||||
Trace1 -.->|next story| CreateStory
|
||||
TestDesignNote["<b>Test design: 'How do I test THIS epic?'</b><br/>Creates test-design-epic-N.md per epic"]
|
||||
TestDesign -.-> TestDesignNote
|
||||
end
|
||||
|
||||
subgraph Gate["<b>EPIC/RELEASE GATE</b>"]
|
||||
NFR["<b>TEA: *nfr-assess (if not done earlier)</b>"]
|
||||
TestReview2["<b>TEA: *test-review (final audit, optional)</b>"]
|
||||
TraceGate["<b>TEA: *trace - Phase 2: Gate</b>"]
|
||||
GateDecision{"<b>Gate Decision</b>"}
|
||||
|
||||
NFR --> TestReview2
|
||||
TestReview2 --> TraceGate
|
||||
TraceGate --> GateDecision
|
||||
GateDecision -->|PASS| Pass["<b>PASS ✅</b>"]
|
||||
GateDecision -->|CONCERNS| Concerns["<b>CONCERNS ⚠️</b>"]
|
||||
GateDecision -->|FAIL| Fail["<b>FAIL ❌</b>"]
|
||||
GateDecision -->|WAIVED| Waived["<b>WAIVED ⏭️</b>"]
|
||||
end
|
||||
|
||||
Phase2 --> Phase3
|
||||
Phase3 --> Phase4
|
||||
Phase4 --> Gate
|
||||
|
||||
style Phase2 fill:#bbdefb,stroke:#0d47a1,stroke-width:3px,color:#000
|
||||
style Phase3 fill:#c8e6c9,stroke:#2e7d32,stroke-width:3px,color:#000
|
||||
style Phase4 fill:#e1bee7,stroke:#4a148c,stroke-width:3px,color:#000
|
||||
style Gate fill:#ffe082,stroke:#f57c00,stroke-width:3px,color:#000
|
||||
style Pass fill:#4caf50,stroke:#1b5e20,stroke-width:3px,color:#000
|
||||
style Concerns fill:#ffc107,stroke:#f57f17,stroke-width:3px,color:#000
|
||||
style Fail fill:#f44336,stroke:#b71c1c,stroke-width:3px,color:#000
|
||||
style Waived fill:#9c27b0,stroke:#4a148c,stroke-width:3px,color:#000
|
||||
```
|
||||
|
||||
**Phase Numbering Note:** BMad uses a 4-phase methodology with optional Phase 0/1:
|
||||
|
||||
- **Phase 0** (Optional): Documentation (brownfield prerequisite - `*document-project`)
|
||||
- **Phase 1** (Optional): Discovery/Analysis (`*brainstorm`, `*research`, `*product-brief`)
|
||||
- **Phase 2** (Required): Planning (`*prd` creates PRD with FRs/NFRs)
|
||||
- **Phase 3** (Track-dependent): Solutioning (`*architecture` → `*create-epics-and-stories` → TEA: `*framework`, `*ci` → `*implementation-readiness`)
|
||||
- **Phase 4** (Required): Implementation (`*sprint-planning` → per-epic: `*test-design` → per-story: dev workflows)
|
||||
|
||||
**TEA workflows:** `*framework` and `*ci` run once in Phase 3 after architecture. `*test-design` runs per-epic in Phase 4. Output: `test-design-epic-N.md`.
|
||||
|
||||
Quick Flow track skips Phases 0, 1, and 3. BMad Method and Enterprise use all phases based on project needs.
|
||||
|
||||
### Why TEA is Different from Other BMM Agents
|
||||
|
||||
TEA is the only BMM agent that operates in **multiple phases** (Phase 3 and Phase 4) and has its own **knowledge base architecture**.
|
||||
|
||||
<details>
|
||||
<summary><strong>Cross-Phase Operation & Unique Architecture</strong></summary>
|
||||
|
||||
### Phase-Specific Agents (Standard Pattern)
|
||||
|
||||
Most BMM agents work in a single phase:
|
||||
|
||||
- **Phase 1 (Analysis)**: Analyst agent
|
||||
- **Phase 2 (Planning)**: PM agent
|
||||
- **Phase 3 (Solutioning)**: Architect agent
|
||||
- **Phase 4 (Implementation)**: SM, DEV agents
|
||||
|
||||
### TEA: Multi-Phase Quality Agent (Unique Pattern)
|
||||
|
||||
TEA is **the only agent that operates in multiple phases**:
|
||||
|
||||
```
|
||||
Phase 1 (Analysis) → [TEA not typically used]
|
||||
↓
|
||||
Phase 2 (Planning) → [PM defines requirements - TEA not active]
|
||||
↓
|
||||
Phase 3 (Solutioning) → TEA: *framework, *ci (test infrastructure AFTER architecture)
|
||||
↓
|
||||
Phase 4 (Implementation) → TEA: *test-design (per epic: "how do I test THIS feature?")
|
||||
→ TEA: *atdd, *automate, *test-review, *trace (per story)
|
||||
↓
|
||||
Epic/Release Gate → TEA: *nfr-assess, *trace Phase 2 (release decision)
|
||||
```
|
||||
|
||||
### TEA's 8 Workflows Across Phases
|
||||
|
||||
**Standard agents**: 1-3 workflows per phase
|
||||
**TEA**: 8 workflows across Phase 3, Phase 4, and Release Gate
|
||||
|
||||
| Phase | TEA Workflows | Frequency | Purpose |
|
||||
| ----------- | ----------------------------------------------------- | ---------------- | ---------------------------------------------- |
|
||||
| **Phase 2** | (none) | - | Planning phase - PM defines requirements |
|
||||
| **Phase 3** | *framework, *ci | Once per project | Setup test infrastructure AFTER architecture |
|
||||
| **Phase 4** | *test-design, *atdd, *automate, *test-review, \*trace | Per epic/story | Test planning per epic, then per-story testing |
|
||||
| **Release** | *nfr-assess, *trace (Phase 2: gate) | Per epic/release | Go/no-go decision |
|
||||
|
||||
**Note**: `*trace` is a two-phase workflow: Phase 1 (traceability) + Phase 2 (gate decision). This reduces cognitive load while maintaining natural workflow.
|
||||
|
||||
### Unique Directory Architecture
|
||||
|
||||
TEA is the only BMM agent with its own top-level module directory (`bmm/testarch/`):
|
||||
|
||||
```
|
||||
src/modules/bmm/
|
||||
├── agents/
|
||||
│ └── tea.agent.yaml # Agent definition (standard location)
|
||||
├── workflows/
|
||||
│ └── testarch/ # TEA workflows (standard location)
|
||||
└── testarch/ # Knowledge base (UNIQUE!)
|
||||
├── knowledge/ # 21 production-ready test pattern fragments
|
||||
├── tea-index.csv # Centralized knowledge lookup (21 fragments indexed)
|
||||
└── README.md # This guide
|
||||
```
|
||||
|
||||
### Why TEA Gets Special Treatment
|
||||
|
||||
TEA uniquely requires:
|
||||
|
||||
- **Extensive domain knowledge**: 21 fragments, 12,821 lines covering test patterns, CI/CD, fixtures, quality practices, healing strategies
|
||||
- **Centralized reference system**: `tea-index.csv` for on-demand fragment loading during workflow execution
|
||||
- **Cross-cutting concerns**: Domain-specific testing patterns (vs project-specific artifacts like PRDs/stories)
|
||||
- **Optional MCP integration**: Healing, exploratory, and verification modes for enhanced testing capabilities
|
||||
|
||||
This architecture enables TEA to maintain consistent, production-ready testing patterns across all BMad projects while operating across multiple development phases.
|
||||
|
||||
</details>
|
||||
|
||||
## High-Level Cheat Sheets
|
||||
|
||||
These cheat sheets map TEA workflows to the **BMad Method and Enterprise tracks** across the **4-Phase Methodology** (Phase 1: Analysis, Phase 2: Planning, Phase 3: Solutioning, Phase 4: Implementation).
|
||||
|
||||
**Note:** Quick Flow projects typically don't require TEA (covered in Overview). These cheat sheets focus on BMad Method and Enterprise tracks where TEA adds value.
|
||||
|
||||
**Legend for Track Deltas:**
|
||||
|
||||
- ➕ = New workflow or phase added (doesn't exist in baseline)
|
||||
- 🔄 = Modified focus (same workflow, different emphasis or purpose)
|
||||
- 📦 = Additional output or archival requirement
|
||||
|
||||
### Greenfield - BMad Method (Simple/Standard Work)
|
||||
|
||||
**Planning Track:** BMad Method (PRD + Architecture)
|
||||
**Use Case:** New projects with standard complexity
|
||||
|
||||
| Workflow Stage | Test Architect | Dev / Team | Outputs |
|
||||
| -------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------- |
|
||||
| **Phase 1**: Discovery | - | Analyst `*product-brief` (optional) | `product-brief.md` |
|
||||
| **Phase 2**: Planning | - | PM `*prd` (creates PRD with FRs/NFRs) | PRD with functional/non-functional requirements |
|
||||
| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test scaffold, CI pipeline |
|
||||
| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint status file with all epics and stories |
|
||||
| **Phase 4**: Epic Planning | Run `*test-design` for THIS epic (per-epic test plan) | Review epic scope | `test-design-epic-N.md` with risk assessment and test plan |
|
||||
| **Phase 4**: Story Dev | (Optional) `*atdd` before dev, then `*automate` after | SM `*create-story`, DEV implements | Tests, story implementation |
|
||||
| **Phase 4**: Story Review | Execute `*test-review` (optional), re-run `*trace` | Address recommendations, update code/tests | Quality report, refreshed coverage matrix |
|
||||
| **Phase 4**: Release Gate | (Optional) `*test-review` for final audit, Run `*trace` (Phase 2) | Confirm Definition of Done, share release notes | Quality audit, Gate YAML + release summary |
|
||||
|
||||
<details>
|
||||
<summary>Execution Notes</summary>
|
||||
|
||||
- Run `*framework` only once per repo or when modern harness support is missing.
|
||||
- **Phase 3 (Solutioning)**: After architecture is complete, run `*framework` and `*ci` to setup test infrastructure based on architectural decisions.
|
||||
- **Phase 4 starts**: After solutioning is complete, sprint planning loads all epics.
|
||||
- **`*test-design` runs per-epic**: At the beginning of working on each epic, run `*test-design` to create a test plan for THAT specific epic/feature. Output: `test-design-epic-N.md`.
|
||||
- Use `*atdd` before coding when the team can adopt ATDD; share its checklist with the dev agent.
|
||||
- Post-implementation, keep `*trace` current, expand coverage with `*automate`, optionally review test quality with `*test-review`. For release gate, run `*trace` with Phase 2 enabled to get deployment decision.
|
||||
- Use `*test-review` after `*atdd` to validate generated tests, after `*automate` to ensure regression quality, or before gate for final audit.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Worked Example – “Nova CRM” Greenfield Feature</summary>
|
||||
|
||||
1. **Planning (Phase 2):** Analyst runs `*product-brief`; PM executes `*prd` to produce PRD with FRs/NFRs.
|
||||
2. **Solutioning (Phase 3):** Architect completes `*architecture` for the new module; `*create-epics-and-stories` generates epics/stories based on architecture; TEA sets up test infrastructure via `*framework` and `*ci` based on architectural decisions; gate check validates planning completeness.
|
||||
3. **Sprint Start (Phase 4):** Scrum Master runs `*sprint-planning` to load all epics into sprint status.
|
||||
4. **Epic 1 Planning (Phase 4):** TEA runs `*test-design` to create test plan for Epic 1, producing `test-design-epic-1.md` with risk assessment.
|
||||
5. **Story Implementation (Phase 4):** For each story in Epic 1, SM generates story via `*create-story`; TEA optionally runs `*atdd`; Dev implements with guidance from failing tests.
|
||||
6. **Post-Dev (Phase 4):** TEA runs `*automate`, optionally `*test-review` to audit test quality, re-runs `*trace` to refresh coverage.
|
||||
7. **Release Gate:** TEA runs `*trace` with Phase 2 enabled to generate gate decision.
|
||||
|
||||
</details>
|
||||
|
||||
### Brownfield - BMad Method or Enterprise (Simple or Complex)
|
||||
|
||||
**Planning Tracks:** BMad Method or Enterprise Method
|
||||
**Use Case:** Existing codebases - simple additions (BMad Method) or complex enterprise requirements (Enterprise Method)
|
||||
|
||||
**🔄 Brownfield Deltas from Greenfield:**
|
||||
|
||||
- ➕ Phase 0 (Documentation) - Document existing codebase if undocumented
|
||||
- ➕ Phase 2: `*trace` - Baseline existing test coverage before planning
|
||||
- 🔄 Phase 4: `*test-design` - Focus on regression hotspots and brownfield risks
|
||||
- 🔄 Phase 4: Story Review - May include `*nfr-assess` if not done earlier
|
||||
|
||||
| Workflow Stage | Test Architect | Dev / Team | Outputs |
|
||||
| ----------------------------- | ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| **Phase 0**: Documentation ➕ | - | Analyst `*document-project` (if undocumented) | Comprehensive project documentation |
|
||||
| **Phase 1**: Discovery | - | Analyst/PM/Architect rerun planning workflows | Updated planning artifacts in `{output_folder}` |
|
||||
| **Phase 2**: Planning | Run ➕ `*trace` (baseline coverage) | PM `*prd` (creates PRD with FRs/NFRs) | PRD with FRs/NFRs, ➕ coverage baseline |
|
||||
| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test framework, CI pipeline |
|
||||
| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint status file with all epics and stories |
|
||||
| **Phase 4**: Epic Planning | Run `*test-design` for THIS epic 🔄 (regression hotspots) | Review epic scope and brownfield risks | `test-design-epic-N.md` with brownfield risk assessment and mitigation |
|
||||
| **Phase 4**: Story Dev | (Optional) `*atdd` before dev, then `*automate` after | SM `*create-story`, DEV implements | Tests, story implementation |
|
||||
| **Phase 4**: Story Review | Apply `*test-review` (optional), re-run `*trace`, ➕ `*nfr-assess` if needed | Resolve gaps, update docs/tests | Quality report, refreshed coverage matrix, NFR report |
|
||||
| **Phase 4**: Release Gate | (Optional) `*test-review` for final audit, Run `*trace` (Phase 2) | Capture sign-offs, share release notes | Quality audit, Gate YAML + release summary |
|
||||
|
||||
<details>
|
||||
<summary>Execution Notes</summary>
|
||||
|
||||
- Lead with `*trace` during Planning (Phase 2) to baseline existing test coverage before architecture work begins.
|
||||
- **Phase 3 (Solutioning)**: After architecture is complete, run `*framework` and `*ci` to modernize test infrastructure. For brownfield, framework may need to integrate with or replace existing test setup.
|
||||
- **Phase 4 starts**: After solutioning is complete and sprint planning loads all epics.
|
||||
- **`*test-design` runs per-epic**: At the beginning of working on each epic, run `*test-design` to identify regression hotspots, integration risks, and mitigation strategies for THAT specific epic/feature. Output: `test-design-epic-N.md`.
|
||||
- Use `*atdd` when stories benefit from ATDD; otherwise proceed to implementation and rely on post-dev automation.
|
||||
- After development, expand coverage with `*automate`, optionally review test quality with `*test-review`, re-run `*trace` (Phase 2 for gate decision). Run `*nfr-assess` now if non-functional risks weren't addressed earlier.
|
||||
- Use `*test-review` to validate existing brownfield tests or audit new tests before gate.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Worked Example – “Atlas Payments” Brownfield Story</summary>
|
||||
|
||||
1. **Planning (Phase 2):** PM executes `*prd` to create PRD with FRs/NFRs; TEA runs `*trace` to baseline existing coverage.
|
||||
2. **Solutioning (Phase 3):** Architect triggers `*architecture` capturing legacy payment flows and integration architecture; `*create-epics-and-stories` generates Epic 1 (Payment Processing) based on architecture; TEA sets up `*framework` and `*ci` based on architectural decisions; gate check validates planning.
|
||||
3. **Sprint Start (Phase 4):** Scrum Master runs `*sprint-planning` to load Epic 1 into sprint status.
|
||||
4. **Epic 1 Planning (Phase 4):** TEA runs `*test-design` for Epic 1 (Payment Processing), producing `test-design-epic-1.md` that flags settlement edge cases, regression hotspots, and mitigation plans.
|
||||
5. **Story Implementation (Phase 4):** For each story in Epic 1, SM generates story via `*create-story`; TEA runs `*atdd` producing failing Playwright specs; Dev implements with guidance from tests and checklist.
|
||||
6. **Post-Dev (Phase 4):** TEA applies `*automate`, optionally `*test-review` to audit test quality, re-runs `*trace` to refresh coverage.
|
||||
7. **Release Gate:** TEA performs `*nfr-assess` to validate SLAs, runs `*trace` with Phase 2 enabled to generate gate decision (PASS/CONCERNS/FAIL).
|
||||
|
||||
</details>
|
||||
|
||||
### Greenfield - Enterprise Method (Enterprise/Compliance Work)
|
||||
|
||||
**Planning Track:** Enterprise Method (BMad Method + extended security/devops/test strategies)
|
||||
**Use Case:** New enterprise projects with compliance, security, or complex regulatory requirements
|
||||
|
||||
**🏢 Enterprise Deltas from BMad Method:**
|
||||
|
||||
- ➕ Phase 1: `*research` - Domain and compliance research (recommended)
|
||||
- ➕ Phase 2: `*nfr-assess` - Capture NFR requirements early (security/performance/reliability)
|
||||
- 🔄 Phase 4: `*test-design` - Enterprise focus (compliance, security architecture alignment)
|
||||
- 📦 Release Gate - Archive artifacts and compliance evidence for audits
|
||||
|
||||
| Workflow Stage | Test Architect | Dev / Team | Outputs |
|
||||
| -------------------------- | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
|
||||
| **Phase 1**: Discovery | - | Analyst ➕ `*research`, `*product-brief` | Domain research, compliance analysis, product brief |
|
||||
| **Phase 2**: Planning | Run ➕ `*nfr-assess` | PM `*prd` (creates PRD with FRs/NFRs), UX `*create-design` | Enterprise PRD with FRs/NFRs, UX design, ➕ NFR documentation |
|
||||
| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test framework, CI pipeline |
|
||||
| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint plan with all epics |
|
||||
| **Phase 4**: Epic Planning | Run `*test-design` for THIS epic 🔄 (compliance focus) | Review epic scope and compliance requirements | `test-design-epic-N.md` with security/performance/compliance focus |
|
||||
| **Phase 4**: Story Dev | (Optional) `*atdd`, `*automate`, `*test-review`, `*trace` per story | SM `*create-story`, DEV implements | Tests, fixtures, quality reports, coverage matrices |
|
||||
| **Phase 4**: Release Gate | Final `*test-review` audit, Run `*trace` (Phase 2), 📦 archive artifacts | Capture sign-offs, 📦 compliance evidence | Quality audit, updated assessments, gate YAML, 📦 audit trail |
|
||||
|
||||
<details>
|
||||
<summary>Execution Notes</summary>
|
||||
|
||||
- `*nfr-assess` runs early in Planning (Phase 2) to capture compliance, security, and performance requirements upfront.
|
||||
- **Phase 3 (Solutioning)**: After architecture is complete, run `*framework` and `*ci` with enterprise-grade configurations (selective testing, burn-in jobs, caching, notifications).
|
||||
- **Phase 4 starts**: After solutioning is complete and sprint planning loads all epics.
|
||||
- **`*test-design` runs per-epic**: At the beginning of working on each epic, run `*test-design` to create an enterprise-focused test plan for THAT specific epic, ensuring alignment with security architecture, performance targets, and compliance requirements. Output: `test-design-epic-N.md`.
|
||||
- Use `*atdd` for stories when feasible so acceptance tests can lead implementation.
|
||||
- Use `*test-review` per story or sprint to maintain quality standards and ensure compliance with testing best practices.
|
||||
- Prior to release, rerun coverage (`*trace`, `*automate`), perform final quality audit with `*test-review`, and formalize the decision with `*trace` Phase 2 (gate decision); archive artifacts for compliance audits.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Worked Example – “Helios Ledger” Enterprise Release</summary>
|
||||
|
||||
1. **Planning (Phase 2):** Analyst runs `*research` and `*product-brief`; PM completes `*prd` creating PRD with FRs/NFRs; TEA runs `*nfr-assess` to establish NFR targets.
|
||||
2. **Solutioning (Phase 3):** Architect completes `*architecture` with enterprise considerations; `*create-epics-and-stories` generates epics/stories based on architecture; TEA sets up `*framework` and `*ci` with enterprise-grade configurations based on architectural decisions; gate check validates planning completeness.
|
||||
3. **Sprint Start (Phase 4):** Scrum Master runs `*sprint-planning` to load all epics into sprint status.
|
||||
4. **Per-Epic (Phase 4):** For each epic, TEA runs `*test-design` to create epic-specific test plan (e.g., `test-design-epic-1.md`, `test-design-epic-2.md`) with compliance-focused risk assessment.
|
||||
5. **Per-Story (Phase 4):** For each story, TEA uses `*atdd`, `*automate`, `*test-review`, and `*trace`; Dev teams iterate on the findings.
|
||||
6. **Release Gate:** TEA re-checks coverage, performs final quality audit with `*test-review`, and logs the final gate decision via `*trace` Phase 2, archiving artifacts for compliance.
|
||||
|
||||
</details>
|
||||
|
||||
## Command Catalog
|
||||
|
||||
<details>
|
||||
<summary><strong>Optional Playwright MCP Enhancements</strong></summary>
|
||||
|
||||
**Two Playwright MCP servers** (actively maintained, continuously updated):
|
||||
|
||||
- `playwright` - Browser automation (`npx @playwright/mcp@latest`)
|
||||
- `playwright-test` - Test runner with failure analysis (`npx playwright run-test-mcp-server`)
|
||||
|
||||
**How MCP Enhances TEA Workflows**:
|
||||
|
||||
MCP provides additional capabilities on top of TEA's default AI-based approach:
|
||||
|
||||
1. `*test-design`:
|
||||
- Default: Analysis + documentation
|
||||
- **+ MCP**: Interactive UI discovery with `browser_navigate`, `browser_click`, `browser_snapshot`, behavior observation
|
||||
|
||||
Benefit: Discover actual functionality, edge cases, undocumented features
|
||||
|
||||
2. `*atdd`, `*automate`:
|
||||
- Default: Infers selectors and interactions from requirements and knowledge fragments
|
||||
- **+ MCP**: Generates tests **then** verifies with `generator_setup_page`, `browser_*` tools, validates against live app
|
||||
|
||||
Benefit: Accurate selectors from real DOM, verified behavior, refined test code
|
||||
|
||||
3. `*automate`:
|
||||
- Default: Pattern-based fixes from error messages + knowledge fragments
|
||||
- **+ MCP**: Pattern fixes **enhanced with** `browser_snapshot`, `browser_console_messages`, `browser_network_requests`, `browser_generate_locator`
|
||||
|
||||
Benefit: Visual failure context, live DOM inspection, root cause discovery
|
||||
|
||||
**Config example**:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"playwright": {
|
||||
"command": "npx",
|
||||
"args": ["@playwright/mcp@latest"]
|
||||
},
|
||||
"playwright-test": {
|
||||
"command": "npx",
|
||||
"args": ["playwright", "run-test-mcp-server"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**To disable**: Set `tea_use_mcp_enhancements: false` in `.bmad/bmm/config.yaml` OR remove MCPs from IDE config.
|
||||
|
||||
</details>
|
||||
|
||||
<br></br>
|
||||
|
||||
| Command | Workflow README | Primary Outputs | Notes | With Playwright MCP Enhancements |
|
||||
| -------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `*framework` | [📖](../workflows/testarch/framework/README.md) | Playwright/Cypress scaffold, `.env.example`, `.nvmrc`, sample specs | Use when no production-ready harness exists | - |
|
||||
| `*ci` | [📖](../workflows/testarch/ci/README.md) | CI workflow, selective test scripts, secrets checklist | Platform-aware (GitHub Actions default) | - |
|
||||
| `*test-design` | [📖](../workflows/testarch/test-design/README.md) | Combined risk assessment, mitigation plan, and coverage strategy | Risk scoring + optional exploratory mode | **+ Exploratory**: Interactive UI discovery with browser automation (uncover actual functionality) |
|
||||
| `*atdd` | [📖](../workflows/testarch/atdd/README.md) | Failing acceptance tests + implementation checklist | TDD red phase + optional recording mode | **+ Recording**: AI generation verified with live browser (accurate selectors from real DOM) |
|
||||
| `*automate` | [📖](../workflows/testarch/automate/README.md) | Prioritized specs, fixtures, README/script updates, DoD summary | Optional healing/recording, avoid duplicate coverage | **+ Healing**: Pattern fixes enhanced with visual debugging + **+ Recording**: AI verified with live browser |
|
||||
| `*test-review` | [📖](../workflows/testarch/test-review/README.md) | Test quality review report with 0-100 score, violations, fixes | Reviews tests against knowledge base patterns | - |
|
||||
| `*nfr-assess` | [📖](../workflows/testarch/nfr-assess/README.md) | NFR assessment report with actions | Focus on security/performance/reliability | - |
|
||||
| `*trace` | [📖](../workflows/testarch/trace/README.md) | Phase 1: Coverage matrix, recommendations. Phase 2: Gate decision (PASS/CONCERNS/FAIL/WAIVED) | Two-phase workflow: traceability + gate decision | - |
|
||||
|
||||
**📖** = Click to view detailed workflow documentation
|
||||
@ -1,366 +0,0 @@
|
||||
# Decision Architecture Workflow - Technical Reference
|
||||
|
||||
**Module:** BMM (BMAD Method Module)
|
||||
**Type:** Solutioning Workflow
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
The Decision Architecture workflow is a complete reimagining of how architectural decisions are made in the BMAD Method. Instead of template-driven documentation, this workflow facilitates an intelligent conversation that produces a **decision-focused architecture document** optimized for preventing AI agent conflicts during implementation.
|
||||
|
||||
---
|
||||
|
||||
## Core Philosophy
|
||||
|
||||
**The Problem**: When multiple AI agents implement different parts of a system, they make conflicting technical decisions leading to incompatible implementations.
|
||||
|
||||
**The Solution**: A "consistency contract" that documents all critical technical decisions upfront, ensuring every agent follows the same patterns and uses the same technologies.
|
||||
|
||||
---
|
||||
|
||||
## Key Features
|
||||
|
||||
### 1. Starter Template Intelligence ⭐ NEW
|
||||
|
||||
- Discovers relevant starter templates (create-next-app, create-t3-app, etc.)
|
||||
- Considers UX requirements when selecting templates (animations, accessibility, etc.)
|
||||
- Searches for current CLI options and defaults
|
||||
- Documents decisions made BY the starter template
|
||||
- Makes remaining architectural decisions around the starter foundation
|
||||
- First implementation story becomes "initialize with starter command"
|
||||
|
||||
### 2. Adaptive Facilitation
|
||||
|
||||
- Adjusts conversation style based on user skill level (beginner/intermediate/expert)
|
||||
- Experts get rapid, technical discussions
|
||||
- Beginners receive education and protection from complexity
|
||||
- Everyone produces the same high-quality output
|
||||
|
||||
### 3. Dynamic Version Verification
|
||||
|
||||
- NEVER trusts hardcoded version numbers
|
||||
- Uses WebSearch to find current stable versions
|
||||
- Verifies versions during the conversation
|
||||
- Documents only verified, current versions
|
||||
|
||||
### 4. Intelligent Discovery
|
||||
|
||||
- No rigid project type templates
|
||||
- Analyzes PRD to identify which decisions matter for THIS project
|
||||
- Uses knowledge base of decisions and patterns
|
||||
- Scales to infinite project types
|
||||
|
||||
### 5. Collaborative Decision Making
|
||||
|
||||
- Facilitates discussion for each critical decision
|
||||
- Presents options with trade-offs
|
||||
- Integrates advanced elicitation for innovative approaches
|
||||
- Ensures decisions are coherent and compatible
|
||||
|
||||
### 6. Consistent Output
|
||||
|
||||
- Structured decision collection during conversation
|
||||
- Strict document generation from collected decisions
|
||||
- Validated against hard requirements
|
||||
- Optimized for AI agent consumption
|
||||
|
||||
---
|
||||
|
||||
## Workflow Structure
|
||||
|
||||
```
|
||||
Step 0: Validate workflow and extract project configuration
|
||||
Step 0.5: Validate workflow sequencing
|
||||
Step 1: Load PRD (with FRs/NFRs) and understand project context
|
||||
Step 2: Discover and evaluate starter templates ⭐ NEW
|
||||
Step 3: Adapt facilitation style and identify remaining decisions
|
||||
Step 4: Facilitate collaborative decision making (with version verification)
|
||||
Step 5: Address cross-cutting concerns
|
||||
Step 6: Define project structure and boundaries
|
||||
Step 7: Design novel architectural patterns (when needed) ⭐ NEW
|
||||
Step 8: Define implementation patterns to prevent agent conflicts
|
||||
Step 9: Validate architectural coherence
|
||||
Step 10: Generate decision architecture document (with initialization commands)
|
||||
Step 11: Validate document completeness
|
||||
Step 12: Final review and update workflow status
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Files in This Workflow
|
||||
|
||||
- **workflow.yaml** - Configuration and metadata
|
||||
- **instructions.md** - The adaptive facilitation flow
|
||||
- **decision-catalog.yaml** - Knowledge base of all architectural decisions
|
||||
- **architecture-patterns.yaml** - Common patterns identified from requirements
|
||||
- **pattern-categories.csv** - Pattern principles that teach LLM what needs defining
|
||||
- **checklist.md** - Validation requirements for the output document
|
||||
- **architecture-template.md** - Strict format for the final document
|
||||
|
||||
---
|
||||
|
||||
## How It's Different from Old architecture
|
||||
|
||||
| Aspect | Old Workflow | New Workflow |
|
||||
| -------------------- | -------------------------------------------- | ----------------------------------------------- |
|
||||
| **Approach** | Template-driven | Conversation-driven |
|
||||
| **Project Types** | 11 rigid types with 22+ files | Infinite flexibility with intelligent discovery |
|
||||
| **User Interaction** | Output sections with "Continue?" | Collaborative decision facilitation |
|
||||
| **Skill Adaptation** | One-size-fits-all | Adapts to beginner/intermediate/expert |
|
||||
| **Decision Making** | Late in process (Step 5) | Upfront and central focus |
|
||||
| **Output** | Multiple documents including faux tech-specs | Single decision-focused architecture |
|
||||
| **Time** | Confusing and slow | 30-90 minutes depending on skill level |
|
||||
| **Elicitation** | Never used | Integrated at decision points |
|
||||
|
||||
---
|
||||
|
||||
## Expected Inputs
|
||||
|
||||
- **PRD** (Product Requirements Document) with:
|
||||
- Functional Requirements
|
||||
- Non-Functional Requirements
|
||||
- Performance and compliance needs
|
||||
|
||||
- **UX Spec** (Optional but valuable) with:
|
||||
- Interface designs and interaction patterns
|
||||
- Accessibility requirements (WCAG levels)
|
||||
- Animation and transition needs
|
||||
- Platform-specific UI requirements
|
||||
- Performance expectations for interactions
|
||||
|
||||
---
|
||||
|
||||
## Output Document
|
||||
|
||||
A single `architecture.md` file containing:
|
||||
|
||||
- Executive summary (2-3 sentences)
|
||||
- Project initialization command (if using starter template)
|
||||
- Decision summary table with verified versions and epic mapping
|
||||
- Complete project structure
|
||||
- Integration specifications
|
||||
- Consistency rules for AI agents
|
||||
|
||||
---
|
||||
|
||||
## How Novel Pattern Design Works
|
||||
|
||||
Step 7 handles unique or complex patterns that need to be INVENTED:
|
||||
|
||||
### 1. Detection
|
||||
|
||||
The workflow analyzes the PRD for concepts that don't have standard solutions:
|
||||
|
||||
- Novel interaction patterns (e.g., "swipe to match" when Tinder doesn't exist)
|
||||
- Complex multi-epic workflows (e.g., "viral invitation system")
|
||||
- Unique data relationships (e.g., "social graph" before Facebook)
|
||||
- New paradigms (e.g., "ephemeral messages" before Snapchat)
|
||||
|
||||
### 2. Design Collaboration
|
||||
|
||||
Instead of just picking technologies, the workflow helps DESIGN the solution:
|
||||
|
||||
- Identifies the core problem to solve
|
||||
- Explores different approaches with the user
|
||||
- Documents how components interact
|
||||
- Creates sequence diagrams for complex flows
|
||||
- Uses elicitation to find innovative solutions
|
||||
|
||||
### 3. Documentation
|
||||
|
||||
Novel patterns become part of the architecture with:
|
||||
|
||||
- Pattern name and purpose
|
||||
- Component interactions
|
||||
- Data flow diagrams
|
||||
- Which epics/stories are affected
|
||||
- Implementation guidance for agents
|
||||
|
||||
### 4. Example
|
||||
|
||||
```
|
||||
PRD: "Users can create 'circles' of friends with overlapping membership"
|
||||
↓
|
||||
Workflow detects: This is a novel social structure pattern
|
||||
↓
|
||||
Designs with user: Circle membership model, permission cascading, UI patterns
|
||||
↓
|
||||
Documents: "Circle Pattern" with component design and data flow
|
||||
↓
|
||||
All agents understand how to implement circle-related features consistently
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## How Implementation Patterns Work
|
||||
|
||||
Step 8 prevents agent conflicts by defining patterns for consistency:
|
||||
|
||||
### 1. The Core Principle
|
||||
|
||||
> "Any time multiple agents might make the SAME decision DIFFERENTLY, that's a pattern to capture"
|
||||
|
||||
The LLM asks: "What could an agent encounter where they'd have to guess?"
|
||||
|
||||
### 2. Pattern Categories (principles, not prescriptions)
|
||||
|
||||
- **Naming**: How things are named (APIs, database fields, files)
|
||||
- **Structure**: How things are organized (folders, modules, layers)
|
||||
- **Format**: How data is formatted (JSON structures, responses)
|
||||
- **Communication**: How components talk (events, messages, protocols)
|
||||
- **Lifecycle**: How states change (workflows, transitions)
|
||||
- **Location**: Where things go (URLs, paths, storage)
|
||||
- **Consistency**: Cross-cutting concerns (dates, errors, logs)
|
||||
|
||||
### 3. LLM Intelligence
|
||||
|
||||
- Uses the principle to identify patterns beyond the 7 categories
|
||||
- Figures out what specific patterns matter for chosen tech
|
||||
- Only asks about patterns that could cause conflicts
|
||||
- Skips obvious patterns that the tech choice determines
|
||||
|
||||
### 4. Example
|
||||
|
||||
```
|
||||
Tech chosen: REST API + PostgreSQL + React
|
||||
↓
|
||||
LLM identifies needs:
|
||||
- REST: URL structure, response format, status codes
|
||||
- PostgreSQL: table naming, column naming, FK patterns
|
||||
- React: component structure, state management, test location
|
||||
↓
|
||||
Facilitates each with user
|
||||
↓
|
||||
Documents as Implementation Patterns in architecture
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## How Starter Templates Work
|
||||
|
||||
When the workflow detects a project type that has a starter template:
|
||||
|
||||
1. **Discovery**: Searches for relevant starter templates based on PRD
|
||||
2. **Investigation**: Looks up current CLI options and defaults
|
||||
3. **Presentation**: Shows user what the starter provides
|
||||
4. **Integration**: Documents starter decisions as "PROVIDED BY STARTER"
|
||||
5. **Continuation**: Only asks about decisions NOT made by starter
|
||||
6. **Documentation**: Includes exact initialization command in architecture
|
||||
|
||||
### Example Flow
|
||||
|
||||
```
|
||||
PRD says: "Next.js web application with authentication"
|
||||
↓
|
||||
Workflow finds: create-next-app and create-t3-app
|
||||
↓
|
||||
User chooses: create-t3-app (includes auth setup)
|
||||
↓
|
||||
Starter provides: Next.js, TypeScript, tRPC, Prisma, NextAuth, Tailwind
|
||||
↓
|
||||
Workflow only asks about: Database choice, deployment target, additional services
|
||||
↓
|
||||
First story becomes: "npx create t3-app@latest my-app --trpc --nextauth --prisma"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
# In your BMAD-enabled project
|
||||
workflow architecture
|
||||
```
|
||||
|
||||
The AI agent will:
|
||||
|
||||
1. Load your PRD (with FRs/NFRs)
|
||||
2. Identify critical decisions needed
|
||||
3. Facilitate discussion on each decision
|
||||
4. Generate a comprehensive architecture document
|
||||
5. Validate completeness
|
||||
|
||||
---
|
||||
|
||||
## Design Principles
|
||||
|
||||
1. **Facilitation over Prescription** - Guide users to good decisions rather than imposing templates
|
||||
2. **Intelligence over Templates** - Use AI understanding rather than rigid structures
|
||||
3. **Decisions over Details** - Focus on what prevents agent conflicts, not implementation minutiae
|
||||
4. **Adaptation over Uniformity** - Meet users where they are while ensuring quality output
|
||||
5. **Collaboration over Output** - The conversation matters as much as the document
|
||||
|
||||
---
|
||||
|
||||
## For Developers
|
||||
|
||||
This workflow assumes:
|
||||
|
||||
- Single developer + AI agents (not teams)
|
||||
- Speed matters (decisions in minutes, not days)
|
||||
- AI agents need clear constraints to prevent conflicts
|
||||
- The architecture document is for agents, not humans
|
||||
|
||||
---
|
||||
|
||||
## Migration from architecture
|
||||
|
||||
Projects using the old `architecture` workflow should:
|
||||
|
||||
1. Complete any in-progress architecture work
|
||||
2. Use `architecture` for new projects
|
||||
3. The old workflow remains available but is deprecated
|
||||
|
||||
---
|
||||
|
||||
## Version History
|
||||
|
||||
**1.3.2** - UX specification integration and fuzzy file matching
|
||||
|
||||
- Added UX spec as optional input with fuzzy file matching
|
||||
- Updated workflow.yaml with input file references
|
||||
- Starter template selection now considers UX requirements
|
||||
- Added UX alignment validation to checklist
|
||||
- Instructions use variable references for flexible file names
|
||||
|
||||
**1.3.1** - Workflow refinement and standardization
|
||||
|
||||
- Added workflow status checking at start (Steps 0 and 0.5)
|
||||
- Added workflow status updating at end (Step 12)
|
||||
- Reorganized step numbering for clarity (removed fractional steps)
|
||||
- Enhanced with intent-based approach throughout
|
||||
- Improved cohesiveness across all workflow components
|
||||
|
||||
**1.3.0** - Novel pattern design for unique architectures
|
||||
|
||||
- Added novel pattern design (now Step 7, formerly Step 5.3)
|
||||
- Detects novel concepts in PRD that need architectural invention
|
||||
- Facilitates design collaboration with sequence diagrams
|
||||
- Uses elicitation for innovative approaches
|
||||
- Documents custom patterns for multi-epic consistency
|
||||
|
||||
**1.2.0** - Implementation patterns for agent consistency
|
||||
|
||||
- Added implementation patterns (now Step 8, formerly Step 5.5)
|
||||
- Created principle-based pattern-categories.csv (7 principles, not 118 prescriptions)
|
||||
- Core principle: "What could agents decide differently?"
|
||||
- LLM uses principle to identify patterns beyond the categories
|
||||
- Prevents agent conflicts through intelligent pattern discovery
|
||||
|
||||
**1.1.0** - Enhanced with starter template discovery and version verification
|
||||
|
||||
- Added intelligent starter template detection and integration (now Step 2)
|
||||
- Added dynamic version verification via web search
|
||||
- Starter decisions are documented as "PROVIDED BY STARTER"
|
||||
- First implementation story uses starter initialization command
|
||||
|
||||
**1.0.0** - Initial release replacing architecture workflow
|
||||
|
||||
---
|
||||
|
||||
**Related Documentation:**
|
||||
|
||||
- [Solutioning Workflows](./workflows-solutioning.md)
|
||||
- [Planning Workflows](./workflows-planning.md)
|
||||
- [Scale Adaptive System](./scale-adaptive-system.md)
|
||||
@ -1,489 +0,0 @@
|
||||
# Document Project Workflow - Technical Reference
|
||||
|
||||
**Module:** BMM (BMAD Method Module)
|
||||
**Type:** Action Workflow (Documentation Generator)
|
||||
|
||||
---
|
||||
|
||||
## Purpose
|
||||
|
||||
Analyzes and documents brownfield projects by scanning codebase, architecture, and patterns to create comprehensive reference documentation for AI-assisted development. Generates a master index and multiple documentation files tailored to project structure and type.
|
||||
|
||||
**NEW in v1.2.0:** Context-safe architecture with scan levels, resumability, and write-as-you-go pattern to prevent context exhaustion.
|
||||
|
||||
---
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Multi-Project Type Support**: Handles web, backend, mobile, CLI, game, embedded, data, infra, library, desktop, and extension projects
|
||||
- **Multi-Part Detection**: Automatically detects and documents projects with separate client/server or multiple services
|
||||
- **Three Scan Levels** (NEW v1.2.0): Quick (2-5 min), Deep (10-30 min), Exhaustive (30-120 min)
|
||||
- **Resumability** (NEW v1.2.0): Interrupt and resume workflows without losing progress
|
||||
- **Write-as-you-go** (NEW v1.2.0): Documents written immediately to prevent context exhaustion
|
||||
- **Intelligent Batching** (NEW v1.2.0): Subfolder-based processing for deep/exhaustive scans
|
||||
- **Data-Driven Analysis**: Uses CSV-based project type detection and documentation requirements
|
||||
- **Comprehensive Scanning**: Analyzes APIs, data models, UI components, configuration, security patterns, and more
|
||||
- **Architecture Matching**: Matches projects to 170+ architecture templates from the solutioning registry
|
||||
- **Brownfield PRD Ready**: Generates documentation specifically designed for AI agents planning new features
|
||||
|
||||
---
|
||||
|
||||
## How to Invoke
|
||||
|
||||
```bash
|
||||
workflow document-project
|
||||
```
|
||||
|
||||
Or from BMAD CLI:
|
||||
|
||||
```bash
|
||||
/bmad:bmm:workflows:document-project
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Scan Levels (NEW in v1.2.0)
|
||||
|
||||
Choose the right scan depth for your needs:
|
||||
|
||||
### 1. Quick Scan (Default)
|
||||
|
||||
**Duration:** 2-5 minutes
|
||||
**What it does:** Pattern-based analysis without reading source files
|
||||
**Reads:** Config files, package manifests, directory structure, README
|
||||
**Use when:**
|
||||
|
||||
- You need a fast project overview
|
||||
- Initial understanding of project structure
|
||||
- Planning next steps before deeper analysis
|
||||
|
||||
**Does NOT read:** Source code files (_.js, _.ts, _.py, _.go, etc.)
|
||||
|
||||
### 2. Deep Scan
|
||||
|
||||
**Duration:** 10-30 minutes
|
||||
**What it does:** Reads files in critical directories based on project type
|
||||
**Reads:** Files in critical paths defined by documentation requirements
|
||||
**Use when:**
|
||||
|
||||
- Creating comprehensive documentation for brownfield PRD
|
||||
- Need detailed analysis of key areas
|
||||
- Want balance between depth and speed
|
||||
|
||||
**Example:** For a web app, reads controllers/, models/, components/, but not every utility file
|
||||
|
||||
### 3. Exhaustive Scan
|
||||
|
||||
**Duration:** 30-120 minutes
|
||||
**What it does:** Reads ALL source files in project
|
||||
**Reads:** Every source file (excludes node_modules, dist, build, .git)
|
||||
**Use when:**
|
||||
|
||||
- Complete project analysis needed
|
||||
- Migration planning requires full understanding
|
||||
- Detailed audit of entire codebase
|
||||
- Deep technical debt assessment
|
||||
|
||||
**Note:** Deep-dive mode ALWAYS uses exhaustive scan (no choice)
|
||||
|
||||
---
|
||||
|
||||
## Resumability (NEW in v1.2.0)
|
||||
|
||||
The workflow can be interrupted and resumed without losing progress:
|
||||
|
||||
- **State Tracking:** Progress saved in `project-scan-report.json`
|
||||
- **Auto-Detection:** Workflow detects incomplete runs (<24 hours old)
|
||||
- **Resume Prompt:** Choose to resume or start fresh
|
||||
- **Step-by-Step:** Resume from exact step where interrupted
|
||||
- **Archiving:** Old state files automatically archived
|
||||
|
||||
**Example Resume Flow:**
|
||||
|
||||
```
|
||||
> workflow document-project
|
||||
|
||||
I found an in-progress workflow state from 2025-10-11 14:32:15.
|
||||
|
||||
Current Progress:
|
||||
- Mode: initial_scan
|
||||
- Scan Level: deep
|
||||
- Completed Steps: 5/12
|
||||
- Last Step: step_5
|
||||
|
||||
Would you like to:
|
||||
1. Resume from where we left off - Continue from step 6
|
||||
2. Start fresh - Archive old state and begin new scan
|
||||
3. Cancel - Exit without changes
|
||||
|
||||
Your choice [1/2/3]:
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## What It Does
|
||||
|
||||
### Step-by-Step Process
|
||||
|
||||
1. **Detects Project Structure** - Identifies if project is single-part or multi-part (client/server/etc.)
|
||||
2. **Classifies Project Type** - Matches against 12 project types (web, backend, mobile, etc.)
|
||||
3. **Discovers Documentation** - Finds existing README, CONTRIBUTING, ARCHITECTURE files
|
||||
4. **Analyzes Tech Stack** - Parses package files, identifies frameworks, versions, dependencies
|
||||
5. **Conditional Scanning** - Performs targeted analysis based on project type requirements:
|
||||
- API routes and endpoints
|
||||
- Database models and schemas
|
||||
- State management patterns
|
||||
- UI component libraries
|
||||
- Configuration and security
|
||||
- CI/CD and deployment configs
|
||||
6. **Generates Source Tree** - Creates annotated directory structure with critical paths
|
||||
7. **Extracts Dev Instructions** - Documents setup, build, run, and test commands
|
||||
8. **Creates Architecture Docs** - Generates detailed architecture using matched templates
|
||||
9. **Builds Master Index** - Creates comprehensive index.md as primary AI retrieval source
|
||||
10. **Validates Output** - Runs 140+ point checklist to ensure completeness
|
||||
|
||||
### Output Files
|
||||
|
||||
**Single-Part Projects:**
|
||||
|
||||
- `index.md` - Master index
|
||||
- `project-overview.md` - Executive summary
|
||||
- `architecture.md` - Detailed architecture
|
||||
- `source-tree-analysis.md` - Annotated directory tree
|
||||
- `component-inventory.md` - Component catalog (if applicable)
|
||||
- `development-guide.md` - Local dev instructions
|
||||
- `api-contracts.md` - API documentation (if applicable)
|
||||
- `data-models.md` - Database schema (if applicable)
|
||||
- `deployment-guide.md` - Deployment process (optional)
|
||||
- `contribution-guide.md` - Contributing guidelines (optional)
|
||||
- `project-scan-report.json` - State file for resumability (NEW v1.2.0)
|
||||
|
||||
**Multi-Part Projects (e.g., client + server):**
|
||||
|
||||
- `index.md` - Master index with part navigation
|
||||
- `project-overview.md` - Multi-part summary
|
||||
- `architecture-{part_id}.md` - Per-part architecture docs
|
||||
- `source-tree-analysis.md` - Full tree with part annotations
|
||||
- `component-inventory-{part_id}.md` - Per-part components
|
||||
- `development-guide-{part_id}.md` - Per-part dev guides
|
||||
- `integration-architecture.md` - How parts communicate
|
||||
- `project-parts.json` - Machine-readable metadata
|
||||
- `project-scan-report.json` - State file for resumability (NEW v1.2.0)
|
||||
- Additional conditional files per part (API, data models, etc.)
|
||||
|
||||
---
|
||||
|
||||
## Data Files
|
||||
|
||||
The workflow uses a single comprehensive CSV file:
|
||||
|
||||
**documentation-requirements.csv** - Complete project analysis guide
|
||||
|
||||
- Location: `/.bmad/bmm/workflows/document-project/documentation-requirements.csv`
|
||||
- 12 project types (web, mobile, backend, cli, library, desktop, game, data, extension, infra, embedded)
|
||||
- 24 columns combining:
|
||||
- **Detection columns**: `project_type_id`, `key_file_patterns` (identifies project type from codebase)
|
||||
- **Requirement columns**: `requires_api_scan`, `requires_data_models`, `requires_ui_components`, etc.
|
||||
- **Pattern columns**: `critical_directories`, `test_file_patterns`, `config_patterns`, etc.
|
||||
- Self-contained: All project detection AND scanning requirements in one file
|
||||
- Architecture patterns inferred from tech stack (no external registry needed)
|
||||
|
||||
---
|
||||
|
||||
## Use Cases
|
||||
|
||||
### Primary Use Case: Brownfield PRD Creation
|
||||
|
||||
After running this workflow, use the generated `index.md` as input to brownfield PRD workflows:
|
||||
|
||||
```
|
||||
User: "I want to add a new dashboard feature"
|
||||
PRD Workflow: Loads docs/index.md
|
||||
→ Understands existing architecture
|
||||
→ Identifies reusable components
|
||||
→ Plans integration with existing APIs
|
||||
→ Creates contextual PRD with FRs and NFRs
|
||||
Architecture Workflow: Creates architecture design
|
||||
Create-Epics-and-Stories Workflow: Breaks down into epics and stories
|
||||
```
|
||||
|
||||
### Other Use Cases
|
||||
|
||||
- **Onboarding New Developers** - Comprehensive project documentation
|
||||
- **Architecture Review** - Structured analysis of existing system
|
||||
- **Technical Debt Assessment** - Identify patterns and anti-patterns
|
||||
- **Migration Planning** - Understand current state before refactoring
|
||||
|
||||
---
|
||||
|
||||
## Requirements
|
||||
|
||||
### Recommended Inputs (Optional)
|
||||
|
||||
- Project root directory (defaults to current directory)
|
||||
- README.md or similar docs (auto-discovered if present)
|
||||
- User guidance on key areas to focus (workflow will ask)
|
||||
|
||||
### Tools Used
|
||||
|
||||
- File system scanning (Glob, Read, Grep)
|
||||
- Code analysis
|
||||
- Git repository analysis (optional)
|
||||
|
||||
---
|
||||
|
||||
## Configuration
|
||||
|
||||
### Default Output Location
|
||||
|
||||
Files are saved to: `{output_folder}` (from config.yaml)
|
||||
|
||||
Default: `/docs/` folder in project root
|
||||
|
||||
### Customization
|
||||
|
||||
- Modify `documentation-requirements.csv` to adjust scanning patterns for project types
|
||||
- Add new project types to `project-types.csv`
|
||||
- Add new architecture templates to `registry.csv`
|
||||
|
||||
---
|
||||
|
||||
## Example: Multi-Part Web App
|
||||
|
||||
**Input:**
|
||||
|
||||
```
|
||||
my-app/
|
||||
├── client/ # React frontend
|
||||
├── server/ # Express backend
|
||||
└── README.md
|
||||
```
|
||||
|
||||
**Detection Result:**
|
||||
|
||||
- Repository Type: Monorepo
|
||||
- Part 1: client (web/React)
|
||||
- Part 2: server (backend/Express)
|
||||
|
||||
**Output (10+ files):**
|
||||
|
||||
```
|
||||
docs/
|
||||
├── index.md
|
||||
├── project-overview.md
|
||||
├── architecture-client.md
|
||||
├── architecture-server.md
|
||||
├── source-tree-analysis.md
|
||||
├── component-inventory-client.md
|
||||
├── development-guide-client.md
|
||||
├── development-guide-server.md
|
||||
├── api-contracts-server.md
|
||||
├── data-models-server.md
|
||||
├── integration-architecture.md
|
||||
└── project-parts.json
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Example: Simple CLI Tool
|
||||
|
||||
**Input:**
|
||||
|
||||
```
|
||||
hello-cli/
|
||||
├── main.go
|
||||
├── go.mod
|
||||
└── README.md
|
||||
```
|
||||
|
||||
**Detection Result:**
|
||||
|
||||
- Repository Type: Monolith
|
||||
- Part 1: main (cli/Go)
|
||||
|
||||
**Output (4 files):**
|
||||
|
||||
```
|
||||
docs/
|
||||
├── index.md
|
||||
├── project-overview.md
|
||||
├── architecture.md
|
||||
└── source-tree-analysis.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Deep-Dive Mode
|
||||
|
||||
### What is Deep-Dive Mode?
|
||||
|
||||
When you run the workflow on a project that already has documentation, you'll be offered a choice:
|
||||
|
||||
1. **Rescan entire project** - Update all documentation with latest changes
|
||||
2. **Deep-dive into specific area** - Generate EXHAUSTIVE documentation for a particular feature/module/folder
|
||||
3. **Cancel** - Keep existing documentation
|
||||
|
||||
Deep-dive mode performs **comprehensive, file-by-file analysis** of a specific area, reading EVERY file completely and documenting:
|
||||
|
||||
- All exports with complete signatures
|
||||
- All imports and dependencies
|
||||
- Dependency graphs and data flow
|
||||
- Code patterns and implementations
|
||||
- Testing coverage and strategies
|
||||
- Integration points
|
||||
- Reuse opportunities
|
||||
|
||||
### When to Use Deep-Dive Mode
|
||||
|
||||
- **Before implementing a feature** - Deep-dive the area you'll be modifying
|
||||
- **During architecture review** - Deep-dive complex modules
|
||||
- **For code understanding** - Deep-dive unfamiliar parts of codebase
|
||||
- **When creating PRDs** - Deep-dive areas affected by new features
|
||||
|
||||
### Deep-Dive Process
|
||||
|
||||
1. Workflow detects existing `index.md`
|
||||
2. Offers deep-dive option
|
||||
3. Suggests areas based on project structure:
|
||||
- API route groups
|
||||
- Feature modules
|
||||
- UI component areas
|
||||
- Services/business logic
|
||||
4. You select area or specify custom path
|
||||
5. Workflow reads EVERY file in that area
|
||||
6. Generates `deep-dive-{area-name}.md` with complete analysis
|
||||
7. Updates `index.md` with link to deep-dive doc
|
||||
8. Offers to deep-dive another area or finish
|
||||
|
||||
### Deep-Dive Output Example
|
||||
|
||||
**docs/deep-dive-dashboard-feature.md:**
|
||||
|
||||
- Complete file inventory (47 files analyzed)
|
||||
- Every export with signatures
|
||||
- Dependency graph
|
||||
- Data flow analysis
|
||||
- Integration points
|
||||
- Testing coverage
|
||||
- Related code references
|
||||
- Implementation guidance
|
||||
- ~3,000 LOC documented in detail
|
||||
|
||||
### Incremental Deep-Diving
|
||||
|
||||
You can deep-dive multiple areas over time:
|
||||
|
||||
- First run: Scan entire project → generates index.md
|
||||
- Second run: Deep-dive dashboard feature
|
||||
- Third run: Deep-dive API layer
|
||||
- Fourth run: Deep-dive authentication system
|
||||
|
||||
All deep-dive docs are linked from the master index.
|
||||
|
||||
---
|
||||
|
||||
## Validation
|
||||
|
||||
The workflow includes a comprehensive 160+ point checklist covering:
|
||||
|
||||
- Project detection accuracy
|
||||
- Technology stack completeness
|
||||
- Codebase scanning thoroughness
|
||||
- Architecture documentation quality
|
||||
- Multi-part handling (if applicable)
|
||||
- Brownfield PRD readiness
|
||||
- Deep-dive completeness (if applicable)
|
||||
|
||||
---
|
||||
|
||||
## Next Steps After Completion
|
||||
|
||||
1. **Review** `docs/index.md` - Your master documentation index
|
||||
2. **Validate** - Check generated docs for accuracy
|
||||
3. **Use for PRD** - Point brownfield PRD workflow to index.md
|
||||
4. **Maintain** - Re-run workflow when architecture changes significantly
|
||||
|
||||
---
|
||||
|
||||
## File Structure
|
||||
|
||||
```
|
||||
document-project/
|
||||
├── workflow.yaml # Workflow configuration
|
||||
├── instructions.md # Step-by-step workflow logic
|
||||
├── checklist.md # Validation criteria
|
||||
├── documentation-requirements.csv # Project type scanning patterns
|
||||
├── templates/ # Output templates
|
||||
│ ├── index-template.md
|
||||
│ ├── project-overview-template.md
|
||||
│ └── source-tree-template.md
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Issue: Project type not detected correctly**
|
||||
|
||||
- Solution: Workflow will ask for confirmation; manually select correct type
|
||||
|
||||
**Issue: Missing critical information**
|
||||
|
||||
- Solution: Provide additional context when prompted; re-run specific analysis steps
|
||||
|
||||
**Issue: Multi-part detection missed a part**
|
||||
|
||||
- Solution: When asked to confirm parts, specify the missing part and its path
|
||||
|
||||
**Issue: Architecture template doesn't match well**
|
||||
|
||||
- Solution: Check registry.csv; may need to add new template or adjust matching criteria
|
||||
|
||||
---
|
||||
|
||||
## Architecture Improvements in v1.2.0
|
||||
|
||||
### Context-Safe Design
|
||||
|
||||
The workflow now uses a write-as-you-go architecture:
|
||||
|
||||
- Documents written immediately to disk (not accumulated in memory)
|
||||
- Detailed findings purged after writing (only summaries kept)
|
||||
- State tracking enables resumption from any step
|
||||
- Batching strategy prevents context exhaustion on large projects
|
||||
|
||||
### Batching Strategy
|
||||
|
||||
For deep/exhaustive scans:
|
||||
|
||||
- Process ONE subfolder at a time
|
||||
- Read files → Extract info → Write output → Validate → Purge context
|
||||
- Primary concern is file SIZE (not count)
|
||||
- Track batches in state file for resumability
|
||||
|
||||
### State File Format
|
||||
|
||||
Optimized JSON (no pretty-printing):
|
||||
|
||||
```json
|
||||
{
|
||||
"workflow_version": "1.2.0",
|
||||
"timestamps": {...},
|
||||
"mode": "initial_scan",
|
||||
"scan_level": "deep",
|
||||
"completed_steps": [...],
|
||||
"current_step": "step_6",
|
||||
"findings": {"summary": "only"},
|
||||
"outputs_generated": [...],
|
||||
"resume_instructions": "..."
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**Related Documentation:**
|
||||
|
||||
- [Brownfield Development Guide](./brownfield-guide.md)
|
||||
- [Implementation Workflows](./workflows-implementation.md)
|
||||
- [Scale Adaptive System](./scale-adaptive-system.md)
|
||||
@ -1,370 +0,0 @@
|
||||
# BMM Analysis Workflows (Phase 1)
|
||||
|
||||
**Reading Time:** ~7 minutes
|
||||
|
||||
## Overview
|
||||
|
||||
Phase 1 (Analysis) workflows are **optional** exploration and discovery tools that help validate ideas, understand markets, and generate strategic context before planning begins.
|
||||
|
||||
**Key principle:** Analysis workflows help you think strategically before committing to implementation. Skip them if your requirements are already clear.
|
||||
|
||||
**When to use:** Starting new projects, exploring opportunities, validating market fit, generating ideas, understanding problem spaces.
|
||||
|
||||
**When to skip:** Continuing existing projects with clear requirements, well-defined features with known solutions, strict constraints where discovery is complete.
|
||||
|
||||
---
|
||||
|
||||
## Phase 1 Analysis Workflow Map
|
||||
|
||||
```mermaid
|
||||
%%{init: {'theme':'base', 'themeVariables': { 'primaryColor':'#fff','primaryTextColor':'#000','primaryBorderColor':'#000','lineColor':'#000','fontSize':'16px','fontFamily':'arial'}}}%%
|
||||
graph TB
|
||||
subgraph Discovery["<b>DISCOVERY & IDEATION (Optional)</b>"]
|
||||
direction LR
|
||||
BrainstormProject["<b>Analyst: brainstorm-project</b><br/>Multi-track solution exploration"]
|
||||
BrainstormGame["<b>Analyst: brainstorm-game</b><br/>Game concept generation"]
|
||||
end
|
||||
|
||||
subgraph Research["<b>RESEARCH & VALIDATION (Optional)</b>"]
|
||||
direction TB
|
||||
ResearchWF["<b>Analyst: research</b><br/>• market (TAM/SAM/SOM)<br/>• technical (framework evaluation)<br/>• competitive (landscape)<br/>• user (personas, JTBD)<br/>• domain (industry analysis)<br/>• deep_prompt (AI research)"]
|
||||
end
|
||||
|
||||
subgraph Strategy["<b>STRATEGIC CAPTURE (Recommended for Greenfield)</b>"]
|
||||
direction LR
|
||||
ProductBrief["<b>Analyst: product-brief</b><br/>Product vision + strategy<br/>(Interactive or YOLO mode)"]
|
||||
GameBrief["<b>Game Designer: game-brief</b><br/>Game vision capture<br/>(Interactive or YOLO mode)"]
|
||||
end
|
||||
|
||||
Discovery -.->|Software| ProductBrief
|
||||
Discovery -.->|Games| GameBrief
|
||||
Discovery -.->|Validate ideas| Research
|
||||
Research -.->|Inform brief| ProductBrief
|
||||
Research -.->|Inform brief| GameBrief
|
||||
ProductBrief --> Phase2["<b>Phase 2: prd workflow</b>"]
|
||||
GameBrief --> Phase2Game["<b>Phase 2: gdd workflow</b>"]
|
||||
Research -.->|Can feed directly| Phase2
|
||||
|
||||
style Discovery fill:#e1f5fe,stroke:#01579b,stroke-width:3px,color:#000
|
||||
style Research fill:#fff9c4,stroke:#f57f17,stroke-width:3px,color:#000
|
||||
style Strategy fill:#f3e5f5,stroke:#4a148c,stroke-width:3px,color:#000
|
||||
style Phase2 fill:#c8e6c9,stroke:#2e7d32,stroke-width:2px,color:#000
|
||||
style Phase2Game fill:#c8e6c9,stroke:#2e7d32,stroke-width:2px,color:#000
|
||||
|
||||
style BrainstormProject fill:#81d4fa,stroke:#0277bd,stroke-width:2px,color:#000
|
||||
style BrainstormGame fill:#81d4fa,stroke:#0277bd,stroke-width:2px,color:#000
|
||||
style ResearchWF fill:#fff59d,stroke:#f57f17,stroke-width:2px,color:#000
|
||||
style ProductBrief fill:#ce93d8,stroke:#6a1b9a,stroke-width:2px,color:#000
|
||||
style GameBrief fill:#ce93d8,stroke:#6a1b9a,stroke-width:2px,color:#000
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Quick Reference
|
||||
|
||||
| Workflow | Agent | Required | Purpose | Output |
|
||||
| ---------------------- | ------------- | ----------- | -------------------------------------------------------------- | ---------------------------- |
|
||||
| **brainstorm-project** | Analyst | No | Explore solution approaches and architectures | Solution options + rationale |
|
||||
| **brainstorm-game** | Analyst | No | Generate game concepts using creative techniques | Game concepts + evaluation |
|
||||
| **research** | Analyst | No | Multi-type research (market/technical/competitive/user/domain) | Research reports |
|
||||
| **product-brief** | Analyst | Recommended | Define product vision and strategy (interactive) | Product Brief document |
|
||||
| **game-brief** | Game Designer | Recommended | Capture game vision before GDD (interactive) | Game Brief document |
|
||||
|
||||
---
|
||||
|
||||
## Workflow Descriptions
|
||||
|
||||
### brainstorm-project
|
||||
|
||||
**Purpose:** Generate multiple solution approaches through parallel ideation tracks (architecture, UX, integration, value).
|
||||
|
||||
**Agent:** Analyst
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- Unclear technical approach with business objectives
|
||||
- Multiple solution paths need evaluation
|
||||
- Hidden assumptions need discovery
|
||||
- Innovation beyond obvious solutions
|
||||
|
||||
**Key Outputs:**
|
||||
|
||||
- Architecture proposals with trade-off analysis
|
||||
- Value framework (prioritized features)
|
||||
- Risk analysis (dependencies, challenges)
|
||||
- Strategic recommendation with rationale
|
||||
|
||||
**Example:** "We need a customer dashboard" → Options: Monolith SSR (faster), Microservices SPA (scalable), Hybrid (balanced) with recommendation.
|
||||
|
||||
---
|
||||
|
||||
### brainstorm-game
|
||||
|
||||
**Purpose:** Generate game concepts through systematic creative exploration using five brainstorming techniques.
|
||||
|
||||
**Agent:** Analyst
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- Generating original game concepts
|
||||
- Exploring variations on themes
|
||||
- Breaking creative blocks
|
||||
- Validating game ideas against constraints
|
||||
|
||||
**Techniques Used:**
|
||||
|
||||
- SCAMPER (systematic modification)
|
||||
- Mind Mapping (hierarchical exploration)
|
||||
- Lotus Blossom (radial expansion)
|
||||
- Six Thinking Hats (multi-perspective)
|
||||
- Random Word Association (lateral thinking)
|
||||
|
||||
**Key Outputs:**
|
||||
|
||||
- Method-specific artifacts (5 separate documents)
|
||||
- Consolidated concept document with feasibility
|
||||
- Design pillar alignment matrix
|
||||
|
||||
**Example:** "Roguelike with psychological themes" → Emotions as characters, inner demons as enemies, therapy sessions as rest points, deck composition affects narrative.
|
||||
|
||||
---
|
||||
|
||||
### research
|
||||
|
||||
**Purpose:** Comprehensive multi-type research system consolidating market, technical, competitive, user, and domain analysis.
|
||||
|
||||
**Agent:** Analyst
|
||||
|
||||
**Research Types:**
|
||||
|
||||
| Type | Purpose | Use When |
|
||||
| --------------- | ------------------------------------------------------ | ----------------------------------- |
|
||||
| **market** | TAM/SAM/SOM, competitive analysis | Need market viability validation |
|
||||
| **technical** | Technology evaluation, ADRs | Choosing frameworks/platforms |
|
||||
| **competitive** | Deep competitor analysis | Understanding competitive landscape |
|
||||
| **user** | Customer insights, personas, JTBD | Need user understanding |
|
||||
| **domain** | Industry deep dives, trends | Understanding domain/industry |
|
||||
| **deep_prompt** | Generate AI research prompts (ChatGPT, Claude, Gemini) | Need deeper AI-assisted research |
|
||||
|
||||
**Key Features:**
|
||||
|
||||
- Real-time web research
|
||||
- Multiple analytical frameworks (Porter's Five Forces, SWOT, Technology Adoption Lifecycle)
|
||||
- Platform-specific optimization for deep_prompt type
|
||||
- Configurable research depth (quick/standard/comprehensive)
|
||||
|
||||
**Example (market):** "SaaS project management tool" → TAM $50B, SAM $5B, SOM $50M, top competitors (Asana, Monday), positioning recommendation.
|
||||
|
||||
---
|
||||
|
||||
### product-brief
|
||||
|
||||
**Purpose:** Interactive product brief creation that guides strategic product vision definition.
|
||||
|
||||
**Agent:** Analyst
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- Starting new product/major feature initiative
|
||||
- Aligning stakeholders before detailed planning
|
||||
- Transitioning from exploration to strategy
|
||||
- Need executive-level product documentation
|
||||
|
||||
**Modes:**
|
||||
|
||||
- **Interactive Mode** (Recommended): Step-by-step collaborative development with probing questions
|
||||
- **YOLO Mode**: AI generates complete draft from context, then iterative refinement
|
||||
|
||||
**Key Outputs:**
|
||||
|
||||
- Executive summary
|
||||
- Problem statement with evidence
|
||||
- Proposed solution and differentiators
|
||||
- Target users (segmented)
|
||||
- MVP scope (ruthlessly defined)
|
||||
- Financial impact and ROI
|
||||
- Strategic alignment
|
||||
- Risks and open questions
|
||||
|
||||
**Integration:** Feeds directly into PRD workflow (Phase 2).
|
||||
|
||||
---
|
||||
|
||||
### game-brief
|
||||
|
||||
**Purpose:** Lightweight interactive brainstorming session capturing game vision before Game Design Document.
|
||||
|
||||
**Agent:** Game Designer
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- Starting new game project
|
||||
- Exploring game ideas before committing
|
||||
- Pitching concepts to team/stakeholders
|
||||
- Validating market fit and feasibility
|
||||
|
||||
**Game Brief vs GDD:**
|
||||
|
||||
| Aspect | Game Brief | GDD |
|
||||
| ------------ | ------------------ | ------------------------- |
|
||||
| Purpose | Validate concept | Design for implementation |
|
||||
| Detail Level | High-level vision | Detailed specs |
|
||||
| Format | Conversational | Structured |
|
||||
| Output | Concise vision doc | Comprehensive design |
|
||||
|
||||
**Key Outputs:**
|
||||
|
||||
- Game vision (concept, pitch)
|
||||
- Target market and positioning
|
||||
- Core gameplay pillars
|
||||
- Scope and constraints
|
||||
- Reference framework
|
||||
- Risk assessment
|
||||
- Success criteria
|
||||
|
||||
**Integration:** Feeds into GDD workflow (Phase 2).
|
||||
|
||||
---
|
||||
|
||||
## Decision Guide
|
||||
|
||||
### Starting a Software Project
|
||||
|
||||
```
|
||||
brainstorm-project (if unclear) → research (market/technical) → product-brief → Phase 2 (prd)
|
||||
```
|
||||
|
||||
### Starting a Game Project
|
||||
|
||||
```
|
||||
brainstorm-game (if generating concepts) → research (market/competitive) → game-brief → Phase 2 (gdd)
|
||||
```
|
||||
|
||||
### Validating an Idea
|
||||
|
||||
```
|
||||
research (market type) → product-brief or game-brief → Phase 2
|
||||
```
|
||||
|
||||
### Technical Decision Only
|
||||
|
||||
```
|
||||
research (technical type) → Use findings in Phase 3 (architecture)
|
||||
```
|
||||
|
||||
### Understanding Market
|
||||
|
||||
```
|
||||
research (market/competitive type) → product-brief → Phase 2
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Integration with Phase 2 (Planning)
|
||||
|
||||
Analysis outputs feed directly into Planning:
|
||||
|
||||
| Analysis Output | Planning Input |
|
||||
| --------------------------- | -------------------------- |
|
||||
| product-brief.md | **prd** workflow |
|
||||
| game-brief.md | **gdd** workflow |
|
||||
| market-research.md | **prd** context |
|
||||
| technical-research.md | **architecture** (Phase 3) |
|
||||
| competitive-intelligence.md | **prd** positioning |
|
||||
|
||||
Planning workflows automatically load these documents if they exist in the output folder.
|
||||
|
||||
---
|
||||
|
||||
## Best Practices
|
||||
|
||||
### 1. Don't Over-Invest in Analysis
|
||||
|
||||
Analysis is optional. If requirements are clear, skip to Phase 2 (Planning).
|
||||
|
||||
### 2. Iterate Between Workflows
|
||||
|
||||
Common pattern: brainstorm → research (validate) → brief (synthesize)
|
||||
|
||||
### 3. Document Assumptions
|
||||
|
||||
Analysis surfaces and validates assumptions. Document them explicitly for planning to challenge.
|
||||
|
||||
### 4. Keep It Strategic
|
||||
|
||||
Focus on "what" and "why", not "how". Leave implementation for Planning and Solutioning.
|
||||
|
||||
### 5. Involve Stakeholders
|
||||
|
||||
Use analysis workflows to align stakeholders before committing to detailed planning.
|
||||
|
||||
---
|
||||
|
||||
## Common Patterns
|
||||
|
||||
### Greenfield Software (Full Analysis)
|
||||
|
||||
```
|
||||
1. brainstorm-project - explore approaches
|
||||
2. research (market) - validate viability
|
||||
3. product-brief - capture strategic vision
|
||||
4. → Phase 2: prd
|
||||
```
|
||||
|
||||
### Greenfield Game (Full Analysis)
|
||||
|
||||
```
|
||||
1. brainstorm-game - generate concepts
|
||||
2. research (competitive) - understand landscape
|
||||
3. game-brief - capture vision
|
||||
4. → Phase 2: gdd
|
||||
```
|
||||
|
||||
### Skip Analysis (Clear Requirements)
|
||||
|
||||
```
|
||||
→ Phase 2: prd or tech-spec directly
|
||||
```
|
||||
|
||||
### Technical Research Only
|
||||
|
||||
```
|
||||
1. research (technical) - evaluate technologies
|
||||
2. → Phase 3: architecture (use findings in ADRs)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Phase 2: Planning Workflows](./workflows-planning.md) - Next phase
|
||||
- [Phase 3: Solutioning Workflows](./workflows-solutioning.md)
|
||||
- [Phase 4: Implementation Workflows](./workflows-implementation.md)
|
||||
- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding project complexity
|
||||
- [Agents Guide](./agents-guide.md) - Complete agent reference
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Q: Do I need to run all analysis workflows?**
|
||||
A: No! Analysis is entirely optional. Use only workflows that help you think through your problem.
|
||||
|
||||
**Q: Which workflow should I start with?**
|
||||
A: If unsure, start with `research` (market type) to validate viability, then move to `product-brief` or `game-brief`.
|
||||
|
||||
**Q: Can I skip straight to Planning?**
|
||||
A: Yes! If you know what you're building and why, skip Phase 1 entirely and start with Phase 2 (prd/gdd/tech-spec).
|
||||
|
||||
**Q: How long should Analysis take?**
|
||||
A: Typically hours to 1-2 days. If taking longer, you may be over-analyzing. Move to Planning.
|
||||
|
||||
**Q: What if I discover problems during Analysis?**
|
||||
A: That's the point! Analysis helps you fail fast and pivot before heavy planning investment.
|
||||
|
||||
**Q: Should brownfield projects do Analysis?**
|
||||
A: Usually no. Start with `document-project` (Phase 0), then skip to Planning (Phase 2).
|
||||
|
||||
---
|
||||
|
||||
_Phase 1 Analysis - Optional strategic thinking before commitment._
|
||||
@ -1,296 +0,0 @@
|
||||
# BMM Implementation Workflows (Phase 4)
|
||||
|
||||
**Reading Time:** ~8 minutes
|
||||
|
||||
## Overview
|
||||
|
||||
Phase 4 (Implementation) workflows manage the iterative sprint-based development cycle using a **story-centric workflow** where each story moves through a defined lifecycle from creation to completion.
|
||||
|
||||
**Key principle:** One story at a time, move it through the entire lifecycle before starting the next.
|
||||
|
||||
---
|
||||
|
||||
## Complete Workflow Context
|
||||
|
||||
Phase 4 is the final phase of the BMad Method workflow. To see how implementation fits into the complete methodology:
|
||||
|
||||
|
||||
|
||||
_Complete workflow showing Phases 1-4. Phase 4 (Implementation) is the rightmost column, showing the iterative epic and story cycles detailed below._
|
||||
|
||||
---
|
||||
|
||||
## Phase 4 Workflow Lifecycle
|
||||
|
||||
```mermaid
|
||||
%%{init: {'theme':'base', 'themeVariables': { 'primaryColor':'#fff','primaryTextColor':'#000','primaryBorderColor':'#000','lineColor':'#000','fontSize':'16px','fontFamily':'arial'}}}%%
|
||||
graph TB
|
||||
subgraph Setup["<b>SPRINT SETUP - Run Once</b>"]
|
||||
direction TB
|
||||
SprintPlanning["<b>SM: sprint-planning</b><br/>Initialize sprint status file"]
|
||||
end
|
||||
|
||||
subgraph EpicCycle["<b>EPIC CYCLE - Repeat Per Epic</b>"]
|
||||
direction TB
|
||||
EpicContext["<b>SM: epic-tech-context</b><br/>Generate epic technical guidance"]
|
||||
ValidateEpic["<b>SM: validate-epic-tech-context</b><br/>(Optional validation)"]
|
||||
|
||||
EpicContext -.->|Optional| ValidateEpic
|
||||
ValidateEpic -.-> StoryLoopStart
|
||||
EpicContext --> StoryLoopStart[Start Story Loop]
|
||||
end
|
||||
|
||||
subgraph StoryLoop["<b>STORY LIFECYCLE - Repeat Per Story</b>"]
|
||||
direction TB
|
||||
|
||||
CreateStory["<b>SM: create-story</b><br/>Create next story from queue"]
|
||||
ValidateStory["<b>SM: validate-create-story</b><br/>(Optional validation)"]
|
||||
StoryContext["<b>SM: story-context</b><br/>Assemble dynamic context"]
|
||||
StoryReady["<b>SM: story-ready-for-dev</b><br/>Mark ready without context"]
|
||||
ValidateContext["<b>SM: validate-story-context</b><br/>(Optional validation)"]
|
||||
DevStory["<b>DEV: develop-story</b><br/>Implement with tests"]
|
||||
CodeReview["<b>DEV: code-review</b><br/>Senior dev review"]
|
||||
StoryDone["<b>DEV: story-done</b><br/>Mark complete, advance queue"]
|
||||
|
||||
CreateStory -.->|Optional| ValidateStory
|
||||
ValidateStory -.-> StoryContext
|
||||
CreateStory --> StoryContext
|
||||
CreateStory -.->|Alternative| StoryReady
|
||||
StoryContext -.->|Optional| ValidateContext
|
||||
ValidateContext -.-> DevStory
|
||||
StoryContext --> DevStory
|
||||
StoryReady -.-> DevStory
|
||||
DevStory --> CodeReview
|
||||
CodeReview -.->|Needs fixes| DevStory
|
||||
CodeReview --> StoryDone
|
||||
StoryDone -.->|Next story| CreateStory
|
||||
end
|
||||
|
||||
subgraph EpicClose["<b>EPIC COMPLETION</b>"]
|
||||
direction TB
|
||||
Retrospective["<b>SM: epic-retrospective</b><br/>Post-epic lessons learned"]
|
||||
end
|
||||
|
||||
subgraph Support["<b>SUPPORTING WORKFLOWS</b>"]
|
||||
direction TB
|
||||
CorrectCourse["<b>SM: correct-course</b><br/>Handle mid-sprint changes"]
|
||||
WorkflowStatus["<b>Any Agent: workflow-status</b><br/>Check what's next"]
|
||||
end
|
||||
|
||||
Setup --> EpicCycle
|
||||
EpicCycle --> StoryLoop
|
||||
StoryLoop --> EpicClose
|
||||
EpicClose -.->|Next epic| EpicCycle
|
||||
StoryLoop -.->|If issues arise| CorrectCourse
|
||||
StoryLoop -.->|Anytime| WorkflowStatus
|
||||
EpicCycle -.->|Anytime| WorkflowStatus
|
||||
|
||||
style Setup fill:#e3f2fd,stroke:#1565c0,stroke-width:3px,color:#000
|
||||
style EpicCycle fill:#c5e1a5,stroke:#33691e,stroke-width:3px,color:#000
|
||||
style StoryLoop fill:#f3e5f5,stroke:#6a1b9a,stroke-width:3px,color:#000
|
||||
style EpicClose fill:#ffcc80,stroke:#e65100,stroke-width:3px,color:#000
|
||||
style Support fill:#fff3e0,stroke:#e65100,stroke-width:3px,color:#000
|
||||
|
||||
style SprintPlanning fill:#90caf9,stroke:#0d47a1,stroke-width:2px,color:#000
|
||||
style EpicContext fill:#aed581,stroke:#1b5e20,stroke-width:2px,color:#000
|
||||
style ValidateEpic fill:#c5e1a5,stroke:#33691e,stroke-width:1px,color:#000
|
||||
style CreateStory fill:#ce93d8,stroke:#4a148c,stroke-width:2px,color:#000
|
||||
style ValidateStory fill:#e1bee7,stroke:#6a1b9a,stroke-width:1px,color:#000
|
||||
style StoryContext fill:#ce93d8,stroke:#4a148c,stroke-width:2px,color:#000
|
||||
style StoryReady fill:#ce93d8,stroke:#4a148c,stroke-width:2px,color:#000
|
||||
style ValidateContext fill:#e1bee7,stroke:#6a1b9a,stroke-width:1px,color:#000
|
||||
style DevStory fill:#a5d6a7,stroke:#1b5e20,stroke-width:2px,color:#000
|
||||
style CodeReview fill:#a5d6a7,stroke:#1b5e20,stroke-width:2px,color:#000
|
||||
style StoryDone fill:#a5d6a7,stroke:#1b5e20,stroke-width:2px,color:#000
|
||||
style Retrospective fill:#ffb74d,stroke:#e65100,stroke-width:2px,color:#000
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Quick Reference
|
||||
|
||||
| Workflow | Agent | When | Purpose |
|
||||
| ------------------------------ | ----- | -------------------------------- | ------------------------------------------- |
|
||||
| **sprint-planning** | SM | Once at Phase 4 start | Initialize sprint tracking file |
|
||||
| **epic-tech-context** | SM | Per epic | Generate epic-specific technical guidance |
|
||||
| **validate-epic-tech-context** | SM | Optional after epic-tech-context | Validate tech spec against checklist |
|
||||
| **create-story** | SM | Per story | Create next story from epic backlog |
|
||||
| **validate-create-story** | SM | Optional after create-story | Independent validation of story draft |
|
||||
| **story-context** | SM | Optional per story | Assemble dynamic story context XML |
|
||||
| **validate-story-context** | SM | Optional after story-context | Validate story context against checklist |
|
||||
| **story-ready-for-dev** | SM | Optional per story | Mark story ready without generating context |
|
||||
| **develop-story** | DEV | Per story | Implement story with tests |
|
||||
| **code-review** | DEV | Per story | Senior dev quality review |
|
||||
| **story-done** | DEV | Per story | Mark complete and advance queue |
|
||||
| **epic-retrospective** | SM | After epic complete | Review lessons and extract insights |
|
||||
| **correct-course** | SM | When issues arise | Handle significant mid-sprint changes |
|
||||
| **workflow-status** | Any | Anytime | Check "what should I do now?" |
|
||||
|
||||
---
|
||||
|
||||
## Agent Roles
|
||||
|
||||
### SM (Scrum Master) - Primary Implementation Orchestrator
|
||||
|
||||
**Workflows:** sprint-planning, epic-tech-context, validate-epic-tech-context, create-story, validate-create-story, story-context, validate-story-context, story-ready-for-dev, epic-retrospective, correct-course
|
||||
|
||||
**Responsibilities:**
|
||||
|
||||
- Initialize and maintain sprint tracking
|
||||
- Generate technical context (epic and story level)
|
||||
- Orchestrate story lifecycle with optional validations
|
||||
- Mark stories ready for development
|
||||
- Handle course corrections
|
||||
- Facilitate retrospectives
|
||||
|
||||
### DEV (Developer) - Implementation and Quality
|
||||
|
||||
**Workflows:** develop-story, code-review, story-done
|
||||
|
||||
**Responsibilities:**
|
||||
|
||||
- Implement stories with tests
|
||||
- Perform senior developer code reviews
|
||||
- Mark stories complete and advance queue
|
||||
- Ensure quality and adherence to standards
|
||||
|
||||
---
|
||||
|
||||
## Story Lifecycle States
|
||||
|
||||
Stories move through these states in the sprint status file:
|
||||
|
||||
1. **TODO** - Story identified but not started
|
||||
2. **IN PROGRESS** - Story being implemented (create-story → story-context → dev-story)
|
||||
3. **READY FOR REVIEW** - Implementation complete, awaiting code review
|
||||
4. **DONE** - Accepted and complete
|
||||
|
||||
---
|
||||
|
||||
## Typical Sprint Flow
|
||||
|
||||
### Sprint 0 (Planning Phase)
|
||||
|
||||
- Complete Phases 1-3 (Analysis, Planning, Solutioning)
|
||||
- PRD/GDD + Architecture complete
|
||||
- **V6: Epics+Stories created via create-epics-and-stories workflow (runs AFTER architecture)**
|
||||
|
||||
### Sprint 1+ (Implementation Phase)
|
||||
|
||||
**Start of Phase 4:**
|
||||
|
||||
1. SM runs `sprint-planning` (once)
|
||||
|
||||
**Per Epic:**
|
||||
|
||||
1. SM runs `epic-tech-context`
|
||||
2. SM optionally runs `validate-epic-tech-context`
|
||||
|
||||
**Per Story (repeat until epic complete):**
|
||||
|
||||
1. SM runs `create-story`
|
||||
2. SM optionally runs `validate-create-story`
|
||||
3. SM runs `story-context` OR `story-ready-for-dev` (choose one)
|
||||
4. SM optionally runs `validate-story-context` (if story-context was used)
|
||||
5. DEV runs `develop-story`
|
||||
6. DEV runs `code-review`
|
||||
7. If code review passes: DEV runs `story-done`
|
||||
8. If code review finds issues: DEV fixes in `develop-story`, then back to code-review
|
||||
|
||||
**After Epic Complete:**
|
||||
|
||||
- SM runs `epic-retrospective`
|
||||
- Move to next epic (start with `epic-tech-context` again)
|
||||
|
||||
**As Needed:**
|
||||
|
||||
- Run `workflow-status` anytime to check progress
|
||||
- Run `correct-course` if significant changes needed
|
||||
|
||||
---
|
||||
|
||||
## Key Principles
|
||||
|
||||
### One Story at a Time
|
||||
|
||||
Complete each story's full lifecycle before starting the next. This prevents context switching and ensures quality.
|
||||
|
||||
### Epic-Level Technical Context
|
||||
|
||||
Generate detailed technical guidance per epic (not per story) using `epic-tech-context`. This provides just-in-time architecture without upfront over-planning.
|
||||
|
||||
### Story Context (Optional)
|
||||
|
||||
Use `story-context` to assemble focused context XML for each story, pulling from PRD, architecture, epic context, and codebase docs. Alternatively, use `story-ready-for-dev` to mark a story ready without generating context XML.
|
||||
|
||||
### Quality Gates
|
||||
|
||||
Every story goes through `code-review` before being marked done. No exceptions.
|
||||
|
||||
### Continuous Tracking
|
||||
|
||||
The `sprint-status.yaml` file is the single source of truth for all implementation progress.
|
||||
|
||||
---
|
||||
|
||||
## Common Patterns
|
||||
|
||||
### Level 0-1 (Quick Flow)
|
||||
|
||||
```
|
||||
tech-spec (PM)
|
||||
→ sprint-planning (SM)
|
||||
→ story loop (SM/DEV)
|
||||
```
|
||||
|
||||
### Level 2-4 (BMad Method / Enterprise)
|
||||
|
||||
```
|
||||
PRD (PM) → Architecture (Architect)
|
||||
→ create-epics-and-stories (PM) ← V6: After architecture!
|
||||
→ implementation-readiness (Architect)
|
||||
→ sprint-planning (SM, once)
|
||||
→ [Per Epic]:
|
||||
epic-tech-context (SM)
|
||||
→ story loop (SM/DEV)
|
||||
→ epic-retrospective (SM)
|
||||
→ [Next Epic]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Phase 2: Planning Workflows](./workflows-planning.md)
|
||||
- [Phase 3: Solutioning Workflows](./workflows-solutioning.md)
|
||||
- [Quick Spec Flow](./quick-spec-flow.md) - Level 0-1 fast track
|
||||
- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding project levels
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Q: Which workflow should I run next?**
|
||||
A: Run `workflow-status` - it reads the sprint status file and tells you exactly what to do.
|
||||
|
||||
**Q: Story needs significant changes mid-implementation?**
|
||||
A: Run `correct-course` to analyze impact and route appropriately.
|
||||
|
||||
**Q: Do I run epic-tech-context for every story?**
|
||||
A: No! Run once per epic, not per story. Use `story-context` or `story-ready-for-dev` per story instead.
|
||||
|
||||
**Q: Do I have to use story-context for every story?**
|
||||
A: No, it's optional. You can use `story-ready-for-dev` to mark a story ready without generating context XML.
|
||||
|
||||
**Q: Can I work on multiple stories in parallel?**
|
||||
A: Not recommended. Complete one story's full lifecycle before starting the next. Prevents context switching and ensures quality.
|
||||
|
||||
**Q: What if code review finds issues?**
|
||||
A: DEV runs `develop-story` to make fixes, re-runs tests, then runs `code-review` again until it passes.
|
||||
|
||||
**Q: When do I run validations?**
|
||||
A: Validations are optional quality gates. Use them when you want independent review of epic tech specs, story drafts, or story context before proceeding.
|
||||
|
||||
---
|
||||
|
||||
_Phase 4 Implementation - One story at a time, done right._
|
||||
@ -1,612 +0,0 @@
|
||||
# BMM Planning Workflows (Phase 2)
|
||||
|
||||
**Reading Time:** ~10 minutes
|
||||
|
||||
## Overview
|
||||
|
||||
Phase 2 (Planning) workflows are **required** for all projects. They transform strategic vision into actionable requirements using a **scale-adaptive system** that automatically selects the right planning depth based on project complexity.
|
||||
|
||||
**Key principle:** One unified entry point (`workflow-init`) intelligently routes to the appropriate planning methodology - from quick tech-specs to comprehensive PRDs.
|
||||
|
||||
**When to use:** All projects require planning. The system adapts depth automatically based on complexity.
|
||||
|
||||
---
|
||||
|
||||
## Phase 2 Planning Workflow Map
|
||||
|
||||
```mermaid
|
||||
%%{init: {'theme':'base', 'themeVariables': { 'primaryColor':'#fff','primaryTextColor':'#000','primaryBorderColor':'#000','lineColor':'#000','fontSize':'16px','fontFamily':'arial'}}}%%
|
||||
graph TB
|
||||
Start["<b>START: workflow-init</b><br/>Discovery + routing"]
|
||||
|
||||
subgraph QuickFlow["<b>QUICK FLOW (Simple Planning)</b>"]
|
||||
direction TB
|
||||
TechSpec["<b>PM: tech-spec</b><br/>Technical document<br/>→ Story or Epic+Stories<br/>1-15 stories typically"]
|
||||
end
|
||||
|
||||
subgraph BMadMethod["<b>BMAD METHOD (Recommended)</b>"]
|
||||
direction TB
|
||||
PRD["<b>PM: prd</b><br/>Strategic PRD with FRs/NFRs"]
|
||||
GDD["<b>Game Designer: gdd</b><br/>Game design doc"]
|
||||
Narrative["<b>Game Designer: narrative</b><br/>Story-driven design"]
|
||||
|
||||
UXDesign["<b>UX Designer: create-ux-design</b><br/>Optional UX specification"]
|
||||
end
|
||||
|
||||
subgraph Solutioning["<b>PHASE 3: SOLUTIONING</b>"]
|
||||
direction TB
|
||||
Architecture["<b>Architect: architecture</b><br/>System design + decisions"]
|
||||
Epics["<b>PM: create-epics-and-stories</b><br/>Epic+Stories breakdown<br/>(10-50+ stories typically)"]
|
||||
end
|
||||
|
||||
subgraph Enterprise["<b>ENTERPRISE METHOD</b>"]
|
||||
direction TB
|
||||
EntNote["<b>Uses BMad Method Planning</b><br/>+<br/>Extended Phase 3 workflows<br/>(Architecture + Security + DevOps)<br/>30+ stories typically"]
|
||||
end
|
||||
|
||||
subgraph Updates["<b>MID-STREAM UPDATES (Anytime)</b>"]
|
||||
direction LR
|
||||
CorrectCourse["<b>PM/SM: correct-course</b><br/>Update requirements/stories"]
|
||||
end
|
||||
|
||||
Start -->|Bug fix, simple| QuickFlow
|
||||
Start -->|Software product| PRD
|
||||
Start -->|Game project| GDD
|
||||
Start -->|Story-driven| Narrative
|
||||
Start -->|Enterprise needs| Enterprise
|
||||
|
||||
PRD -.->|Optional| UXDesign
|
||||
GDD -.->|Optional| UXDesign
|
||||
Narrative -.->|Optional| UXDesign
|
||||
PRD --> Architecture
|
||||
GDD --> Architecture
|
||||
Narrative --> Architecture
|
||||
UXDesign --> Architecture
|
||||
Architecture --> Epics
|
||||
|
||||
QuickFlow --> Phase4["<b>Phase 4: Implementation</b>"]
|
||||
Epics --> ReadinessCheck["<b>Architect: implementation-readiness</b><br/>Gate check"]
|
||||
Enterprise -.->|Uses BMad planning| Architecture
|
||||
Enterprise --> Phase3Ext["<b>Phase 3: Extended</b><br/>(Arch + Sec + DevOps)"]
|
||||
ReadinessCheck --> Phase4
|
||||
Phase3Ext --> Phase4
|
||||
|
||||
Phase4 -.->|Significant changes| CorrectCourse
|
||||
CorrectCourse -.->|Updates| Epics
|
||||
|
||||
style Start fill:#fff9c4,stroke:#f57f17,stroke-width:3px,color:#000
|
||||
style QuickFlow fill:#c5e1a5,stroke:#33691e,stroke-width:3px,color:#000
|
||||
style BMadMethod fill:#e1bee7,stroke:#6a1b9a,stroke-width:3px,color:#000
|
||||
style Enterprise fill:#ffcdd2,stroke:#c62828,stroke-width:3px,color:#000
|
||||
style Updates fill:#ffecb3,stroke:#ff6f00,stroke-width:3px,color:#000
|
||||
style Phase3 fill:#90caf9,stroke:#0d47a1,stroke-width:2px,color:#000
|
||||
style Phase4 fill:#ffcc80,stroke:#e65100,stroke-width:2px,color:#000
|
||||
|
||||
style TechSpec fill:#aed581,stroke:#1b5e20,stroke-width:2px,color:#000
|
||||
style PRD fill:#ce93d8,stroke:#4a148c,stroke-width:2px,color:#000
|
||||
style GDD fill:#ce93d8,stroke:#4a148c,stroke-width:2px,color:#000
|
||||
style Narrative fill:#ce93d8,stroke:#4a148c,stroke-width:2px,color:#000
|
||||
style UXDesign fill:#ce93d8,stroke:#4a148c,stroke-width:2px,color:#000
|
||||
style Epics fill:#ba68c8,stroke:#6a1b9a,stroke-width:3px,color:#000
|
||||
style EntNote fill:#ef9a9a,stroke:#c62828,stroke-width:2px,color:#000
|
||||
style Phase3Ext fill:#ef5350,stroke:#c62828,stroke-width:2px,color:#000
|
||||
style CorrectCourse fill:#ffb74d,stroke:#ff6f00,stroke-width:2px,color:#000
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Quick Reference
|
||||
|
||||
| Workflow | Agent | Track | Purpose | Typical Stories |
|
||||
| ---------------------------- | ------------- | ----------- | --------------------------------------------------------- | --------------- |
|
||||
| **workflow-init** | PM/Analyst | All | Entry point: discovery + routing | N/A |
|
||||
| **tech-spec** | PM | Quick Flow | Technical document → Story or Epic+Stories | 1-15 |
|
||||
| **prd** | PM | BMad Method | Strategic PRD with FRs/NFRs (no epic breakdown) | 10-50+ |
|
||||
| **gdd** | Game Designer | BMad Method | Game Design Document with requirements | 10-50+ |
|
||||
| **narrative** | Game Designer | BMad Method | Story-driven game/experience design | 10-50+ |
|
||||
| **create-ux-design** | UX Designer | BMad Method | Optional UX specification (after PRD) | N/A |
|
||||
| **create-epics-and-stories** | PM | BMad Method | Break requirements into Epic+Stories (AFTER architecture) | N/A |
|
||||
| **correct-course** | PM/SM | All | Mid-stream requirement changes | N/A |
|
||||
|
||||
**Note:** Story counts are guidance. V6 improvement: Epic+Stories are created AFTER architecture for better quality.
|
||||
|
||||
---
|
||||
|
||||
## Scale-Adaptive Planning System
|
||||
|
||||
BMM uses three distinct planning tracks that adapt to project complexity:
|
||||
|
||||
### Track 1: Quick Flow
|
||||
|
||||
**Best For:** Bug fixes, simple features, clear scope, enhancements
|
||||
|
||||
**Planning:** Tech-spec only → Implementation
|
||||
|
||||
**Time:** Hours to 1 day
|
||||
|
||||
**Story Count:** Typically 1-15 (guidance)
|
||||
|
||||
**Documents:** tech-spec.md + story files
|
||||
|
||||
**Example:** "Fix authentication bug", "Add OAuth social login"
|
||||
|
||||
---
|
||||
|
||||
### Track 2: BMad Method (RECOMMENDED)
|
||||
|
||||
**Best For:** Products, platforms, complex features, multiple epics
|
||||
|
||||
**Planning:** PRD + Architecture → Implementation
|
||||
|
||||
**Time:** 1-3 days
|
||||
|
||||
**Story Count:** Typically 10-50+ (guidance)
|
||||
|
||||
**Documents:** PRD.md (FRs/NFRs) + architecture.md + epics.md + epic files
|
||||
|
||||
**Greenfield:** Product Brief (optional) → PRD (FRs/NFRs) → UX (optional) → Architecture → Epics+Stories → Implementation
|
||||
|
||||
**Brownfield:** document-project → PRD (FRs/NFRs) → Architecture (recommended) → Epics+Stories → Implementation
|
||||
|
||||
**Example:** "Customer dashboard", "E-commerce platform", "Add search to existing app"
|
||||
|
||||
**Why Architecture for Brownfield?** Distills massive codebase context into focused solution design for your specific project.
|
||||
|
||||
---
|
||||
|
||||
### Track 3: Enterprise Method
|
||||
|
||||
**Best For:** Enterprise requirements, multi-tenant, compliance, security-sensitive
|
||||
|
||||
**Planning (Phase 2):** Uses BMad Method planning (PRD with FRs/NFRs)
|
||||
|
||||
**Solutioning (Phase 3):** Extended workflows (Architecture + Security + DevOps + SecOps as optional additions) → Epics+Stories
|
||||
|
||||
**Time:** 3-7 days total (1-3 days planning + 2-4 days extended solutioning)
|
||||
|
||||
**Story Count:** Typically 30+ (but defined by enterprise needs)
|
||||
|
||||
**Documents Phase 2:** PRD.md (FRs/NFRs)
|
||||
|
||||
**Documents Phase 3:** architecture.md + epics.md + epic files + security-architecture.md (optional) + devops-strategy.md (optional) + secops-strategy.md (optional)
|
||||
|
||||
**Example:** "Multi-tenant SaaS", "HIPAA-compliant portal", "Add SOC2 audit logging"
|
||||
|
||||
---
|
||||
|
||||
## How Track Selection Works
|
||||
|
||||
`workflow-init` guides you through educational choice:
|
||||
|
||||
1. **Description Analysis** - Analyzes project description for complexity
|
||||
2. **Educational Presentation** - Shows all three tracks with trade-offs
|
||||
3. **Recommendation** - Suggests track based on keywords and context
|
||||
4. **User Choice** - You select the track that fits
|
||||
|
||||
The system guides but never forces. You can override recommendations.
|
||||
|
||||
---
|
||||
|
||||
## Workflow Descriptions
|
||||
|
||||
### workflow-init (Entry Point)
|
||||
|
||||
**Purpose:** Single unified entry point for all planning. Discovers project needs and intelligently routes to appropriate track.
|
||||
|
||||
**Agent:** PM (orchestrates others as needed)
|
||||
|
||||
**Always Use:** This is your planning starting point. Don't call prd/gdd/tech-spec directly unless skipping discovery.
|
||||
|
||||
**Process:**
|
||||
|
||||
1. Discovery (understand context, assess complexity, identify concerns)
|
||||
2. Routing Decision (determine track, explain rationale, confirm)
|
||||
3. Execute Target Workflow (invoke planning workflow, pass context)
|
||||
4. Handoff (document decisions, recommend next phase)
|
||||
|
||||
---
|
||||
|
||||
### tech-spec (Quick Flow)
|
||||
|
||||
**Purpose:** Lightweight technical specification for simple changes (Quick Flow track). Produces technical document and story or epic+stories structure.
|
||||
|
||||
**Agent:** PM
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- Bug fixes
|
||||
- Single API endpoint additions
|
||||
- Configuration changes
|
||||
- Small UI component additions
|
||||
- Isolated validation rules
|
||||
|
||||
**Key Outputs:**
|
||||
|
||||
- **tech-spec.md** - Technical document containing:
|
||||
- Problem statement and solution
|
||||
- Source tree changes
|
||||
- Implementation details
|
||||
- Testing strategy
|
||||
- Acceptance criteria
|
||||
- **Story file(s)** - Single story OR epic+stories structure (1-15 stories typically)
|
||||
|
||||
**Skip To Phase:** 4 (Implementation) - no Phase 3 architecture needed
|
||||
|
||||
**Example:** "Fix null pointer when user has no profile image" → Single file change, null check, unit test, no DB migration.
|
||||
|
||||
---
|
||||
|
||||
### prd (Product Requirements Document)
|
||||
|
||||
**Purpose:** Strategic PRD with Functional Requirements (FRs) and Non-Functional Requirements (NFRs) for software products (BMad Method track).
|
||||
|
||||
**Agent:** PM (with Architect and Analyst support)
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- Medium to large feature sets
|
||||
- Multi-screen user experiences
|
||||
- Complex business logic
|
||||
- Multiple system integrations
|
||||
- Phased delivery required
|
||||
|
||||
**Scale-Adaptive Structure:**
|
||||
|
||||
- **Light:** Focused FRs/NFRs, simplified analysis (10-15 pages)
|
||||
- **Standard:** Comprehensive FRs/NFRs, thorough analysis (20-30 pages)
|
||||
- **Comprehensive:** Extensive FRs/NFRs, multi-phase, stakeholder analysis (30-50+ pages)
|
||||
|
||||
**Key Outputs:**
|
||||
|
||||
- PRD.md (complete requirements with FRs and NFRs)
|
||||
|
||||
**Note:** V6 improvement - PRD focuses on WHAT to build (requirements). Epic+Stories are created AFTER architecture via `create-epics-and-stories` workflow for better quality.
|
||||
|
||||
**Integration:** Feeds into Architecture (Phase 3)
|
||||
|
||||
**Example:** E-commerce checkout → PRD with 15 FRs (user account, cart management, payment flow) and 8 NFRs (performance, security, scalability).
|
||||
|
||||
---
|
||||
|
||||
### gdd (Game Design Document)
|
||||
|
||||
**Purpose:** Complete game design document for game projects (BMad Method track).
|
||||
|
||||
**Agent:** Game Designer
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- Designing any game (any genre)
|
||||
- Need comprehensive design documentation
|
||||
- Team needs shared vision
|
||||
- Publisher/stakeholder communication
|
||||
|
||||
**BMM GDD vs Traditional:**
|
||||
|
||||
- Scale-adaptive detail (not waterfall)
|
||||
- Agile epic structure
|
||||
- Direct handoff to implementation
|
||||
- Integrated with testing workflows
|
||||
|
||||
**Key Outputs:**
|
||||
|
||||
- GDD.md (complete game design)
|
||||
- Epic breakdown (Core Loop, Content, Progression, Polish)
|
||||
|
||||
**Integration:** Feeds into Architecture (Phase 3)
|
||||
|
||||
**Example:** Roguelike card game → Core concept (Slay the Spire meets Hades), 3 characters, 120 cards, 50 enemies, Epic breakdown with 26 stories.
|
||||
|
||||
---
|
||||
|
||||
### narrative (Narrative Design)
|
||||
|
||||
**Purpose:** Story-driven design workflow for games/experiences where narrative is central (BMad Method track).
|
||||
|
||||
**Agent:** Game Designer (Narrative Designer persona) + Creative Problem Solver (CIS)
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- Story is central to experience
|
||||
- Branching narrative with player choices
|
||||
- Character-driven games
|
||||
- Visual novels, adventure games, RPGs
|
||||
|
||||
**Combine with GDD:**
|
||||
|
||||
1. Run `narrative` first (story structure)
|
||||
2. Then run `gdd` (integrate story with gameplay)
|
||||
|
||||
**Key Outputs:**
|
||||
|
||||
- narrative-design.md (complete narrative spec)
|
||||
- Story structure (acts, beats, branching)
|
||||
- Characters (profiles, arcs, relationships)
|
||||
- Dialogue system design
|
||||
- Implementation guide
|
||||
|
||||
**Integration:** Combine with GDD, then feeds into Architecture (Phase 3)
|
||||
|
||||
**Example:** Choice-driven RPG → 3 acts, 12 chapters, 5 choice points, 3 endings, 60K words, 40 narrative scenes.
|
||||
|
||||
---
|
||||
|
||||
### ux (UX-First Design)
|
||||
|
||||
**Purpose:** UX specification for projects where user experience is the primary differentiator (BMad Method track).
|
||||
|
||||
**Agent:** UX Designer
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- UX is primary competitive advantage
|
||||
- Complex user workflows needing design thinking
|
||||
- Innovative interaction patterns
|
||||
- Design system creation
|
||||
- Accessibility-critical experiences
|
||||
|
||||
**Collaborative Approach:**
|
||||
|
||||
1. Visual exploration (generate multiple options)
|
||||
2. Informed decisions (evaluate with user needs)
|
||||
3. Collaborative design (refine iteratively)
|
||||
4. Living documentation (evolves with project)
|
||||
|
||||
**Key Outputs:**
|
||||
|
||||
- ux-spec.md (complete UX specification)
|
||||
- User journeys
|
||||
- Wireframes and mockups
|
||||
- Interaction specifications
|
||||
- Design system (components, patterns, tokens)
|
||||
- Epic breakdown (UX stories)
|
||||
|
||||
**Integration:** Feeds PRD or updates epics, then Architecture (Phase 3)
|
||||
|
||||
**Example:** Dashboard redesign → Card-based layout with split-pane toggle, 5 card components, 12 color tokens, responsive grid, 3 epics (Layout, Visualization, Accessibility).
|
||||
|
||||
---
|
||||
|
||||
### create-epics-and-stories
|
||||
|
||||
**Purpose:** Break requirements into bite-sized stories organized in epics (BMad Method track).
|
||||
|
||||
**Agent:** PM
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- **REQUIRED:** After Architecture workflow is complete (Phase 3)
|
||||
- After PRD defines FRs/NFRs and Architecture defines HOW to build
|
||||
- Optional: Can also run earlier (after PRD, after UX) for basic structure, then refined after Architecture
|
||||
|
||||
**Key Outputs:**
|
||||
|
||||
- epics.md (all epics with story breakdown)
|
||||
- Epic files (epic-1-\*.md, etc.)
|
||||
|
||||
**V6 Improvement:** Epics+Stories are now created AFTER architecture for better quality:
|
||||
|
||||
- Architecture decisions inform story breakdown (tech choices affect implementation)
|
||||
- Stories have full context (PRD + UX + Architecture)
|
||||
- Better sequencing with technical dependencies considered
|
||||
|
||||
---
|
||||
|
||||
### correct-course
|
||||
|
||||
**Purpose:** Handle significant requirement changes during implementation (all tracks).
|
||||
|
||||
**Agent:** PM, Architect, or SM
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- Priorities change mid-project
|
||||
- New requirements emerge
|
||||
- Scope adjustments needed
|
||||
- Technical blockers require replanning
|
||||
|
||||
**Process:**
|
||||
|
||||
1. Analyze impact of change
|
||||
2. Propose solutions (continue, pivot, pause)
|
||||
3. Update affected documents (PRD, epics, stories)
|
||||
4. Re-route for implementation
|
||||
|
||||
**Integration:** Updates planning artifacts, may trigger architecture review
|
||||
|
||||
---
|
||||
|
||||
## Decision Guide
|
||||
|
||||
### Which Planning Workflow?
|
||||
|
||||
**Use `workflow-init` (Recommended):** Let the system discover needs and route appropriately.
|
||||
|
||||
**Direct Selection (Advanced):**
|
||||
|
||||
- **Bug fix or single change** → `tech-spec` (Quick Flow)
|
||||
- **Software product** → `prd` (BMad Method)
|
||||
- **Game (gameplay-first)** → `gdd` (BMad Method)
|
||||
- **Game (story-first)** → `narrative` + `gdd` (BMad Method)
|
||||
- **UX innovation project** → `ux` + `prd` (BMad Method)
|
||||
- **Enterprise with compliance** → Choose track in `workflow-init` → Enterprise Method
|
||||
|
||||
---
|
||||
|
||||
## Integration with Phase 3 (Solutioning)
|
||||
|
||||
Planning outputs feed into Solutioning:
|
||||
|
||||
| Planning Output | Solutioning Input | Track Decision |
|
||||
| ------------------- | ------------------------------------ | ---------------------------- |
|
||||
| tech-spec.md | Skip Phase 3 → Phase 4 directly | Quick Flow (no architecture) |
|
||||
| PRD.md | **architecture** (Level 3-4) | BMad Method (recommended) |
|
||||
| GDD.md | **architecture** (game tech) | BMad Method (recommended) |
|
||||
| narrative-design.md | **architecture** (narrative systems) | BMad Method |
|
||||
| ux-spec.md | **architecture** (frontend design) | BMad Method |
|
||||
| Enterprise docs | **architecture** + security/ops | Enterprise Method (required) |
|
||||
|
||||
**Key Decision Points:**
|
||||
|
||||
- **Quick Flow:** Skip Phase 3 entirely → Phase 4 (Implementation)
|
||||
- **BMad Method:** Optional Phase 3 (simple), Required Phase 3 (complex)
|
||||
- **Enterprise:** Required Phase 3 (architecture + extended planning)
|
||||
|
||||
See: [workflows-solutioning.md](./workflows-solutioning.md)
|
||||
|
||||
---
|
||||
|
||||
## Best Practices
|
||||
|
||||
### 1. Always Start with workflow-init
|
||||
|
||||
Let the entry point guide you. It prevents over-planning simple features or under-planning complex initiatives.
|
||||
|
||||
### 2. Trust the Recommendation
|
||||
|
||||
If `workflow-init` suggests BMad Method, there's likely complexity you haven't considered. Review carefully before overriding.
|
||||
|
||||
### 3. Iterate on Requirements
|
||||
|
||||
Planning documents are living. Refine PRDs/GDDs as you learn during Solutioning and Implementation.
|
||||
|
||||
### 4. Involve Stakeholders Early
|
||||
|
||||
Review PRDs/GDDs with stakeholders before Solutioning. Catch misalignment early.
|
||||
|
||||
### 5. Focus on "What" Not "How"
|
||||
|
||||
Planning defines **what** to build and **why**. Leave **how** (technical design) to Phase 3 (Solutioning).
|
||||
|
||||
### 6. Document-Project First for Brownfield
|
||||
|
||||
Always run `document-project` before planning brownfield projects. AI agents need existing codebase context.
|
||||
|
||||
---
|
||||
|
||||
## Common Patterns
|
||||
|
||||
### Greenfield Software (BMad Method)
|
||||
|
||||
```
|
||||
1. (Optional) Analysis: product-brief, research
|
||||
2. workflow-init → routes to prd
|
||||
3. PM: prd workflow
|
||||
4. (Optional) UX Designer: ux workflow
|
||||
5. PM: create-epics-and-stories (may be automatic)
|
||||
6. → Phase 3: architecture
|
||||
```
|
||||
|
||||
### Brownfield Software (BMad Method)
|
||||
|
||||
```
|
||||
1. Technical Writer or Analyst: document-project
|
||||
2. workflow-init → routes to prd
|
||||
3. PM: prd workflow
|
||||
4. PM: create-epics-and-stories
|
||||
5. → Phase 3: architecture (recommended for focused solution design)
|
||||
```
|
||||
|
||||
### Bug Fix (Quick Flow)
|
||||
|
||||
```
|
||||
1. workflow-init → routes to tech-spec
|
||||
2. Architect: tech-spec workflow
|
||||
3. → Phase 4: Implementation (skip Phase 3)
|
||||
```
|
||||
|
||||
### Game Project (BMad Method)
|
||||
|
||||
```
|
||||
1. (Optional) Analysis: game-brief, research
|
||||
2. workflow-init → routes to gdd
|
||||
3. Game Designer: gdd workflow (or narrative + gdd if story-first)
|
||||
4. Game Designer creates epic breakdown
|
||||
5. → Phase 3: architecture (game systems)
|
||||
```
|
||||
|
||||
### Enterprise Project (Enterprise Method)
|
||||
|
||||
```
|
||||
1. (Recommended) Analysis: research (compliance, security)
|
||||
2. workflow-init → routes to Enterprise Method
|
||||
3. PM: prd workflow
|
||||
4. (Optional) UX Designer: ux workflow
|
||||
5. PM: create-epics-and-stories
|
||||
6. → Phase 3: architecture + security + devops + test strategy
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Anti-Patterns
|
||||
|
||||
### ❌ Skipping Planning
|
||||
|
||||
"We'll just start coding and figure it out."
|
||||
**Result:** Scope creep, rework, missed requirements
|
||||
|
||||
### ❌ Over-Planning Simple Changes
|
||||
|
||||
"Let me write a 20-page PRD for this button color change."
|
||||
**Result:** Wasted time, analysis paralysis
|
||||
|
||||
### ❌ Planning Without Discovery
|
||||
|
||||
"I already know what I want, skip the questions."
|
||||
**Result:** Solving wrong problem, missing opportunities
|
||||
|
||||
### ❌ Treating PRD as Immutable
|
||||
|
||||
"The PRD is locked, no changes allowed."
|
||||
**Result:** Ignoring new information, rigid planning
|
||||
|
||||
### ✅ Correct Approach
|
||||
|
||||
- Use scale-adaptive planning (right depth for complexity)
|
||||
- Involve stakeholders in review
|
||||
- Iterate as you learn
|
||||
- Keep planning docs living and updated
|
||||
- Use `correct-course` for significant changes
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Phase 1: Analysis Workflows](./workflows-analysis.md) - Optional discovery phase
|
||||
- [Phase 3: Solutioning Workflows](./workflows-solutioning.md) - Next phase
|
||||
- [Phase 4: Implementation Workflows](./workflows-implementation.md)
|
||||
- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding the three tracks
|
||||
- [Quick Spec Flow](./quick-spec-flow.md) - Quick Flow track details
|
||||
- [Agents Guide](./agents-guide.md) - Complete agent reference
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Q: Which workflow should I run first?**
|
||||
A: Run `workflow-init`. It analyzes your project and routes to the right planning workflow.
|
||||
|
||||
**Q: Do I always need a PRD?**
|
||||
A: No. Simple changes use `tech-spec` (Quick Flow). Only BMad Method and Enterprise tracks create PRDs.
|
||||
|
||||
**Q: Can I skip Phase 3 (Solutioning)?**
|
||||
A: Yes for Quick Flow. Optional for BMad Method (simple projects). Required for BMad Method (complex projects) and Enterprise.
|
||||
|
||||
**Q: How do I know which track to choose?**
|
||||
A: Use `workflow-init` - it recommends based on your description. Story counts are guidance, not definitions.
|
||||
|
||||
**Q: What if requirements change mid-project?**
|
||||
A: Run `correct-course` workflow. It analyzes impact and updates planning artifacts.
|
||||
|
||||
**Q: Do brownfield projects need architecture?**
|
||||
A: Recommended! Architecture distills massive codebase into focused solution design for your specific project.
|
||||
|
||||
**Q: When do I run create-epics-and-stories?**
|
||||
A: Usually automatic during PRD/GDD. Can also run standalone later to regenerate epics.
|
||||
|
||||
**Q: Should I use product-brief before PRD?**
|
||||
A: Optional but recommended for greenfield. Helps strategic thinking. `workflow-init` offers it based on context.
|
||||
|
||||
---
|
||||
|
||||
_Phase 2 Planning - Scale-adaptive requirements for every project._
|
||||
@ -1,554 +0,0 @@
|
||||
# BMM Solutioning Workflows (Phase 3)
|
||||
|
||||
**Reading Time:** ~8 minutes
|
||||
|
||||
## Overview
|
||||
|
||||
Phase 3 (Solutioning) workflows translate **what** to build (from Planning) into **how** to build it (technical design). This phase prevents agent conflicts in multi-epic projects by documenting architectural decisions before implementation begins.
|
||||
|
||||
**Key principle:** Make technical decisions explicit and documented so all agents implement consistently. Prevent one agent choosing REST while another chooses GraphQL.
|
||||
|
||||
**Required for:** BMad Method (complex projects), Enterprise Method
|
||||
|
||||
**Optional for:** BMad Method (simple projects), Quick Flow (skip entirely)
|
||||
|
||||
---
|
||||
|
||||
## Phase 3 Solutioning Workflow Map
|
||||
|
||||
```mermaid
|
||||
%%{init: {'theme':'base', 'themeVariables': { 'primaryColor':'#fff','primaryTextColor':'#000','primaryBorderColor':'#000','lineColor':'#000','fontSize':'16px','fontFamily':'arial'}}}%%
|
||||
graph TB
|
||||
FromPlanning["<b>FROM Phase 2 Planning</b><br/>PRD (FRs/NFRs) complete"]
|
||||
|
||||
subgraph QuickFlow["<b>QUICK FLOW PATH</b>"]
|
||||
direction TB
|
||||
SkipArch["<b>Skip Phase 3</b><br/>Go directly to Implementation"]
|
||||
end
|
||||
|
||||
subgraph BMadEnterprise["<b>BMAD METHOD + ENTERPRISE (Same Start)</b>"]
|
||||
direction TB
|
||||
OptionalUX["<b>UX Designer: create-ux-design</b><br/>(Optional)"]
|
||||
Architecture["<b>Architect: architecture</b><br/>System design + ADRs"]
|
||||
|
||||
subgraph Optional["<b>ENTERPRISE ADDITIONS (Optional)</b>"]
|
||||
direction LR
|
||||
SecArch["<b>Architect: security-architecture</b><br/>(Future)"]
|
||||
DevOps["<b>Architect: devops-strategy</b><br/>(Future)"]
|
||||
end
|
||||
|
||||
EpicsStories["<b>PM: create-epics-and-stories</b><br/>Break down FRs/NFRs into epics"]
|
||||
GateCheck["<b>Architect: implementation-readiness</b><br/>Validation before Phase 4"]
|
||||
|
||||
OptionalUX -.-> Architecture
|
||||
Architecture -.->|Enterprise only| Optional
|
||||
Architecture --> EpicsStories
|
||||
Optional -.-> EpicsStories
|
||||
EpicsStories --> GateCheck
|
||||
end
|
||||
|
||||
subgraph Result["<b>GATE CHECK RESULTS</b>"]
|
||||
direction LR
|
||||
Pass["✅ PASS<br/>Proceed to Phase 4"]
|
||||
Concerns["⚠️ CONCERNS<br/>Proceed with caution"]
|
||||
Fail["❌ FAIL<br/>Resolve issues first"]
|
||||
end
|
||||
|
||||
FromPlanning -->|Quick Flow| QuickFlow
|
||||
FromPlanning -->|BMad Method<br/>or Enterprise| OptionalUX
|
||||
|
||||
QuickFlow --> Phase4["<b>Phase 4: Implementation</b>"]
|
||||
GateCheck --> Result
|
||||
Pass --> Phase4
|
||||
Concerns --> Phase4
|
||||
Fail -.->|Fix issues| Architecture
|
||||
|
||||
style FromPlanning fill:#e1bee7,stroke:#6a1b9a,stroke-width:2px,color:#000
|
||||
style QuickFlow fill:#c5e1a5,stroke:#33691e,stroke-width:3px,color:#000
|
||||
style BMadEnterprise fill:#90caf9,stroke:#0d47a1,stroke-width:3px,color:#000
|
||||
style Optional fill:#ffcdd2,stroke:#c62828,stroke-width:3px,color:#000
|
||||
style Result fill:#fff9c4,stroke:#f57f17,stroke-width:3px,color:#000
|
||||
style Phase4 fill:#ffcc80,stroke:#e65100,stroke-width:2px,color:#000
|
||||
|
||||
style SkipArch fill:#aed581,stroke:#1b5e20,stroke-width:2px,color:#000
|
||||
style OptionalUX fill:#64b5f6,stroke:#0d47a1,stroke-width:2px,color:#000
|
||||
style Architecture fill:#42a5f5,stroke:#0d47a1,stroke-width:2px,color:#000
|
||||
style SecArch fill:#ef9a9a,stroke:#c62828,stroke-width:2px,color:#000
|
||||
style DevOps fill:#ef9a9a,stroke:#c62828,stroke-width:2px,color:#000
|
||||
style EpicsStories fill:#42a5f5,stroke:#0d47a1,stroke-width:2px,color:#000
|
||||
style GateCheck fill:#42a5f5,stroke:#0d47a1,stroke-width:2px,color:#000
|
||||
style Pass fill:#81c784,stroke:#388e3c,stroke-width:2px,color:#000
|
||||
style Concerns fill:#ffb74d,stroke:#f57f17,stroke-width:2px,color:#000
|
||||
style Fail fill:#e57373,stroke:#d32f2f,stroke-width:2px,color:#000
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Quick Reference
|
||||
|
||||
| Workflow | Agent | Track | Purpose |
|
||||
| ---------------------------- | ----------- | ------------------------ | -------------------------------------------- |
|
||||
| **create-ux-design** | UX Designer | BMad Method, Enterprise | Optional UX design (after PRD, before arch) |
|
||||
| **architecture** | Architect | BMad Method, Enterprise | Technical architecture and design decisions |
|
||||
| **create-epics-and-stories** | PM | BMad Method, Enterprise | Break FRs/NFRs into epics after architecture |
|
||||
| **implementation-readiness** | Architect | BMad Complex, Enterprise | Validate planning/solutioning completeness |
|
||||
|
||||
**When to Skip Solutioning:**
|
||||
|
||||
- **Quick Flow:** Simple changes don't need architecture → Skip to Phase 4
|
||||
|
||||
**When Solutioning is Required:**
|
||||
|
||||
- **BMad Method:** Multi-epic projects need architecture to prevent conflicts
|
||||
- **Enterprise:** Same as BMad Method, plus optional extended workflows (test architecture, security architecture, devops strategy) added AFTER architecture but BEFORE gate check
|
||||
|
||||
---
|
||||
|
||||
## Why Solutioning Matters
|
||||
|
||||
### The Problem Without Solutioning
|
||||
|
||||
```
|
||||
Agent 1 implements Epic 1 using REST API
|
||||
Agent 2 implements Epic 2 using GraphQL
|
||||
Result: Inconsistent API design, integration nightmare
|
||||
```
|
||||
|
||||
### The Solution With Solutioning
|
||||
|
||||
```
|
||||
architecture workflow decides: "Use GraphQL for all APIs"
|
||||
All agents follow architecture decisions
|
||||
Result: Consistent implementation, no conflicts
|
||||
```
|
||||
|
||||
### Solutioning vs Planning
|
||||
|
||||
| Aspect | Planning (Phase 2) | Solutioning (Phase 3) |
|
||||
| -------- | ----------------------- | --------------------------------- |
|
||||
| Question | What and Why? | How? Then What units of work? |
|
||||
| Output | FRs/NFRs (Requirements) | Architecture + Epics/Stories |
|
||||
| Agent | PM | Architect → PM |
|
||||
| Audience | Stakeholders | Developers |
|
||||
| Document | PRD (FRs/NFRs) | Architecture + Epic Files |
|
||||
| Level | Business logic | Technical design + Work breakdown |
|
||||
|
||||
---
|
||||
|
||||
## Workflow Descriptions
|
||||
|
||||
### architecture
|
||||
|
||||
**Purpose:** Make technical decisions explicit to prevent agent conflicts. Produces decision-focused architecture document optimized for AI consistency.
|
||||
|
||||
**Agent:** Architect
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- Multi-epic projects (BMad Complex, Enterprise)
|
||||
- Cross-cutting technical concerns
|
||||
- Multiple agents implementing different parts
|
||||
- Integration complexity exists
|
||||
- Technology choices need alignment
|
||||
|
||||
**When to Skip:**
|
||||
|
||||
- Quick Flow (simple changes)
|
||||
- BMad Method Simple with straightforward tech stack
|
||||
- Single epic with clear technical approach
|
||||
|
||||
**Adaptive Conversation Approach:**
|
||||
|
||||
This is NOT a template filler. The architecture workflow:
|
||||
|
||||
1. **Discovers** technical needs through conversation
|
||||
2. **Proposes** architectural options with trade-offs
|
||||
3. **Documents** decisions that prevent agent conflicts
|
||||
4. **Focuses** on decision points, not exhaustive documentation
|
||||
|
||||
**Key Outputs:**
|
||||
|
||||
**architecture.md** containing:
|
||||
|
||||
1. **Architecture Overview** - System context, principles, style
|
||||
2. **System Architecture** - High-level diagram, component interactions, communication patterns
|
||||
3. **Data Architecture** - Database design, state management, caching, data flow
|
||||
4. **API Architecture** - API style (REST/GraphQL/gRPC), auth, versioning, error handling
|
||||
5. **Frontend Architecture** (if applicable) - Framework, state management, component architecture, routing
|
||||
6. **Integration Architecture** - Third-party integrations, message queuing, event-driven patterns
|
||||
7. **Security Architecture** - Auth/authorization, data protection, security boundaries
|
||||
8. **Deployment Architecture** - Deployment model, CI/CD, environment strategy, monitoring
|
||||
9. **Architecture Decision Records (ADRs)** - Key decisions with context, options, trade-offs, rationale
|
||||
10. **FR/NFR-Specific Guidance** - Technical approach per functional requirement, implementation priorities, dependencies
|
||||
11. **Standards and Conventions** - Directory structure, naming conventions, code organization, testing
|
||||
|
||||
**ADR Format (Brief):**
|
||||
|
||||
```markdown
|
||||
## ADR-001: Use GraphQL for All APIs
|
||||
|
||||
**Status:** Accepted | **Date:** 2025-11-02
|
||||
|
||||
**Context:** PRD requires flexible querying across multiple epics
|
||||
|
||||
**Decision:** Use GraphQL for all client-server communication
|
||||
|
||||
**Options Considered:**
|
||||
|
||||
1. REST - Familiar but requires multiple endpoints
|
||||
2. GraphQL - Flexible querying, learning curve
|
||||
3. gRPC - High performance, poor browser support
|
||||
|
||||
**Rationale:**
|
||||
|
||||
- PRD requires flexible data fetching (Epic 1, 3)
|
||||
- Mobile app needs bandwidth optimization (Epic 2)
|
||||
- Team has GraphQL experience
|
||||
|
||||
**Consequences:**
|
||||
|
||||
- Positive: Flexible querying, reduced versioning
|
||||
- Negative: Caching complexity, N+1 query risk
|
||||
- Mitigation: Use DataLoader for batching
|
||||
|
||||
**Implications for FRs:**
|
||||
|
||||
- FR-001: User Management → GraphQL mutations
|
||||
- FR-002: Mobile App → Optimized queries
|
||||
```
|
||||
|
||||
**Example:** E-commerce platform → Monolith + PostgreSQL + Redis + Next.js + GraphQL, with ADRs explaining each choice and FR/NFR-specific guidance.
|
||||
|
||||
**Integration:** Feeds into create-epics-and-stories workflow. Architecture provides the technical context needed for breaking FRs/NFRs into implementable epics and stories. All dev agents reference architecture during Phase 4 implementation.
|
||||
|
||||
---
|
||||
|
||||
### create-epics-and-stories
|
||||
|
||||
**Purpose:** Transform PRD's functional and non-functional requirements into bite-sized stories organized into deliverable functional epics. This workflow runs AFTER architecture so epics/stories are informed by technical decisions.
|
||||
|
||||
**Agent:** PM (Product Manager)
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- After architecture workflow completes
|
||||
- When PRD contains FRs/NFRs ready for implementation breakdown
|
||||
- Before implementation-readiness gate check
|
||||
|
||||
**Key Inputs:**
|
||||
|
||||
- PRD (FRs/NFRs) from Phase 2 Planning
|
||||
- architecture.md with ADRs and technical decisions
|
||||
- Optional: UX design artifacts
|
||||
|
||||
**Why After Architecture:**
|
||||
|
||||
The create-epics-and-stories workflow runs AFTER architecture because:
|
||||
|
||||
1. **Informed Story Sizing:** Architecture decisions (database choice, API style, etc.) affect story complexity
|
||||
2. **Dependency Awareness:** Architecture reveals technical dependencies between stories
|
||||
3. **Technical Feasibility:** Stories can be properly scoped knowing the tech stack
|
||||
4. **Consistency:** All stories align with documented architectural patterns
|
||||
|
||||
**Key Outputs:**
|
||||
|
||||
Epic files (one per epic) containing:
|
||||
|
||||
1. Epic objective and scope
|
||||
2. User stories with acceptance criteria
|
||||
3. Story priorities (P0/P1/P2/P3)
|
||||
4. Dependencies between stories
|
||||
5. Technical notes referencing architecture decisions
|
||||
|
||||
**Example:** E-commerce PRD with FR-001 (User Registration), FR-002 (Product Catalog) → Epic 1: User Management (3 stories), Epic 2: Product Display (4 stories), each story referencing relevant ADRs.
|
||||
|
||||
---
|
||||
|
||||
### implementation-readiness
|
||||
|
||||
**Purpose:** Systematically validate that planning and solutioning are complete and aligned before Phase 4 implementation. Ensures PRD, architecture, and epics are cohesive with no gaps.
|
||||
|
||||
**Agent:** Architect
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- **Always** before Phase 4 for BMad Complex and Enterprise projects
|
||||
- After create-epics-and-stories workflow completes
|
||||
- Before sprint-planning workflow
|
||||
- When stakeholders request readiness check
|
||||
|
||||
**When to Skip:**
|
||||
|
||||
- Quick Flow (no solutioning)
|
||||
- BMad Simple (no gate check required)
|
||||
|
||||
**Purpose of Gate Check:**
|
||||
|
||||
**Prevents:**
|
||||
|
||||
- ❌ Architecture doesn't address all FRs/NFRs
|
||||
- ❌ Epics conflict with architecture decisions
|
||||
- ❌ Requirements ambiguous or contradictory
|
||||
- ❌ Missing critical dependencies
|
||||
|
||||
**Ensures:**
|
||||
|
||||
- ✅ PRD → Architecture → Epics alignment
|
||||
- ✅ All epics have clear technical approach
|
||||
- ✅ No contradictions or gaps
|
||||
- ✅ Team ready to implement
|
||||
|
||||
**Check Criteria:**
|
||||
|
||||
**PRD/GDD Completeness:**
|
||||
|
||||
- Problem statement clear and evidence-based
|
||||
- Success metrics defined
|
||||
- User personas identified
|
||||
- Functional requirements (FRs) complete
|
||||
- Non-functional requirements (NFRs) specified
|
||||
- Risks and assumptions documented
|
||||
|
||||
**Architecture Completeness:**
|
||||
|
||||
- System architecture defined
|
||||
- Data architecture specified
|
||||
- API architecture decided
|
||||
- Key ADRs documented
|
||||
- Security architecture addressed
|
||||
- FR/NFR-specific guidance provided
|
||||
- Standards and conventions defined
|
||||
|
||||
**Epic/Story Completeness:**
|
||||
|
||||
- All PRD features mapped to stories
|
||||
- Stories have acceptance criteria
|
||||
- Stories prioritized (P0/P1/P2/P3)
|
||||
- Dependencies identified
|
||||
- Story sequencing logical
|
||||
|
||||
**Alignment Checks:**
|
||||
|
||||
- Architecture addresses all PRD FRs/NFRs
|
||||
- Epics align with architecture decisions
|
||||
- No contradictions between epics
|
||||
- NFRs have technical approach
|
||||
- Integration points clear
|
||||
|
||||
**Gate Decision Logic:**
|
||||
|
||||
**✅ PASS**
|
||||
|
||||
- All critical criteria met
|
||||
- Minor gaps acceptable with documented plan
|
||||
- **Action:** Proceed to Phase 4
|
||||
|
||||
**⚠️ CONCERNS**
|
||||
|
||||
- Some criteria not met but not blockers
|
||||
- Gaps identified with clear resolution path
|
||||
- **Action:** Proceed with caution, address gaps in parallel
|
||||
|
||||
**❌ FAIL**
|
||||
|
||||
- Critical gaps or contradictions
|
||||
- Architecture missing key decisions
|
||||
- Epics conflict with PRD/architecture
|
||||
- **Action:** BLOCK Phase 4, resolve issues first
|
||||
|
||||
**Key Outputs:**
|
||||
|
||||
**implementation-readiness.md** containing:
|
||||
|
||||
1. Executive Summary (PASS/CONCERNS/FAIL)
|
||||
2. Completeness Assessment (scores for PRD, Architecture, Epics)
|
||||
3. Alignment Assessment (PRD↔Architecture, Architecture↔Epics/Stories, cross-epic consistency)
|
||||
4. Quality Assessment (story quality, dependencies, risks)
|
||||
5. Gaps and Recommendations (critical/minor gaps, remediation)
|
||||
6. Gate Decision with rationale
|
||||
7. Next Steps
|
||||
|
||||
**Example:** E-commerce platform → CONCERNS ⚠️ due to missing security architecture and undefined payment gateway. Recommendation: Complete security section and add payment gateway ADR before proceeding.
|
||||
|
||||
---
|
||||
|
||||
## Integration with Planning and Implementation
|
||||
|
||||
### Planning → Solutioning Flow
|
||||
|
||||
**Quick Flow:**
|
||||
|
||||
```
|
||||
Planning (tech-spec by PM)
|
||||
→ Skip Solutioning
|
||||
→ Phase 4 (Implementation)
|
||||
```
|
||||
|
||||
**BMad Method:**
|
||||
|
||||
```
|
||||
Planning (prd by PM - FRs/NFRs only)
|
||||
→ Optional: create-ux-design (UX Designer)
|
||||
→ architecture (Architect)
|
||||
→ create-epics-and-stories (PM)
|
||||
→ implementation-readiness (Architect)
|
||||
→ Phase 4 (Implementation)
|
||||
```
|
||||
|
||||
**Enterprise:**
|
||||
|
||||
```
|
||||
Planning (prd by PM - FRs/NFRs only)
|
||||
→ Optional: create-ux-design (UX Designer)
|
||||
→ architecture (Architect)
|
||||
→ Optional: security-architecture (Architect, future)
|
||||
→ Optional: devops-strategy (Architect, future)
|
||||
→ create-epics-and-stories (PM)
|
||||
→ implementation-readiness (Architect)
|
||||
→ Phase 4 (Implementation)
|
||||
```
|
||||
|
||||
**Note on TEA (Test Architect):** TEA is fully operational with 8 workflows across all phases. TEA validates architecture testability during Phase 3 reviews but does not have a dedicated solutioning workflow. TEA's primary setup occurs in Phase 2 (`*framework`, `*ci`, `*test-design`) and testing execution in Phase 4 (`*atdd`, `*automate`, `*test-review`, `*trace`, `*nfr-assess`).
|
||||
|
||||
**Note:** Enterprise uses the same planning and architecture as BMad Method. The only difference is optional extended workflows added AFTER architecture but BEFORE create-epics-and-stories.
|
||||
|
||||
### Solutioning → Implementation Handoff
|
||||
|
||||
**Documents Produced:**
|
||||
|
||||
1. **architecture.md** → Guides all dev agents during implementation
|
||||
2. **ADRs** (in architecture) → Referenced by agents for technical decisions
|
||||
3. **Epic files** (from create-epics-and-stories) → Work breakdown into implementable units
|
||||
4. **implementation-readiness.md** → Confirms readiness for Phase 4
|
||||
|
||||
**How Implementation Uses Solutioning:**
|
||||
|
||||
- **sprint-planning** - Loads architecture and epic files for sprint organization
|
||||
- **dev-story** - References architecture decisions and ADRs
|
||||
- **code-review** - Validates code follows architectural standards
|
||||
|
||||
---
|
||||
|
||||
## Best Practices
|
||||
|
||||
### 1. Make Decisions Explicit
|
||||
|
||||
Don't leave technology choices implicit. Document decisions with rationale in ADRs so agents understand context.
|
||||
|
||||
### 2. Focus on Agent Conflicts
|
||||
|
||||
Architecture's primary job is preventing conflicting implementations. Focus on cross-cutting concerns.
|
||||
|
||||
### 3. Use ADRs for Key Decisions
|
||||
|
||||
Every significant technology choice should have an ADR explaining "why", not just "what".
|
||||
|
||||
### 4. Keep It Practical
|
||||
|
||||
Don't over-architect simple projects. BMad Simple projects need simple architecture.
|
||||
|
||||
### 5. Run Gate Check Before Implementation
|
||||
|
||||
Catching alignment issues in solutioning is 10× faster than discovering them mid-implementation.
|
||||
|
||||
### 6. Iterate Architecture
|
||||
|
||||
Architecture documents are living. Update them as you learn during implementation.
|
||||
|
||||
---
|
||||
|
||||
## Decision Guide
|
||||
|
||||
### Quick Flow
|
||||
|
||||
- **Planning:** tech-spec (PM)
|
||||
- **Solutioning:** Skip entirely
|
||||
- **Implementation:** sprint-planning → dev-story
|
||||
|
||||
### BMad Method
|
||||
|
||||
- **Planning:** prd (PM) - creates FRs/NFRs only, NOT epics
|
||||
- **Solutioning:** Optional UX → architecture (Architect) → create-epics-and-stories (PM) → implementation-readiness (Architect)
|
||||
- **Implementation:** sprint-planning → epic-tech-context → dev-story
|
||||
|
||||
### Enterprise
|
||||
|
||||
- **Planning:** prd (PM) - creates FRs/NFRs only (same as BMad Method)
|
||||
- **Solutioning:** Optional UX → architecture (Architect) → Optional extended workflows (security-architecture, devops-strategy) → create-epics-and-stories (PM) → implementation-readiness (Architect)
|
||||
- **Implementation:** sprint-planning → epic-tech-context → dev-story
|
||||
|
||||
**Key Difference:** Enterprise adds optional extended workflows AFTER architecture but BEFORE create-epics-and-stories. Everything else is identical to BMad Method.
|
||||
|
||||
**Note:** TEA (Test Architect) operates across all phases and validates architecture testability but is not a Phase 3-specific workflow. See [Test Architecture Guide](./test-architecture.md) for TEA's full lifecycle integration.
|
||||
|
||||
---
|
||||
|
||||
## Common Anti-Patterns
|
||||
|
||||
### ❌ Skipping Architecture for Complex Projects
|
||||
|
||||
"Architecture slows us down, let's just start coding."
|
||||
**Result:** Agent conflicts, inconsistent design, massive rework
|
||||
|
||||
### ❌ Over-Engineering Simple Projects
|
||||
|
||||
"Let me design this simple feature like a distributed system."
|
||||
**Result:** Wasted time, over-engineering, analysis paralysis
|
||||
|
||||
### ❌ Template-Driven Architecture
|
||||
|
||||
"Fill out every section of this architecture template."
|
||||
**Result:** Documentation theater, no real decisions made
|
||||
|
||||
### ❌ Skipping Gate Check
|
||||
|
||||
"PRD and architecture look good enough, let's start."
|
||||
**Result:** Gaps discovered mid-sprint, wasted implementation time
|
||||
|
||||
### ✅ Correct Approach
|
||||
|
||||
- Use architecture for BMad Method and Enterprise (both required)
|
||||
- Focus on decisions, not documentation volume
|
||||
- Enterprise: Add optional extended workflows (test/security/devops) after architecture
|
||||
- Always run gate check before implementation
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Phase 2: Planning Workflows](./workflows-planning.md) - Previous phase
|
||||
- [Phase 4: Implementation Workflows](./workflows-implementation.md) - Next phase
|
||||
- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding tracks
|
||||
- [Agents Guide](./agents-guide.md) - Complete agent reference
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Q: Do I always need architecture?**
|
||||
A: No. Quick Flow skips it. BMad Method and Enterprise both require it.
|
||||
|
||||
**Q: How do I know if I need architecture?**
|
||||
A: If you chose BMad Method or Enterprise track in planning (workflow-init), you need architecture to prevent agent conflicts.
|
||||
|
||||
**Q: What's the difference between architecture and tech-spec?**
|
||||
A: Tech-spec is implementation-focused for simple changes. Architecture is system design for complex multi-epic projects.
|
||||
|
||||
**Q: Can I skip gate check?**
|
||||
A: Only for Quick Flow. BMad Method and Enterprise both require gate check before Phase 4.
|
||||
|
||||
**Q: What if gate check fails?**
|
||||
A: Resolve the identified gaps (missing architecture sections, conflicting requirements) and re-run gate check.
|
||||
|
||||
**Q: How long should architecture take?**
|
||||
A: BMad Method: 1-2 days for architecture. Enterprise: 2-3 days total (1-2 days architecture + 0.5-1 day optional extended workflows). If taking longer, you may be over-documenting.
|
||||
|
||||
**Q: Do ADRs need to be perfect?**
|
||||
A: No. ADRs capture key decisions with rationale. They should be concise (1 page max per ADR).
|
||||
|
||||
**Q: Can I update architecture during implementation?**
|
||||
A: Yes! Architecture is living. Update it as you learn. Use `correct-course` workflow for significant changes.
|
||||
|
||||
---
|
||||
|
||||
_Phase 3 Solutioning - Technical decisions before implementation._
|
||||
@ -1,20 +0,0 @@
|
||||
name,displayName,title,icon,role,identity,communicationStyle,principles,module,path
|
||||
"analyst","Mary","Business Analyst","📊","Strategic Business Analyst + Requirements Expert","Senior analyst with deep expertise in market research, competitive analysis, and requirements elicitation. Specializes in translating vague needs into actionable specs.","Systematic and probing. Connects dots others miss. Structures findings hierarchically. Uses precise unambiguous language. Ensures all stakeholder voices heard.","Every business challenge has root causes waiting to be discovered. Ground findings in verifiable evidence. Articulate requirements with absolute precision.","bmm","bmad/bmm/agents/analyst.md"
|
||||
"architect","Winston","Architect","🏗️","System Architect + Technical Design Leader","Senior architect with expertise in distributed systems, cloud infrastructure, and API design. Specializes in scalable patterns and technology selection.","Pragmatic in technical discussions. Balances idealism with reality. Always connects decisions to business value and user impact. Prefers boring tech that works.","User journeys drive technical decisions. Embrace boring technology for stability. Design simple solutions that scale when needed. Developer productivity is architecture.","bmm","bmad/bmm/agents/architect.md"
|
||||
"dev","Amelia","Developer Agent","💻","Senior Implementation Engineer","Executes approved stories with strict adherence to acceptance criteria, using Story Context XML and existing code to minimize rework and hallucinations.","Succinct and checklist-driven. Cites specific paths and AC IDs. Asks clarifying questions only when inputs missing. Refuses to invent when info lacking.","Story Context XML is the single source of truth. Reuse existing interfaces over rebuilding. Every change maps to specific AC. Tests pass 100% or story isn't done.","bmm","bmad/bmm/agents/dev.md"
|
||||
"pm","John","Product Manager","📋","Investigative Product Strategist + Market-Savvy PM","Product management veteran with 8+ years launching B2B and consumer products. Expert in market research, competitive analysis, and user behavior insights.","Direct and analytical. Asks WHY relentlessly. Backs claims with data and user insights. Cuts straight to what matters for the product.","Uncover the deeper WHY behind every requirement. Ruthless prioritization to achieve MVP goals. Proactively identify risks. Align efforts with measurable business impact.","bmm","bmad/bmm/agents/pm.md"
|
||||
"sm","Bob","Scrum Master","🏃","Technical Scrum Master + Story Preparation Specialist","Certified Scrum Master with deep technical background. Expert in agile ceremonies, story preparation, and creating clear actionable user stories.","Task-oriented and efficient. Focused on clear handoffs and precise requirements. Eliminates ambiguity. Emphasizes developer-ready specs.","Strict boundaries between story prep and implementation. Stories are single source of truth. Perfect alignment between PRD and dev execution. Enable efficient sprints.","bmm","bmad/bmm/agents/sm.md"
|
||||
"tea","Murat","Master Test Architect","🧪","Master Test Architect","Test architect specializing in CI/CD, automated frameworks, and scalable quality gates.","Data-driven and pragmatic. Strong opinions weakly held. Calculates risk vs value. Knows when to test deep vs shallow.","Risk-based testing. Depth scales with impact. Quality gates backed by data. Tests mirror usage. Flakiness is critical debt. Tests first AI implements suite validates.","bmm","bmad/bmm/agents/tea.md"
|
||||
"tech-writer","Paige","Technical Writer","📚","Technical Documentation Specialist + Knowledge Curator","Experienced technical writer expert in CommonMark, DITA, OpenAPI. Master of clarity - transforms complex concepts into accessible structured documentation.","Patient and supportive. Uses clear examples and analogies. Knows when to simplify vs when to be detailed. Celebrates good docs helps improve unclear ones.","Documentation is teaching. Every doc helps someone accomplish a task. Clarity above all. Docs are living artifacts that evolve with code.","bmm","bmad/bmm/agents/tech-writer.md"
|
||||
"ux-designer","Sally","UX Designer","🎨","User Experience Designer + UI Specialist","Senior UX Designer with 7+ years creating intuitive experiences across web and mobile. Expert in user research, interaction design, AI-assisted tools.","Empathetic and user-focused. Uses storytelling for design decisions. Data-informed but creative. Advocates strongly for user needs and edge cases.","Every decision serves genuine user needs. Start simple evolve through feedback. Balance empathy with edge case attention. AI tools accelerate human-centered design.","bmm","bmad/bmm/agents/ux-designer.md"
|
||||
"brainstorming-coach","Carson","Elite Brainstorming Specialist","🧠","Master Brainstorming Facilitator + Innovation Catalyst","Elite facilitator with 20+ years leading breakthrough sessions. Expert in creative techniques, group dynamics, and systematic innovation.","Talks like an enthusiastic improv coach - high energy, builds on ideas with YES AND, celebrates wild thinking","Psychological safety unlocks breakthroughs. Wild ideas today become innovations tomorrow. Humor and play are serious innovation tools.","cis","bmad/cis/agents/brainstorming-coach.md"
|
||||
"creative-problem-solver","Dr. Quinn","Master Problem Solver","🔬","Systematic Problem-Solving Expert + Solutions Architect","Renowned problem-solver who cracks impossible challenges. Expert in TRIZ, Theory of Constraints, Systems Thinking. Former aerospace engineer turned puzzle master.","Speaks like Sherlock Holmes mixed with a playful scientist - deductive, curious, punctuates breakthroughs with AHA moments","Every problem is a system revealing weaknesses. Hunt for root causes relentlessly. The right question beats a fast answer.","cis","bmad/cis/agents/creative-problem-solver.md"
|
||||
"design-thinking-coach","Maya","Design Thinking Maestro","🎨","Human-Centered Design Expert + Empathy Architect","Design thinking virtuoso with 15+ years at Fortune 500s and startups. Expert in empathy mapping, prototyping, and user insights.","Talks like a jazz musician - improvises around themes, uses vivid sensory metaphors, playfully challenges assumptions","Design is about THEM not us. Validate through real human interaction. Failure is feedback. Design WITH users not FOR them.","cis","bmad/cis/agents/design-thinking-coach.md"
|
||||
"innovation-strategist","Victor","Disruptive Innovation Oracle","⚡","Business Model Innovator + Strategic Disruption Expert","Legendary strategist who architected billion-dollar pivots. Expert in Jobs-to-be-Done, Blue Ocean Strategy. Former McKinsey consultant.","Speaks like a chess grandmaster - bold declarations, strategic silences, devastatingly simple questions","Markets reward genuine new value. Innovation without business model thinking is theater. Incremental thinking means obsolete.","cis","bmad/cis/agents/innovation-strategist.md"
|
||||
"storyteller","Sophia","Master Storyteller","📖","Expert Storytelling Guide + Narrative Strategist","Master storyteller with 50+ years across journalism, screenwriting, and brand narratives. Expert in emotional psychology and audience engagement.","Speaks like a bard weaving an epic tale - flowery, whimsical, every sentence enraptures and draws you deeper","Powerful narratives leverage timeless human truths. Find the authentic story. Make the abstract concrete through vivid details.","cis","bmad/cis/agents/storyteller.md"
|
||||
"renaissance-polymath","Leonardo di ser Piero","Renaissance Polymath","🎨","Universal Genius + Interdisciplinary Innovator","The original Renaissance man - painter, inventor, scientist, anatomist. Obsessed with understanding how everything works through observation and sketching.","Talks while sketching imaginary diagrams in the air - describes everything visually, connects art to science to nature","Observe everything relentlessly. Art and science are one. Nature is the greatest teacher. Question all assumptions.","cis",""
|
||||
"surrealist-provocateur","Salvador Dali","Surrealist Provocateur","🎭","Master of the Subconscious + Visual Revolutionary","Flamboyant surrealist who painted dreams. Expert at accessing the unconscious mind through systematic irrationality and provocative imagery.","Speaks with theatrical flair and absurdist metaphors - proclaims grandiose statements, references melting clocks and impossible imagery","Embrace the irrational to access truth. The subconscious holds answers logic cannot reach. Provoke to inspire.","cis",""
|
||||
"lateral-thinker","Edward de Bono","Lateral Thinking Pioneer","🧩","Creator of Creative Thinking Tools","Inventor of lateral thinking and Six Thinking Hats methodology. Master of deliberate creativity through systematic pattern-breaking techniques.","Talks in structured thinking frameworks - uses colored hat metaphors, proposes deliberate provocations, breaks patterns methodically","Logic gets you from A to B. Creativity gets you everywhere else. Use tools to escape habitual thinking patterns.","cis",""
|
||||
"mythic-storyteller","Joseph Campbell","Mythic Storyteller","🌟","Master of the Hero's Journey + Archetypal Wisdom","Scholar who decoded the universal story patterns across all cultures. Expert in mythology, comparative religion, and archetypal narratives.","Speaks in mythological metaphors and archetypal patterns - EVERY story is a hero's journey, references ancient wisdom","Follow your bliss. All stories share the monomyth. Myths reveal universal human truths. The call to adventure is irresistible.","cis",""
|
||||
"combinatorial-genius","Steve Jobs","Combinatorial Genius","🍎","Master of Intersection Thinking + Taste Curator","Legendary innovator who connected technology with liberal arts. Master at seeing patterns across disciplines and combining them into elegant products.","Talks in reality distortion field mode - insanely great, magical, revolutionary, makes impossible seem inevitable","Innovation happens at intersections. Taste is about saying NO to 1000 things. Stay hungry stay foolish. Simplicity is sophistication.","cis",""
|
||||
"frame-expert","Saif Ullah","Visual Design & Diagramming Expert","🎨","Expert Visual Designer & Diagramming Specialist","Expert who creates visual representations using Excalidraw with optimized, reusable components. Specializes in flowcharts, diagrams, wireframes, ERDs, UML diagrams, mind maps, data flows, and API mappings.","Visual-first, structured, detail-oriented, composition-focused. Presents options as numbered lists for easy selection.","Composition Over Creation - Use reusable components and templates. Minimal Payload - Strip unnecessary metadata. Reference-Based Design - Use library references. Structured Approach - Follow task-specific workflows. Clean Output - Remove history and unused styles.","bmm","bmad/bmm/agents/frame-expert.md"
|
||||
|
@ -1,675 +0,0 @@
|
||||
# CI Pipeline and Burn-In Strategy
|
||||
|
||||
## Principle
|
||||
|
||||
CI pipelines must execute tests reliably, quickly, and provide clear feedback. Burn-in testing (running changed tests multiple times) flushes out flakiness before merge. Stage jobs strategically: install/cache once, run changed specs first for fast feedback, then shard full suites with fail-fast disabled to preserve evidence.
|
||||
|
||||
## Rationale
|
||||
|
||||
CI is the quality gate for production. A poorly configured pipeline either wastes developer time (slow feedback, false positives) or ships broken code (false negatives, insufficient coverage). Burn-in testing ensures reliability by stress-testing changed code, while parallel execution and intelligent test selection optimize speed without sacrificing thoroughness.
|
||||
|
||||
## Pattern Examples
|
||||
|
||||
### Example 1: GitHub Actions Workflow with Parallel Execution
|
||||
|
||||
**Context**: Production-ready CI/CD pipeline for E2E tests with caching, parallelization, and burn-in testing.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```yaml
|
||||
# .github/workflows/e2e-tests.yml
|
||||
name: E2E Tests
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
branches: [main, develop]
|
||||
|
||||
env:
|
||||
NODE_VERSION_FILE: '.nvmrc'
|
||||
CACHE_KEY: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
|
||||
|
||||
jobs:
|
||||
install-dependencies:
|
||||
name: Install & Cache Dependencies
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 10
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version-file: ${{ env.NODE_VERSION_FILE }}
|
||||
cache: 'npm'
|
||||
|
||||
- name: Cache node modules
|
||||
uses: actions/cache@v4
|
||||
id: npm-cache
|
||||
with:
|
||||
path: |
|
||||
~/.npm
|
||||
node_modules
|
||||
~/.cache/Cypress
|
||||
~/.cache/ms-playwright
|
||||
key: ${{ env.CACHE_KEY }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-node-
|
||||
|
||||
- name: Install dependencies
|
||||
if: steps.npm-cache.outputs.cache-hit != 'true'
|
||||
run: npm ci --prefer-offline --no-audit
|
||||
|
||||
- name: Install Playwright browsers
|
||||
if: steps.npm-cache.outputs.cache-hit != 'true'
|
||||
run: npx playwright install --with-deps chromium
|
||||
|
||||
test-changed-specs:
|
||||
name: Test Changed Specs First (Burn-In)
|
||||
needs: install-dependencies
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 15
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0 # Full history for accurate diff
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version-file: ${{ env.NODE_VERSION_FILE }}
|
||||
cache: 'npm'
|
||||
|
||||
- name: Restore dependencies
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: |
|
||||
~/.npm
|
||||
node_modules
|
||||
~/.cache/ms-playwright
|
||||
key: ${{ env.CACHE_KEY }}
|
||||
|
||||
- name: Detect changed test files
|
||||
id: changed-tests
|
||||
run: |
|
||||
CHANGED_SPECS=$(git diff --name-only origin/main...HEAD | grep -E '\.(spec|test)\.(ts|js|tsx|jsx)$' || echo "")
|
||||
echo "changed_specs=${CHANGED_SPECS}" >> $GITHUB_OUTPUT
|
||||
echo "Changed specs: ${CHANGED_SPECS}"
|
||||
|
||||
- name: Run burn-in on changed specs (10 iterations)
|
||||
if: steps.changed-tests.outputs.changed_specs != ''
|
||||
run: |
|
||||
SPECS="${{ steps.changed-tests.outputs.changed_specs }}"
|
||||
echo "Running burn-in: 10 iterations on changed specs"
|
||||
for i in {1..10}; do
|
||||
echo "Burn-in iteration $i/10"
|
||||
npm run test -- $SPECS || {
|
||||
echo "❌ Burn-in failed on iteration $i"
|
||||
exit 1
|
||||
}
|
||||
done
|
||||
echo "✅ Burn-in passed - 10/10 successful runs"
|
||||
|
||||
- name: Upload artifacts on failure
|
||||
if: failure()
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: burn-in-failure-artifacts
|
||||
path: |
|
||||
test-results/
|
||||
playwright-report/
|
||||
screenshots/
|
||||
retention-days: 7
|
||||
|
||||
test-e2e-sharded:
|
||||
name: E2E Tests (Shard ${{ matrix.shard }}/${{ strategy.job-total }})
|
||||
needs: [install-dependencies, test-changed-specs]
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 30
|
||||
strategy:
|
||||
fail-fast: false # Run all shards even if one fails
|
||||
matrix:
|
||||
shard: [1, 2, 3, 4]
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version-file: ${{ env.NODE_VERSION_FILE }}
|
||||
cache: 'npm'
|
||||
|
||||
- name: Restore dependencies
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: |
|
||||
~/.npm
|
||||
node_modules
|
||||
~/.cache/ms-playwright
|
||||
key: ${{ env.CACHE_KEY }}
|
||||
|
||||
- name: Run E2E tests (shard ${{ matrix.shard }})
|
||||
run: npm run test:e2e -- --shard=${{ matrix.shard }}/4
|
||||
env:
|
||||
TEST_ENV: staging
|
||||
CI: true
|
||||
|
||||
- name: Upload test results
|
||||
if: always()
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: test-results-shard-${{ matrix.shard }}
|
||||
path: |
|
||||
test-results/
|
||||
playwright-report/
|
||||
retention-days: 30
|
||||
|
||||
- name: Upload JUnit report
|
||||
if: always()
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: junit-results-shard-${{ matrix.shard }}
|
||||
path: test-results/junit.xml
|
||||
retention-days: 30
|
||||
|
||||
merge-test-results:
|
||||
name: Merge Test Results & Generate Report
|
||||
needs: test-e2e-sharded
|
||||
runs-on: ubuntu-latest
|
||||
if: always()
|
||||
steps:
|
||||
- name: Download all shard results
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
pattern: test-results-shard-*
|
||||
path: all-results/
|
||||
|
||||
- name: Merge HTML reports
|
||||
run: |
|
||||
npx playwright merge-reports --reporter=html all-results/
|
||||
echo "Merged report available in playwright-report/"
|
||||
|
||||
- name: Upload merged report
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: merged-playwright-report
|
||||
path: playwright-report/
|
||||
retention-days: 30
|
||||
|
||||
- name: Comment PR with results
|
||||
if: github.event_name == 'pull_request'
|
||||
uses: daun/playwright-report-comment@v3
|
||||
with:
|
||||
report-path: playwright-report/
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Install once, reuse everywhere**: Dependencies cached across all jobs
|
||||
- **Burn-in first**: Changed specs run 10x before full suite
|
||||
- **Fail-fast disabled**: All shards run to completion for full evidence
|
||||
- **Parallel execution**: 4 shards cut execution time by ~75%
|
||||
- **Artifact retention**: 30 days for reports, 7 days for failure debugging
|
||||
|
||||
---
|
||||
|
||||
### Example 2: Burn-In Loop Pattern (Standalone Script)
|
||||
|
||||
**Context**: Reusable bash script for burn-in testing changed specs locally or in CI.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# scripts/burn-in-changed.sh
|
||||
# Usage: ./scripts/burn-in-changed.sh [iterations] [base-branch]
|
||||
|
||||
set -e # Exit on error
|
||||
|
||||
# Configuration
|
||||
ITERATIONS=${1:-10}
|
||||
BASE_BRANCH=${2:-main}
|
||||
SPEC_PATTERN='\.(spec|test)\.(ts|js|tsx|jsx)$'
|
||||
|
||||
echo "🔥 Burn-In Test Runner"
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
echo "Iterations: $ITERATIONS"
|
||||
echo "Base branch: $BASE_BRANCH"
|
||||
echo ""
|
||||
|
||||
# Detect changed test files
|
||||
echo "📋 Detecting changed test files..."
|
||||
CHANGED_SPECS=$(git diff --name-only $BASE_BRANCH...HEAD | grep -E "$SPEC_PATTERN" || echo "")
|
||||
|
||||
if [ -z "$CHANGED_SPECS" ]; then
|
||||
echo "✅ No test files changed. Skipping burn-in."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
echo "Changed test files:"
|
||||
echo "$CHANGED_SPECS" | sed 's/^/ - /'
|
||||
echo ""
|
||||
|
||||
# Count specs
|
||||
SPEC_COUNT=$(echo "$CHANGED_SPECS" | wc -l | xargs)
|
||||
echo "Running burn-in on $SPEC_COUNT test file(s)..."
|
||||
echo ""
|
||||
|
||||
# Burn-in loop
|
||||
FAILURES=()
|
||||
for i in $(seq 1 $ITERATIONS); do
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
echo "🔄 Iteration $i/$ITERATIONS"
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
|
||||
# Run tests with explicit file list
|
||||
if npm run test -- $CHANGED_SPECS 2>&1 | tee "burn-in-log-$i.txt"; then
|
||||
echo "✅ Iteration $i passed"
|
||||
else
|
||||
echo "❌ Iteration $i failed"
|
||||
FAILURES+=($i)
|
||||
|
||||
# Save failure artifacts
|
||||
mkdir -p burn-in-failures/iteration-$i
|
||||
cp -r test-results/ burn-in-failures/iteration-$i/ 2>/dev/null || true
|
||||
cp -r screenshots/ burn-in-failures/iteration-$i/ 2>/dev/null || true
|
||||
|
||||
echo ""
|
||||
echo "🛑 BURN-IN FAILED on iteration $i"
|
||||
echo "Failure artifacts saved to: burn-in-failures/iteration-$i/"
|
||||
echo "Logs saved to: burn-in-log-$i.txt"
|
||||
echo ""
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo ""
|
||||
done
|
||||
|
||||
# Success summary
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
echo "🎉 BURN-IN PASSED"
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
echo "All $ITERATIONS iterations passed for $SPEC_COUNT test file(s)"
|
||||
echo "Changed specs are stable and ready to merge."
|
||||
echo ""
|
||||
|
||||
# Cleanup logs
|
||||
rm -f burn-in-log-*.txt
|
||||
|
||||
exit 0
|
||||
```
|
||||
|
||||
**Usage**:
|
||||
|
||||
```bash
|
||||
# Run locally with default settings (10 iterations, compare to main)
|
||||
./scripts/burn-in-changed.sh
|
||||
|
||||
# Custom iterations and base branch
|
||||
./scripts/burn-in-changed.sh 20 develop
|
||||
|
||||
# Add to package.json
|
||||
{
|
||||
"scripts": {
|
||||
"test:burn-in": "bash scripts/burn-in-changed.sh",
|
||||
"test:burn-in:strict": "bash scripts/burn-in-changed.sh 20"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Exit on first failure**: Flaky tests caught immediately
|
||||
- **Failure artifacts**: Saved per-iteration for debugging
|
||||
- **Flexible configuration**: Iterations and base branch customizable
|
||||
- **CI/local parity**: Same script runs in both environments
|
||||
- **Clear output**: Visual feedback on progress and results
|
||||
|
||||
---
|
||||
|
||||
### Example 3: Shard Orchestration with Result Aggregation
|
||||
|
||||
**Context**: Advanced sharding strategy for large test suites with intelligent result merging.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```javascript
|
||||
// scripts/run-sharded-tests.js
|
||||
const { spawn } = require('child_process');
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
|
||||
/**
|
||||
* Run tests across multiple shards and aggregate results
|
||||
* Usage: node scripts/run-sharded-tests.js --shards=4 --env=staging
|
||||
*/
|
||||
|
||||
const SHARD_COUNT = parseInt(process.env.SHARD_COUNT || '4');
|
||||
const TEST_ENV = process.env.TEST_ENV || 'local';
|
||||
const RESULTS_DIR = path.join(__dirname, '../test-results');
|
||||
|
||||
console.log(`🚀 Running tests across ${SHARD_COUNT} shards`);
|
||||
console.log(`Environment: ${TEST_ENV}`);
|
||||
console.log('━'.repeat(50));
|
||||
|
||||
// Ensure results directory exists
|
||||
if (!fs.existsSync(RESULTS_DIR)) {
|
||||
fs.mkdirSync(RESULTS_DIR, { recursive: true });
|
||||
}
|
||||
|
||||
/**
|
||||
* Run a single shard
|
||||
*/
|
||||
function runShard(shardIndex) {
|
||||
return new Promise((resolve, reject) => {
|
||||
const shardId = `${shardIndex}/${SHARD_COUNT}`;
|
||||
console.log(`\n📦 Starting shard ${shardId}...`);
|
||||
|
||||
const child = spawn('npx', ['playwright', 'test', `--shard=${shardId}`, '--reporter=json'], {
|
||||
env: { ...process.env, TEST_ENV, SHARD_INDEX: shardIndex },
|
||||
stdio: 'pipe',
|
||||
});
|
||||
|
||||
let stdout = '';
|
||||
let stderr = '';
|
||||
|
||||
child.stdout.on('data', (data) => {
|
||||
stdout += data.toString();
|
||||
process.stdout.write(data);
|
||||
});
|
||||
|
||||
child.stderr.on('data', (data) => {
|
||||
stderr += data.toString();
|
||||
process.stderr.write(data);
|
||||
});
|
||||
|
||||
child.on('close', (code) => {
|
||||
// Save shard results
|
||||
const resultFile = path.join(RESULTS_DIR, `shard-${shardIndex}.json`);
|
||||
try {
|
||||
const result = JSON.parse(stdout);
|
||||
fs.writeFileSync(resultFile, JSON.stringify(result, null, 2));
|
||||
console.log(`✅ Shard ${shardId} completed (exit code: ${code})`);
|
||||
resolve({ shardIndex, code, result });
|
||||
} catch (error) {
|
||||
console.error(`❌ Shard ${shardId} failed to parse results:`, error.message);
|
||||
reject({ shardIndex, code, error });
|
||||
}
|
||||
});
|
||||
|
||||
child.on('error', (error) => {
|
||||
console.error(`❌ Shard ${shardId} process error:`, error.message);
|
||||
reject({ shardIndex, error });
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Aggregate results from all shards
|
||||
*/
|
||||
function aggregateResults() {
|
||||
console.log('\n📊 Aggregating results from all shards...');
|
||||
|
||||
const shardResults = [];
|
||||
let totalTests = 0;
|
||||
let totalPassed = 0;
|
||||
let totalFailed = 0;
|
||||
let totalSkipped = 0;
|
||||
let totalFlaky = 0;
|
||||
|
||||
for (let i = 1; i <= SHARD_COUNT; i++) {
|
||||
const resultFile = path.join(RESULTS_DIR, `shard-${i}.json`);
|
||||
if (fs.existsSync(resultFile)) {
|
||||
const result = JSON.parse(fs.readFileSync(resultFile, 'utf8'));
|
||||
shardResults.push(result);
|
||||
|
||||
// Aggregate stats
|
||||
totalTests += result.stats?.expected || 0;
|
||||
totalPassed += result.stats?.expected || 0;
|
||||
totalFailed += result.stats?.unexpected || 0;
|
||||
totalSkipped += result.stats?.skipped || 0;
|
||||
totalFlaky += result.stats?.flaky || 0;
|
||||
}
|
||||
}
|
||||
|
||||
const summary = {
|
||||
totalShards: SHARD_COUNT,
|
||||
environment: TEST_ENV,
|
||||
totalTests,
|
||||
passed: totalPassed,
|
||||
failed: totalFailed,
|
||||
skipped: totalSkipped,
|
||||
flaky: totalFlaky,
|
||||
duration: shardResults.reduce((acc, r) => acc + (r.duration || 0), 0),
|
||||
timestamp: new Date().toISOString(),
|
||||
};
|
||||
|
||||
// Save aggregated summary
|
||||
fs.writeFileSync(path.join(RESULTS_DIR, 'summary.json'), JSON.stringify(summary, null, 2));
|
||||
|
||||
console.log('\n━'.repeat(50));
|
||||
console.log('📈 Test Results Summary');
|
||||
console.log('━'.repeat(50));
|
||||
console.log(`Total tests: ${totalTests}`);
|
||||
console.log(`✅ Passed: ${totalPassed}`);
|
||||
console.log(`❌ Failed: ${totalFailed}`);
|
||||
console.log(`⏭️ Skipped: ${totalSkipped}`);
|
||||
console.log(`⚠️ Flaky: ${totalFlaky}`);
|
||||
console.log(`⏱️ Duration: ${(summary.duration / 1000).toFixed(2)}s`);
|
||||
console.log('━'.repeat(50));
|
||||
|
||||
return summary;
|
||||
}
|
||||
|
||||
/**
|
||||
* Main execution
|
||||
*/
|
||||
async function main() {
|
||||
const startTime = Date.now();
|
||||
const shardPromises = [];
|
||||
|
||||
// Run all shards in parallel
|
||||
for (let i = 1; i <= SHARD_COUNT; i++) {
|
||||
shardPromises.push(runShard(i));
|
||||
}
|
||||
|
||||
try {
|
||||
await Promise.allSettled(shardPromises);
|
||||
} catch (error) {
|
||||
console.error('❌ One or more shards failed:', error);
|
||||
}
|
||||
|
||||
// Aggregate results
|
||||
const summary = aggregateResults();
|
||||
|
||||
const totalTime = ((Date.now() - startTime) / 1000).toFixed(2);
|
||||
console.log(`\n⏱️ Total execution time: ${totalTime}s`);
|
||||
|
||||
// Exit with failure if any tests failed
|
||||
if (summary.failed > 0) {
|
||||
console.error('\n❌ Test suite failed');
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
console.log('\n✅ All tests passed');
|
||||
process.exit(0);
|
||||
}
|
||||
|
||||
main().catch((error) => {
|
||||
console.error('Fatal error:', error);
|
||||
process.exit(1);
|
||||
});
|
||||
```
|
||||
|
||||
**package.json integration**:
|
||||
|
||||
```json
|
||||
{
|
||||
"scripts": {
|
||||
"test:sharded": "node scripts/run-sharded-tests.js",
|
||||
"test:sharded:ci": "SHARD_COUNT=8 TEST_ENV=staging node scripts/run-sharded-tests.js"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Parallel shard execution**: All shards run simultaneously
|
||||
- **Result aggregation**: Unified summary across shards
|
||||
- **Failure detection**: Exit code reflects overall test status
|
||||
- **Artifact preservation**: Individual shard results saved for debugging
|
||||
- **CI/local compatibility**: Same script works in both environments
|
||||
|
||||
---
|
||||
|
||||
### Example 4: Selective Test Execution (Changed Files + Tags)
|
||||
|
||||
**Context**: Optimize CI by running only relevant tests based on file changes and tags.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# scripts/selective-test-runner.sh
|
||||
# Intelligent test selection based on changed files and test tags
|
||||
|
||||
set -e
|
||||
|
||||
BASE_BRANCH=${BASE_BRANCH:-main}
|
||||
TEST_ENV=${TEST_ENV:-local}
|
||||
|
||||
echo "🎯 Selective Test Runner"
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
echo "Base branch: $BASE_BRANCH"
|
||||
echo "Environment: $TEST_ENV"
|
||||
echo ""
|
||||
|
||||
# Detect changed files (all types, not just tests)
|
||||
CHANGED_FILES=$(git diff --name-only $BASE_BRANCH...HEAD)
|
||||
|
||||
if [ -z "$CHANGED_FILES" ]; then
|
||||
echo "✅ No files changed. Skipping tests."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
echo "Changed files:"
|
||||
echo "$CHANGED_FILES" | sed 's/^/ - /'
|
||||
echo ""
|
||||
|
||||
# Determine test strategy based on changes
|
||||
run_smoke_only=false
|
||||
run_all_tests=false
|
||||
affected_specs=""
|
||||
|
||||
# Critical files = run all tests
|
||||
if echo "$CHANGED_FILES" | grep -qE '(package\.json|package-lock\.json|playwright\.config|cypress\.config|\.github/workflows)'; then
|
||||
echo "⚠️ Critical configuration files changed. Running ALL tests."
|
||||
run_all_tests=true
|
||||
|
||||
# Auth/security changes = run all auth + smoke tests
|
||||
elif echo "$CHANGED_FILES" | grep -qE '(auth|login|signup|security)'; then
|
||||
echo "🔒 Auth/security files changed. Running auth + smoke tests."
|
||||
npm run test -- --grep "@auth|@smoke"
|
||||
exit $?
|
||||
|
||||
# API changes = run integration + smoke tests
|
||||
elif echo "$CHANGED_FILES" | grep -qE '(api|service|controller)'; then
|
||||
echo "🔌 API files changed. Running integration + smoke tests."
|
||||
npm run test -- --grep "@integration|@smoke"
|
||||
exit $?
|
||||
|
||||
# UI component changes = run related component tests
|
||||
elif echo "$CHANGED_FILES" | grep -qE '\.(tsx|jsx|vue)$'; then
|
||||
echo "🎨 UI components changed. Running component + smoke tests."
|
||||
|
||||
# Extract component names and find related tests
|
||||
components=$(echo "$CHANGED_FILES" | grep -E '\.(tsx|jsx|vue)$' | xargs -I {} basename {} | sed 's/\.[^.]*$//')
|
||||
for component in $components; do
|
||||
# Find tests matching component name
|
||||
affected_specs+=$(find tests -name "*${component}*" -type f) || true
|
||||
done
|
||||
|
||||
if [ -n "$affected_specs" ]; then
|
||||
echo "Running tests for: $affected_specs"
|
||||
npm run test -- $affected_specs --grep "@smoke"
|
||||
else
|
||||
echo "No specific tests found. Running smoke tests only."
|
||||
npm run test -- --grep "@smoke"
|
||||
fi
|
||||
exit $?
|
||||
|
||||
# Documentation/config only = run smoke tests
|
||||
elif echo "$CHANGED_FILES" | grep -qE '\.(md|txt|json|yml|yaml)$'; then
|
||||
echo "📝 Documentation/config files changed. Running smoke tests only."
|
||||
run_smoke_only=true
|
||||
else
|
||||
echo "⚙️ Other files changed. Running smoke tests."
|
||||
run_smoke_only=true
|
||||
fi
|
||||
|
||||
# Execute selected strategy
|
||||
if [ "$run_all_tests" = true ]; then
|
||||
echo ""
|
||||
echo "Running full test suite..."
|
||||
npm run test
|
||||
elif [ "$run_smoke_only" = true ]; then
|
||||
echo ""
|
||||
echo "Running smoke tests..."
|
||||
npm run test -- --grep "@smoke"
|
||||
fi
|
||||
```
|
||||
|
||||
**Usage in GitHub Actions**:
|
||||
|
||||
```yaml
|
||||
# .github/workflows/selective-tests.yml
|
||||
name: Selective Tests
|
||||
on: pull_request
|
||||
|
||||
jobs:
|
||||
selective-tests:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Run selective tests
|
||||
run: bash scripts/selective-test-runner.sh
|
||||
env:
|
||||
BASE_BRANCH: ${{ github.base_ref }}
|
||||
TEST_ENV: staging
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Intelligent routing**: Tests selected based on changed file types
|
||||
- **Tag-based filtering**: Use @smoke, @auth, @integration tags
|
||||
- **Fast feedback**: Only relevant tests run on most PRs
|
||||
- **Safety net**: Critical changes trigger full suite
|
||||
- **Component mapping**: UI changes run related component tests
|
||||
|
||||
---
|
||||
|
||||
## CI Configuration Checklist
|
||||
|
||||
Before deploying your CI pipeline, verify:
|
||||
|
||||
- [ ] **Caching strategy**: node_modules, npm cache, browser binaries cached
|
||||
- [ ] **Timeout budgets**: Each job has reasonable timeout (10-30 min)
|
||||
- [ ] **Artifact retention**: 30 days for reports, 7 days for failure artifacts
|
||||
- [ ] **Parallelization**: Matrix strategy uses fail-fast: false
|
||||
- [ ] **Burn-in enabled**: Changed specs run 5-10x before merge
|
||||
- [ ] **wait-on app startup**: CI waits for app (wait-on: 'http://localhost:3000')
|
||||
- [ ] **Secrets documented**: README lists required secrets (API keys, tokens)
|
||||
- [ ] **Local parity**: CI scripts runnable locally (npm run test:ci)
|
||||
|
||||
## Integration Points
|
||||
|
||||
- Used in workflows: `*ci` (CI/CD pipeline setup)
|
||||
- Related fragments: `selective-testing.md`, `playwright-config.md`, `test-quality.md`
|
||||
- CI tools: GitHub Actions, GitLab CI, CircleCI, Jenkins
|
||||
|
||||
_Source: Murat CI/CD strategy blog, Playwright/Cypress workflow examples, SEON production pipelines_
|
||||
@ -1,486 +0,0 @@
|
||||
# Component Test-Driven Development Loop
|
||||
|
||||
## Principle
|
||||
|
||||
Start every UI change with a failing component test (`cy.mount`, Playwright component test, or RTL `render`). Follow the Red-Green-Refactor cycle: write a failing test (red), make it pass with minimal code (green), then improve the implementation (refactor). Ship only after the cycle completes. Keep component tests under 100 lines, isolated with fresh providers per test, and validate accessibility alongside functionality.
|
||||
|
||||
## Rationale
|
||||
|
||||
Component TDD provides immediate feedback during development. Failing tests (red) clarify requirements before writing code. Minimal implementations (green) prevent over-engineering. Refactoring with passing tests ensures changes don't break functionality. Isolated tests with fresh providers prevent state bleed in parallel runs. Accessibility assertions catch usability issues early. Visual debugging (Cypress runner, Storybook, Playwright trace viewer) accelerates diagnosis when tests fail.
|
||||
|
||||
## Pattern Examples
|
||||
|
||||
### Example 1: Red-Green-Refactor Loop
|
||||
|
||||
**Context**: When building a new component, start with a failing test that describes the desired behavior. Implement just enough to pass, then refactor for quality.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// Step 1: RED - Write failing test
|
||||
// Button.cy.tsx (Cypress Component Test)
|
||||
import { Button } from './Button';
|
||||
|
||||
describe('Button Component', () => {
|
||||
it('should render with label', () => {
|
||||
cy.mount(<Button label="Click Me" />);
|
||||
cy.contains('Click Me').should('be.visible');
|
||||
});
|
||||
|
||||
it('should call onClick when clicked', () => {
|
||||
const onClickSpy = cy.stub().as('onClick');
|
||||
cy.mount(<Button label="Submit" onClick={onClickSpy} />);
|
||||
|
||||
cy.get('button').click();
|
||||
cy.get('@onClick').should('have.been.calledOnce');
|
||||
});
|
||||
});
|
||||
|
||||
// Run test: FAILS - Button component doesn't exist yet
|
||||
// Error: "Cannot find module './Button'"
|
||||
|
||||
// Step 2: GREEN - Minimal implementation
|
||||
// Button.tsx
|
||||
type ButtonProps = {
|
||||
label: string;
|
||||
onClick?: () => void;
|
||||
};
|
||||
|
||||
export const Button = ({ label, onClick }: ButtonProps) => {
|
||||
return <button onClick={onClick}>{label}</button>;
|
||||
};
|
||||
|
||||
// Run test: PASSES - Component renders and handles clicks
|
||||
|
||||
// Step 3: REFACTOR - Improve implementation
|
||||
// Add disabled state, loading state, variants
|
||||
type ButtonProps = {
|
||||
label: string;
|
||||
onClick?: () => void;
|
||||
disabled?: boolean;
|
||||
loading?: boolean;
|
||||
variant?: 'primary' | 'secondary' | 'danger';
|
||||
};
|
||||
|
||||
export const Button = ({
|
||||
label,
|
||||
onClick,
|
||||
disabled = false,
|
||||
loading = false,
|
||||
variant = 'primary'
|
||||
}: ButtonProps) => {
|
||||
return (
|
||||
<button
|
||||
onClick={onClick}
|
||||
disabled={disabled || loading}
|
||||
className={`btn btn-${variant}`}
|
||||
data-testid="button"
|
||||
>
|
||||
{loading ? <Spinner /> : label}
|
||||
</button>
|
||||
);
|
||||
};
|
||||
|
||||
// Step 4: Expand tests for new features
|
||||
describe('Button Component', () => {
|
||||
it('should render with label', () => {
|
||||
cy.mount(<Button label="Click Me" />);
|
||||
cy.contains('Click Me').should('be.visible');
|
||||
});
|
||||
|
||||
it('should call onClick when clicked', () => {
|
||||
const onClickSpy = cy.stub().as('onClick');
|
||||
cy.mount(<Button label="Submit" onClick={onClickSpy} />);
|
||||
|
||||
cy.get('button').click();
|
||||
cy.get('@onClick').should('have.been.calledOnce');
|
||||
});
|
||||
|
||||
it('should be disabled when disabled prop is true', () => {
|
||||
cy.mount(<Button label="Submit" disabled={true} />);
|
||||
cy.get('button').should('be.disabled');
|
||||
});
|
||||
|
||||
it('should show spinner when loading', () => {
|
||||
cy.mount(<Button label="Submit" loading={true} />);
|
||||
cy.get('[data-testid="spinner"]').should('be.visible');
|
||||
cy.get('button').should('be.disabled');
|
||||
});
|
||||
|
||||
it('should apply variant styles', () => {
|
||||
cy.mount(<Button label="Delete" variant="danger" />);
|
||||
cy.get('button').should('have.class', 'btn-danger');
|
||||
});
|
||||
});
|
||||
|
||||
// Run tests: ALL PASS - Refactored component still works
|
||||
|
||||
// Playwright Component Test equivalent
|
||||
import { test, expect } from '@playwright/experimental-ct-react';
|
||||
import { Button } from './Button';
|
||||
|
||||
test.describe('Button Component', () => {
|
||||
test('should call onClick when clicked', async ({ mount }) => {
|
||||
let clicked = false;
|
||||
const component = await mount(
|
||||
<Button label="Submit" onClick={() => { clicked = true; }} />
|
||||
);
|
||||
|
||||
await component.getByRole('button').click();
|
||||
expect(clicked).toBe(true);
|
||||
});
|
||||
|
||||
test('should be disabled when loading', async ({ mount }) => {
|
||||
const component = await mount(<Button label="Submit" loading={true} />);
|
||||
await expect(component.getByRole('button')).toBeDisabled();
|
||||
await expect(component.getByTestId('spinner')).toBeVisible();
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Red: Write failing test first - clarifies requirements before coding
|
||||
- Green: Implement minimal code to pass - prevents over-engineering
|
||||
- Refactor: Improve code quality while keeping tests green
|
||||
- Expand: Add tests for new features after refactoring
|
||||
- Cycle repeats: Each new feature starts with a failing test
|
||||
|
||||
### Example 2: Provider Isolation Pattern
|
||||
|
||||
**Context**: When testing components that depend on context providers (React Query, Auth, Router), wrap them with required providers in each test to prevent state bleed between tests.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// test-utils/AllTheProviders.tsx
|
||||
import { FC, ReactNode } from 'react';
|
||||
import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
|
||||
import { BrowserRouter } from 'react-router-dom';
|
||||
import { AuthProvider } from '../contexts/AuthContext';
|
||||
|
||||
type Props = {
|
||||
children: ReactNode;
|
||||
initialAuth?: { user: User | null; token: string | null };
|
||||
};
|
||||
|
||||
export const AllTheProviders: FC<Props> = ({ children, initialAuth }) => {
|
||||
// Create NEW QueryClient per test (prevent state bleed)
|
||||
const queryClient = new QueryClient({
|
||||
defaultOptions: {
|
||||
queries: { retry: false },
|
||||
mutations: { retry: false }
|
||||
}
|
||||
});
|
||||
|
||||
return (
|
||||
<QueryClientProvider client={queryClient}>
|
||||
<BrowserRouter>
|
||||
<AuthProvider initialAuth={initialAuth}>
|
||||
{children}
|
||||
</AuthProvider>
|
||||
</BrowserRouter>
|
||||
</QueryClientProvider>
|
||||
);
|
||||
};
|
||||
|
||||
// Cypress custom mount command
|
||||
// cypress/support/component.tsx
|
||||
import { mount } from 'cypress/react18';
|
||||
import { AllTheProviders } from '../../test-utils/AllTheProviders';
|
||||
|
||||
Cypress.Commands.add('wrappedMount', (component, options = {}) => {
|
||||
const { initialAuth, ...mountOptions } = options;
|
||||
|
||||
return mount(
|
||||
<AllTheProviders initialAuth={initialAuth}>
|
||||
{component}
|
||||
</AllTheProviders>,
|
||||
mountOptions
|
||||
);
|
||||
});
|
||||
|
||||
// Usage in tests
|
||||
// UserProfile.cy.tsx
|
||||
import { UserProfile } from './UserProfile';
|
||||
|
||||
describe('UserProfile Component', () => {
|
||||
it('should display user when authenticated', () => {
|
||||
const user = { id: 1, name: 'John Doe', email: 'john@example.com' };
|
||||
|
||||
cy.wrappedMount(<UserProfile />, {
|
||||
initialAuth: { user, token: 'fake-token' }
|
||||
});
|
||||
|
||||
cy.contains('John Doe').should('be.visible');
|
||||
cy.contains('john@example.com').should('be.visible');
|
||||
});
|
||||
|
||||
it('should show login prompt when not authenticated', () => {
|
||||
cy.wrappedMount(<UserProfile />, {
|
||||
initialAuth: { user: null, token: null }
|
||||
});
|
||||
|
||||
cy.contains('Please log in').should('be.visible');
|
||||
});
|
||||
});
|
||||
|
||||
// Playwright Component Test with providers
|
||||
import { test, expect } from '@playwright/experimental-ct-react';
|
||||
import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
|
||||
import { UserProfile } from './UserProfile';
|
||||
import { AuthProvider } from '../contexts/AuthContext';
|
||||
|
||||
test.describe('UserProfile Component', () => {
|
||||
test('should display user when authenticated', async ({ mount }) => {
|
||||
const user = { id: 1, name: 'John Doe', email: 'john@example.com' };
|
||||
const queryClient = new QueryClient();
|
||||
|
||||
const component = await mount(
|
||||
<QueryClientProvider client={queryClient}>
|
||||
<AuthProvider initialAuth={{ user, token: 'fake-token' }}>
|
||||
<UserProfile />
|
||||
</AuthProvider>
|
||||
</QueryClientProvider>
|
||||
);
|
||||
|
||||
await expect(component.getByText('John Doe')).toBeVisible();
|
||||
await expect(component.getByText('john@example.com')).toBeVisible();
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Create NEW providers per test (QueryClient, Router, Auth)
|
||||
- Prevents state pollution between tests
|
||||
- `initialAuth` prop allows testing different auth states
|
||||
- Custom mount command (`wrappedMount`) reduces boilerplate
|
||||
- Providers wrap component, not the entire test suite
|
||||
|
||||
### Example 3: Accessibility Assertions
|
||||
|
||||
**Context**: When testing components, validate accessibility alongside functionality using axe-core, ARIA roles, labels, and keyboard navigation.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// Cypress with axe-core
|
||||
// cypress/support/component.tsx
|
||||
import 'cypress-axe';
|
||||
|
||||
// Form.cy.tsx
|
||||
import { Form } from './Form';
|
||||
|
||||
describe('Form Component Accessibility', () => {
|
||||
beforeEach(() => {
|
||||
cy.wrappedMount(<Form />);
|
||||
cy.injectAxe(); // Inject axe-core
|
||||
});
|
||||
|
||||
it('should have no accessibility violations', () => {
|
||||
cy.checkA11y(); // Run axe scan
|
||||
});
|
||||
|
||||
it('should have proper ARIA labels', () => {
|
||||
cy.get('input[name="email"]').should('have.attr', 'aria-label', 'Email address');
|
||||
cy.get('input[name="password"]').should('have.attr', 'aria-label', 'Password');
|
||||
cy.get('button[type="submit"]').should('have.attr', 'aria-label', 'Submit form');
|
||||
});
|
||||
|
||||
it('should support keyboard navigation', () => {
|
||||
// Tab through form fields
|
||||
cy.get('input[name="email"]').focus().type('test@example.com');
|
||||
cy.realPress('Tab'); // cypress-real-events plugin
|
||||
cy.focused().should('have.attr', 'name', 'password');
|
||||
|
||||
cy.focused().type('password123');
|
||||
cy.realPress('Tab');
|
||||
cy.focused().should('have.attr', 'type', 'submit');
|
||||
|
||||
cy.realPress('Enter'); // Submit via keyboard
|
||||
cy.contains('Form submitted').should('be.visible');
|
||||
});
|
||||
|
||||
it('should announce errors to screen readers', () => {
|
||||
cy.get('button[type="submit"]').click(); // Submit without data
|
||||
|
||||
// Error has role="alert" and aria-live="polite"
|
||||
cy.get('[role="alert"]')
|
||||
.should('be.visible')
|
||||
.and('have.attr', 'aria-live', 'polite')
|
||||
.and('contain', 'Email is required');
|
||||
});
|
||||
|
||||
it('should have sufficient color contrast', () => {
|
||||
cy.checkA11y(null, {
|
||||
rules: {
|
||||
'color-contrast': { enabled: true }
|
||||
}
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
// Playwright with axe-playwright
|
||||
import { test, expect } from '@playwright/experimental-ct-react';
|
||||
import AxeBuilder from '@axe-core/playwright';
|
||||
import { Form } from './Form';
|
||||
|
||||
test.describe('Form Component Accessibility', () => {
|
||||
test('should have no accessibility violations', async ({ mount, page }) => {
|
||||
await mount(<Form />);
|
||||
|
||||
const accessibilityScanResults = await new AxeBuilder({ page })
|
||||
.analyze();
|
||||
|
||||
expect(accessibilityScanResults.violations).toEqual([]);
|
||||
});
|
||||
|
||||
test('should support keyboard navigation', async ({ mount, page }) => {
|
||||
const component = await mount(<Form />);
|
||||
|
||||
await component.getByLabel('Email address').fill('test@example.com');
|
||||
await page.keyboard.press('Tab');
|
||||
|
||||
await expect(component.getByLabel('Password')).toBeFocused();
|
||||
|
||||
await component.getByLabel('Password').fill('password123');
|
||||
await page.keyboard.press('Tab');
|
||||
|
||||
await expect(component.getByRole('button', { name: 'Submit form' })).toBeFocused();
|
||||
|
||||
await page.keyboard.press('Enter');
|
||||
await expect(component.getByText('Form submitted')).toBeVisible();
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Use `cy.checkA11y()` (Cypress) or `AxeBuilder` (Playwright) for automated accessibility scanning
|
||||
- Validate ARIA roles, labels, and live regions
|
||||
- Test keyboard navigation (Tab, Enter, Escape)
|
||||
- Ensure errors are announced to screen readers (`role="alert"`, `aria-live`)
|
||||
- Check color contrast meets WCAG standards
|
||||
|
||||
### Example 4: Visual Regression Test
|
||||
|
||||
**Context**: When testing components, capture screenshots to detect unintended visual changes. Use Playwright visual comparison or Cypress snapshot plugins.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// Playwright visual regression
|
||||
import { test, expect } from '@playwright/experimental-ct-react';
|
||||
import { Button } from './Button';
|
||||
|
||||
test.describe('Button Visual Regression', () => {
|
||||
test('should match primary button snapshot', async ({ mount }) => {
|
||||
const component = await mount(<Button label="Primary" variant="primary" />);
|
||||
|
||||
// Capture and compare screenshot
|
||||
await expect(component).toHaveScreenshot('button-primary.png');
|
||||
});
|
||||
|
||||
test('should match secondary button snapshot', async ({ mount }) => {
|
||||
const component = await mount(<Button label="Secondary" variant="secondary" />);
|
||||
await expect(component).toHaveScreenshot('button-secondary.png');
|
||||
});
|
||||
|
||||
test('should match disabled button snapshot', async ({ mount }) => {
|
||||
const component = await mount(<Button label="Disabled" disabled={true} />);
|
||||
await expect(component).toHaveScreenshot('button-disabled.png');
|
||||
});
|
||||
|
||||
test('should match loading button snapshot', async ({ mount }) => {
|
||||
const component = await mount(<Button label="Loading" loading={true} />);
|
||||
await expect(component).toHaveScreenshot('button-loading.png');
|
||||
});
|
||||
});
|
||||
|
||||
// Cypress visual regression with percy or snapshot plugins
|
||||
import { Button } from './Button';
|
||||
|
||||
describe('Button Visual Regression', () => {
|
||||
it('should match primary button snapshot', () => {
|
||||
cy.wrappedMount(<Button label="Primary" variant="primary" />);
|
||||
|
||||
// Option 1: Percy (cloud-based visual testing)
|
||||
cy.percySnapshot('Button - Primary');
|
||||
|
||||
// Option 2: cypress-plugin-snapshots (local snapshots)
|
||||
cy.get('button').toMatchImageSnapshot({
|
||||
name: 'button-primary',
|
||||
threshold: 0.01 // 1% threshold for pixel differences
|
||||
});
|
||||
});
|
||||
|
||||
it('should match hover state', () => {
|
||||
cy.wrappedMount(<Button label="Hover Me" />);
|
||||
cy.get('button').realHover(); // cypress-real-events
|
||||
cy.percySnapshot('Button - Hover State');
|
||||
});
|
||||
|
||||
it('should match focus state', () => {
|
||||
cy.wrappedMount(<Button label="Focus Me" />);
|
||||
cy.get('button').focus();
|
||||
cy.percySnapshot('Button - Focus State');
|
||||
});
|
||||
});
|
||||
|
||||
// Playwright configuration for visual regression
|
||||
// playwright.config.ts
|
||||
export default defineConfig({
|
||||
expect: {
|
||||
toHaveScreenshot: {
|
||||
maxDiffPixels: 100, // Allow 100 pixels difference
|
||||
threshold: 0.2 // 20% threshold
|
||||
}
|
||||
},
|
||||
use: {
|
||||
screenshot: 'only-on-failure'
|
||||
}
|
||||
});
|
||||
|
||||
// Update snapshots when intentional changes are made
|
||||
// npx playwright test --update-snapshots
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Playwright: Use `toHaveScreenshot()` for built-in visual comparison
|
||||
- Cypress: Use Percy (cloud) or snapshot plugins (local) for visual testing
|
||||
- Capture different states: default, hover, focus, disabled, loading
|
||||
- Set threshold for acceptable pixel differences (avoid false positives)
|
||||
- Update snapshots when visual changes are intentional
|
||||
- Visual tests catch unintended CSS/layout regressions
|
||||
|
||||
## Integration Points
|
||||
|
||||
- **Used in workflows**: `*atdd` (component test generation), `*automate` (component test expansion), `*framework` (component testing setup)
|
||||
- **Related fragments**:
|
||||
- `test-quality.md` - Keep component tests <100 lines, isolated, focused
|
||||
- `fixture-architecture.md` - Provider wrapping patterns, custom mount commands
|
||||
- `data-factories.md` - Factory functions for component props
|
||||
- `test-levels-framework.md` - When to use component tests vs E2E tests
|
||||
|
||||
## TDD Workflow Summary
|
||||
|
||||
**Red-Green-Refactor Cycle**:
|
||||
|
||||
1. **Red**: Write failing test describing desired behavior
|
||||
2. **Green**: Implement minimal code to make test pass
|
||||
3. **Refactor**: Improve code quality, tests stay green
|
||||
4. **Repeat**: Each new feature starts with failing test
|
||||
|
||||
**Component Test Checklist**:
|
||||
|
||||
- [ ] Test renders with required props
|
||||
- [ ] Test user interactions (click, type, submit)
|
||||
- [ ] Test different states (loading, error, disabled)
|
||||
- [ ] Test accessibility (ARIA, keyboard navigation)
|
||||
- [ ] Test visual regression (snapshots)
|
||||
- [ ] Isolate with fresh providers (no state bleed)
|
||||
- [ ] Keep tests <100 lines (split by intent)
|
||||
|
||||
_Source: CCTDD repository, Murat component testing talks, Playwright/Cypress component testing docs._
|
||||
@ -1,957 +0,0 @@
|
||||
# Contract Testing Essentials (Pact)
|
||||
|
||||
## Principle
|
||||
|
||||
Contract testing validates API contracts between consumer and provider services without requiring integrated end-to-end tests. Store consumer contracts alongside integration specs, version contracts semantically, and publish on every CI run. Provider verification before merge surfaces breaking changes immediately, while explicit fallback behavior (timeouts, retries, error payloads) captures resilience guarantees in contracts.
|
||||
|
||||
## Rationale
|
||||
|
||||
Traditional integration testing requires running both consumer and provider simultaneously, creating slow, flaky tests with complex setup. Contract testing decouples services: consumers define expectations (pact files), providers verify against those expectations independently. This enables parallel development, catches breaking changes early, and documents API behavior as executable specifications. Pair contract tests with API smoke tests to validate data mapping and UI rendering in tandem.
|
||||
|
||||
## Pattern Examples
|
||||
|
||||
### Example 1: Pact Consumer Test (Frontend → Backend API)
|
||||
|
||||
**Context**: React application consuming a user management API, defining expected interactions.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/contract/user-api.pact.spec.ts
|
||||
import { PactV3, MatchersV3 } from '@pact-foundation/pact';
|
||||
import { getUserById, createUser, User } from '@/api/user-service';
|
||||
|
||||
const { like, eachLike, string, integer } = MatchersV3;
|
||||
|
||||
/**
|
||||
* Consumer-Driven Contract Test
|
||||
* - Consumer (React app) defines expected API behavior
|
||||
* - Generates pact file for provider to verify
|
||||
* - Runs in isolation (no real backend required)
|
||||
*/
|
||||
|
||||
const provider = new PactV3({
|
||||
consumer: 'user-management-web',
|
||||
provider: 'user-api-service',
|
||||
dir: './pacts', // Output directory for pact files
|
||||
logLevel: 'warn',
|
||||
});
|
||||
|
||||
describe('User API Contract', () => {
|
||||
describe('GET /users/:id', () => {
|
||||
it('should return user when user exists', async () => {
|
||||
// Arrange: Define expected interaction
|
||||
await provider
|
||||
.given('user with id 1 exists') // Provider state
|
||||
.uponReceiving('a request for user 1')
|
||||
.withRequest({
|
||||
method: 'GET',
|
||||
path: '/users/1',
|
||||
headers: {
|
||||
Accept: 'application/json',
|
||||
Authorization: like('Bearer token123'), // Matcher: any string
|
||||
},
|
||||
})
|
||||
.willRespondWith({
|
||||
status: 200,
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
},
|
||||
body: like({
|
||||
id: integer(1),
|
||||
name: string('John Doe'),
|
||||
email: string('john@example.com'),
|
||||
role: string('user'),
|
||||
createdAt: string('2025-01-15T10:00:00Z'),
|
||||
}),
|
||||
})
|
||||
.executeTest(async (mockServer) => {
|
||||
// Act: Call consumer code against mock server
|
||||
const user = await getUserById(1, {
|
||||
baseURL: mockServer.url,
|
||||
headers: { Authorization: 'Bearer token123' },
|
||||
});
|
||||
|
||||
// Assert: Validate consumer behavior
|
||||
expect(user).toEqual(
|
||||
expect.objectContaining({
|
||||
id: 1,
|
||||
name: 'John Doe',
|
||||
email: 'john@example.com',
|
||||
role: 'user',
|
||||
}),
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
it('should handle 404 when user does not exist', async () => {
|
||||
await provider
|
||||
.given('user with id 999 does not exist')
|
||||
.uponReceiving('a request for non-existent user')
|
||||
.withRequest({
|
||||
method: 'GET',
|
||||
path: '/users/999',
|
||||
headers: { Accept: 'application/json' },
|
||||
})
|
||||
.willRespondWith({
|
||||
status: 404,
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: {
|
||||
error: 'User not found',
|
||||
code: 'USER_NOT_FOUND',
|
||||
},
|
||||
})
|
||||
.executeTest(async (mockServer) => {
|
||||
// Act & Assert: Consumer handles 404 gracefully
|
||||
await expect(getUserById(999, { baseURL: mockServer.url })).rejects.toThrow('User not found');
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('POST /users', () => {
|
||||
it('should create user and return 201', async () => {
|
||||
const newUser: Omit<User, 'id' | 'createdAt'> = {
|
||||
name: 'Jane Smith',
|
||||
email: 'jane@example.com',
|
||||
role: 'admin',
|
||||
};
|
||||
|
||||
await provider
|
||||
.given('no users exist')
|
||||
.uponReceiving('a request to create a user')
|
||||
.withRequest({
|
||||
method: 'POST',
|
||||
path: '/users',
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
Accept: 'application/json',
|
||||
},
|
||||
body: like(newUser),
|
||||
})
|
||||
.willRespondWith({
|
||||
status: 201,
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: like({
|
||||
id: integer(2),
|
||||
name: string('Jane Smith'),
|
||||
email: string('jane@example.com'),
|
||||
role: string('admin'),
|
||||
createdAt: string('2025-01-15T11:00:00Z'),
|
||||
}),
|
||||
})
|
||||
.executeTest(async (mockServer) => {
|
||||
const createdUser = await createUser(newUser, {
|
||||
baseURL: mockServer.url,
|
||||
});
|
||||
|
||||
expect(createdUser).toEqual(
|
||||
expect.objectContaining({
|
||||
id: expect.any(Number),
|
||||
name: 'Jane Smith',
|
||||
email: 'jane@example.com',
|
||||
role: 'admin',
|
||||
}),
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**package.json scripts**:
|
||||
|
||||
```json
|
||||
{
|
||||
"scripts": {
|
||||
"test:contract": "jest tests/contract --testTimeout=30000",
|
||||
"pact:publish": "pact-broker publish ./pacts --consumer-app-version=$GIT_SHA --broker-base-url=$PACT_BROKER_URL --broker-token=$PACT_BROKER_TOKEN"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Consumer-driven**: Frontend defines expectations, not backend
|
||||
- **Matchers**: `like`, `string`, `integer` for flexible matching
|
||||
- **Provider states**: given() sets up test preconditions
|
||||
- **Isolation**: No real backend needed, runs fast
|
||||
- **Pact generation**: Automatically creates JSON pact files
|
||||
|
||||
---
|
||||
|
||||
### Example 2: Pact Provider Verification (Backend validates contracts)
|
||||
|
||||
**Context**: Node.js/Express API verifying pacts published by consumers.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/contract/user-api.provider.spec.ts
|
||||
import { Verifier, VerifierOptions } from '@pact-foundation/pact';
|
||||
import { server } from '../../src/server'; // Your Express/Fastify app
|
||||
import { seedDatabase, resetDatabase } from '../support/db-helpers';
|
||||
|
||||
/**
|
||||
* Provider Verification Test
|
||||
* - Provider (backend API) verifies against published pacts
|
||||
* - State handlers setup test data for each interaction
|
||||
* - Runs before merge to catch breaking changes
|
||||
*/
|
||||
|
||||
describe('Pact Provider Verification', () => {
|
||||
let serverInstance;
|
||||
const PORT = 3001;
|
||||
|
||||
beforeAll(async () => {
|
||||
// Start provider server
|
||||
serverInstance = server.listen(PORT);
|
||||
console.log(`Provider server running on port ${PORT}`);
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
// Cleanup
|
||||
await serverInstance.close();
|
||||
});
|
||||
|
||||
it('should verify pacts from all consumers', async () => {
|
||||
const opts: VerifierOptions = {
|
||||
// Provider details
|
||||
provider: 'user-api-service',
|
||||
providerBaseUrl: `http://localhost:${PORT}`,
|
||||
|
||||
// Pact Broker configuration
|
||||
pactBrokerUrl: process.env.PACT_BROKER_URL,
|
||||
pactBrokerToken: process.env.PACT_BROKER_TOKEN,
|
||||
publishVerificationResult: process.env.CI === 'true',
|
||||
providerVersion: process.env.GIT_SHA || 'dev',
|
||||
|
||||
// State handlers: Setup provider state for each interaction
|
||||
stateHandlers: {
|
||||
'user with id 1 exists': async () => {
|
||||
await seedDatabase({
|
||||
users: [
|
||||
{
|
||||
id: 1,
|
||||
name: 'John Doe',
|
||||
email: 'john@example.com',
|
||||
role: 'user',
|
||||
createdAt: '2025-01-15T10:00:00Z',
|
||||
},
|
||||
],
|
||||
});
|
||||
return 'User seeded successfully';
|
||||
},
|
||||
|
||||
'user with id 999 does not exist': async () => {
|
||||
// Ensure user doesn't exist
|
||||
await resetDatabase();
|
||||
return 'Database reset';
|
||||
},
|
||||
|
||||
'no users exist': async () => {
|
||||
await resetDatabase();
|
||||
return 'Database empty';
|
||||
},
|
||||
},
|
||||
|
||||
// Request filters: Add auth headers to all requests
|
||||
requestFilter: (req, res, next) => {
|
||||
// Mock authentication for verification
|
||||
req.headers['x-user-id'] = 'test-user';
|
||||
req.headers['authorization'] = 'Bearer valid-test-token';
|
||||
next();
|
||||
},
|
||||
|
||||
// Timeout for verification
|
||||
timeout: 30000,
|
||||
};
|
||||
|
||||
// Run verification
|
||||
await new Verifier(opts).verifyProvider();
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**CI integration**:
|
||||
|
||||
```yaml
|
||||
# .github/workflows/pact-provider.yml
|
||||
name: Pact Provider Verification
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
branches: [main]
|
||||
|
||||
jobs:
|
||||
verify-contracts:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version-file: '.nvmrc'
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Start database
|
||||
run: docker-compose up -d postgres
|
||||
|
||||
- name: Run migrations
|
||||
run: npm run db:migrate
|
||||
|
||||
- name: Verify pacts
|
||||
run: npm run test:contract:provider
|
||||
env:
|
||||
PACT_BROKER_URL: ${{ secrets.PACT_BROKER_URL }}
|
||||
PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
|
||||
GIT_SHA: ${{ github.sha }}
|
||||
CI: true
|
||||
|
||||
- name: Can I Deploy?
|
||||
run: |
|
||||
npx pact-broker can-i-deploy \
|
||||
--pacticipant user-api-service \
|
||||
--version ${{ github.sha }} \
|
||||
--to-environment production
|
||||
env:
|
||||
PACT_BROKER_BASE_URL: ${{ secrets.PACT_BROKER_URL }}
|
||||
PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **State handlers**: Setup provider data for each given() state
|
||||
- **Request filters**: Add auth/headers for verification requests
|
||||
- **CI publishing**: Verification results sent to broker
|
||||
- **can-i-deploy**: Safety check before production deployment
|
||||
- **Database isolation**: Reset between state handlers
|
||||
|
||||
---
|
||||
|
||||
### Example 3: Contract CI Integration (Consumer & Provider Workflow)
|
||||
|
||||
**Context**: Complete CI/CD workflow coordinating consumer pact publishing and provider verification.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```yaml
|
||||
# .github/workflows/pact-consumer.yml (Consumer side)
|
||||
name: Pact Consumer Tests
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
branches: [main]
|
||||
|
||||
jobs:
|
||||
consumer-tests:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version-file: '.nvmrc'
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Run consumer contract tests
|
||||
run: npm run test:contract
|
||||
|
||||
- name: Publish pacts to broker
|
||||
if: github.ref == 'refs/heads/main' || github.event_name == 'pull_request'
|
||||
run: |
|
||||
npx pact-broker publish ./pacts \
|
||||
--consumer-app-version ${{ github.sha }} \
|
||||
--branch ${{ github.head_ref || github.ref_name }} \
|
||||
--broker-base-url ${{ secrets.PACT_BROKER_URL }} \
|
||||
--broker-token ${{ secrets.PACT_BROKER_TOKEN }}
|
||||
|
||||
- name: Tag pact with environment (main branch only)
|
||||
if: github.ref == 'refs/heads/main'
|
||||
run: |
|
||||
npx pact-broker create-version-tag \
|
||||
--pacticipant user-management-web \
|
||||
--version ${{ github.sha }} \
|
||||
--tag production \
|
||||
--broker-base-url ${{ secrets.PACT_BROKER_URL }} \
|
||||
--broker-token ${{ secrets.PACT_BROKER_TOKEN }}
|
||||
```
|
||||
|
||||
```yaml
|
||||
# .github/workflows/pact-provider.yml (Provider side)
|
||||
name: Pact Provider Verification
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
branches: [main]
|
||||
repository_dispatch:
|
||||
types: [pact_changed] # Webhook from Pact Broker
|
||||
|
||||
jobs:
|
||||
verify-contracts:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version-file: '.nvmrc'
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Start dependencies
|
||||
run: docker-compose up -d
|
||||
|
||||
- name: Run provider verification
|
||||
run: npm run test:contract:provider
|
||||
env:
|
||||
PACT_BROKER_URL: ${{ secrets.PACT_BROKER_URL }}
|
||||
PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
|
||||
GIT_SHA: ${{ github.sha }}
|
||||
CI: true
|
||||
|
||||
- name: Publish verification results
|
||||
if: always()
|
||||
run: echo "Verification results published to broker"
|
||||
|
||||
- name: Can I Deploy to Production?
|
||||
if: github.ref == 'refs/heads/main'
|
||||
run: |
|
||||
npx pact-broker can-i-deploy \
|
||||
--pacticipant user-api-service \
|
||||
--version ${{ github.sha }} \
|
||||
--to-environment production \
|
||||
--broker-base-url ${{ secrets.PACT_BROKER_URL }} \
|
||||
--broker-token ${{ secrets.PACT_BROKER_TOKEN }} \
|
||||
--retry-while-unknown 6 \
|
||||
--retry-interval 10
|
||||
|
||||
- name: Record deployment (if can-i-deploy passed)
|
||||
if: success() && github.ref == 'refs/heads/main'
|
||||
run: |
|
||||
npx pact-broker record-deployment \
|
||||
--pacticipant user-api-service \
|
||||
--version ${{ github.sha }} \
|
||||
--environment production \
|
||||
--broker-base-url ${{ secrets.PACT_BROKER_URL }} \
|
||||
--broker-token ${{ secrets.PACT_BROKER_TOKEN }}
|
||||
```
|
||||
|
||||
**Pact Broker Webhook Configuration**:
|
||||
|
||||
```json
|
||||
{
|
||||
"events": [
|
||||
{
|
||||
"name": "contract_content_changed"
|
||||
}
|
||||
],
|
||||
"request": {
|
||||
"method": "POST",
|
||||
"url": "https://api.github.com/repos/your-org/user-api/dispatches",
|
||||
"headers": {
|
||||
"Authorization": "Bearer ${user.githubToken}",
|
||||
"Content-Type": "application/json",
|
||||
"Accept": "application/vnd.github.v3+json"
|
||||
},
|
||||
"body": {
|
||||
"event_type": "pact_changed",
|
||||
"client_payload": {
|
||||
"pact_url": "${pactbroker.pactUrl}",
|
||||
"consumer": "${pactbroker.consumerName}",
|
||||
"provider": "${pactbroker.providerName}"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Automatic trigger**: Consumer pact changes trigger provider verification via webhook
|
||||
- **Branch tracking**: Pacts published per branch for feature testing
|
||||
- **can-i-deploy**: Safety gate before production deployment
|
||||
- **Record deployment**: Track which version is in each environment
|
||||
- **Parallel dev**: Consumer and provider teams work independently
|
||||
|
||||
---
|
||||
|
||||
### Example 4: Resilience Coverage (Testing Fallback Behavior)
|
||||
|
||||
**Context**: Capture timeout, retry, and error handling behavior explicitly in contracts.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/contract/user-api-resilience.pact.spec.ts
|
||||
import { PactV3, MatchersV3 } from '@pact-foundation/pact';
|
||||
import { getUserById, ApiError } from '@/api/user-service';
|
||||
|
||||
const { like, string } = MatchersV3;
|
||||
|
||||
const provider = new PactV3({
|
||||
consumer: 'user-management-web',
|
||||
provider: 'user-api-service',
|
||||
dir: './pacts',
|
||||
});
|
||||
|
||||
describe('User API Resilience Contract', () => {
|
||||
/**
|
||||
* Test 500 error handling
|
||||
* Verifies consumer handles server errors gracefully
|
||||
*/
|
||||
it('should handle 500 errors with retry logic', async () => {
|
||||
await provider
|
||||
.given('server is experiencing errors')
|
||||
.uponReceiving('a request that returns 500')
|
||||
.withRequest({
|
||||
method: 'GET',
|
||||
path: '/users/1',
|
||||
headers: { Accept: 'application/json' },
|
||||
})
|
||||
.willRespondWith({
|
||||
status: 500,
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: {
|
||||
error: 'Internal server error',
|
||||
code: 'INTERNAL_ERROR',
|
||||
retryable: true,
|
||||
},
|
||||
})
|
||||
.executeTest(async (mockServer) => {
|
||||
// Consumer should retry on 500
|
||||
try {
|
||||
await getUserById(1, {
|
||||
baseURL: mockServer.url,
|
||||
retries: 3,
|
||||
retryDelay: 100,
|
||||
});
|
||||
fail('Should have thrown error after retries');
|
||||
} catch (error) {
|
||||
expect(error).toBeInstanceOf(ApiError);
|
||||
expect((error as ApiError).code).toBe('INTERNAL_ERROR');
|
||||
expect((error as ApiError).retryable).toBe(true);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
/**
|
||||
* Test 429 rate limiting
|
||||
* Verifies consumer respects rate limits
|
||||
*/
|
||||
it('should handle 429 rate limit with backoff', async () => {
|
||||
await provider
|
||||
.given('rate limit exceeded for user')
|
||||
.uponReceiving('a request that is rate limited')
|
||||
.withRequest({
|
||||
method: 'GET',
|
||||
path: '/users/1',
|
||||
})
|
||||
.willRespondWith({
|
||||
status: 429,
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
'Retry-After': '60', // Retry after 60 seconds
|
||||
},
|
||||
body: {
|
||||
error: 'Too many requests',
|
||||
code: 'RATE_LIMIT_EXCEEDED',
|
||||
},
|
||||
})
|
||||
.executeTest(async (mockServer) => {
|
||||
try {
|
||||
await getUserById(1, {
|
||||
baseURL: mockServer.url,
|
||||
respectRateLimit: true,
|
||||
});
|
||||
fail('Should have thrown rate limit error');
|
||||
} catch (error) {
|
||||
expect(error).toBeInstanceOf(ApiError);
|
||||
expect((error as ApiError).code).toBe('RATE_LIMIT_EXCEEDED');
|
||||
expect((error as ApiError).retryAfter).toBe(60);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
/**
|
||||
* Test timeout handling
|
||||
* Verifies consumer has appropriate timeout configuration
|
||||
*/
|
||||
it('should timeout after 10 seconds', async () => {
|
||||
await provider
|
||||
.given('server is slow to respond')
|
||||
.uponReceiving('a request that times out')
|
||||
.withRequest({
|
||||
method: 'GET',
|
||||
path: '/users/1',
|
||||
})
|
||||
.willRespondWith({
|
||||
status: 200,
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: like({ id: 1, name: 'John' }),
|
||||
})
|
||||
.withDelay(15000) // Simulate 15 second delay
|
||||
.executeTest(async (mockServer) => {
|
||||
try {
|
||||
await getUserById(1, {
|
||||
baseURL: mockServer.url,
|
||||
timeout: 10000, // 10 second timeout
|
||||
});
|
||||
fail('Should have timed out');
|
||||
} catch (error) {
|
||||
expect(error).toBeInstanceOf(ApiError);
|
||||
expect((error as ApiError).code).toBe('TIMEOUT');
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
/**
|
||||
* Test partial response (optional fields)
|
||||
* Verifies consumer handles missing optional data
|
||||
*/
|
||||
it('should handle response with missing optional fields', async () => {
|
||||
await provider
|
||||
.given('user exists with minimal data')
|
||||
.uponReceiving('a request for user with partial data')
|
||||
.withRequest({
|
||||
method: 'GET',
|
||||
path: '/users/1',
|
||||
})
|
||||
.willRespondWith({
|
||||
status: 200,
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: {
|
||||
id: integer(1),
|
||||
name: string('John Doe'),
|
||||
email: string('john@example.com'),
|
||||
// role, createdAt, etc. omitted (optional fields)
|
||||
},
|
||||
})
|
||||
.executeTest(async (mockServer) => {
|
||||
const user = await getUserById(1, { baseURL: mockServer.url });
|
||||
|
||||
// Consumer handles missing optional fields gracefully
|
||||
expect(user.id).toBe(1);
|
||||
expect(user.name).toBe('John Doe');
|
||||
expect(user.role).toBeUndefined(); // Optional field
|
||||
expect(user.createdAt).toBeUndefined(); // Optional field
|
||||
});
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**API client with retry logic**:
|
||||
|
||||
```typescript
|
||||
// src/api/user-service.ts
|
||||
import axios, { AxiosInstance, AxiosRequestConfig } from 'axios';
|
||||
|
||||
export class ApiError extends Error {
|
||||
constructor(
|
||||
message: string,
|
||||
public code: string,
|
||||
public retryable: boolean = false,
|
||||
public retryAfter?: number,
|
||||
) {
|
||||
super(message);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* User API client with retry and error handling
|
||||
*/
|
||||
export async function getUserById(
|
||||
id: number,
|
||||
config?: AxiosRequestConfig & { retries?: number; retryDelay?: number; respectRateLimit?: boolean },
|
||||
): Promise<User> {
|
||||
const { retries = 3, retryDelay = 1000, respectRateLimit = true, ...axiosConfig } = config || {};
|
||||
|
||||
let lastError: Error;
|
||||
|
||||
for (let attempt = 1; attempt <= retries; attempt++) {
|
||||
try {
|
||||
const response = await axios.get(`/users/${id}`, axiosConfig);
|
||||
return response.data;
|
||||
} catch (error: any) {
|
||||
lastError = error;
|
||||
|
||||
// Handle rate limiting
|
||||
if (error.response?.status === 429) {
|
||||
const retryAfter = parseInt(error.response.headers['retry-after'] || '60');
|
||||
throw new ApiError('Too many requests', 'RATE_LIMIT_EXCEEDED', false, retryAfter);
|
||||
}
|
||||
|
||||
// Retry on 500 errors
|
||||
if (error.response?.status === 500 && attempt < retries) {
|
||||
await new Promise((resolve) => setTimeout(resolve, retryDelay * attempt));
|
||||
continue;
|
||||
}
|
||||
|
||||
// Handle 404
|
||||
if (error.response?.status === 404) {
|
||||
throw new ApiError('User not found', 'USER_NOT_FOUND', false);
|
||||
}
|
||||
|
||||
// Handle timeout
|
||||
if (error.code === 'ECONNABORTED') {
|
||||
throw new ApiError('Request timeout', 'TIMEOUT', true);
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
throw new ApiError('Request failed after retries', 'INTERNAL_ERROR', true);
|
||||
}
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Resilience contracts**: Timeouts, retries, errors explicitly tested
|
||||
- **State handlers**: Provider sets up each test scenario
|
||||
- **Error handling**: Consumer validates graceful degradation
|
||||
- **Retry logic**: Exponential backoff tested
|
||||
- **Optional fields**: Consumer handles partial responses
|
||||
|
||||
---
|
||||
|
||||
### Example 4: Pact Broker Housekeeping & Lifecycle Management
|
||||
|
||||
**Context**: Automated broker maintenance to prevent contract sprawl and noise.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// scripts/pact-broker-housekeeping.ts
|
||||
/**
|
||||
* Pact Broker Housekeeping Script
|
||||
* - Archive superseded contracts
|
||||
* - Expire unused pacts
|
||||
* - Tag releases for environment tracking
|
||||
*/
|
||||
|
||||
import { execSync } from 'child_process';
|
||||
|
||||
const PACT_BROKER_URL = process.env.PACT_BROKER_URL!;
|
||||
const PACT_BROKER_TOKEN = process.env.PACT_BROKER_TOKEN!;
|
||||
const PACTICIPANT = 'user-api-service';
|
||||
|
||||
/**
|
||||
* Tag release with environment
|
||||
*/
|
||||
function tagRelease(version: string, environment: 'staging' | 'production') {
|
||||
console.log(`🏷️ Tagging ${PACTICIPANT} v${version} as ${environment}`);
|
||||
|
||||
execSync(
|
||||
`npx pact-broker create-version-tag \
|
||||
--pacticipant ${PACTICIPANT} \
|
||||
--version ${version} \
|
||||
--tag ${environment} \
|
||||
--broker-base-url ${PACT_BROKER_URL} \
|
||||
--broker-token ${PACT_BROKER_TOKEN}`,
|
||||
{ stdio: 'inherit' },
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Record deployment to environment
|
||||
*/
|
||||
function recordDeployment(version: string, environment: 'staging' | 'production') {
|
||||
console.log(`📝 Recording deployment of ${PACTICIPANT} v${version} to ${environment}`);
|
||||
|
||||
execSync(
|
||||
`npx pact-broker record-deployment \
|
||||
--pacticipant ${PACTICIPANT} \
|
||||
--version ${version} \
|
||||
--environment ${environment} \
|
||||
--broker-base-url ${PACT_BROKER_URL} \
|
||||
--broker-token ${PACT_BROKER_TOKEN}`,
|
||||
{ stdio: 'inherit' },
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Clean up old pact versions (retention policy)
|
||||
* Keep: last 30 days, all production tags, latest from each branch
|
||||
*/
|
||||
function cleanupOldPacts() {
|
||||
console.log(`🧹 Cleaning up old pacts for ${PACTICIPANT}`);
|
||||
|
||||
execSync(
|
||||
`npx pact-broker clean \
|
||||
--pacticipant ${PACTICIPANT} \
|
||||
--broker-base-url ${PACT_BROKER_URL} \
|
||||
--broker-token ${PACT_BROKER_TOKEN} \
|
||||
--keep-latest-for-branch 1 \
|
||||
--keep-min-age 30`,
|
||||
{ stdio: 'inherit' },
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check deployment compatibility
|
||||
*/
|
||||
function canIDeploy(version: string, toEnvironment: string): boolean {
|
||||
console.log(`🔍 Checking if ${PACTICIPANT} v${version} can deploy to ${toEnvironment}`);
|
||||
|
||||
try {
|
||||
execSync(
|
||||
`npx pact-broker can-i-deploy \
|
||||
--pacticipant ${PACTICIPANT} \
|
||||
--version ${version} \
|
||||
--to-environment ${toEnvironment} \
|
||||
--broker-base-url ${PACT_BROKER_URL} \
|
||||
--broker-token ${PACT_BROKER_TOKEN} \
|
||||
--retry-while-unknown 6 \
|
||||
--retry-interval 10`,
|
||||
{ stdio: 'inherit' },
|
||||
);
|
||||
return true;
|
||||
} catch (error) {
|
||||
console.error(`❌ Cannot deploy to ${toEnvironment}`);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Main housekeeping workflow
|
||||
*/
|
||||
async function main() {
|
||||
const command = process.argv[2];
|
||||
const version = process.argv[3];
|
||||
const environment = process.argv[4] as 'staging' | 'production';
|
||||
|
||||
switch (command) {
|
||||
case 'tag-release':
|
||||
tagRelease(version, environment);
|
||||
break;
|
||||
|
||||
case 'record-deployment':
|
||||
recordDeployment(version, environment);
|
||||
break;
|
||||
|
||||
case 'can-i-deploy':
|
||||
const canDeploy = canIDeploy(version, environment);
|
||||
process.exit(canDeploy ? 0 : 1);
|
||||
|
||||
case 'cleanup':
|
||||
cleanupOldPacts();
|
||||
break;
|
||||
|
||||
default:
|
||||
console.error('Unknown command. Use: tag-release | record-deployment | can-i-deploy | cleanup');
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
main();
|
||||
```
|
||||
|
||||
**package.json scripts**:
|
||||
|
||||
```json
|
||||
{
|
||||
"scripts": {
|
||||
"pact:tag": "ts-node scripts/pact-broker-housekeeping.ts tag-release",
|
||||
"pact:record": "ts-node scripts/pact-broker-housekeeping.ts record-deployment",
|
||||
"pact:can-deploy": "ts-node scripts/pact-broker-housekeeping.ts can-i-deploy",
|
||||
"pact:cleanup": "ts-node scripts/pact-broker-housekeeping.ts cleanup"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Deployment workflow integration**:
|
||||
|
||||
```yaml
|
||||
# .github/workflows/deploy-production.yml
|
||||
name: Deploy to Production
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- 'v*'
|
||||
|
||||
jobs:
|
||||
verify-contracts:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Check pact compatibility
|
||||
run: npm run pact:can-deploy ${{ github.ref_name }} production
|
||||
env:
|
||||
PACT_BROKER_URL: ${{ secrets.PACT_BROKER_URL }}
|
||||
PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
|
||||
|
||||
deploy:
|
||||
needs: verify-contracts
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Deploy to production
|
||||
run: ./scripts/deploy.sh production
|
||||
|
||||
- name: Record deployment in Pact Broker
|
||||
run: npm run pact:record ${{ github.ref_name }} production
|
||||
env:
|
||||
PACT_BROKER_URL: ${{ secrets.PACT_BROKER_URL }}
|
||||
PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
|
||||
```
|
||||
|
||||
**Scheduled cleanup**:
|
||||
|
||||
```yaml
|
||||
# .github/workflows/pact-housekeeping.yml
|
||||
name: Pact Broker Housekeeping
|
||||
on:
|
||||
schedule:
|
||||
- cron: '0 2 * * 0' # Weekly on Sunday at 2 AM
|
||||
|
||||
jobs:
|
||||
cleanup:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Cleanup old pacts
|
||||
run: npm run pact:cleanup
|
||||
env:
|
||||
PACT_BROKER_URL: ${{ secrets.PACT_BROKER_URL }}
|
||||
PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN }}
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Automated tagging**: Releases tagged with environment
|
||||
- **Deployment tracking**: Broker knows which version is where
|
||||
- **Safety gate**: can-i-deploy blocks incompatible deployments
|
||||
- **Retention policy**: Keep recent, production, and branch-latest pacts
|
||||
- **Webhook triggers**: Provider verification runs on consumer changes
|
||||
|
||||
---
|
||||
|
||||
## Contract Testing Checklist
|
||||
|
||||
Before implementing contract testing, verify:
|
||||
|
||||
- [ ] **Pact Broker setup**: Hosted (Pactflow) or self-hosted broker configured
|
||||
- [ ] **Consumer tests**: Generate pacts in CI, publish to broker on merge
|
||||
- [ ] **Provider verification**: Runs on PR, verifies all consumer pacts
|
||||
- [ ] **State handlers**: Provider implements all given() states
|
||||
- [ ] **can-i-deploy**: Blocks deployment if contracts incompatible
|
||||
- [ ] **Webhooks configured**: Consumer changes trigger provider verification
|
||||
- [ ] **Retention policy**: Old pacts archived (keep 30 days, all production tags)
|
||||
- [ ] **Resilience tested**: Timeouts, retries, error codes in contracts
|
||||
|
||||
## Integration Points
|
||||
|
||||
- Used in workflows: `*automate` (integration test generation), `*ci` (contract CI setup)
|
||||
- Related fragments: `test-levels-framework.md`, `ci-burn-in.md`
|
||||
- Tools: Pact.js, Pact Broker (Pactflow or self-hosted), Pact CLI
|
||||
|
||||
_Source: Pact consumer/provider sample repos, Murat contract testing blog, Pact official documentation_
|
||||
@ -1,500 +0,0 @@
|
||||
# Data Factories and API-First Setup
|
||||
|
||||
## Principle
|
||||
|
||||
Prefer factory functions that accept overrides and return complete objects (`createUser(overrides)`). Seed test state through APIs, tasks, or direct DB helpers before visiting the UI—never via slow UI interactions. UI is for validation only, not setup.
|
||||
|
||||
## Rationale
|
||||
|
||||
Static fixtures (JSON files, hardcoded objects) create brittle tests that:
|
||||
|
||||
- Fail when schemas evolve (missing new required fields)
|
||||
- Cause collisions in parallel execution (same user IDs)
|
||||
- Hide test intent (what matters for _this_ test?)
|
||||
|
||||
Dynamic factories with overrides provide:
|
||||
|
||||
- **Parallel safety**: UUIDs and timestamps prevent collisions
|
||||
- **Schema evolution**: Defaults adapt to schema changes automatically
|
||||
- **Explicit intent**: Overrides show what matters for each test
|
||||
- **Speed**: API setup is 10-50x faster than UI
|
||||
|
||||
## Pattern Examples
|
||||
|
||||
### Example 1: Factory Function with Overrides
|
||||
|
||||
**Context**: When creating test data, build factory functions with sensible defaults and explicit overrides. Use `faker` for dynamic values that prevent collisions.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// test-utils/factories/user-factory.ts
|
||||
import { faker } from '@faker-js/faker';
|
||||
|
||||
type User = {
|
||||
id: string;
|
||||
email: string;
|
||||
name: string;
|
||||
role: 'user' | 'admin' | 'moderator';
|
||||
createdAt: Date;
|
||||
isActive: boolean;
|
||||
};
|
||||
|
||||
export const createUser = (overrides: Partial<User> = {}): User => ({
|
||||
id: faker.string.uuid(),
|
||||
email: faker.internet.email(),
|
||||
name: faker.person.fullName(),
|
||||
role: 'user',
|
||||
createdAt: new Date(),
|
||||
isActive: true,
|
||||
...overrides,
|
||||
});
|
||||
|
||||
// test-utils/factories/product-factory.ts
|
||||
type Product = {
|
||||
id: string;
|
||||
name: string;
|
||||
price: number;
|
||||
stock: number;
|
||||
category: string;
|
||||
};
|
||||
|
||||
export const createProduct = (overrides: Partial<Product> = {}): Product => ({
|
||||
id: faker.string.uuid(),
|
||||
name: faker.commerce.productName(),
|
||||
price: parseFloat(faker.commerce.price()),
|
||||
stock: faker.number.int({ min: 0, max: 100 }),
|
||||
category: faker.commerce.department(),
|
||||
...overrides,
|
||||
});
|
||||
|
||||
// Usage in tests:
|
||||
test('admin can delete users', async ({ page, apiRequest }) => {
|
||||
// Default user
|
||||
const user = createUser();
|
||||
|
||||
// Admin user (explicit override shows intent)
|
||||
const admin = createUser({ role: 'admin' });
|
||||
|
||||
// Seed via API (fast!)
|
||||
await apiRequest({ method: 'POST', url: '/api/users', data: user });
|
||||
await apiRequest({ method: 'POST', url: '/api/users', data: admin });
|
||||
|
||||
// Now test UI behavior
|
||||
await page.goto('/admin/users');
|
||||
await page.click(`[data-testid="delete-user-${user.id}"]`);
|
||||
await expect(page.getByText(`User ${user.name} deleted`)).toBeVisible();
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- `Partial<User>` allows overriding any field without breaking type safety
|
||||
- Faker generates unique values—no collisions in parallel tests
|
||||
- Override shows test intent: `createUser({ role: 'admin' })` is explicit
|
||||
- Factory lives in `test-utils/factories/` for easy reuse
|
||||
|
||||
### Example 2: Nested Factory Pattern
|
||||
|
||||
**Context**: When testing relationships (orders with users and products), nest factories to create complete object graphs. Control relationship data explicitly.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// test-utils/factories/order-factory.ts
|
||||
import { createUser } from './user-factory';
|
||||
import { createProduct } from './product-factory';
|
||||
|
||||
type OrderItem = {
|
||||
product: Product;
|
||||
quantity: number;
|
||||
price: number;
|
||||
};
|
||||
|
||||
type Order = {
|
||||
id: string;
|
||||
user: User;
|
||||
items: OrderItem[];
|
||||
total: number;
|
||||
status: 'pending' | 'paid' | 'shipped' | 'delivered';
|
||||
createdAt: Date;
|
||||
};
|
||||
|
||||
export const createOrderItem = (overrides: Partial<OrderItem> = {}): OrderItem => {
|
||||
const product = overrides.product || createProduct();
|
||||
const quantity = overrides.quantity || faker.number.int({ min: 1, max: 5 });
|
||||
|
||||
return {
|
||||
product,
|
||||
quantity,
|
||||
price: product.price * quantity,
|
||||
...overrides,
|
||||
};
|
||||
};
|
||||
|
||||
export const createOrder = (overrides: Partial<Order> = {}): Order => {
|
||||
const items = overrides.items || [createOrderItem(), createOrderItem()];
|
||||
const total = items.reduce((sum, item) => sum + item.price, 0);
|
||||
|
||||
return {
|
||||
id: faker.string.uuid(),
|
||||
user: overrides.user || createUser(),
|
||||
items,
|
||||
total,
|
||||
status: 'pending',
|
||||
createdAt: new Date(),
|
||||
...overrides,
|
||||
};
|
||||
};
|
||||
|
||||
// Usage in tests:
|
||||
test('user can view order details', async ({ page, apiRequest }) => {
|
||||
const user = createUser({ email: 'test@example.com' });
|
||||
const product1 = createProduct({ name: 'Widget A', price: 10.0 });
|
||||
const product2 = createProduct({ name: 'Widget B', price: 15.0 });
|
||||
|
||||
// Explicit relationships
|
||||
const order = createOrder({
|
||||
user,
|
||||
items: [
|
||||
createOrderItem({ product: product1, quantity: 2 }), // $20
|
||||
createOrderItem({ product: product2, quantity: 1 }), // $15
|
||||
],
|
||||
});
|
||||
|
||||
// Seed via API
|
||||
await apiRequest({ method: 'POST', url: '/api/users', data: user });
|
||||
await apiRequest({ method: 'POST', url: '/api/products', data: product1 });
|
||||
await apiRequest({ method: 'POST', url: '/api/products', data: product2 });
|
||||
await apiRequest({ method: 'POST', url: '/api/orders', data: order });
|
||||
|
||||
// Test UI
|
||||
await page.goto(`/orders/${order.id}`);
|
||||
await expect(page.getByText('Widget A x 2')).toBeVisible();
|
||||
await expect(page.getByText('Widget B x 1')).toBeVisible();
|
||||
await expect(page.getByText('Total: $35.00')).toBeVisible();
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Nested factories handle relationships (order → user, order → products)
|
||||
- Overrides cascade: provide custom user/products or use defaults
|
||||
- Calculated fields (total) derived automatically from nested data
|
||||
- Explicit relationships make test data clear and maintainable
|
||||
|
||||
### Example 3: Factory with API Seeding
|
||||
|
||||
**Context**: When tests need data setup, always use API calls or database tasks—never UI navigation. Wrap factory usage with seeding utilities for clean test setup.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// playwright/support/helpers/seed-helpers.ts
|
||||
import { APIRequestContext } from '@playwright/test';
|
||||
import { User, createUser } from '../../test-utils/factories/user-factory';
|
||||
import { Product, createProduct } from '../../test-utils/factories/product-factory';
|
||||
|
||||
export async function seedUser(request: APIRequestContext, overrides: Partial<User> = {}): Promise<User> {
|
||||
const user = createUser(overrides);
|
||||
|
||||
const response = await request.post('/api/users', {
|
||||
data: user,
|
||||
});
|
||||
|
||||
if (!response.ok()) {
|
||||
throw new Error(`Failed to seed user: ${response.status()}`);
|
||||
}
|
||||
|
||||
return user;
|
||||
}
|
||||
|
||||
export async function seedProduct(request: APIRequestContext, overrides: Partial<Product> = {}): Promise<Product> {
|
||||
const product = createProduct(overrides);
|
||||
|
||||
const response = await request.post('/api/products', {
|
||||
data: product,
|
||||
});
|
||||
|
||||
if (!response.ok()) {
|
||||
throw new Error(`Failed to seed product: ${response.status()}`);
|
||||
}
|
||||
|
||||
return product;
|
||||
}
|
||||
|
||||
// Playwright globalSetup for shared data
|
||||
// playwright/support/global-setup.ts
|
||||
import { chromium, FullConfig } from '@playwright/test';
|
||||
import { seedUser } from './helpers/seed-helpers';
|
||||
|
||||
async function globalSetup(config: FullConfig) {
|
||||
const browser = await chromium.launch();
|
||||
const page = await browser.newPage();
|
||||
const context = page.context();
|
||||
|
||||
// Seed admin user for all tests
|
||||
const admin = await seedUser(context.request, {
|
||||
email: 'admin@example.com',
|
||||
role: 'admin',
|
||||
});
|
||||
|
||||
// Save auth state for reuse
|
||||
await context.storageState({ path: 'playwright/.auth/admin.json' });
|
||||
|
||||
await browser.close();
|
||||
}
|
||||
|
||||
export default globalSetup;
|
||||
|
||||
// Cypress equivalent with cy.task
|
||||
// cypress/support/tasks.ts
|
||||
export const seedDatabase = async (entity: string, data: unknown) => {
|
||||
// Direct database insert or API call
|
||||
if (entity === 'users') {
|
||||
await db.users.create(data);
|
||||
}
|
||||
return null;
|
||||
};
|
||||
|
||||
// Usage in Cypress tests:
|
||||
beforeEach(() => {
|
||||
const user = createUser({ email: 'test@example.com' });
|
||||
cy.task('db:seed', { entity: 'users', data: user });
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- API seeding is 10-50x faster than UI-based setup
|
||||
- `globalSetup` seeds shared data once (e.g., admin user)
|
||||
- Per-test seeding uses `seedUser()` helpers for isolation
|
||||
- Cypress `cy.task` allows direct database access for speed
|
||||
|
||||
### Example 4: Anti-Pattern - Hardcoded Test Data
|
||||
|
||||
**Problem**:
|
||||
|
||||
```typescript
|
||||
// ❌ BAD: Hardcoded test data
|
||||
test('user can login', async ({ page }) => {
|
||||
await page.goto('/login');
|
||||
await page.fill('[data-testid="email"]', 'test@test.com'); // Hardcoded
|
||||
await page.fill('[data-testid="password"]', 'password123'); // Hardcoded
|
||||
await page.click('[data-testid="submit"]');
|
||||
|
||||
// What if this user already exists? Test fails in parallel runs.
|
||||
// What if schema adds required fields? Test breaks.
|
||||
});
|
||||
|
||||
// ❌ BAD: Static JSON fixtures
|
||||
// fixtures/users.json
|
||||
{
|
||||
"users": [
|
||||
{ "id": 1, "email": "user1@test.com", "name": "User 1" },
|
||||
{ "id": 2, "email": "user2@test.com", "name": "User 2" }
|
||||
]
|
||||
}
|
||||
|
||||
test('admin can delete user', async ({ page }) => {
|
||||
const users = require('../fixtures/users.json');
|
||||
// Brittle: IDs collide in parallel, schema drift breaks tests
|
||||
});
|
||||
```
|
||||
|
||||
**Why It Fails**:
|
||||
|
||||
- **Parallel collisions**: Hardcoded IDs (`id: 1`, `email: 'test@test.com'`) cause failures when tests run concurrently
|
||||
- **Schema drift**: Adding required fields (`phoneNumber`, `address`) breaks all tests using fixtures
|
||||
- **Hidden intent**: Does this test need `email: 'test@test.com'` specifically, or any email?
|
||||
- **Slow setup**: UI-based data creation is 10-50x slower than API
|
||||
|
||||
**Better Approach**: Use factories
|
||||
|
||||
```typescript
|
||||
// ✅ GOOD: Factory-based data
|
||||
test('user can login', async ({ page, apiRequest }) => {
|
||||
const user = createUser({ email: 'unique@example.com', password: 'secure123' });
|
||||
|
||||
// Seed via API (fast, parallel-safe)
|
||||
await apiRequest({ method: 'POST', url: '/api/users', data: user });
|
||||
|
||||
// Test UI
|
||||
await page.goto('/login');
|
||||
await page.fill('[data-testid="email"]', user.email);
|
||||
await page.fill('[data-testid="password"]', user.password);
|
||||
await page.click('[data-testid="submit"]');
|
||||
|
||||
await expect(page).toHaveURL('/dashboard');
|
||||
});
|
||||
|
||||
// ✅ GOOD: Factories adapt to schema changes automatically
|
||||
// When `phoneNumber` becomes required, update factory once:
|
||||
export const createUser = (overrides: Partial<User> = {}): User => ({
|
||||
id: faker.string.uuid(),
|
||||
email: faker.internet.email(),
|
||||
name: faker.person.fullName(),
|
||||
phoneNumber: faker.phone.number(), // NEW field, all tests get it automatically
|
||||
role: 'user',
|
||||
...overrides,
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Factories generate unique, parallel-safe data
|
||||
- Schema evolution handled in one place (factory), not every test
|
||||
- Test intent explicit via overrides
|
||||
- API seeding is fast and reliable
|
||||
|
||||
### Example 5: Factory Composition
|
||||
|
||||
**Context**: When building specialized factories, compose simpler factories instead of duplicating logic. Layer overrides for specific test scenarios.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// test-utils/factories/user-factory.ts (base)
|
||||
export const createUser = (overrides: Partial<User> = {}): User => ({
|
||||
id: faker.string.uuid(),
|
||||
email: faker.internet.email(),
|
||||
name: faker.person.fullName(),
|
||||
role: 'user',
|
||||
createdAt: new Date(),
|
||||
isActive: true,
|
||||
...overrides,
|
||||
});
|
||||
|
||||
// Compose specialized factories
|
||||
export const createAdminUser = (overrides: Partial<User> = {}): User => createUser({ role: 'admin', ...overrides });
|
||||
|
||||
export const createModeratorUser = (overrides: Partial<User> = {}): User => createUser({ role: 'moderator', ...overrides });
|
||||
|
||||
export const createInactiveUser = (overrides: Partial<User> = {}): User => createUser({ isActive: false, ...overrides });
|
||||
|
||||
// Account-level factories with feature flags
|
||||
type Account = {
|
||||
id: string;
|
||||
owner: User;
|
||||
plan: 'free' | 'pro' | 'enterprise';
|
||||
features: string[];
|
||||
maxUsers: number;
|
||||
};
|
||||
|
||||
export const createAccount = (overrides: Partial<Account> = {}): Account => ({
|
||||
id: faker.string.uuid(),
|
||||
owner: overrides.owner || createUser(),
|
||||
plan: 'free',
|
||||
features: [],
|
||||
maxUsers: 1,
|
||||
...overrides,
|
||||
});
|
||||
|
||||
export const createProAccount = (overrides: Partial<Account> = {}): Account =>
|
||||
createAccount({
|
||||
plan: 'pro',
|
||||
features: ['advanced-analytics', 'priority-support'],
|
||||
maxUsers: 10,
|
||||
...overrides,
|
||||
});
|
||||
|
||||
export const createEnterpriseAccount = (overrides: Partial<Account> = {}): Account =>
|
||||
createAccount({
|
||||
plan: 'enterprise',
|
||||
features: ['advanced-analytics', 'priority-support', 'sso', 'audit-logs'],
|
||||
maxUsers: 100,
|
||||
...overrides,
|
||||
});
|
||||
|
||||
// Usage in tests:
|
||||
test('pro accounts can access analytics', async ({ page, apiRequest }) => {
|
||||
const admin = createAdminUser({ email: 'admin@company.com' });
|
||||
const account = createProAccount({ owner: admin });
|
||||
|
||||
await apiRequest({ method: 'POST', url: '/api/users', data: admin });
|
||||
await apiRequest({ method: 'POST', url: '/api/accounts', data: account });
|
||||
|
||||
await page.goto('/analytics');
|
||||
await expect(page.getByText('Advanced Analytics')).toBeVisible();
|
||||
});
|
||||
|
||||
test('free accounts cannot access analytics', async ({ page, apiRequest }) => {
|
||||
const user = createUser({ email: 'user@company.com' });
|
||||
const account = createAccount({ owner: user }); // Defaults to free plan
|
||||
|
||||
await apiRequest({ method: 'POST', url: '/api/users', data: user });
|
||||
await apiRequest({ method: 'POST', url: '/api/accounts', data: account });
|
||||
|
||||
await page.goto('/analytics');
|
||||
await expect(page.getByText('Upgrade to Pro')).toBeVisible();
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Compose specialized factories from base factories (`createAdminUser` → `createUser`)
|
||||
- Defaults cascade: `createProAccount` sets plan + features automatically
|
||||
- Still allow overrides: `createProAccount({ maxUsers: 50 })` works
|
||||
- Test intent clear: `createProAccount()` vs `createAccount({ plan: 'pro', features: [...] })`
|
||||
|
||||
## Integration Points
|
||||
|
||||
- **Used in workflows**: `*atdd` (test generation), `*automate` (test expansion), `*framework` (factory setup)
|
||||
- **Related fragments**:
|
||||
- `fixture-architecture.md` - Pure functions and fixtures for factory integration
|
||||
- `network-first.md` - API-first setup patterns
|
||||
- `test-quality.md` - Parallel-safe, deterministic test design
|
||||
|
||||
## Cleanup Strategy
|
||||
|
||||
Ensure factories work with cleanup patterns:
|
||||
|
||||
```typescript
|
||||
// Track created IDs for cleanup
|
||||
const createdUsers: string[] = [];
|
||||
|
||||
afterEach(async ({ apiRequest }) => {
|
||||
// Clean up all users created during test
|
||||
for (const userId of createdUsers) {
|
||||
await apiRequest({ method: 'DELETE', url: `/api/users/${userId}` });
|
||||
}
|
||||
createdUsers.length = 0;
|
||||
});
|
||||
|
||||
test('user registration flow', async ({ page, apiRequest }) => {
|
||||
const user = createUser();
|
||||
createdUsers.push(user.id);
|
||||
|
||||
await apiRequest({ method: 'POST', url: '/api/users', data: user });
|
||||
// ... test logic
|
||||
});
|
||||
```
|
||||
|
||||
## Feature Flag Integration
|
||||
|
||||
When working with feature flags, layer them into factories:
|
||||
|
||||
```typescript
|
||||
export const createUserWithFlags = (
|
||||
overrides: Partial<User> = {},
|
||||
flags: Record<string, boolean> = {},
|
||||
): User & { flags: Record<string, boolean> } => ({
|
||||
...createUser(overrides),
|
||||
flags: {
|
||||
'new-dashboard': false,
|
||||
'beta-features': false,
|
||||
...flags,
|
||||
},
|
||||
});
|
||||
|
||||
// Usage:
|
||||
const user = createUserWithFlags(
|
||||
{ email: 'test@example.com' },
|
||||
{
|
||||
'new-dashboard': true,
|
||||
'beta-features': true,
|
||||
},
|
||||
);
|
||||
```
|
||||
|
||||
_Source: Murat Testing Philosophy (lines 94-120), API-first testing patterns, faker.js documentation._
|
||||
@ -1,721 +0,0 @@
|
||||
# Email-Based Authentication Testing
|
||||
|
||||
## Principle
|
||||
|
||||
Email-based authentication (magic links, one-time codes, passwordless login) requires specialized testing with email capture services like Mailosaur or Ethereal. Extract magic links via HTML parsing or use built-in link extraction, preserve browser storage (local/session/cookies) when processing links, cache email payloads to avoid exhausting inbox quotas, and cover negative cases (expired links, reused links, multiple rapid requests). Log email IDs and links for troubleshooting, but scrub PII before committing artifacts.
|
||||
|
||||
## Rationale
|
||||
|
||||
Email authentication introduces unique challenges: asynchronous email delivery, quota limits (AWS Cognito: 50/day), cost per email, and complex state management (session preservation across link clicks). Without proper patterns, tests become slow (wait for email each time), expensive (quota exhaustion), and brittle (timing issues, missing state). Using email capture services + session caching + state preservation patterns makes email auth tests fast, reliable, and cost-effective.
|
||||
|
||||
## Pattern Examples
|
||||
|
||||
### Example 1: Magic Link Extraction with Mailosaur
|
||||
|
||||
**Context**: Passwordless login flow where user receives magic link via email, clicks it, and is authenticated.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/e2e/magic-link-auth.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
/**
|
||||
* Magic Link Authentication Flow
|
||||
* 1. User enters email
|
||||
* 2. Backend sends magic link
|
||||
* 3. Test retrieves email via Mailosaur
|
||||
* 4. Extract and visit magic link
|
||||
* 5. Verify user is authenticated
|
||||
*/
|
||||
|
||||
// Mailosaur configuration
|
||||
const MAILOSAUR_API_KEY = process.env.MAILOSAUR_API_KEY!;
|
||||
const MAILOSAUR_SERVER_ID = process.env.MAILOSAUR_SERVER_ID!;
|
||||
|
||||
/**
|
||||
* Extract href from HTML email body
|
||||
* DOMParser provides XML/HTML parsing in Node.js
|
||||
*/
|
||||
function extractMagicLink(htmlString: string): string | null {
|
||||
const { JSDOM } = require('jsdom');
|
||||
const dom = new JSDOM(htmlString);
|
||||
const link = dom.window.document.querySelector('#magic-link-button');
|
||||
return link ? (link as HTMLAnchorElement).href : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Alternative: Use Mailosaur's built-in link extraction
|
||||
* Mailosaur automatically parses links - no regex needed!
|
||||
*/
|
||||
async function getMagicLinkFromEmail(email: string): Promise<string> {
|
||||
const MailosaurClient = require('mailosaur');
|
||||
const mailosaur = new MailosaurClient(MAILOSAUR_API_KEY);
|
||||
|
||||
// Wait for email (timeout: 30 seconds)
|
||||
const message = await mailosaur.messages.get(
|
||||
MAILOSAUR_SERVER_ID,
|
||||
{
|
||||
sentTo: email,
|
||||
},
|
||||
{
|
||||
timeout: 30000, // 30 seconds
|
||||
},
|
||||
);
|
||||
|
||||
// Mailosaur extracts links automatically - no parsing needed!
|
||||
const magicLink = message.html?.links?.[0]?.href;
|
||||
|
||||
if (!magicLink) {
|
||||
throw new Error(`Magic link not found in email to ${email}`);
|
||||
}
|
||||
|
||||
console.log(`📧 Email received. Magic link extracted: ${magicLink}`);
|
||||
return magicLink;
|
||||
}
|
||||
|
||||
test.describe('Magic Link Authentication', () => {
|
||||
test('should authenticate user via magic link', async ({ page, context }) => {
|
||||
// Arrange: Generate unique test email
|
||||
const randomId = Math.floor(Math.random() * 1000000);
|
||||
const testEmail = `user-${randomId}@${MAILOSAUR_SERVER_ID}.mailosaur.net`;
|
||||
|
||||
// Act: Request magic link
|
||||
await page.goto('/login');
|
||||
await page.getByTestId('email-input').fill(testEmail);
|
||||
await page.getByTestId('send-magic-link').click();
|
||||
|
||||
// Assert: Success message
|
||||
await expect(page.getByTestId('check-email-message')).toBeVisible();
|
||||
await expect(page.getByTestId('check-email-message')).toContainText('Check your email');
|
||||
|
||||
// Retrieve magic link from email
|
||||
const magicLink = await getMagicLinkFromEmail(testEmail);
|
||||
|
||||
// Visit magic link
|
||||
await page.goto(magicLink);
|
||||
|
||||
// Assert: User is authenticated
|
||||
await expect(page.getByTestId('user-menu')).toBeVisible();
|
||||
await expect(page.getByTestId('user-email')).toContainText(testEmail);
|
||||
|
||||
// Verify session storage preserved
|
||||
const localStorage = await page.evaluate(() => JSON.stringify(window.localStorage));
|
||||
expect(localStorage).toContain('authToken');
|
||||
});
|
||||
|
||||
test('should handle expired magic link', async ({ page }) => {
|
||||
// Use pre-expired link (older than 15 minutes)
|
||||
const expiredLink = 'http://localhost:3000/auth/verify?token=expired-token-123';
|
||||
|
||||
await page.goto(expiredLink);
|
||||
|
||||
// Assert: Error message displayed
|
||||
await expect(page.getByTestId('error-message')).toBeVisible();
|
||||
await expect(page.getByTestId('error-message')).toContainText('link has expired');
|
||||
|
||||
// Assert: User NOT authenticated
|
||||
await expect(page.getByTestId('user-menu')).not.toBeVisible();
|
||||
});
|
||||
|
||||
test('should prevent reusing magic link', async ({ page }) => {
|
||||
const randomId = Math.floor(Math.random() * 1000000);
|
||||
const testEmail = `user-${randomId}@${MAILOSAUR_SERVER_ID}.mailosaur.net`;
|
||||
|
||||
// Request magic link
|
||||
await page.goto('/login');
|
||||
await page.getByTestId('email-input').fill(testEmail);
|
||||
await page.getByTestId('send-magic-link').click();
|
||||
|
||||
const magicLink = await getMagicLinkFromEmail(testEmail);
|
||||
|
||||
// Visit link first time (success)
|
||||
await page.goto(magicLink);
|
||||
await expect(page.getByTestId('user-menu')).toBeVisible();
|
||||
|
||||
// Sign out
|
||||
await page.getByTestId('sign-out').click();
|
||||
|
||||
// Try to reuse same link (should fail)
|
||||
await page.goto(magicLink);
|
||||
await expect(page.getByTestId('error-message')).toBeVisible();
|
||||
await expect(page.getByTestId('error-message')).toContainText('link has already been used');
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Cypress equivalent with Mailosaur plugin**:
|
||||
|
||||
```javascript
|
||||
// cypress/e2e/magic-link-auth.cy.ts
|
||||
describe('Magic Link Authentication', () => {
|
||||
it('should authenticate user via magic link', () => {
|
||||
const serverId = Cypress.env('MAILOSAUR_SERVERID');
|
||||
const randomId = Cypress._.random(1e6);
|
||||
const testEmail = `user-${randomId}@${serverId}.mailosaur.net`;
|
||||
|
||||
// Request magic link
|
||||
cy.visit('/login');
|
||||
cy.get('[data-cy="email-input"]').type(testEmail);
|
||||
cy.get('[data-cy="send-magic-link"]').click();
|
||||
cy.get('[data-cy="check-email-message"]').should('be.visible');
|
||||
|
||||
// Retrieve and visit magic link
|
||||
cy.mailosaurGetMessage(serverId, { sentTo: testEmail })
|
||||
.its('html.links.0.href') // Mailosaur extracts links automatically!
|
||||
.should('exist')
|
||||
.then((magicLink) => {
|
||||
cy.log(`Magic link: ${magicLink}`);
|
||||
cy.visit(magicLink);
|
||||
});
|
||||
|
||||
// Verify authenticated
|
||||
cy.get('[data-cy="user-menu"]').should('be.visible');
|
||||
cy.get('[data-cy="user-email"]').should('contain', testEmail);
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Mailosaur auto-extraction**: `html.links[0].href` or `html.codes[0].value`
|
||||
- **Unique emails**: Random ID prevents collisions
|
||||
- **Negative testing**: Expired and reused links tested
|
||||
- **State verification**: localStorage/session checked
|
||||
- **Fast email retrieval**: 30 second timeout typical
|
||||
|
||||
---
|
||||
|
||||
### Example 2: State Preservation Pattern with cy.session / Playwright storageState
|
||||
|
||||
**Context**: Cache authenticated session to avoid requesting magic link on every test.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// playwright/fixtures/email-auth-fixture.ts
|
||||
import { test as base } from '@playwright/test';
|
||||
import { getMagicLinkFromEmail } from '../support/mailosaur-helpers';
|
||||
|
||||
type EmailAuthFixture = {
|
||||
authenticatedUser: { email: string; token: string };
|
||||
};
|
||||
|
||||
export const test = base.extend<EmailAuthFixture>({
|
||||
authenticatedUser: async ({ page, context }, use) => {
|
||||
const randomId = Math.floor(Math.random() * 1000000);
|
||||
const testEmail = `user-${randomId}@${process.env.MAILOSAUR_SERVER_ID}.mailosaur.net`;
|
||||
|
||||
// Check if we have cached auth state for this email
|
||||
const storageStatePath = `./test-results/auth-state-${testEmail}.json`;
|
||||
|
||||
try {
|
||||
// Try to reuse existing session
|
||||
await context.storageState({ path: storageStatePath });
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// Validate session is still valid
|
||||
const isAuthenticated = await page.getByTestId('user-menu').isVisible({ timeout: 2000 });
|
||||
|
||||
if (isAuthenticated) {
|
||||
console.log(`✅ Reusing cached session for ${testEmail}`);
|
||||
await use({ email: testEmail, token: 'cached' });
|
||||
return;
|
||||
}
|
||||
} catch (error) {
|
||||
console.log(`📧 No cached session, requesting magic link for ${testEmail}`);
|
||||
}
|
||||
|
||||
// Request new magic link
|
||||
await page.goto('/login');
|
||||
await page.getByTestId('email-input').fill(testEmail);
|
||||
await page.getByTestId('send-magic-link').click();
|
||||
|
||||
// Get magic link from email
|
||||
const magicLink = await getMagicLinkFromEmail(testEmail);
|
||||
|
||||
// Visit link and authenticate
|
||||
await page.goto(magicLink);
|
||||
await expect(page.getByTestId('user-menu')).toBeVisible();
|
||||
|
||||
// Extract auth token from localStorage
|
||||
const authToken = await page.evaluate(() => localStorage.getItem('authToken'));
|
||||
|
||||
// Save session state for reuse
|
||||
await context.storageState({ path: storageStatePath });
|
||||
|
||||
console.log(`💾 Cached session for ${testEmail}`);
|
||||
|
||||
await use({ email: testEmail, token: authToken || '' });
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
**Cypress equivalent with cy.session + data-session**:
|
||||
|
||||
```javascript
|
||||
// cypress/support/commands/email-auth.js
|
||||
import { dataSession } from 'cypress-data-session';
|
||||
|
||||
/**
|
||||
* Authenticate via magic link with session caching
|
||||
* - First run: Requests email, extracts link, authenticates
|
||||
* - Subsequent runs: Reuses cached session (no email)
|
||||
*/
|
||||
Cypress.Commands.add('authViaMagicLink', (email) => {
|
||||
return dataSession({
|
||||
name: `magic-link-${email}`,
|
||||
|
||||
// First-time setup: Request and process magic link
|
||||
setup: () => {
|
||||
cy.visit('/login');
|
||||
cy.get('[data-cy="email-input"]').type(email);
|
||||
cy.get('[data-cy="send-magic-link"]').click();
|
||||
|
||||
// Get magic link from Mailosaur
|
||||
cy.mailosaurGetMessage(Cypress.env('MAILOSAUR_SERVERID'), {
|
||||
sentTo: email,
|
||||
})
|
||||
.its('html.links.0.href')
|
||||
.should('exist')
|
||||
.then((magicLink) => {
|
||||
cy.visit(magicLink);
|
||||
});
|
||||
|
||||
// Wait for authentication
|
||||
cy.get('[data-cy="user-menu"]', { timeout: 10000 }).should('be.visible');
|
||||
|
||||
// Preserve authentication state
|
||||
return cy.getAllLocalStorage().then((storage) => {
|
||||
return { storage, email };
|
||||
});
|
||||
},
|
||||
|
||||
// Validate cached session is still valid
|
||||
validate: (cached) => {
|
||||
return cy.wrap(Boolean(cached?.storage));
|
||||
},
|
||||
|
||||
// Recreate session from cache (no email needed)
|
||||
recreate: (cached) => {
|
||||
// Restore localStorage
|
||||
cy.setLocalStorage(cached.storage);
|
||||
cy.visit('/dashboard');
|
||||
cy.get('[data-cy="user-menu"]', { timeout: 5000 }).should('be.visible');
|
||||
},
|
||||
|
||||
shareAcrossSpecs: true, // Share session across all tests
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Usage in tests**:
|
||||
|
||||
```javascript
|
||||
// cypress/e2e/dashboard.cy.ts
|
||||
describe('Dashboard', () => {
|
||||
const serverId = Cypress.env('MAILOSAUR_SERVERID');
|
||||
const testEmail = `test-user@${serverId}.mailosaur.net`;
|
||||
|
||||
beforeEach(() => {
|
||||
// First test: Requests magic link
|
||||
// Subsequent tests: Reuses cached session (no email!)
|
||||
cy.authViaMagicLink(testEmail);
|
||||
});
|
||||
|
||||
it('should display user dashboard', () => {
|
||||
cy.get('[data-cy="dashboard-content"]').should('be.visible');
|
||||
});
|
||||
|
||||
it('should show user profile', () => {
|
||||
cy.get('[data-cy="user-email"]').should('contain', testEmail);
|
||||
});
|
||||
|
||||
// Both tests share same session - only 1 email consumed!
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Session caching**: First test requests email, rest reuse session
|
||||
- **State preservation**: localStorage/cookies saved and restored
|
||||
- **Validation**: Check cached session is still valid
|
||||
- **Quota optimization**: Massive reduction in email consumption
|
||||
- **Fast tests**: Cached auth takes seconds vs. minutes
|
||||
|
||||
---
|
||||
|
||||
### Example 3: Negative Flow Tests (Expired, Invalid, Reused Links)
|
||||
|
||||
**Context**: Comprehensive negative testing for email authentication edge cases.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/e2e/email-auth-negative.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
import { getMagicLinkFromEmail } from '../support/mailosaur-helpers';
|
||||
|
||||
const MAILOSAUR_SERVER_ID = process.env.MAILOSAUR_SERVER_ID!;
|
||||
|
||||
test.describe('Email Auth Negative Flows', () => {
|
||||
test('should reject expired magic link', async ({ page }) => {
|
||||
// Generate expired link (simulate 24 hours ago)
|
||||
const expiredToken = Buffer.from(
|
||||
JSON.stringify({
|
||||
email: 'test@example.com',
|
||||
exp: Date.now() - 24 * 60 * 60 * 1000, // 24 hours ago
|
||||
}),
|
||||
).toString('base64');
|
||||
|
||||
const expiredLink = `http://localhost:3000/auth/verify?token=${expiredToken}`;
|
||||
|
||||
// Visit expired link
|
||||
await page.goto(expiredLink);
|
||||
|
||||
// Assert: Error displayed
|
||||
await expect(page.getByTestId('error-message')).toBeVisible();
|
||||
await expect(page.getByTestId('error-message')).toContainText(/link.*expired|expired.*link/i);
|
||||
|
||||
// Assert: Link to request new one
|
||||
await expect(page.getByTestId('request-new-link')).toBeVisible();
|
||||
|
||||
// Assert: User NOT authenticated
|
||||
await expect(page.getByTestId('user-menu')).not.toBeVisible();
|
||||
});
|
||||
|
||||
test('should reject invalid magic link token', async ({ page }) => {
|
||||
const invalidLink = 'http://localhost:3000/auth/verify?token=invalid-garbage';
|
||||
|
||||
await page.goto(invalidLink);
|
||||
|
||||
// Assert: Error displayed
|
||||
await expect(page.getByTestId('error-message')).toBeVisible();
|
||||
await expect(page.getByTestId('error-message')).toContainText(/invalid.*link|link.*invalid/i);
|
||||
|
||||
// Assert: User not authenticated
|
||||
await expect(page.getByTestId('user-menu')).not.toBeVisible();
|
||||
});
|
||||
|
||||
test('should reject already-used magic link', async ({ page, context }) => {
|
||||
const randomId = Math.floor(Math.random() * 1000000);
|
||||
const testEmail = `user-${randomId}@${MAILOSAUR_SERVER_ID}.mailosaur.net`;
|
||||
|
||||
// Request magic link
|
||||
await page.goto('/login');
|
||||
await page.getByTestId('email-input').fill(testEmail);
|
||||
await page.getByTestId('send-magic-link').click();
|
||||
|
||||
const magicLink = await getMagicLinkFromEmail(testEmail);
|
||||
|
||||
// Visit link FIRST time (success)
|
||||
await page.goto(magicLink);
|
||||
await expect(page.getByTestId('user-menu')).toBeVisible();
|
||||
|
||||
// Sign out
|
||||
await page.getByTestId('user-menu').click();
|
||||
await page.getByTestId('sign-out').click();
|
||||
await expect(page.getByTestId('user-menu')).not.toBeVisible();
|
||||
|
||||
// Try to reuse SAME link (should fail)
|
||||
await page.goto(magicLink);
|
||||
|
||||
// Assert: Link already used error
|
||||
await expect(page.getByTestId('error-message')).toBeVisible();
|
||||
await expect(page.getByTestId('error-message')).toContainText(/already.*used|link.*used/i);
|
||||
|
||||
// Assert: User not authenticated
|
||||
await expect(page.getByTestId('user-menu')).not.toBeVisible();
|
||||
});
|
||||
|
||||
test('should handle rapid successive link requests', async ({ page }) => {
|
||||
const randomId = Math.floor(Math.random() * 1000000);
|
||||
const testEmail = `user-${randomId}@${MAILOSAUR_SERVER_ID}.mailosaur.net`;
|
||||
|
||||
// Request magic link 3 times rapidly
|
||||
for (let i = 0; i < 3; i++) {
|
||||
await page.goto('/login');
|
||||
await page.getByTestId('email-input').fill(testEmail);
|
||||
await page.getByTestId('send-magic-link').click();
|
||||
await expect(page.getByTestId('check-email-message')).toBeVisible();
|
||||
}
|
||||
|
||||
// Only the LATEST link should work
|
||||
const MailosaurClient = require('mailosaur');
|
||||
const mailosaur = new MailosaurClient(process.env.MAILOSAUR_API_KEY);
|
||||
|
||||
const messages = await mailosaur.messages.list(MAILOSAUR_SERVER_ID, {
|
||||
sentTo: testEmail,
|
||||
});
|
||||
|
||||
// Should receive 3 emails
|
||||
expect(messages.items.length).toBeGreaterThanOrEqual(3);
|
||||
|
||||
// Get the LATEST magic link
|
||||
const latestMessage = messages.items[0]; // Most recent first
|
||||
const latestLink = latestMessage.html.links[0].href;
|
||||
|
||||
// Latest link works
|
||||
await page.goto(latestLink);
|
||||
await expect(page.getByTestId('user-menu')).toBeVisible();
|
||||
|
||||
// Older links should NOT work (if backend invalidates previous)
|
||||
await page.getByTestId('sign-out').click();
|
||||
const olderLink = messages.items[1].html.links[0].href;
|
||||
|
||||
await page.goto(olderLink);
|
||||
await expect(page.getByTestId('error-message')).toBeVisible();
|
||||
});
|
||||
|
||||
test('should rate-limit excessive magic link requests', async ({ page }) => {
|
||||
const randomId = Math.floor(Math.random() * 1000000);
|
||||
const testEmail = `user-${randomId}@${MAILOSAUR_SERVER_ID}.mailosaur.net`;
|
||||
|
||||
// Request magic link 10 times rapidly (should hit rate limit)
|
||||
for (let i = 0; i < 10; i++) {
|
||||
await page.goto('/login');
|
||||
await page.getByTestId('email-input').fill(testEmail);
|
||||
await page.getByTestId('send-magic-link').click();
|
||||
|
||||
// After N requests, should show rate limit error
|
||||
const errorVisible = await page
|
||||
.getByTestId('rate-limit-error')
|
||||
.isVisible({ timeout: 1000 })
|
||||
.catch(() => false);
|
||||
|
||||
if (errorVisible) {
|
||||
console.log(`Rate limit hit after ${i + 1} requests`);
|
||||
await expect(page.getByTestId('rate-limit-error')).toContainText(/too many.*requests|rate.*limit/i);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// If no rate limit after 10 requests, log warning
|
||||
console.warn('⚠️ No rate limit detected after 10 requests');
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Expired links**: Test 24+ hour old tokens
|
||||
- **Invalid tokens**: Malformed or garbage tokens rejected
|
||||
- **Reuse prevention**: Same link can't be used twice
|
||||
- **Rapid requests**: Multiple requests handled gracefully
|
||||
- **Rate limiting**: Excessive requests blocked
|
||||
|
||||
---
|
||||
|
||||
### Example 4: Caching Strategy with cypress-data-session / Playwright Projects
|
||||
|
||||
**Context**: Minimize email consumption by sharing authentication state across tests and specs.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```javascript
|
||||
// cypress/support/commands/register-and-sign-in.js
|
||||
import { dataSession } from 'cypress-data-session';
|
||||
|
||||
/**
|
||||
* Email Authentication Caching Strategy
|
||||
* - One email per test run (not per spec, not per test)
|
||||
* - First spec: Full registration flow (form → email → code → sign in)
|
||||
* - Subsequent specs: Only sign in (reuse user)
|
||||
* - Subsequent tests in same spec: Session already active (no sign in)
|
||||
*/
|
||||
|
||||
// Helper: Fill registration form
|
||||
function fillRegistrationForm({ fullName, userName, email, password }) {
|
||||
cy.intercept('POST', 'https://cognito-idp*').as('cognito');
|
||||
cy.contains('Register').click();
|
||||
cy.get('#reg-dialog-form').should('be.visible');
|
||||
cy.get('#first-name').type(fullName, { delay: 0 });
|
||||
cy.get('#last-name').type(lastName, { delay: 0 });
|
||||
cy.get('#email').type(email, { delay: 0 });
|
||||
cy.get('#username').type(userName, { delay: 0 });
|
||||
cy.get('#password').type(password, { delay: 0 });
|
||||
cy.contains('button', 'Create an account').click();
|
||||
cy.wait('@cognito').its('response.statusCode').should('equal', 200);
|
||||
}
|
||||
|
||||
// Helper: Confirm registration with email code
|
||||
function confirmRegistration(email) {
|
||||
return cy
|
||||
.mailosaurGetMessage(Cypress.env('MAILOSAUR_SERVERID'), { sentTo: email })
|
||||
.its('html.codes.0.value') // Mailosaur auto-extracts codes!
|
||||
.then((code) => {
|
||||
cy.intercept('POST', 'https://cognito-idp*').as('cognito');
|
||||
cy.get('#verification-code').type(code, { delay: 0 });
|
||||
cy.contains('button', 'Confirm registration').click();
|
||||
cy.wait('@cognito');
|
||||
cy.contains('You are now registered!').should('be.visible');
|
||||
cy.contains('button', /ok/i).click();
|
||||
return cy.wrap(code); // Return code for reference
|
||||
});
|
||||
}
|
||||
|
||||
// Helper: Full registration (form + email)
|
||||
function register({ fullName, userName, email, password }) {
|
||||
fillRegistrationForm({ fullName, userName, email, password });
|
||||
return confirmRegistration(email);
|
||||
}
|
||||
|
||||
// Helper: Sign in
|
||||
function signIn({ userName, password }) {
|
||||
cy.intercept('POST', 'https://cognito-idp*').as('cognito');
|
||||
cy.contains('Sign in').click();
|
||||
cy.get('#sign-in-username').type(userName, { delay: 0 });
|
||||
cy.get('#sign-in-password').type(password, { delay: 0 });
|
||||
cy.contains('button', 'Sign in').click();
|
||||
cy.wait('@cognito');
|
||||
cy.contains('Sign out').should('be.visible');
|
||||
}
|
||||
|
||||
/**
|
||||
* Register and sign in with email caching
|
||||
* ONE EMAIL PER MACHINE (cypress run or cypress open)
|
||||
*/
|
||||
Cypress.Commands.add('registerAndSignIn', ({ fullName, userName, email, password }) => {
|
||||
return dataSession({
|
||||
name: email, // Unique session per email
|
||||
|
||||
// First time: Full registration (form → email → code)
|
||||
init: () => register({ fullName, userName, email, password }),
|
||||
|
||||
// Subsequent specs: Just check email exists (code already used)
|
||||
setup: () => confirmRegistration(email),
|
||||
|
||||
// Always runs after init/setup: Sign in
|
||||
recreate: () => signIn({ userName, password }),
|
||||
|
||||
// Share across ALL specs (one email for entire test run)
|
||||
shareAcrossSpecs: true,
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Usage across multiple specs**:
|
||||
|
||||
```javascript
|
||||
// cypress/e2e/place-order.cy.ts
|
||||
describe('Place Order', () => {
|
||||
beforeEach(() => {
|
||||
cy.visit('/');
|
||||
cy.registerAndSignIn({
|
||||
fullName: Cypress.env('fullName'), // From cypress.config
|
||||
userName: Cypress.env('userName'),
|
||||
email: Cypress.env('email'), // SAME email across all specs
|
||||
password: Cypress.env('password'),
|
||||
});
|
||||
});
|
||||
|
||||
it('should place order', () => {
|
||||
/* ... */
|
||||
});
|
||||
it('should view order history', () => {
|
||||
/* ... */
|
||||
});
|
||||
});
|
||||
|
||||
// cypress/e2e/profile.cy.ts
|
||||
describe('User Profile', () => {
|
||||
beforeEach(() => {
|
||||
cy.visit('/');
|
||||
cy.registerAndSignIn({
|
||||
fullName: Cypress.env('fullName'),
|
||||
userName: Cypress.env('userName'),
|
||||
email: Cypress.env('email'), // SAME email - no new email sent!
|
||||
password: Cypress.env('password'),
|
||||
});
|
||||
});
|
||||
|
||||
it('should update profile', () => {
|
||||
/* ... */
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Playwright equivalent with storageState**:
|
||||
|
||||
```typescript
|
||||
// playwright.config.ts
|
||||
import { defineConfig } from '@playwright/test';
|
||||
|
||||
export default defineConfig({
|
||||
projects: [
|
||||
{
|
||||
name: 'setup',
|
||||
testMatch: /global-setup\.ts/,
|
||||
},
|
||||
{
|
||||
name: 'authenticated',
|
||||
testMatch: /.*\.spec\.ts/,
|
||||
dependencies: ['setup'],
|
||||
use: {
|
||||
storageState: '.auth/user-session.json', // Reuse auth state
|
||||
},
|
||||
},
|
||||
],
|
||||
});
|
||||
```
|
||||
|
||||
```typescript
|
||||
// tests/global-setup.ts (runs once)
|
||||
import { test as setup } from '@playwright/test';
|
||||
import { getMagicLinkFromEmail } from './support/mailosaur-helpers';
|
||||
|
||||
const authFile = '.auth/user-session.json';
|
||||
|
||||
setup('authenticate via magic link', async ({ page }) => {
|
||||
const testEmail = process.env.TEST_USER_EMAIL!;
|
||||
|
||||
// Request magic link
|
||||
await page.goto('/login');
|
||||
await page.getByTestId('email-input').fill(testEmail);
|
||||
await page.getByTestId('send-magic-link').click();
|
||||
|
||||
// Get and visit magic link
|
||||
const magicLink = await getMagicLinkFromEmail(testEmail);
|
||||
await page.goto(magicLink);
|
||||
|
||||
// Verify authenticated
|
||||
await expect(page.getByTestId('user-menu')).toBeVisible();
|
||||
|
||||
// Save authenticated state (ONE TIME for all tests)
|
||||
await page.context().storageState({ path: authFile });
|
||||
|
||||
console.log('✅ Authentication state saved to', authFile);
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **One email per run**: Global setup authenticates once
|
||||
- **State reuse**: All tests use cached storageState
|
||||
- **cypress-data-session**: Intelligently manages cache lifecycle
|
||||
- **shareAcrossSpecs**: Session shared across all spec files
|
||||
- **Massive savings**: 500 tests = 1 email (not 500!)
|
||||
|
||||
---
|
||||
|
||||
## Email Authentication Testing Checklist
|
||||
|
||||
Before implementing email auth tests, verify:
|
||||
|
||||
- [ ] **Email service**: Mailosaur/Ethereal/MailHog configured with API keys
|
||||
- [ ] **Link extraction**: Use built-in parsing (html.links[0].href) over regex
|
||||
- [ ] **State preservation**: localStorage/session/cookies saved and restored
|
||||
- [ ] **Session caching**: cypress-data-session or storageState prevents redundant emails
|
||||
- [ ] **Negative flows**: Expired, invalid, reused, rapid requests tested
|
||||
- [ ] **Quota awareness**: One email per run (not per test)
|
||||
- [ ] **PII scrubbing**: Email IDs logged for debug, but scrubbed from artifacts
|
||||
- [ ] **Timeout handling**: 30 second email retrieval timeout configured
|
||||
|
||||
## Integration Points
|
||||
|
||||
- Used in workflows: `*framework` (email auth setup), `*automate` (email auth test generation)
|
||||
- Related fragments: `fixture-architecture.md`, `test-quality.md`
|
||||
- Email services: Mailosaur (recommended), Ethereal (free), MailHog (self-hosted)
|
||||
- Plugins: cypress-mailosaur, cypress-data-session
|
||||
|
||||
_Source: Email authentication blog, Murat testing toolkit, Mailosaur documentation_
|
||||
@ -1,725 +0,0 @@
|
||||
# Error Handling and Resilience Checks
|
||||
|
||||
## Principle
|
||||
|
||||
Treat expected failures explicitly: intercept network errors, assert UI fallbacks (error messages visible, retries triggered), and use scoped exception handling to ignore known errors while catching regressions. Test retry/backoff logic by forcing sequential failures (500 → timeout → success) and validate telemetry logging. Log captured errors with context (request payload, user/session) but redact secrets to keep artifacts safe for sharing.
|
||||
|
||||
## Rationale
|
||||
|
||||
Tests fail for two reasons: genuine bugs or poor error handling in the test itself. Without explicit error handling patterns, tests become noisy (uncaught exceptions cause false failures) or silent (swallowing all errors hides real bugs). Scoped exception handling (Cypress.on('uncaught:exception'), page.on('pageerror')) allows tests to ignore documented, expected errors while surfacing unexpected ones. Resilience testing (retry logic, graceful degradation) ensures applications handle failures gracefully in production.
|
||||
|
||||
## Pattern Examples
|
||||
|
||||
### Example 1: Scoped Exception Handling (Expected Errors Only)
|
||||
|
||||
**Context**: Handle known errors (Network failures, expected 500s) without masking unexpected bugs.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/e2e/error-handling.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
/**
|
||||
* Scoped Error Handling Pattern
|
||||
* - Only ignore specific, documented errors
|
||||
* - Rethrow everything else to catch regressions
|
||||
* - Validate error UI and user experience
|
||||
*/
|
||||
|
||||
test.describe('API Error Handling', () => {
|
||||
test('should display error message when API returns 500', async ({ page }) => {
|
||||
// Scope error handling to THIS test only
|
||||
const consoleErrors: string[] = [];
|
||||
page.on('pageerror', (error) => {
|
||||
// Only swallow documented NetworkError
|
||||
if (error.message.includes('NetworkError: Failed to fetch')) {
|
||||
consoleErrors.push(error.message);
|
||||
return; // Swallow this specific error
|
||||
}
|
||||
// Rethrow all other errors (catch regressions!)
|
||||
throw error;
|
||||
});
|
||||
|
||||
// Arrange: Mock 500 error response
|
||||
await page.route('**/api/users', (route) =>
|
||||
route.fulfill({
|
||||
status: 500,
|
||||
contentType: 'application/json',
|
||||
body: JSON.stringify({
|
||||
error: 'Internal server error',
|
||||
code: 'INTERNAL_ERROR',
|
||||
}),
|
||||
}),
|
||||
);
|
||||
|
||||
// Act: Navigate to page that fetches users
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// Assert: Error UI displayed
|
||||
await expect(page.getByTestId('error-message')).toBeVisible();
|
||||
await expect(page.getByTestId('error-message')).toContainText(/error.*loading|failed.*load/i);
|
||||
|
||||
// Assert: Retry button visible
|
||||
await expect(page.getByTestId('retry-button')).toBeVisible();
|
||||
|
||||
// Assert: NetworkError was thrown and caught
|
||||
expect(consoleErrors).toContainEqual(expect.stringContaining('NetworkError'));
|
||||
});
|
||||
|
||||
test('should NOT swallow unexpected errors', async ({ page }) => {
|
||||
let unexpectedError: Error | null = null;
|
||||
|
||||
page.on('pageerror', (error) => {
|
||||
// Capture but don't swallow - test should fail
|
||||
unexpectedError = error;
|
||||
throw error;
|
||||
});
|
||||
|
||||
// Arrange: App has JavaScript error (bug)
|
||||
await page.addInitScript(() => {
|
||||
// Simulate bug in app code
|
||||
(window as any).buggyFunction = () => {
|
||||
throw new Error('UNEXPECTED BUG: undefined is not a function');
|
||||
};
|
||||
});
|
||||
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// Trigger buggy function
|
||||
await page.evaluate(() => (window as any).buggyFunction());
|
||||
|
||||
// Assert: Test fails because unexpected error was NOT swallowed
|
||||
expect(unexpectedError).not.toBeNull();
|
||||
expect(unexpectedError?.message).toContain('UNEXPECTED BUG');
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Cypress equivalent**:
|
||||
|
||||
```javascript
|
||||
// cypress/e2e/error-handling.cy.ts
|
||||
describe('API Error Handling', () => {
|
||||
it('should display error message when API returns 500', () => {
|
||||
// Scoped to this test only
|
||||
cy.on('uncaught:exception', (err) => {
|
||||
// Only swallow documented NetworkError
|
||||
if (err.message.includes('NetworkError')) {
|
||||
return false; // Prevent test failure
|
||||
}
|
||||
// All other errors fail the test
|
||||
return true;
|
||||
});
|
||||
|
||||
// Arrange: Mock 500 error
|
||||
cy.intercept('GET', '**/api/users', {
|
||||
statusCode: 500,
|
||||
body: {
|
||||
error: 'Internal server error',
|
||||
code: 'INTERNAL_ERROR',
|
||||
},
|
||||
}).as('getUsers');
|
||||
|
||||
// Act
|
||||
cy.visit('/dashboard');
|
||||
cy.wait('@getUsers');
|
||||
|
||||
// Assert: Error UI
|
||||
cy.get('[data-cy="error-message"]').should('be.visible');
|
||||
cy.get('[data-cy="error-message"]').should('contain', 'error loading');
|
||||
cy.get('[data-cy="retry-button"]').should('be.visible');
|
||||
});
|
||||
|
||||
it('should NOT swallow unexpected errors', () => {
|
||||
// No exception handler - test should fail on unexpected errors
|
||||
|
||||
cy.visit('/dashboard');
|
||||
|
||||
// Trigger unexpected error
|
||||
cy.window().then((win) => {
|
||||
// This should fail the test
|
||||
win.eval('throw new Error("UNEXPECTED BUG")');
|
||||
});
|
||||
|
||||
// Test fails (as expected) - validates error detection works
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Scoped handling**: page.on() / cy.on() scoped to specific tests
|
||||
- **Explicit allow-list**: Only ignore documented errors
|
||||
- **Rethrow unexpected**: Catch regressions by failing on unknown errors
|
||||
- **Error UI validation**: Assert user sees error message
|
||||
- **Logging**: Capture errors for debugging, don't swallow silently
|
||||
|
||||
---
|
||||
|
||||
### Example 2: Retry Validation Pattern (Network Resilience)
|
||||
|
||||
**Context**: Test that retry/backoff logic works correctly for transient failures.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/e2e/retry-resilience.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
/**
|
||||
* Retry Validation Pattern
|
||||
* - Force sequential failures (500 → 500 → 200)
|
||||
* - Validate retry attempts and backoff timing
|
||||
* - Assert telemetry captures retry events
|
||||
*/
|
||||
|
||||
test.describe('Network Retry Logic', () => {
|
||||
test('should retry on 500 error and succeed', async ({ page }) => {
|
||||
let attemptCount = 0;
|
||||
const attemptTimestamps: number[] = [];
|
||||
|
||||
// Mock API: Fail twice, succeed on third attempt
|
||||
await page.route('**/api/products', (route) => {
|
||||
attemptCount++;
|
||||
attemptTimestamps.push(Date.now());
|
||||
|
||||
if (attemptCount <= 2) {
|
||||
// First 2 attempts: 500 error
|
||||
route.fulfill({
|
||||
status: 500,
|
||||
body: JSON.stringify({ error: 'Server error' }),
|
||||
});
|
||||
} else {
|
||||
// 3rd attempt: Success
|
||||
route.fulfill({
|
||||
status: 200,
|
||||
contentType: 'application/json',
|
||||
body: JSON.stringify({ products: [{ id: 1, name: 'Product 1' }] }),
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
// Act: Navigate (should retry automatically)
|
||||
await page.goto('/products');
|
||||
|
||||
// Assert: Data eventually loads after retries
|
||||
await expect(page.getByTestId('product-list')).toBeVisible();
|
||||
await expect(page.getByTestId('product-item')).toHaveCount(1);
|
||||
|
||||
// Assert: Exactly 3 attempts made
|
||||
expect(attemptCount).toBe(3);
|
||||
|
||||
// Assert: Exponential backoff timing (1s → 2s between attempts)
|
||||
if (attemptTimestamps.length === 3) {
|
||||
const delay1 = attemptTimestamps[1] - attemptTimestamps[0];
|
||||
const delay2 = attemptTimestamps[2] - attemptTimestamps[1];
|
||||
|
||||
expect(delay1).toBeGreaterThanOrEqual(900); // ~1 second
|
||||
expect(delay1).toBeLessThan(1200);
|
||||
expect(delay2).toBeGreaterThanOrEqual(1900); // ~2 seconds
|
||||
expect(delay2).toBeLessThan(2200);
|
||||
}
|
||||
|
||||
// Assert: Telemetry logged retry events
|
||||
const telemetryEvents = await page.evaluate(() => (window as any).__TELEMETRY_EVENTS__ || []);
|
||||
expect(telemetryEvents).toContainEqual(
|
||||
expect.objectContaining({
|
||||
event: 'api_retry',
|
||||
attempt: 1,
|
||||
endpoint: '/api/products',
|
||||
}),
|
||||
);
|
||||
expect(telemetryEvents).toContainEqual(
|
||||
expect.objectContaining({
|
||||
event: 'api_retry',
|
||||
attempt: 2,
|
||||
}),
|
||||
);
|
||||
});
|
||||
|
||||
test('should give up after max retries and show error', async ({ page }) => {
|
||||
let attemptCount = 0;
|
||||
|
||||
// Mock API: Always fail (test retry limit)
|
||||
await page.route('**/api/products', (route) => {
|
||||
attemptCount++;
|
||||
route.fulfill({
|
||||
status: 500,
|
||||
body: JSON.stringify({ error: 'Persistent server error' }),
|
||||
});
|
||||
});
|
||||
|
||||
// Act
|
||||
await page.goto('/products');
|
||||
|
||||
// Assert: Max retries reached (3 attempts typical)
|
||||
expect(attemptCount).toBe(3);
|
||||
|
||||
// Assert: Error UI displayed after exhausting retries
|
||||
await expect(page.getByTestId('error-message')).toBeVisible();
|
||||
await expect(page.getByTestId('error-message')).toContainText(/unable.*load|failed.*after.*retries/i);
|
||||
|
||||
// Assert: Data not displayed
|
||||
await expect(page.getByTestId('product-list')).not.toBeVisible();
|
||||
});
|
||||
|
||||
test('should NOT retry on 404 (non-retryable error)', async ({ page }) => {
|
||||
let attemptCount = 0;
|
||||
|
||||
// Mock API: 404 error (should NOT retry)
|
||||
await page.route('**/api/products/999', (route) => {
|
||||
attemptCount++;
|
||||
route.fulfill({
|
||||
status: 404,
|
||||
body: JSON.stringify({ error: 'Product not found' }),
|
||||
});
|
||||
});
|
||||
|
||||
await page.goto('/products/999');
|
||||
|
||||
// Assert: Only 1 attempt (no retries on 404)
|
||||
expect(attemptCount).toBe(1);
|
||||
|
||||
// Assert: 404 error displayed immediately
|
||||
await expect(page.getByTestId('not-found-message')).toBeVisible();
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Cypress with retry interception**:
|
||||
|
||||
```javascript
|
||||
// cypress/e2e/retry-resilience.cy.ts
|
||||
describe('Network Retry Logic', () => {
|
||||
it('should retry on 500 and succeed on 3rd attempt', () => {
|
||||
let attemptCount = 0;
|
||||
|
||||
cy.intercept('GET', '**/api/products', (req) => {
|
||||
attemptCount++;
|
||||
|
||||
if (attemptCount <= 2) {
|
||||
req.reply({ statusCode: 500, body: { error: 'Server error' } });
|
||||
} else {
|
||||
req.reply({ statusCode: 200, body: { products: [{ id: 1, name: 'Product 1' }] } });
|
||||
}
|
||||
}).as('getProducts');
|
||||
|
||||
cy.visit('/products');
|
||||
|
||||
// Wait for final successful request
|
||||
cy.wait('@getProducts').its('response.statusCode').should('eq', 200);
|
||||
|
||||
// Assert: Data loaded
|
||||
cy.get('[data-cy="product-list"]').should('be.visible');
|
||||
cy.get('[data-cy="product-item"]').should('have.length', 1);
|
||||
|
||||
// Validate retry count
|
||||
cy.wrap(attemptCount).should('eq', 3);
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Sequential failures**: Test retry logic with 500 → 500 → 200
|
||||
- **Backoff timing**: Validate exponential backoff delays
|
||||
- **Retry limits**: Max attempts enforced (typically 3)
|
||||
- **Non-retryable errors**: 404s don't trigger retries
|
||||
- **Telemetry**: Log retry attempts for monitoring
|
||||
|
||||
---
|
||||
|
||||
### Example 3: Telemetry Logging with Context (Sentry Integration)
|
||||
|
||||
**Context**: Capture errors with full context for production debugging without exposing secrets.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/e2e/telemetry-logging.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
/**
|
||||
* Telemetry Logging Pattern
|
||||
* - Log errors with request context
|
||||
* - Redact sensitive data (tokens, passwords, PII)
|
||||
* - Integrate with monitoring (Sentry, Datadog)
|
||||
* - Validate error logging without exposing secrets
|
||||
*/
|
||||
|
||||
type ErrorLog = {
|
||||
level: 'error' | 'warn' | 'info';
|
||||
message: string;
|
||||
context?: {
|
||||
endpoint?: string;
|
||||
method?: string;
|
||||
statusCode?: number;
|
||||
userId?: string;
|
||||
sessionId?: string;
|
||||
};
|
||||
timestamp: string;
|
||||
};
|
||||
|
||||
test.describe('Error Telemetry', () => {
|
||||
test('should log API errors with context', async ({ page }) => {
|
||||
const errorLogs: ErrorLog[] = [];
|
||||
|
||||
// Capture console errors
|
||||
page.on('console', (msg) => {
|
||||
if (msg.type() === 'error') {
|
||||
try {
|
||||
const log = JSON.parse(msg.text());
|
||||
errorLogs.push(log);
|
||||
} catch {
|
||||
// Not a structured log, ignore
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
// Mock failing API
|
||||
await page.route('**/api/orders', (route) =>
|
||||
route.fulfill({
|
||||
status: 500,
|
||||
body: JSON.stringify({ error: 'Payment processor unavailable' }),
|
||||
}),
|
||||
);
|
||||
|
||||
// Act: Trigger error
|
||||
await page.goto('/checkout');
|
||||
await page.getByTestId('place-order').click();
|
||||
|
||||
// Wait for error UI
|
||||
await expect(page.getByTestId('error-message')).toBeVisible();
|
||||
|
||||
// Assert: Error logged with context
|
||||
expect(errorLogs).toContainEqual(
|
||||
expect.objectContaining({
|
||||
level: 'error',
|
||||
message: expect.stringContaining('API request failed'),
|
||||
context: expect.objectContaining({
|
||||
endpoint: '/api/orders',
|
||||
method: 'POST',
|
||||
statusCode: 500,
|
||||
userId: expect.any(String),
|
||||
}),
|
||||
}),
|
||||
);
|
||||
|
||||
// Assert: Sensitive data NOT logged
|
||||
const logString = JSON.stringify(errorLogs);
|
||||
expect(logString).not.toContain('password');
|
||||
expect(logString).not.toContain('token');
|
||||
expect(logString).not.toContain('creditCard');
|
||||
});
|
||||
|
||||
test('should send errors to Sentry with breadcrumbs', async ({ page }) => {
|
||||
const sentryEvents: any[] = [];
|
||||
|
||||
// Mock Sentry SDK
|
||||
await page.addInitScript(() => {
|
||||
(window as any).Sentry = {
|
||||
captureException: (error: Error, context?: any) => {
|
||||
(window as any).__SENTRY_EVENTS__ = (window as any).__SENTRY_EVENTS__ || [];
|
||||
(window as any).__SENTRY_EVENTS__.push({
|
||||
error: error.message,
|
||||
context,
|
||||
timestamp: Date.now(),
|
||||
});
|
||||
},
|
||||
addBreadcrumb: (breadcrumb: any) => {
|
||||
(window as any).__SENTRY_BREADCRUMBS__ = (window as any).__SENTRY_BREADCRUMBS__ || [];
|
||||
(window as any).__SENTRY_BREADCRUMBS__.push(breadcrumb);
|
||||
},
|
||||
};
|
||||
});
|
||||
|
||||
// Mock failing API
|
||||
await page.route('**/api/users', (route) => route.fulfill({ status: 403, body: { error: 'Forbidden' } }));
|
||||
|
||||
// Act
|
||||
await page.goto('/users');
|
||||
|
||||
// Assert: Sentry captured error
|
||||
const events = await page.evaluate(() => (window as any).__SENTRY_EVENTS__);
|
||||
expect(events).toHaveLength(1);
|
||||
expect(events[0]).toMatchObject({
|
||||
error: expect.stringContaining('403'),
|
||||
context: expect.objectContaining({
|
||||
endpoint: '/api/users',
|
||||
statusCode: 403,
|
||||
}),
|
||||
});
|
||||
|
||||
// Assert: Breadcrumbs include user actions
|
||||
const breadcrumbs = await page.evaluate(() => (window as any).__SENTRY_BREADCRUMBS__);
|
||||
expect(breadcrumbs).toContainEqual(
|
||||
expect.objectContaining({
|
||||
category: 'navigation',
|
||||
message: '/users',
|
||||
}),
|
||||
);
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Cypress with Sentry**:
|
||||
|
||||
```javascript
|
||||
// cypress/e2e/telemetry-logging.cy.ts
|
||||
describe('Error Telemetry', () => {
|
||||
it('should log API errors with redacted sensitive data', () => {
|
||||
const errorLogs = [];
|
||||
|
||||
// Capture console errors
|
||||
cy.on('window:before:load', (win) => {
|
||||
cy.stub(win.console, 'error').callsFake((msg) => {
|
||||
errorLogs.push(msg);
|
||||
});
|
||||
});
|
||||
|
||||
// Mock failing API
|
||||
cy.intercept('POST', '**/api/orders', {
|
||||
statusCode: 500,
|
||||
body: { error: 'Payment failed' },
|
||||
});
|
||||
|
||||
// Act
|
||||
cy.visit('/checkout');
|
||||
cy.get('[data-cy="place-order"]').click();
|
||||
|
||||
// Assert: Error logged
|
||||
cy.wrap(errorLogs).should('have.length.greaterThan', 0);
|
||||
|
||||
// Assert: Context included
|
||||
cy.wrap(errorLogs[0]).should('include', '/api/orders');
|
||||
|
||||
// Assert: Secrets redacted
|
||||
cy.wrap(JSON.stringify(errorLogs)).should('not.contain', 'password');
|
||||
cy.wrap(JSON.stringify(errorLogs)).should('not.contain', 'creditCard');
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Error logger utility with redaction**:
|
||||
|
||||
```typescript
|
||||
// src/utils/error-logger.ts
|
||||
type ErrorContext = {
|
||||
endpoint?: string;
|
||||
method?: string;
|
||||
statusCode?: number;
|
||||
userId?: string;
|
||||
sessionId?: string;
|
||||
requestPayload?: any;
|
||||
};
|
||||
|
||||
const SENSITIVE_KEYS = ['password', 'token', 'creditCard', 'ssn', 'apiKey'];
|
||||
|
||||
/**
|
||||
* Redact sensitive data from objects
|
||||
*/
|
||||
function redactSensitiveData(obj: any): any {
|
||||
if (typeof obj !== 'object' || obj === null) return obj;
|
||||
|
||||
const redacted = { ...obj };
|
||||
|
||||
for (const key of Object.keys(redacted)) {
|
||||
if (SENSITIVE_KEYS.some((sensitive) => key.toLowerCase().includes(sensitive))) {
|
||||
redacted[key] = '[REDACTED]';
|
||||
} else if (typeof redacted[key] === 'object') {
|
||||
redacted[key] = redactSensitiveData(redacted[key]);
|
||||
}
|
||||
}
|
||||
|
||||
return redacted;
|
||||
}
|
||||
|
||||
/**
|
||||
* Log error with context (Sentry integration)
|
||||
*/
|
||||
export function logError(error: Error, context?: ErrorContext) {
|
||||
const safeContext = context ? redactSensitiveData(context) : {};
|
||||
|
||||
const errorLog = {
|
||||
level: 'error' as const,
|
||||
message: error.message,
|
||||
stack: error.stack,
|
||||
context: safeContext,
|
||||
timestamp: new Date().toISOString(),
|
||||
};
|
||||
|
||||
// Console (development)
|
||||
console.error(JSON.stringify(errorLog));
|
||||
|
||||
// Sentry (production)
|
||||
if (typeof window !== 'undefined' && (window as any).Sentry) {
|
||||
(window as any).Sentry.captureException(error, {
|
||||
contexts: { custom: safeContext },
|
||||
});
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Context-rich logging**: Endpoint, method, status, user ID
|
||||
- **Secret redaction**: Passwords, tokens, PII removed before logging
|
||||
- **Sentry integration**: Production monitoring with breadcrumbs
|
||||
- **Structured logs**: JSON format for easy parsing
|
||||
- **Test validation**: Assert logs contain context but not secrets
|
||||
|
||||
---
|
||||
|
||||
### Example 4: Graceful Degradation Tests (Fallback Behavior)
|
||||
|
||||
**Context**: Validate application continues functioning when services are unavailable.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/e2e/graceful-degradation.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
/**
|
||||
* Graceful Degradation Pattern
|
||||
* - Simulate service unavailability
|
||||
* - Validate fallback behavior
|
||||
* - Ensure user experience degrades gracefully
|
||||
* - Verify telemetry captures degradation events
|
||||
*/
|
||||
|
||||
test.describe('Service Unavailability', () => {
|
||||
test('should display cached data when API is down', async ({ page }) => {
|
||||
// Arrange: Seed localStorage with cached data
|
||||
await page.addInitScript(() => {
|
||||
localStorage.setItem(
|
||||
'products_cache',
|
||||
JSON.stringify({
|
||||
data: [
|
||||
{ id: 1, name: 'Cached Product 1' },
|
||||
{ id: 2, name: 'Cached Product 2' },
|
||||
],
|
||||
timestamp: Date.now(),
|
||||
}),
|
||||
);
|
||||
});
|
||||
|
||||
// Mock API unavailable
|
||||
await page.route(
|
||||
'**/api/products',
|
||||
(route) => route.abort('connectionrefused'), // Simulate server down
|
||||
);
|
||||
|
||||
// Act
|
||||
await page.goto('/products');
|
||||
|
||||
// Assert: Cached data displayed
|
||||
await expect(page.getByTestId('product-list')).toBeVisible();
|
||||
await expect(page.getByText('Cached Product 1')).toBeVisible();
|
||||
|
||||
// Assert: Stale data warning shown
|
||||
await expect(page.getByTestId('cache-warning')).toBeVisible();
|
||||
await expect(page.getByTestId('cache-warning')).toContainText(/showing.*cached|offline.*mode/i);
|
||||
|
||||
// Assert: Retry button available
|
||||
await expect(page.getByTestId('refresh-button')).toBeVisible();
|
||||
});
|
||||
|
||||
test('should show fallback UI when analytics service fails', async ({ page }) => {
|
||||
// Mock analytics service down (non-critical)
|
||||
await page.route('**/analytics/track', (route) => route.fulfill({ status: 503, body: 'Service unavailable' }));
|
||||
|
||||
// Act: Navigate normally
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// Assert: Page loads successfully (analytics failure doesn't block)
|
||||
await expect(page.getByTestId('dashboard-content')).toBeVisible();
|
||||
|
||||
// Assert: Analytics error logged but not shown to user
|
||||
const consoleErrors = [];
|
||||
page.on('console', (msg) => {
|
||||
if (msg.type() === 'error') consoleErrors.push(msg.text());
|
||||
});
|
||||
|
||||
// Trigger analytics event
|
||||
await page.getByTestId('track-action-button').click();
|
||||
|
||||
// Analytics error logged
|
||||
expect(consoleErrors).toContainEqual(expect.stringContaining('Analytics service unavailable'));
|
||||
|
||||
// But user doesn't see error
|
||||
await expect(page.getByTestId('error-message')).not.toBeVisible();
|
||||
});
|
||||
|
||||
test('should fallback to local validation when API is slow', async ({ page }) => {
|
||||
// Mock slow API (> 5 seconds)
|
||||
await page.route('**/api/validate-email', async (route) => {
|
||||
await new Promise((resolve) => setTimeout(resolve, 6000)); // 6 second delay
|
||||
route.fulfill({
|
||||
status: 200,
|
||||
body: JSON.stringify({ valid: true }),
|
||||
});
|
||||
});
|
||||
|
||||
// Act: Fill form
|
||||
await page.goto('/signup');
|
||||
await page.getByTestId('email-input').fill('test@example.com');
|
||||
await page.getByTestId('email-input').blur();
|
||||
|
||||
// Assert: Client-side validation triggers immediately (doesn't wait for API)
|
||||
await expect(page.getByTestId('email-valid-icon')).toBeVisible({ timeout: 1000 });
|
||||
|
||||
// Assert: Eventually API validates too (but doesn't block UX)
|
||||
await expect(page.getByTestId('email-validated-badge')).toBeVisible({ timeout: 7000 });
|
||||
});
|
||||
|
||||
test('should maintain functionality with third-party script failure', async ({ page }) => {
|
||||
// Block third-party scripts (Google Analytics, Intercom, etc.)
|
||||
await page.route('**/*.google-analytics.com/**', (route) => route.abort());
|
||||
await page.route('**/*.intercom.io/**', (route) => route.abort());
|
||||
|
||||
// Act
|
||||
await page.goto('/');
|
||||
|
||||
// Assert: App works without third-party scripts
|
||||
await expect(page.getByTestId('main-content')).toBeVisible();
|
||||
await expect(page.getByTestId('nav-menu')).toBeVisible();
|
||||
|
||||
// Assert: Core functionality intact
|
||||
await page.getByTestId('nav-products').click();
|
||||
await expect(page).toHaveURL(/.*\/products/);
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Cached fallbacks**: Display stale data when API unavailable
|
||||
- **Non-critical degradation**: Analytics failures don't block app
|
||||
- **Client-side fallbacks**: Local validation when API slow
|
||||
- **Third-party resilience**: App works without external scripts
|
||||
- **User transparency**: Stale data warnings displayed
|
||||
|
||||
---
|
||||
|
||||
## Error Handling Testing Checklist
|
||||
|
||||
Before shipping error handling code, verify:
|
||||
|
||||
- [ ] **Scoped exception handling**: Only ignore documented errors (NetworkError, specific codes)
|
||||
- [ ] **Rethrow unexpected**: Unknown errors fail tests (catch regressions)
|
||||
- [ ] **Error UI tested**: User sees error messages for all error states
|
||||
- [ ] **Retry logic validated**: Sequential failures test backoff and max attempts
|
||||
- [ ] **Telemetry verified**: Errors logged with context (endpoint, status, user)
|
||||
- [ ] **Secret redaction**: Logs don't contain passwords, tokens, PII
|
||||
- [ ] **Graceful degradation**: Critical services down, app shows fallback UI
|
||||
- [ ] **Non-critical failures**: Analytics/tracking failures don't block app
|
||||
|
||||
## Integration Points
|
||||
|
||||
- Used in workflows: `*automate` (error handling test generation), `*test-review` (error pattern detection)
|
||||
- Related fragments: `network-first.md`, `test-quality.md`, `contract-testing.md`
|
||||
- Monitoring tools: Sentry, Datadog, LogRocket
|
||||
|
||||
_Source: Murat error-handling patterns, Pact resilience guidance, SEON production error handling_
|
||||
@ -1,750 +0,0 @@
|
||||
# Feature Flag Governance
|
||||
|
||||
## Principle
|
||||
|
||||
Feature flags enable controlled rollouts and A/B testing, but require disciplined testing governance. Centralize flag definitions in a frozen enum, test both enabled and disabled states, clean up targeting after each spec, and maintain a comprehensive flag lifecycle checklist. For LaunchDarkly-style systems, script API helpers to seed variations programmatically rather than manual UI mutations.
|
||||
|
||||
## Rationale
|
||||
|
||||
Poorly managed feature flags become technical debt: untested variations ship broken code, forgotten flags clutter the codebase, and shared environments become unstable from leftover targeting rules. Structured governance ensures flags are testable, traceable, temporary, and safe. Testing both states prevents surprises when flags flip in production.
|
||||
|
||||
## Pattern Examples
|
||||
|
||||
### Example 1: Feature Flag Enum Pattern with Type Safety
|
||||
|
||||
**Context**: Centralized flag management with TypeScript type safety and runtime validation.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// src/utils/feature-flags.ts
|
||||
/**
|
||||
* Centralized feature flag definitions
|
||||
* - Object.freeze prevents runtime modifications
|
||||
* - TypeScript ensures compile-time type safety
|
||||
* - Single source of truth for all flag keys
|
||||
*/
|
||||
export const FLAGS = Object.freeze({
|
||||
// User-facing features
|
||||
NEW_CHECKOUT_FLOW: 'new-checkout-flow',
|
||||
DARK_MODE: 'dark-mode',
|
||||
ENHANCED_SEARCH: 'enhanced-search',
|
||||
|
||||
// Experiments
|
||||
PRICING_EXPERIMENT_A: 'pricing-experiment-a',
|
||||
HOMEPAGE_VARIANT_B: 'homepage-variant-b',
|
||||
|
||||
// Infrastructure
|
||||
USE_NEW_API_ENDPOINT: 'use-new-api-endpoint',
|
||||
ENABLE_ANALYTICS_V2: 'enable-analytics-v2',
|
||||
|
||||
// Killswitches (emergency disables)
|
||||
DISABLE_PAYMENT_PROCESSING: 'disable-payment-processing',
|
||||
DISABLE_EMAIL_NOTIFICATIONS: 'disable-email-notifications',
|
||||
} as const);
|
||||
|
||||
/**
|
||||
* Type-safe flag keys
|
||||
* Prevents typos and ensures autocomplete in IDEs
|
||||
*/
|
||||
export type FlagKey = (typeof FLAGS)[keyof typeof FLAGS];
|
||||
|
||||
/**
|
||||
* Flag metadata for governance
|
||||
*/
|
||||
type FlagMetadata = {
|
||||
key: FlagKey;
|
||||
name: string;
|
||||
owner: string;
|
||||
createdDate: string;
|
||||
expiryDate?: string;
|
||||
defaultState: boolean;
|
||||
requiresCleanup: boolean;
|
||||
dependencies?: FlagKey[];
|
||||
telemetryEvents?: string[];
|
||||
};
|
||||
|
||||
/**
|
||||
* Flag registry with governance metadata
|
||||
* Used for flag lifecycle tracking and cleanup alerts
|
||||
*/
|
||||
export const FLAG_REGISTRY: Record<FlagKey, FlagMetadata> = {
|
||||
[FLAGS.NEW_CHECKOUT_FLOW]: {
|
||||
key: FLAGS.NEW_CHECKOUT_FLOW,
|
||||
name: 'New Checkout Flow',
|
||||
owner: 'payments-team',
|
||||
createdDate: '2025-01-15',
|
||||
expiryDate: '2025-03-15',
|
||||
defaultState: false,
|
||||
requiresCleanup: true,
|
||||
dependencies: [FLAGS.USE_NEW_API_ENDPOINT],
|
||||
telemetryEvents: ['checkout_started', 'checkout_completed'],
|
||||
},
|
||||
[FLAGS.DARK_MODE]: {
|
||||
key: FLAGS.DARK_MODE,
|
||||
name: 'Dark Mode UI',
|
||||
owner: 'frontend-team',
|
||||
createdDate: '2025-01-10',
|
||||
defaultState: false,
|
||||
requiresCleanup: false, // Permanent feature toggle
|
||||
},
|
||||
// ... rest of registry
|
||||
};
|
||||
|
||||
/**
|
||||
* Validate flag exists in registry
|
||||
* Throws at runtime if flag is unregistered
|
||||
*/
|
||||
export function validateFlag(flag: string): asserts flag is FlagKey {
|
||||
if (!Object.values(FLAGS).includes(flag as FlagKey)) {
|
||||
throw new Error(`Unregistered feature flag: ${flag}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if flag is expired (needs removal)
|
||||
*/
|
||||
export function isFlagExpired(flag: FlagKey): boolean {
|
||||
const metadata = FLAG_REGISTRY[flag];
|
||||
if (!metadata.expiryDate) return false;
|
||||
|
||||
const expiry = new Date(metadata.expiryDate);
|
||||
return Date.now() > expiry.getTime();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all expired flags requiring cleanup
|
||||
*/
|
||||
export function getExpiredFlags(): FlagMetadata[] {
|
||||
return Object.values(FLAG_REGISTRY).filter((meta) => isFlagExpired(meta.key));
|
||||
}
|
||||
```
|
||||
|
||||
**Usage in application code**:
|
||||
|
||||
```typescript
|
||||
// components/Checkout.tsx
|
||||
import { FLAGS } from '@/utils/feature-flags';
|
||||
import { useFeatureFlag } from '@/hooks/useFeatureFlag';
|
||||
|
||||
export function Checkout() {
|
||||
const isNewFlow = useFeatureFlag(FLAGS.NEW_CHECKOUT_FLOW);
|
||||
|
||||
return isNewFlow ? <NewCheckoutFlow /> : <LegacyCheckoutFlow />;
|
||||
}
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Type safety**: TypeScript catches typos at compile time
|
||||
- **Runtime validation**: validateFlag ensures only registered flags used
|
||||
- **Metadata tracking**: Owner, dates, dependencies documented
|
||||
- **Expiry alerts**: Automated detection of stale flags
|
||||
- **Single source of truth**: All flags defined in one place
|
||||
|
||||
---
|
||||
|
||||
### Example 2: Feature Flag Testing Pattern (Both States)
|
||||
|
||||
**Context**: Comprehensive testing of feature flag variations with proper cleanup.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/e2e/checkout-feature-flag.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
import { FLAGS } from '@/utils/feature-flags';
|
||||
|
||||
/**
|
||||
* Feature Flag Testing Strategy:
|
||||
* 1. Test BOTH enabled and disabled states
|
||||
* 2. Clean up targeting after each test
|
||||
* 3. Use dedicated test users (not production data)
|
||||
* 4. Verify telemetry events fire correctly
|
||||
*/
|
||||
|
||||
test.describe('Checkout Flow - Feature Flag Variations', () => {
|
||||
let testUserId: string;
|
||||
|
||||
test.beforeEach(async () => {
|
||||
// Generate unique test user ID
|
||||
testUserId = `test-user-${Date.now()}`;
|
||||
});
|
||||
|
||||
test.afterEach(async ({ request }) => {
|
||||
// CRITICAL: Clean up flag targeting to prevent shared env pollution
|
||||
await request.post('/api/feature-flags/cleanup', {
|
||||
data: {
|
||||
flagKey: FLAGS.NEW_CHECKOUT_FLOW,
|
||||
userId: testUserId,
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
test('should use NEW checkout flow when flag is ENABLED', async ({ page, request }) => {
|
||||
// Arrange: Enable flag for test user
|
||||
await request.post('/api/feature-flags/target', {
|
||||
data: {
|
||||
flagKey: FLAGS.NEW_CHECKOUT_FLOW,
|
||||
userId: testUserId,
|
||||
variation: true, // ENABLED
|
||||
},
|
||||
});
|
||||
|
||||
// Act: Navigate as targeted user
|
||||
await page.goto('/checkout', {
|
||||
extraHTTPHeaders: {
|
||||
'X-Test-User-ID': testUserId,
|
||||
},
|
||||
});
|
||||
|
||||
// Assert: New flow UI elements visible
|
||||
await expect(page.getByTestId('checkout-v2-container')).toBeVisible();
|
||||
await expect(page.getByTestId('express-payment-options')).toBeVisible();
|
||||
await expect(page.getByTestId('saved-addresses-dropdown')).toBeVisible();
|
||||
|
||||
// Assert: Legacy flow NOT visible
|
||||
await expect(page.getByTestId('checkout-v1-container')).not.toBeVisible();
|
||||
|
||||
// Assert: Telemetry event fired
|
||||
const analyticsEvents = await page.evaluate(() => (window as any).__ANALYTICS_EVENTS__ || []);
|
||||
expect(analyticsEvents).toContainEqual(
|
||||
expect.objectContaining({
|
||||
event: 'checkout_started',
|
||||
properties: expect.objectContaining({
|
||||
variant: 'new_flow',
|
||||
}),
|
||||
}),
|
||||
);
|
||||
});
|
||||
|
||||
test('should use LEGACY checkout flow when flag is DISABLED', async ({ page, request }) => {
|
||||
// Arrange: Disable flag for test user (or don't target at all)
|
||||
await request.post('/api/feature-flags/target', {
|
||||
data: {
|
||||
flagKey: FLAGS.NEW_CHECKOUT_FLOW,
|
||||
userId: testUserId,
|
||||
variation: false, // DISABLED
|
||||
},
|
||||
});
|
||||
|
||||
// Act: Navigate as targeted user
|
||||
await page.goto('/checkout', {
|
||||
extraHTTPHeaders: {
|
||||
'X-Test-User-ID': testUserId,
|
||||
},
|
||||
});
|
||||
|
||||
// Assert: Legacy flow UI elements visible
|
||||
await expect(page.getByTestId('checkout-v1-container')).toBeVisible();
|
||||
await expect(page.getByTestId('legacy-payment-form')).toBeVisible();
|
||||
|
||||
// Assert: New flow NOT visible
|
||||
await expect(page.getByTestId('checkout-v2-container')).not.toBeVisible();
|
||||
await expect(page.getByTestId('express-payment-options')).not.toBeVisible();
|
||||
|
||||
// Assert: Telemetry event fired with correct variant
|
||||
const analyticsEvents = await page.evaluate(() => (window as any).__ANALYTICS_EVENTS__ || []);
|
||||
expect(analyticsEvents).toContainEqual(
|
||||
expect.objectContaining({
|
||||
event: 'checkout_started',
|
||||
properties: expect.objectContaining({
|
||||
variant: 'legacy_flow',
|
||||
}),
|
||||
}),
|
||||
);
|
||||
});
|
||||
|
||||
test('should handle flag evaluation errors gracefully', async ({ page, request }) => {
|
||||
// Arrange: Simulate flag service unavailable
|
||||
await page.route('**/api/feature-flags/evaluate', (route) => route.fulfill({ status: 500, body: 'Service Unavailable' }));
|
||||
|
||||
// Act: Navigate (should fallback to default state)
|
||||
await page.goto('/checkout', {
|
||||
extraHTTPHeaders: {
|
||||
'X-Test-User-ID': testUserId,
|
||||
},
|
||||
});
|
||||
|
||||
// Assert: Fallback to safe default (legacy flow)
|
||||
await expect(page.getByTestId('checkout-v1-container')).toBeVisible();
|
||||
|
||||
// Assert: Error logged but no user-facing error
|
||||
const consoleErrors = [];
|
||||
page.on('console', (msg) => {
|
||||
if (msg.type() === 'error') consoleErrors.push(msg.text());
|
||||
});
|
||||
expect(consoleErrors).toContain(expect.stringContaining('Feature flag evaluation failed'));
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Cypress equivalent**:
|
||||
|
||||
```javascript
|
||||
// cypress/e2e/checkout-feature-flag.cy.ts
|
||||
import { FLAGS } from '@/utils/feature-flags';
|
||||
|
||||
describe('Checkout Flow - Feature Flag Variations', () => {
|
||||
let testUserId;
|
||||
|
||||
beforeEach(() => {
|
||||
testUserId = `test-user-${Date.now()}`;
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
// Clean up targeting
|
||||
cy.task('removeFeatureFlagTarget', {
|
||||
flagKey: FLAGS.NEW_CHECKOUT_FLOW,
|
||||
userId: testUserId,
|
||||
});
|
||||
});
|
||||
|
||||
it('should use NEW checkout flow when flag is ENABLED', () => {
|
||||
// Arrange: Enable flag via Cypress task
|
||||
cy.task('setFeatureFlagVariation', {
|
||||
flagKey: FLAGS.NEW_CHECKOUT_FLOW,
|
||||
userId: testUserId,
|
||||
variation: true,
|
||||
});
|
||||
|
||||
// Act
|
||||
cy.visit('/checkout', {
|
||||
headers: { 'X-Test-User-ID': testUserId },
|
||||
});
|
||||
|
||||
// Assert
|
||||
cy.get('[data-testid="checkout-v2-container"]').should('be.visible');
|
||||
cy.get('[data-testid="checkout-v1-container"]').should('not.exist');
|
||||
});
|
||||
|
||||
it('should use LEGACY checkout flow when flag is DISABLED', () => {
|
||||
// Arrange: Disable flag
|
||||
cy.task('setFeatureFlagVariation', {
|
||||
flagKey: FLAGS.NEW_CHECKOUT_FLOW,
|
||||
userId: testUserId,
|
||||
variation: false,
|
||||
});
|
||||
|
||||
// Act
|
||||
cy.visit('/checkout', {
|
||||
headers: { 'X-Test-User-ID': testUserId },
|
||||
});
|
||||
|
||||
// Assert
|
||||
cy.get('[data-testid="checkout-v1-container"]').should('be.visible');
|
||||
cy.get('[data-testid="checkout-v2-container"]').should('not.exist');
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Test both states**: Enabled AND disabled variations
|
||||
- **Automatic cleanup**: afterEach removes targeting (prevent pollution)
|
||||
- **Unique test users**: Avoid conflicts with real user data
|
||||
- **Telemetry validation**: Verify analytics events fire correctly
|
||||
- **Graceful degradation**: Test fallback behavior on errors
|
||||
|
||||
---
|
||||
|
||||
### Example 3: Feature Flag Targeting Helper Pattern
|
||||
|
||||
**Context**: Reusable helpers for programmatic flag control via LaunchDarkly/Split.io API.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/support/feature-flag-helpers.ts
|
||||
import { request as playwrightRequest } from '@playwright/test';
|
||||
import { FLAGS, FlagKey } from '@/utils/feature-flags';
|
||||
|
||||
/**
|
||||
* LaunchDarkly API client configuration
|
||||
* Use test project SDK key (NOT production)
|
||||
*/
|
||||
const LD_SDK_KEY = process.env.LD_SDK_KEY_TEST;
|
||||
const LD_API_BASE = 'https://app.launchdarkly.com/api/v2';
|
||||
|
||||
type FlagVariation = boolean | string | number | object;
|
||||
|
||||
/**
|
||||
* Set flag variation for specific user
|
||||
* Uses LaunchDarkly API to create user target
|
||||
*/
|
||||
export async function setFlagForUser(flagKey: FlagKey, userId: string, variation: FlagVariation): Promise<void> {
|
||||
const response = await playwrightRequest.newContext().then((ctx) =>
|
||||
ctx.post(`${LD_API_BASE}/flags/${flagKey}/targeting`, {
|
||||
headers: {
|
||||
Authorization: LD_SDK_KEY!,
|
||||
'Content-Type': 'application/json',
|
||||
},
|
||||
data: {
|
||||
targets: [
|
||||
{
|
||||
values: [userId],
|
||||
variation: variation ? 1 : 0, // 0 = off, 1 = on
|
||||
},
|
||||
],
|
||||
},
|
||||
}),
|
||||
);
|
||||
|
||||
if (!response.ok()) {
|
||||
throw new Error(`Failed to set flag ${flagKey} for user ${userId}: ${response.status()}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove user from flag targeting
|
||||
* CRITICAL for test cleanup
|
||||
*/
|
||||
export async function removeFlagTarget(flagKey: FlagKey, userId: string): Promise<void> {
|
||||
const response = await playwrightRequest.newContext().then((ctx) =>
|
||||
ctx.delete(`${LD_API_BASE}/flags/${flagKey}/targeting/users/${userId}`, {
|
||||
headers: {
|
||||
Authorization: LD_SDK_KEY!,
|
||||
},
|
||||
}),
|
||||
);
|
||||
|
||||
if (!response.ok() && response.status() !== 404) {
|
||||
// 404 is acceptable (user wasn't targeted)
|
||||
throw new Error(`Failed to remove flag ${flagKey} target for user ${userId}: ${response.status()}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Percentage rollout helper
|
||||
* Enable flag for N% of users
|
||||
*/
|
||||
export async function setFlagRolloutPercentage(flagKey: FlagKey, percentage: number): Promise<void> {
|
||||
if (percentage < 0 || percentage > 100) {
|
||||
throw new Error('Percentage must be between 0 and 100');
|
||||
}
|
||||
|
||||
const response = await playwrightRequest.newContext().then((ctx) =>
|
||||
ctx.patch(`${LD_API_BASE}/flags/${flagKey}`, {
|
||||
headers: {
|
||||
Authorization: LD_SDK_KEY!,
|
||||
'Content-Type': 'application/json',
|
||||
},
|
||||
data: {
|
||||
rollout: {
|
||||
variations: [
|
||||
{ variation: 0, weight: 100 - percentage }, // off
|
||||
{ variation: 1, weight: percentage }, // on
|
||||
],
|
||||
},
|
||||
},
|
||||
}),
|
||||
);
|
||||
|
||||
if (!response.ok()) {
|
||||
throw new Error(`Failed to set rollout for flag ${flagKey}: ${response.status()}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Enable flag globally (100% rollout)
|
||||
*/
|
||||
export async function enableFlagGlobally(flagKey: FlagKey): Promise<void> {
|
||||
await setFlagRolloutPercentage(flagKey, 100);
|
||||
}
|
||||
|
||||
/**
|
||||
* Disable flag globally (0% rollout)
|
||||
*/
|
||||
export async function disableFlagGlobally(flagKey: FlagKey): Promise<void> {
|
||||
await setFlagRolloutPercentage(flagKey, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Stub feature flags in local/test environments
|
||||
* Bypasses LaunchDarkly entirely
|
||||
*/
|
||||
export function stubFeatureFlags(flags: Record<FlagKey, FlagVariation>): void {
|
||||
// Set flags in localStorage or inject into window
|
||||
if (typeof window !== 'undefined') {
|
||||
(window as any).__STUBBED_FLAGS__ = flags;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Usage in Playwright fixture**:
|
||||
|
||||
```typescript
|
||||
// playwright/fixtures/feature-flag-fixture.ts
|
||||
import { test as base } from '@playwright/test';
|
||||
import { setFlagForUser, removeFlagTarget } from '../support/feature-flag-helpers';
|
||||
import { FlagKey } from '@/utils/feature-flags';
|
||||
|
||||
type FeatureFlagFixture = {
|
||||
featureFlags: {
|
||||
enable: (flag: FlagKey, userId: string) => Promise<void>;
|
||||
disable: (flag: FlagKey, userId: string) => Promise<void>;
|
||||
cleanup: (flag: FlagKey, userId: string) => Promise<void>;
|
||||
};
|
||||
};
|
||||
|
||||
export const test = base.extend<FeatureFlagFixture>({
|
||||
featureFlags: async ({}, use) => {
|
||||
const cleanupQueue: Array<{ flag: FlagKey; userId: string }> = [];
|
||||
|
||||
await use({
|
||||
enable: async (flag, userId) => {
|
||||
await setFlagForUser(flag, userId, true);
|
||||
cleanupQueue.push({ flag, userId });
|
||||
},
|
||||
disable: async (flag, userId) => {
|
||||
await setFlagForUser(flag, userId, false);
|
||||
cleanupQueue.push({ flag, userId });
|
||||
},
|
||||
cleanup: async (flag, userId) => {
|
||||
await removeFlagTarget(flag, userId);
|
||||
},
|
||||
});
|
||||
|
||||
// Auto-cleanup after test
|
||||
for (const { flag, userId } of cleanupQueue) {
|
||||
await removeFlagTarget(flag, userId);
|
||||
}
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **API-driven control**: No manual UI clicks required
|
||||
- **Auto-cleanup**: Fixture tracks and removes targeting
|
||||
- **Percentage rollouts**: Test gradual feature releases
|
||||
- **Stubbing option**: Local development without LaunchDarkly
|
||||
- **Type-safe**: FlagKey prevents typos
|
||||
|
||||
---
|
||||
|
||||
### Example 4: Feature Flag Lifecycle Checklist & Cleanup Strategy
|
||||
|
||||
**Context**: Governance checklist and automated cleanup detection for stale flags.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// scripts/feature-flag-audit.ts
|
||||
/**
|
||||
* Feature Flag Lifecycle Audit Script
|
||||
* Run weekly to detect stale flags requiring cleanup
|
||||
*/
|
||||
|
||||
import { FLAG_REGISTRY, FLAGS, getExpiredFlags, FlagKey } from '../src/utils/feature-flags';
|
||||
import * as fs from 'fs';
|
||||
import * as path from 'path';
|
||||
|
||||
type AuditResult = {
|
||||
totalFlags: number;
|
||||
expiredFlags: FlagKey[];
|
||||
missingOwners: FlagKey[];
|
||||
missingDates: FlagKey[];
|
||||
permanentFlags: FlagKey[];
|
||||
flagsNearingExpiry: FlagKey[];
|
||||
};
|
||||
|
||||
/**
|
||||
* Audit all feature flags for governance compliance
|
||||
*/
|
||||
function auditFeatureFlags(): AuditResult {
|
||||
const allFlags = Object.keys(FLAG_REGISTRY) as FlagKey[];
|
||||
const expiredFlags = getExpiredFlags().map((meta) => meta.key);
|
||||
|
||||
// Flags expiring in next 30 days
|
||||
const thirtyDaysFromNow = Date.now() + 30 * 24 * 60 * 60 * 1000;
|
||||
const flagsNearingExpiry = allFlags.filter((flag) => {
|
||||
const meta = FLAG_REGISTRY[flag];
|
||||
if (!meta.expiryDate) return false;
|
||||
const expiry = new Date(meta.expiryDate).getTime();
|
||||
return expiry > Date.now() && expiry < thirtyDaysFromNow;
|
||||
});
|
||||
|
||||
// Missing metadata
|
||||
const missingOwners = allFlags.filter((flag) => !FLAG_REGISTRY[flag].owner);
|
||||
const missingDates = allFlags.filter((flag) => !FLAG_REGISTRY[flag].createdDate);
|
||||
|
||||
// Permanent flags (no expiry, requiresCleanup = false)
|
||||
const permanentFlags = allFlags.filter((flag) => {
|
||||
const meta = FLAG_REGISTRY[flag];
|
||||
return !meta.expiryDate && !meta.requiresCleanup;
|
||||
});
|
||||
|
||||
return {
|
||||
totalFlags: allFlags.length,
|
||||
expiredFlags,
|
||||
missingOwners,
|
||||
missingDates,
|
||||
permanentFlags,
|
||||
flagsNearingExpiry,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate markdown report
|
||||
*/
|
||||
function generateReport(audit: AuditResult): string {
|
||||
let report = `# Feature Flag Audit Report\n\n`;
|
||||
report += `**Date**: ${new Date().toISOString()}\n`;
|
||||
report += `**Total Flags**: ${audit.totalFlags}\n\n`;
|
||||
|
||||
if (audit.expiredFlags.length > 0) {
|
||||
report += `## ⚠️ EXPIRED FLAGS - IMMEDIATE CLEANUP REQUIRED\n\n`;
|
||||
audit.expiredFlags.forEach((flag) => {
|
||||
const meta = FLAG_REGISTRY[flag];
|
||||
report += `- **${meta.name}** (\`${flag}\`)\n`;
|
||||
report += ` - Owner: ${meta.owner}\n`;
|
||||
report += ` - Expired: ${meta.expiryDate}\n`;
|
||||
report += ` - Action: Remove flag code, update tests, deploy\n\n`;
|
||||
});
|
||||
}
|
||||
|
||||
if (audit.flagsNearingExpiry.length > 0) {
|
||||
report += `## ⏰ FLAGS EXPIRING SOON (Next 30 Days)\n\n`;
|
||||
audit.flagsNearingExpiry.forEach((flag) => {
|
||||
const meta = FLAG_REGISTRY[flag];
|
||||
report += `- **${meta.name}** (\`${flag}\`)\n`;
|
||||
report += ` - Owner: ${meta.owner}\n`;
|
||||
report += ` - Expires: ${meta.expiryDate}\n`;
|
||||
report += ` - Action: Plan cleanup or extend expiry\n\n`;
|
||||
});
|
||||
}
|
||||
|
||||
if (audit.permanentFlags.length > 0) {
|
||||
report += `## 🔄 PERMANENT FLAGS (No Expiry)\n\n`;
|
||||
audit.permanentFlags.forEach((flag) => {
|
||||
const meta = FLAG_REGISTRY[flag];
|
||||
report += `- **${meta.name}** (\`${flag}\`) - Owner: ${meta.owner}\n`;
|
||||
});
|
||||
report += `\n`;
|
||||
}
|
||||
|
||||
if (audit.missingOwners.length > 0 || audit.missingDates.length > 0) {
|
||||
report += `## ❌ GOVERNANCE ISSUES\n\n`;
|
||||
if (audit.missingOwners.length > 0) {
|
||||
report += `**Missing Owners**: ${audit.missingOwners.join(', ')}\n`;
|
||||
}
|
||||
if (audit.missingDates.length > 0) {
|
||||
report += `**Missing Created Dates**: ${audit.missingDates.join(', ')}\n`;
|
||||
}
|
||||
report += `\n`;
|
||||
}
|
||||
|
||||
return report;
|
||||
}
|
||||
|
||||
/**
|
||||
* Feature Flag Lifecycle Checklist
|
||||
*/
|
||||
const FLAG_LIFECYCLE_CHECKLIST = `
|
||||
# Feature Flag Lifecycle Checklist
|
||||
|
||||
## Before Creating a New Flag
|
||||
|
||||
- [ ] **Name**: Follow naming convention (kebab-case, descriptive)
|
||||
- [ ] **Owner**: Assign team/individual responsible
|
||||
- [ ] **Default State**: Determine safe default (usually false)
|
||||
- [ ] **Expiry Date**: Set removal date (30-90 days typical)
|
||||
- [ ] **Dependencies**: Document related flags
|
||||
- [ ] **Telemetry**: Plan analytics events to track
|
||||
- [ ] **Rollback Plan**: Define how to disable quickly
|
||||
|
||||
## During Development
|
||||
|
||||
- [ ] **Code Paths**: Both enabled/disabled states implemented
|
||||
- [ ] **Tests**: Both variations tested in CI
|
||||
- [ ] **Documentation**: Flag purpose documented in code/PR
|
||||
- [ ] **Telemetry**: Analytics events instrumented
|
||||
- [ ] **Error Handling**: Graceful degradation on flag service failure
|
||||
|
||||
## Before Launch
|
||||
|
||||
- [ ] **QA**: Both states tested in staging
|
||||
- [ ] **Rollout Plan**: Gradual rollout percentage defined
|
||||
- [ ] **Monitoring**: Dashboards/alerts for flag-related metrics
|
||||
- [ ] **Stakeholder Communication**: Product/design aligned
|
||||
|
||||
## After Launch (Monitoring)
|
||||
|
||||
- [ ] **Metrics**: Success criteria tracked
|
||||
- [ ] **Error Rates**: No increase in errors
|
||||
- [ ] **Performance**: No degradation
|
||||
- [ ] **User Feedback**: Qualitative data collected
|
||||
|
||||
## Cleanup (Post-Launch)
|
||||
|
||||
- [ ] **Remove Flag Code**: Delete if/else branches
|
||||
- [ ] **Update Tests**: Remove flag-specific tests
|
||||
- [ ] **Remove Targeting**: Clear all user targets
|
||||
- [ ] **Delete Flag Config**: Remove from LaunchDarkly/registry
|
||||
- [ ] **Update Documentation**: Remove references
|
||||
- [ ] **Deploy**: Ship cleanup changes
|
||||
`;
|
||||
|
||||
// Run audit
|
||||
const audit = auditFeatureFlags();
|
||||
const report = generateReport(audit);
|
||||
|
||||
// Save report
|
||||
const outputPath = path.join(__dirname, '../feature-flag-audit-report.md');
|
||||
fs.writeFileSync(outputPath, report);
|
||||
fs.writeFileSync(path.join(__dirname, '../FEATURE-FLAG-CHECKLIST.md'), FLAG_LIFECYCLE_CHECKLIST);
|
||||
|
||||
console.log(`✅ Audit complete. Report saved to: ${outputPath}`);
|
||||
console.log(`Total flags: ${audit.totalFlags}`);
|
||||
console.log(`Expired flags: ${audit.expiredFlags.length}`);
|
||||
console.log(`Flags expiring soon: ${audit.flagsNearingExpiry.length}`);
|
||||
|
||||
// Exit with error if expired flags exist
|
||||
if (audit.expiredFlags.length > 0) {
|
||||
console.error(`\n❌ EXPIRED FLAGS DETECTED - CLEANUP REQUIRED`);
|
||||
process.exit(1);
|
||||
}
|
||||
```
|
||||
|
||||
**package.json scripts**:
|
||||
|
||||
```json
|
||||
{
|
||||
"scripts": {
|
||||
"feature-flags:audit": "ts-node scripts/feature-flag-audit.ts",
|
||||
"feature-flags:audit:ci": "npm run feature-flags:audit || true"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Automated detection**: Weekly audit catches stale flags
|
||||
- **Lifecycle checklist**: Comprehensive governance guide
|
||||
- **Expiry tracking**: Flags auto-expire after defined date
|
||||
- **CI integration**: Audit runs in pipeline, warns on expiry
|
||||
- **Ownership clarity**: Every flag has assigned owner
|
||||
|
||||
---
|
||||
|
||||
## Feature Flag Testing Checklist
|
||||
|
||||
Before merging flag-related code, verify:
|
||||
|
||||
- [ ] **Both states tested**: Enabled AND disabled variations covered
|
||||
- [ ] **Cleanup automated**: afterEach removes targeting (no manual cleanup)
|
||||
- [ ] **Unique test data**: Test users don't collide with production
|
||||
- [ ] **Telemetry validated**: Analytics events fire for both variations
|
||||
- [ ] **Error handling**: Graceful fallback when flag service unavailable
|
||||
- [ ] **Flag metadata**: Owner, dates, dependencies documented in registry
|
||||
- [ ] **Rollback plan**: Clear steps to disable flag in production
|
||||
- [ ] **Expiry date set**: Removal date defined (or marked permanent)
|
||||
|
||||
## Integration Points
|
||||
|
||||
- Used in workflows: `*automate` (test generation), `*framework` (flag setup)
|
||||
- Related fragments: `test-quality.md`, `selective-testing.md`
|
||||
- Flag services: LaunchDarkly, Split.io, Unleash, custom implementations
|
||||
|
||||
_Source: LaunchDarkly strategy blog, Murat test architecture notes, SEON feature flag governance_
|
||||
@ -1,401 +0,0 @@
|
||||
# Fixture Architecture Playbook
|
||||
|
||||
## Principle
|
||||
|
||||
Build test helpers as pure functions first, then wrap them in framework-specific fixtures. Compose capabilities using `mergeTests` (Playwright) or layered commands (Cypress) instead of inheritance. Each fixture should solve one isolated concern (auth, API, logs, network).
|
||||
|
||||
## Rationale
|
||||
|
||||
Traditional Page Object Models create tight coupling through inheritance chains (`BasePage → LoginPage → AdminPage`). When base classes change, all descendants break. Pure functions with fixture wrappers provide:
|
||||
|
||||
- **Testability**: Pure functions run in unit tests without framework overhead
|
||||
- **Composability**: Mix capabilities freely via `mergeTests`, no inheritance constraints
|
||||
- **Reusability**: Export fixtures via package subpaths for cross-project sharing
|
||||
- **Maintainability**: One concern per fixture = clear responsibility boundaries
|
||||
|
||||
## Pattern Examples
|
||||
|
||||
### Example 1: Pure Function → Fixture Pattern
|
||||
|
||||
**Context**: When building any test helper, always start with a pure function that accepts all dependencies explicitly. Then wrap it in a Playwright fixture or Cypress command.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// playwright/support/helpers/api-request.ts
|
||||
// Step 1: Pure function (ALWAYS FIRST!)
|
||||
type ApiRequestParams = {
|
||||
request: APIRequestContext;
|
||||
method: 'GET' | 'POST' | 'PUT' | 'DELETE';
|
||||
url: string;
|
||||
data?: unknown;
|
||||
headers?: Record<string, string>;
|
||||
};
|
||||
|
||||
export async function apiRequest({
|
||||
request,
|
||||
method,
|
||||
url,
|
||||
data,
|
||||
headers = {}
|
||||
}: ApiRequestParams) {
|
||||
const response = await request.fetch(url, {
|
||||
method,
|
||||
data,
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
...headers
|
||||
}
|
||||
});
|
||||
|
||||
if (!response.ok()) {
|
||||
throw new Error(`API request failed: ${response.status()} ${await response.text()}`);
|
||||
}
|
||||
|
||||
return response.json();
|
||||
}
|
||||
|
||||
// Step 2: Fixture wrapper
|
||||
// playwright/support/fixtures/api-request-fixture.ts
|
||||
import { test as base } from '@playwright/test';
|
||||
import { apiRequest } from '../helpers/api-request';
|
||||
|
||||
export const test = base.extend<{ apiRequest: typeof apiRequest }>({
|
||||
apiRequest: async ({ request }, use) => {
|
||||
// Inject framework dependency, expose pure function
|
||||
await use((params) => apiRequest({ request, ...params }));
|
||||
}
|
||||
});
|
||||
|
||||
// Step 3: Package exports for reusability
|
||||
// package.json
|
||||
{
|
||||
"exports": {
|
||||
"./api-request": "./playwright/support/helpers/api-request.ts",
|
||||
"./api-request/fixtures": "./playwright/support/fixtures/api-request-fixture.ts"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Pure function is unit-testable without Playwright running
|
||||
- Framework dependency (`request`) injected at fixture boundary
|
||||
- Fixture exposes the pure function to test context
|
||||
- Package subpath exports enable `import { apiRequest } from 'my-fixtures/api-request'`
|
||||
|
||||
### Example 2: Composable Fixture System with mergeTests
|
||||
|
||||
**Context**: When building comprehensive test capabilities, compose multiple focused fixtures instead of creating monolithic helper classes. Each fixture provides one capability.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// playwright/support/fixtures/merged-fixtures.ts
|
||||
import { test as base, mergeTests } from '@playwright/test';
|
||||
import { test as apiRequestFixture } from './api-request-fixture';
|
||||
import { test as networkFixture } from './network-fixture';
|
||||
import { test as authFixture } from './auth-fixture';
|
||||
import { test as logFixture } from './log-fixture';
|
||||
|
||||
// Compose all fixtures for comprehensive capabilities
|
||||
export const test = mergeTests(base, apiRequestFixture, networkFixture, authFixture, logFixture);
|
||||
|
||||
export { expect } from '@playwright/test';
|
||||
|
||||
// Example usage in tests:
|
||||
// import { test, expect } from './support/fixtures/merged-fixtures';
|
||||
//
|
||||
// test('user can create order', async ({ page, apiRequest, auth, network }) => {
|
||||
// await auth.loginAs('customer@example.com');
|
||||
// await network.interceptRoute('POST', '**/api/orders', { id: 123 });
|
||||
// await page.goto('/checkout');
|
||||
// await page.click('[data-testid="submit-order"]');
|
||||
// await expect(page.getByText('Order #123')).toBeVisible();
|
||||
// });
|
||||
```
|
||||
|
||||
**Individual Fixture Examples**:
|
||||
|
||||
```typescript
|
||||
// network-fixture.ts
|
||||
export const test = base.extend({
|
||||
network: async ({ page }, use) => {
|
||||
const interceptedRoutes = new Map();
|
||||
|
||||
const interceptRoute = async (method: string, url: string, response: unknown) => {
|
||||
await page.route(url, (route) => {
|
||||
if (route.request().method() === method) {
|
||||
route.fulfill({ body: JSON.stringify(response) });
|
||||
}
|
||||
});
|
||||
interceptedRoutes.set(`${method}:${url}`, response);
|
||||
};
|
||||
|
||||
await use({ interceptRoute });
|
||||
|
||||
// Cleanup
|
||||
interceptedRoutes.clear();
|
||||
},
|
||||
});
|
||||
|
||||
// auth-fixture.ts
|
||||
export const test = base.extend({
|
||||
auth: async ({ page, context }, use) => {
|
||||
const loginAs = async (email: string) => {
|
||||
// Use API to setup auth (fast!)
|
||||
const token = await getAuthToken(email);
|
||||
await context.addCookies([
|
||||
{
|
||||
name: 'auth_token',
|
||||
value: token,
|
||||
domain: 'localhost',
|
||||
path: '/',
|
||||
},
|
||||
]);
|
||||
};
|
||||
|
||||
await use({ loginAs });
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- `mergeTests` combines fixtures without inheritance
|
||||
- Each fixture has single responsibility (network, auth, logs)
|
||||
- Tests import merged fixture and access all capabilities
|
||||
- No coupling between fixtures—add/remove freely
|
||||
|
||||
### Example 3: Framework-Agnostic HTTP Helper
|
||||
|
||||
**Context**: When building HTTP helpers, keep them framework-agnostic. Accept all params explicitly so they work in unit tests, Playwright, Cypress, or any context.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// shared/helpers/http-helper.ts
|
||||
// Pure, framework-agnostic function
|
||||
type HttpHelperParams = {
|
||||
baseUrl: string;
|
||||
endpoint: string;
|
||||
method: 'GET' | 'POST' | 'PUT' | 'DELETE';
|
||||
body?: unknown;
|
||||
headers?: Record<string, string>;
|
||||
token?: string;
|
||||
};
|
||||
|
||||
export async function makeHttpRequest({ baseUrl, endpoint, method, body, headers = {}, token }: HttpHelperParams): Promise<unknown> {
|
||||
const url = `${baseUrl}${endpoint}`;
|
||||
const requestHeaders = {
|
||||
'Content-Type': 'application/json',
|
||||
...(token && { Authorization: `Bearer ${token}` }),
|
||||
...headers,
|
||||
};
|
||||
|
||||
const response = await fetch(url, {
|
||||
method,
|
||||
headers: requestHeaders,
|
||||
body: body ? JSON.stringify(body) : undefined,
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
const errorText = await response.text();
|
||||
throw new Error(`HTTP ${method} ${url} failed: ${response.status} ${errorText}`);
|
||||
}
|
||||
|
||||
return response.json();
|
||||
}
|
||||
|
||||
// Playwright fixture wrapper
|
||||
// playwright/support/fixtures/http-fixture.ts
|
||||
import { test as base } from '@playwright/test';
|
||||
import { makeHttpRequest } from '../../shared/helpers/http-helper';
|
||||
|
||||
export const test = base.extend({
|
||||
httpHelper: async ({}, use) => {
|
||||
const baseUrl = process.env.API_BASE_URL || 'http://localhost:3000';
|
||||
|
||||
await use((params) => makeHttpRequest({ baseUrl, ...params }));
|
||||
},
|
||||
});
|
||||
|
||||
// Cypress command wrapper
|
||||
// cypress/support/commands.ts
|
||||
import { makeHttpRequest } from '../../shared/helpers/http-helper';
|
||||
|
||||
Cypress.Commands.add('apiRequest', (params) => {
|
||||
const baseUrl = Cypress.env('API_BASE_URL') || 'http://localhost:3000';
|
||||
return cy.wrap(makeHttpRequest({ baseUrl, ...params }));
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Pure function uses only standard `fetch`, no framework dependencies
|
||||
- Unit tests call `makeHttpRequest` directly with all params
|
||||
- Playwright and Cypress wrappers inject framework-specific config
|
||||
- Same logic runs everywhere—zero duplication
|
||||
|
||||
### Example 4: Fixture Cleanup Pattern
|
||||
|
||||
**Context**: When fixtures create resources (data, files, connections), ensure automatic cleanup in fixture teardown. Tests must not leak state.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// playwright/support/fixtures/database-fixture.ts
|
||||
import { test as base } from '@playwright/test';
|
||||
import { seedDatabase, deleteRecord } from '../helpers/db-helpers';
|
||||
|
||||
type DatabaseFixture = {
|
||||
seedUser: (userData: Partial<User>) => Promise<User>;
|
||||
seedOrder: (orderData: Partial<Order>) => Promise<Order>;
|
||||
};
|
||||
|
||||
export const test = base.extend<DatabaseFixture>({
|
||||
seedUser: async ({}, use) => {
|
||||
const createdUsers: string[] = [];
|
||||
|
||||
const seedUser = async (userData: Partial<User>) => {
|
||||
const user = await seedDatabase('users', userData);
|
||||
createdUsers.push(user.id);
|
||||
return user;
|
||||
};
|
||||
|
||||
await use(seedUser);
|
||||
|
||||
// Auto-cleanup: Delete all users created during test
|
||||
for (const userId of createdUsers) {
|
||||
await deleteRecord('users', userId);
|
||||
}
|
||||
createdUsers.length = 0;
|
||||
},
|
||||
|
||||
seedOrder: async ({}, use) => {
|
||||
const createdOrders: string[] = [];
|
||||
|
||||
const seedOrder = async (orderData: Partial<Order>) => {
|
||||
const order = await seedDatabase('orders', orderData);
|
||||
createdOrders.push(order.id);
|
||||
return order;
|
||||
};
|
||||
|
||||
await use(seedOrder);
|
||||
|
||||
// Auto-cleanup: Delete all orders
|
||||
for (const orderId of createdOrders) {
|
||||
await deleteRecord('orders', orderId);
|
||||
}
|
||||
createdOrders.length = 0;
|
||||
},
|
||||
});
|
||||
|
||||
// Example usage:
|
||||
// test('user can place order', async ({ seedUser, seedOrder, page }) => {
|
||||
// const user = await seedUser({ email: 'test@example.com' });
|
||||
// const order = await seedOrder({ userId: user.id, total: 100 });
|
||||
//
|
||||
// await page.goto(`/orders/${order.id}`);
|
||||
// await expect(page.getByText('Order Total: $100')).toBeVisible();
|
||||
//
|
||||
// // No manual cleanup needed—fixture handles it automatically
|
||||
// });
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Track all created resources in array during test execution
|
||||
- Teardown (after `use()`) deletes all tracked resources
|
||||
- Tests don't manually clean up—happens automatically
|
||||
- Prevents test pollution and flakiness from shared state
|
||||
|
||||
### Anti-Pattern: Inheritance-Based Page Objects
|
||||
|
||||
**Problem**:
|
||||
|
||||
```typescript
|
||||
// ❌ BAD: Page Object Model with inheritance
|
||||
class BasePage {
|
||||
constructor(public page: Page) {}
|
||||
|
||||
async navigate(url: string) {
|
||||
await this.page.goto(url);
|
||||
}
|
||||
|
||||
async clickButton(selector: string) {
|
||||
await this.page.click(selector);
|
||||
}
|
||||
}
|
||||
|
||||
class LoginPage extends BasePage {
|
||||
async login(email: string, password: string) {
|
||||
await this.navigate('/login');
|
||||
await this.page.fill('#email', email);
|
||||
await this.page.fill('#password', password);
|
||||
await this.clickButton('#submit');
|
||||
}
|
||||
}
|
||||
|
||||
class AdminPage extends LoginPage {
|
||||
async accessAdminPanel() {
|
||||
await this.login('admin@example.com', 'admin123');
|
||||
await this.navigate('/admin');
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Why It Fails**:
|
||||
|
||||
- Changes to `BasePage` break all descendants (`LoginPage`, `AdminPage`)
|
||||
- `AdminPage` inherits unnecessary `login` details—tight coupling
|
||||
- Cannot compose capabilities (e.g., admin + reporting features require multiple inheritance)
|
||||
- Hard to test `BasePage` methods in isolation
|
||||
- Hidden state in class instances leads to unpredictable behavior
|
||||
|
||||
**Better Approach**: Use pure functions + fixtures
|
||||
|
||||
```typescript
|
||||
// ✅ GOOD: Pure functions with fixture composition
|
||||
// helpers/navigation.ts
|
||||
export async function navigate(page: Page, url: string) {
|
||||
await page.goto(url);
|
||||
}
|
||||
|
||||
// helpers/auth.ts
|
||||
export async function login(page: Page, email: string, password: string) {
|
||||
await page.fill('[data-testid="email"]', email);
|
||||
await page.fill('[data-testid="password"]', password);
|
||||
await page.click('[data-testid="submit"]');
|
||||
}
|
||||
|
||||
// fixtures/admin-fixture.ts
|
||||
export const test = base.extend({
|
||||
adminPage: async ({ page }, use) => {
|
||||
await login(page, 'admin@example.com', 'admin123');
|
||||
await navigate(page, '/admin');
|
||||
await use(page);
|
||||
},
|
||||
});
|
||||
|
||||
// Tests import exactly what they need—no inheritance
|
||||
```
|
||||
|
||||
## Integration Points
|
||||
|
||||
- **Used in workflows**: `*atdd` (test generation), `*automate` (test expansion), `*framework` (initial setup)
|
||||
- **Related fragments**:
|
||||
- `data-factories.md` - Factory functions for test data
|
||||
- `network-first.md` - Network interception patterns
|
||||
- `test-quality.md` - Deterministic test design principles
|
||||
|
||||
## Helper Function Reuse Guidelines
|
||||
|
||||
When deciding whether to create a fixture, follow these rules:
|
||||
|
||||
- **3+ uses** → Create fixture with subpath export (shared across tests/projects)
|
||||
- **2-3 uses** → Create utility module (shared within project)
|
||||
- **1 use** → Keep inline (avoid premature abstraction)
|
||||
- **Complex logic** → Factory function pattern (dynamic data generation)
|
||||
|
||||
_Source: Murat Testing Philosophy (lines 74-122), SEON production patterns, Playwright fixture docs._
|
||||
@ -1,486 +0,0 @@
|
||||
# Network-First Safeguards
|
||||
|
||||
## Principle
|
||||
|
||||
Register network interceptions **before** any navigation or user action. Store the interception promise and await it immediately after the triggering step. Replace implicit waits with deterministic signals based on network responses, spinner disappearance, or event hooks.
|
||||
|
||||
## Rationale
|
||||
|
||||
The most common source of flaky E2E tests is **race conditions** between navigation and network interception:
|
||||
|
||||
- Navigate then intercept = missed requests (too late)
|
||||
- No explicit wait = assertion runs before response arrives
|
||||
- Hard waits (`waitForTimeout(3000)`) = slow, unreliable, brittle
|
||||
|
||||
Network-first patterns provide:
|
||||
|
||||
- **Zero race conditions**: Intercept is active before triggering action
|
||||
- **Deterministic waits**: Wait for actual response, not arbitrary timeouts
|
||||
- **Actionable failures**: Assert on response status/body, not generic "element not found"
|
||||
- **Speed**: No padding with extra wait time
|
||||
|
||||
## Pattern Examples
|
||||
|
||||
### Example 1: Intercept Before Navigate Pattern
|
||||
|
||||
**Context**: The foundational pattern for all E2E tests. Always register route interception **before** the action that triggers the request (navigation, click, form submit).
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// ✅ CORRECT: Intercept BEFORE navigate
|
||||
test('user can view dashboard data', async ({ page }) => {
|
||||
// Step 1: Register interception FIRST
|
||||
const usersPromise = page.waitForResponse((resp) => resp.url().includes('/api/users') && resp.status() === 200);
|
||||
|
||||
// Step 2: THEN trigger the request
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// Step 3: THEN await the response
|
||||
const usersResponse = await usersPromise;
|
||||
const users = await usersResponse.json();
|
||||
|
||||
// Step 4: Assert on structured data
|
||||
expect(users).toHaveLength(10);
|
||||
await expect(page.getByText(users[0].name)).toBeVisible();
|
||||
});
|
||||
|
||||
// Cypress equivalent
|
||||
describe('Dashboard', () => {
|
||||
it('should display users', () => {
|
||||
// Step 1: Register interception FIRST
|
||||
cy.intercept('GET', '**/api/users').as('getUsers');
|
||||
|
||||
// Step 2: THEN trigger
|
||||
cy.visit('/dashboard');
|
||||
|
||||
// Step 3: THEN await
|
||||
cy.wait('@getUsers').then((interception) => {
|
||||
// Step 4: Assert on structured data
|
||||
expect(interception.response.statusCode).to.equal(200);
|
||||
expect(interception.response.body).to.have.length(10);
|
||||
cy.contains(interception.response.body[0].name).should('be.visible');
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
// ❌ WRONG: Navigate BEFORE intercept (race condition!)
|
||||
test('flaky test example', async ({ page }) => {
|
||||
await page.goto('/dashboard'); // Request fires immediately
|
||||
|
||||
const usersPromise = page.waitForResponse('/api/users'); // TOO LATE - might miss it
|
||||
const response = await usersPromise; // May timeout randomly
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Playwright: Use `page.waitForResponse()` with URL pattern or predicate **before** `page.goto()` or `page.click()`
|
||||
- Cypress: Use `cy.intercept().as()` **before** `cy.visit()` or `cy.click()`
|
||||
- Store promise/alias, trigger action, **then** await response
|
||||
- This prevents 95% of race-condition flakiness in E2E tests
|
||||
|
||||
### Example 2: HAR Capture for Debugging
|
||||
|
||||
**Context**: When debugging flaky tests or building deterministic mocks, capture real network traffic with HAR files. Replay them in tests for consistent, offline-capable test runs.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// playwright.config.ts - Enable HAR recording
|
||||
export default defineConfig({
|
||||
use: {
|
||||
// Record HAR on first run
|
||||
recordHar: { path: './hars/', mode: 'minimal' },
|
||||
// Or replay HAR in tests
|
||||
// serviceWorkers: 'block',
|
||||
},
|
||||
});
|
||||
|
||||
// Capture HAR for specific test
|
||||
test('capture network for order flow', async ({ page, context }) => {
|
||||
// Start recording
|
||||
await context.routeFromHAR('./hars/order-flow.har', {
|
||||
url: '**/api/**',
|
||||
update: true, // Update HAR with new requests
|
||||
});
|
||||
|
||||
await page.goto('/checkout');
|
||||
await page.fill('[data-testid="credit-card"]', '4111111111111111');
|
||||
await page.click('[data-testid="submit-order"]');
|
||||
await expect(page.getByText('Order Confirmed')).toBeVisible();
|
||||
|
||||
// HAR saved to ./hars/order-flow.har
|
||||
});
|
||||
|
||||
// Replay HAR for deterministic tests (no real API needed)
|
||||
test('replay order flow from HAR', async ({ page, context }) => {
|
||||
// Replay captured HAR
|
||||
await context.routeFromHAR('./hars/order-flow.har', {
|
||||
url: '**/api/**',
|
||||
update: false, // Read-only mode
|
||||
});
|
||||
|
||||
// Test runs with exact recorded responses - fully deterministic
|
||||
await page.goto('/checkout');
|
||||
await page.fill('[data-testid="credit-card"]', '4111111111111111');
|
||||
await page.click('[data-testid="submit-order"]');
|
||||
await expect(page.getByText('Order Confirmed')).toBeVisible();
|
||||
});
|
||||
|
||||
// Custom mock based on HAR insights
|
||||
test('mock order response based on HAR', async ({ page }) => {
|
||||
// After analyzing HAR, create focused mock
|
||||
await page.route('**/api/orders', (route) =>
|
||||
route.fulfill({
|
||||
status: 200,
|
||||
contentType: 'application/json',
|
||||
body: JSON.stringify({
|
||||
orderId: '12345',
|
||||
status: 'confirmed',
|
||||
total: 99.99,
|
||||
}),
|
||||
}),
|
||||
);
|
||||
|
||||
await page.goto('/checkout');
|
||||
await page.click('[data-testid="submit-order"]');
|
||||
await expect(page.getByText('Order #12345')).toBeVisible();
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- HAR files capture real request/response pairs for analysis
|
||||
- `update: true` records new traffic; `update: false` replays existing
|
||||
- Replay mode makes tests fully deterministic (no upstream API needed)
|
||||
- Use HAR to understand API contracts, then create focused mocks
|
||||
|
||||
### Example 3: Network Stub with Edge Cases
|
||||
|
||||
**Context**: When testing error handling, timeouts, and edge cases, stub network responses to simulate failures. Test both happy path and error scenarios.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// Test happy path
|
||||
test('order succeeds with valid data', async ({ page }) => {
|
||||
await page.route('**/api/orders', (route) =>
|
||||
route.fulfill({
|
||||
status: 200,
|
||||
contentType: 'application/json',
|
||||
body: JSON.stringify({ orderId: '123', status: 'confirmed' }),
|
||||
}),
|
||||
);
|
||||
|
||||
await page.goto('/checkout');
|
||||
await page.click('[data-testid="submit-order"]');
|
||||
await expect(page.getByText('Order Confirmed')).toBeVisible();
|
||||
});
|
||||
|
||||
// Test 500 error
|
||||
test('order fails with server error', async ({ page }) => {
|
||||
// Listen for console errors (app should log gracefully)
|
||||
const consoleErrors: string[] = [];
|
||||
page.on('console', (msg) => {
|
||||
if (msg.type() === 'error') consoleErrors.push(msg.text());
|
||||
});
|
||||
|
||||
// Stub 500 error
|
||||
await page.route('**/api/orders', (route) =>
|
||||
route.fulfill({
|
||||
status: 500,
|
||||
contentType: 'application/json',
|
||||
body: JSON.stringify({ error: 'Internal Server Error' }),
|
||||
}),
|
||||
);
|
||||
|
||||
await page.goto('/checkout');
|
||||
await page.click('[data-testid="submit-order"]');
|
||||
|
||||
// Assert UI shows error gracefully
|
||||
await expect(page.getByText('Something went wrong')).toBeVisible();
|
||||
await expect(page.getByText('Please try again')).toBeVisible();
|
||||
|
||||
// Verify error logged (not thrown)
|
||||
expect(consoleErrors.some((e) => e.includes('Order failed'))).toBeTruthy();
|
||||
});
|
||||
|
||||
// Test network timeout
|
||||
test('order times out after 10 seconds', async ({ page }) => {
|
||||
// Stub delayed response (never resolves within timeout)
|
||||
await page.route(
|
||||
'**/api/orders',
|
||||
(route) => new Promise(() => {}), // Never resolves - simulates timeout
|
||||
);
|
||||
|
||||
await page.goto('/checkout');
|
||||
await page.click('[data-testid="submit-order"]');
|
||||
|
||||
// App should show timeout message after configured timeout
|
||||
await expect(page.getByText('Request timed out')).toBeVisible({ timeout: 15000 });
|
||||
});
|
||||
|
||||
// Test partial data response
|
||||
test('order handles missing optional fields', async ({ page }) => {
|
||||
await page.route('**/api/orders', (route) =>
|
||||
route.fulfill({
|
||||
status: 200,
|
||||
contentType: 'application/json',
|
||||
// Missing optional fields like 'trackingNumber', 'estimatedDelivery'
|
||||
body: JSON.stringify({ orderId: '123', status: 'confirmed' }),
|
||||
}),
|
||||
);
|
||||
|
||||
await page.goto('/checkout');
|
||||
await page.click('[data-testid="submit-order"]');
|
||||
|
||||
// App should handle gracefully - no crash, shows what's available
|
||||
await expect(page.getByText('Order Confirmed')).toBeVisible();
|
||||
await expect(page.getByText('Tracking information pending')).toBeVisible();
|
||||
});
|
||||
|
||||
// Cypress equivalents
|
||||
describe('Order Edge Cases', () => {
|
||||
it('should handle 500 error', () => {
|
||||
cy.intercept('POST', '**/api/orders', {
|
||||
statusCode: 500,
|
||||
body: { error: 'Internal Server Error' },
|
||||
}).as('orderFailed');
|
||||
|
||||
cy.visit('/checkout');
|
||||
cy.get('[data-testid="submit-order"]').click();
|
||||
cy.wait('@orderFailed');
|
||||
cy.contains('Something went wrong').should('be.visible');
|
||||
});
|
||||
|
||||
it('should handle timeout', () => {
|
||||
cy.intercept('POST', '**/api/orders', (req) => {
|
||||
req.reply({ delay: 20000 }); // Delay beyond app timeout
|
||||
}).as('orderTimeout');
|
||||
|
||||
cy.visit('/checkout');
|
||||
cy.get('[data-testid="submit-order"]').click();
|
||||
cy.contains('Request timed out', { timeout: 15000 }).should('be.visible');
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Stub different HTTP status codes (200, 400, 500, 503)
|
||||
- Simulate timeouts with `delay` or non-resolving promises
|
||||
- Test partial/incomplete data responses
|
||||
- Verify app handles errors gracefully (no crashes, user-friendly messages)
|
||||
|
||||
### Example 4: Deterministic Waiting
|
||||
|
||||
**Context**: Never use hard waits (`waitForTimeout(3000)`). Always wait for explicit signals: network responses, element state changes, or custom events.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// ✅ GOOD: Wait for response with predicate
|
||||
test('wait for specific response', async ({ page }) => {
|
||||
const responsePromise = page.waitForResponse((resp) => resp.url().includes('/api/users') && resp.status() === 200);
|
||||
|
||||
await page.goto('/dashboard');
|
||||
const response = await responsePromise;
|
||||
|
||||
expect(response.status()).toBe(200);
|
||||
await expect(page.getByText('Dashboard')).toBeVisible();
|
||||
});
|
||||
|
||||
// ✅ GOOD: Wait for multiple responses
|
||||
test('wait for all required data', async ({ page }) => {
|
||||
const usersPromise = page.waitForResponse('**/api/users');
|
||||
const productsPromise = page.waitForResponse('**/api/products');
|
||||
const ordersPromise = page.waitForResponse('**/api/orders');
|
||||
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// Wait for all in parallel
|
||||
const [users, products, orders] = await Promise.all([usersPromise, productsPromise, ordersPromise]);
|
||||
|
||||
expect(users.status()).toBe(200);
|
||||
expect(products.status()).toBe(200);
|
||||
expect(orders.status()).toBe(200);
|
||||
});
|
||||
|
||||
// ✅ GOOD: Wait for spinner to disappear
|
||||
test('wait for loading indicator', async ({ page }) => {
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// Wait for spinner to disappear (signals data loaded)
|
||||
await expect(page.getByTestId('loading-spinner')).not.toBeVisible();
|
||||
await expect(page.getByText('Dashboard')).toBeVisible();
|
||||
});
|
||||
|
||||
// ✅ GOOD: Wait for custom event (advanced)
|
||||
test('wait for custom ready event', async ({ page }) => {
|
||||
let appReady = false;
|
||||
page.on('console', (msg) => {
|
||||
if (msg.text() === 'App ready') appReady = true;
|
||||
});
|
||||
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// Poll until custom condition met
|
||||
await page.waitForFunction(() => appReady, { timeout: 10000 });
|
||||
|
||||
await expect(page.getByText('Dashboard')).toBeVisible();
|
||||
});
|
||||
|
||||
// ❌ BAD: Hard wait (arbitrary timeout)
|
||||
test('flaky hard wait example', async ({ page }) => {
|
||||
await page.goto('/dashboard');
|
||||
await page.waitForTimeout(3000); // WHY 3 seconds? What if slower? What if faster?
|
||||
await expect(page.getByText('Dashboard')).toBeVisible(); // May fail if >3s
|
||||
});
|
||||
|
||||
// Cypress equivalents
|
||||
describe('Deterministic Waiting', () => {
|
||||
it('should wait for response', () => {
|
||||
cy.intercept('GET', '**/api/users').as('getUsers');
|
||||
cy.visit('/dashboard');
|
||||
cy.wait('@getUsers').its('response.statusCode').should('eq', 200);
|
||||
cy.contains('Dashboard').should('be.visible');
|
||||
});
|
||||
|
||||
it('should wait for spinner to disappear', () => {
|
||||
cy.visit('/dashboard');
|
||||
cy.get('[data-testid="loading-spinner"]').should('not.exist');
|
||||
cy.contains('Dashboard').should('be.visible');
|
||||
});
|
||||
|
||||
// ❌ BAD: Hard wait
|
||||
it('flaky hard wait', () => {
|
||||
cy.visit('/dashboard');
|
||||
cy.wait(3000); // NEVER DO THIS
|
||||
cy.contains('Dashboard').should('be.visible');
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- `waitForResponse()` with URL pattern or predicate = deterministic
|
||||
- `waitForLoadState('networkidle')` = wait for all network activity to finish
|
||||
- Wait for element state changes (spinner disappears, button enabled)
|
||||
- **NEVER** use `waitForTimeout()` or `cy.wait(ms)` - always non-deterministic
|
||||
|
||||
### Example 5: Anti-Pattern - Navigate Then Mock
|
||||
|
||||
**Problem**:
|
||||
|
||||
```typescript
|
||||
// ❌ BAD: Race condition - mock registered AFTER navigation starts
|
||||
test('flaky test - navigate then mock', async ({ page }) => {
|
||||
// Navigation starts immediately
|
||||
await page.goto('/dashboard'); // Request to /api/users fires NOW
|
||||
|
||||
// Mock registered too late - request already sent
|
||||
await page.route('**/api/users', (route) =>
|
||||
route.fulfill({
|
||||
status: 200,
|
||||
body: JSON.stringify([{ id: 1, name: 'Test User' }]),
|
||||
}),
|
||||
);
|
||||
|
||||
// Test randomly passes/fails depending on timing
|
||||
await expect(page.getByText('Test User')).toBeVisible(); // Flaky!
|
||||
});
|
||||
|
||||
// ❌ BAD: No wait for response
|
||||
test('flaky test - no explicit wait', async ({ page }) => {
|
||||
await page.route('**/api/users', (route) => route.fulfill({ status: 200, body: JSON.stringify([]) }));
|
||||
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// Assertion runs immediately - may fail if response slow
|
||||
await expect(page.getByText('No users found')).toBeVisible(); // Flaky!
|
||||
});
|
||||
|
||||
// ❌ BAD: Generic timeout
|
||||
test('flaky test - hard wait', async ({ page }) => {
|
||||
await page.goto('/dashboard');
|
||||
await page.waitForTimeout(2000); // Arbitrary wait - brittle
|
||||
|
||||
await expect(page.getByText('Dashboard')).toBeVisible();
|
||||
});
|
||||
```
|
||||
|
||||
**Why It Fails**:
|
||||
|
||||
- **Mock after navigate**: Request fires during navigation, mock isn't active yet (race condition)
|
||||
- **No explicit wait**: Assertion runs before response arrives (timing-dependent)
|
||||
- **Hard waits**: Slow tests, brittle (fails if < timeout, wastes time if > timeout)
|
||||
- **Non-deterministic**: Passes locally, fails in CI (different speeds)
|
||||
|
||||
**Better Approach**: Always intercept → trigger → await
|
||||
|
||||
```typescript
|
||||
// ✅ GOOD: Intercept BEFORE navigate
|
||||
test('deterministic test', async ({ page }) => {
|
||||
// Step 1: Register mock FIRST
|
||||
await page.route('**/api/users', (route) =>
|
||||
route.fulfill({
|
||||
status: 200,
|
||||
contentType: 'application/json',
|
||||
body: JSON.stringify([{ id: 1, name: 'Test User' }]),
|
||||
}),
|
||||
);
|
||||
|
||||
// Step 2: Store response promise BEFORE trigger
|
||||
const responsePromise = page.waitForResponse('**/api/users');
|
||||
|
||||
// Step 3: THEN trigger
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// Step 4: THEN await response
|
||||
await responsePromise;
|
||||
|
||||
// Step 5: THEN assert (data is guaranteed loaded)
|
||||
await expect(page.getByText('Test User')).toBeVisible();
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Order matters: Mock → Promise → Trigger → Await → Assert
|
||||
- No race conditions: Mock is active before request fires
|
||||
- Explicit wait: Response promise ensures data loaded
|
||||
- Deterministic: Always passes if app works correctly
|
||||
|
||||
## Integration Points
|
||||
|
||||
- **Used in workflows**: `*atdd` (test generation), `*automate` (test expansion), `*framework` (network setup)
|
||||
- **Related fragments**:
|
||||
- `fixture-architecture.md` - Network fixture patterns
|
||||
- `data-factories.md` - API-first setup with network
|
||||
- `test-quality.md` - Deterministic test principles
|
||||
|
||||
## Debugging Network Issues
|
||||
|
||||
When network tests fail, check:
|
||||
|
||||
1. **Timing**: Is interception registered **before** action?
|
||||
2. **URL pattern**: Does pattern match actual request URL?
|
||||
3. **Response format**: Is mocked response valid JSON/format?
|
||||
4. **Status code**: Is app checking for 200 vs 201 vs 204?
|
||||
5. **HAR file**: Capture real traffic to understand actual API contract
|
||||
|
||||
```typescript
|
||||
// Debug network issues with logging
|
||||
test('debug network', async ({ page }) => {
|
||||
// Log all requests
|
||||
page.on('request', (req) => console.log('→', req.method(), req.url()));
|
||||
|
||||
// Log all responses
|
||||
page.on('response', (resp) => console.log('←', resp.status(), resp.url()));
|
||||
|
||||
await page.goto('/dashboard');
|
||||
});
|
||||
```
|
||||
|
||||
_Source: Murat Testing Philosophy (lines 94-137), Playwright network patterns, Cypress intercept best practices._
|
||||
@ -1,670 +0,0 @@
|
||||
# Non-Functional Requirements (NFR) Criteria
|
||||
|
||||
## Principle
|
||||
|
||||
Non-functional requirements (security, performance, reliability, maintainability) are **validated through automated tests**, not checklists. NFR assessment uses objective pass/fail criteria tied to measurable thresholds. Ambiguous requirements default to CONCERNS until clarified.
|
||||
|
||||
## Rationale
|
||||
|
||||
**The Problem**: Teams ship features that "work" functionally but fail under load, expose security vulnerabilities, or lack error recovery. NFRs are treated as optional "nice-to-haves" instead of release blockers.
|
||||
|
||||
**The Solution**: Define explicit NFR criteria with automated validation. Security tests verify auth/authz and secret handling. Performance tests enforce SLO/SLA thresholds with profiling evidence. Reliability tests validate error handling, retries, and health checks. Maintainability is measured by test coverage, code duplication, and observability.
|
||||
|
||||
**Why This Matters**:
|
||||
|
||||
- Prevents production incidents (security breaches, performance degradation, cascading failures)
|
||||
- Provides objective release criteria (no subjective "feels fast enough")
|
||||
- Automates compliance validation (audit trail for regulated environments)
|
||||
- Forces clarity on ambiguous requirements (default to CONCERNS)
|
||||
|
||||
## Pattern Examples
|
||||
|
||||
### Example 1: Security NFR Validation (Auth, Secrets, OWASP)
|
||||
|
||||
**Context**: Automated security tests enforcing authentication, authorization, and secret handling
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/nfr/security.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
test.describe('Security NFR: Authentication & Authorization', () => {
|
||||
test('unauthenticated users cannot access protected routes', async ({ page }) => {
|
||||
// Attempt to access dashboard without auth
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// Should redirect to login (not expose data)
|
||||
await expect(page).toHaveURL(/\/login/);
|
||||
await expect(page.getByText('Please sign in')).toBeVisible();
|
||||
|
||||
// Verify no sensitive data leaked in response
|
||||
const pageContent = await page.content();
|
||||
expect(pageContent).not.toContain('user_id');
|
||||
expect(pageContent).not.toContain('api_key');
|
||||
});
|
||||
|
||||
test('JWT tokens expire after 15 minutes', async ({ page, request }) => {
|
||||
// Login and capture token
|
||||
await page.goto('/login');
|
||||
await page.getByLabel('Email').fill('test@example.com');
|
||||
await page.getByLabel('Password').fill('ValidPass123!');
|
||||
await page.getByRole('button', { name: 'Sign In' }).click();
|
||||
|
||||
const token = await page.evaluate(() => localStorage.getItem('auth_token'));
|
||||
expect(token).toBeTruthy();
|
||||
|
||||
// Wait 16 minutes (use mock clock in real tests)
|
||||
await page.clock.fastForward('00:16:00');
|
||||
|
||||
// Token should be expired, API call should fail
|
||||
const response = await request.get('/api/user/profile', {
|
||||
headers: { Authorization: `Bearer ${token}` },
|
||||
});
|
||||
|
||||
expect(response.status()).toBe(401);
|
||||
const body = await response.json();
|
||||
expect(body.error).toContain('expired');
|
||||
});
|
||||
|
||||
test('passwords are never logged or exposed in errors', async ({ page }) => {
|
||||
// Trigger login error
|
||||
await page.goto('/login');
|
||||
await page.getByLabel('Email').fill('test@example.com');
|
||||
await page.getByLabel('Password').fill('WrongPassword123!');
|
||||
|
||||
// Monitor console for password leaks
|
||||
const consoleLogs: string[] = [];
|
||||
page.on('console', (msg) => consoleLogs.push(msg.text()));
|
||||
|
||||
await page.getByRole('button', { name: 'Sign In' }).click();
|
||||
|
||||
// Error shown to user (generic message)
|
||||
await expect(page.getByText('Invalid credentials')).toBeVisible();
|
||||
|
||||
// Verify password NEVER appears in console, DOM, or network
|
||||
const pageContent = await page.content();
|
||||
expect(pageContent).not.toContain('WrongPassword123!');
|
||||
expect(consoleLogs.join('\n')).not.toContain('WrongPassword123!');
|
||||
});
|
||||
|
||||
test('RBAC: users can only access resources they own', async ({ page, request }) => {
|
||||
// Login as User A
|
||||
const userAToken = await login(request, 'userA@example.com', 'password');
|
||||
|
||||
// Try to access User B's order
|
||||
const response = await request.get('/api/orders/user-b-order-id', {
|
||||
headers: { Authorization: `Bearer ${userAToken}` },
|
||||
});
|
||||
|
||||
expect(response.status()).toBe(403); // Forbidden
|
||||
const body = await response.json();
|
||||
expect(body.error).toContain('insufficient permissions');
|
||||
});
|
||||
|
||||
test('SQL injection attempts are blocked', async ({ page }) => {
|
||||
await page.goto('/search');
|
||||
|
||||
// Attempt SQL injection
|
||||
await page.getByPlaceholder('Search products').fill("'; DROP TABLE users; --");
|
||||
await page.getByRole('button', { name: 'Search' }).click();
|
||||
|
||||
// Should return empty results, NOT crash or expose error
|
||||
await expect(page.getByText('No results found')).toBeVisible();
|
||||
|
||||
// Verify app still works (table not dropped)
|
||||
await page.goto('/dashboard');
|
||||
await expect(page.getByText('Welcome')).toBeVisible();
|
||||
});
|
||||
|
||||
test('XSS attempts are sanitized', async ({ page }) => {
|
||||
await page.goto('/profile/edit');
|
||||
|
||||
// Attempt XSS injection
|
||||
const xssPayload = '<script>alert("XSS")</script>';
|
||||
await page.getByLabel('Bio').fill(xssPayload);
|
||||
await page.getByRole('button', { name: 'Save' }).click();
|
||||
|
||||
// Reload and verify XSS is escaped (not executed)
|
||||
await page.reload();
|
||||
const bio = await page.getByTestId('user-bio').textContent();
|
||||
|
||||
// Text should be escaped, script should NOT execute
|
||||
expect(bio).toContain('<script>');
|
||||
expect(bio).not.toContain('<script>');
|
||||
});
|
||||
});
|
||||
|
||||
// Helper
|
||||
async function login(request: any, email: string, password: string): Promise<string> {
|
||||
const response = await request.post('/api/auth/login', {
|
||||
data: { email, password },
|
||||
});
|
||||
const body = await response.json();
|
||||
return body.token;
|
||||
}
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Authentication: Unauthenticated access redirected (not exposed)
|
||||
- Authorization: RBAC enforced (403 for insufficient permissions)
|
||||
- Token expiry: JWT expires after 15 minutes (automated validation)
|
||||
- Secret handling: Passwords never logged or exposed in errors
|
||||
- OWASP Top 10: SQL injection and XSS blocked (input sanitization)
|
||||
|
||||
**Security NFR Criteria**:
|
||||
|
||||
- ✅ PASS: All 6 tests green (auth, authz, token expiry, secret handling, SQL injection, XSS)
|
||||
- ⚠️ CONCERNS: 1-2 tests failing with mitigation plan and owner assigned
|
||||
- ❌ FAIL: Critical exposure (unauthenticated access, password leak, SQL injection succeeds)
|
||||
|
||||
---
|
||||
|
||||
### Example 2: Performance NFR Validation (k6 Load Testing for SLO/SLA)
|
||||
|
||||
**Context**: Use k6 for load testing, stress testing, and SLO/SLA enforcement (NOT Playwright)
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```javascript
|
||||
// tests/nfr/performance.k6.js
|
||||
import http from 'k6/http';
|
||||
import { check, sleep } from 'k6';
|
||||
import { Rate, Trend } from 'k6/metrics';
|
||||
|
||||
// Custom metrics
|
||||
const errorRate = new Rate('errors');
|
||||
const apiDuration = new Trend('api_duration');
|
||||
|
||||
// Performance thresholds (SLO/SLA)
|
||||
export const options = {
|
||||
stages: [
|
||||
{ duration: '1m', target: 50 }, // Ramp up to 50 users
|
||||
{ duration: '3m', target: 50 }, // Stay at 50 users for 3 minutes
|
||||
{ duration: '1m', target: 100 }, // Spike to 100 users
|
||||
{ duration: '3m', target: 100 }, // Stay at 100 users
|
||||
{ duration: '1m', target: 0 }, // Ramp down
|
||||
],
|
||||
thresholds: {
|
||||
// SLO: 95% of requests must complete in <500ms
|
||||
http_req_duration: ['p(95)<500'],
|
||||
// SLO: Error rate must be <1%
|
||||
errors: ['rate<0.01'],
|
||||
// SLA: API endpoints must respond in <1s (99th percentile)
|
||||
api_duration: ['p(99)<1000'],
|
||||
},
|
||||
};
|
||||
|
||||
export default function () {
|
||||
// Test 1: Homepage load performance
|
||||
const homepageResponse = http.get(`${__ENV.BASE_URL}/`);
|
||||
check(homepageResponse, {
|
||||
'homepage status is 200': (r) => r.status === 200,
|
||||
'homepage loads in <2s': (r) => r.timings.duration < 2000,
|
||||
});
|
||||
errorRate.add(homepageResponse.status !== 200);
|
||||
|
||||
// Test 2: API endpoint performance
|
||||
const apiResponse = http.get(`${__ENV.BASE_URL}/api/products?limit=10`, {
|
||||
headers: { Authorization: `Bearer ${__ENV.API_TOKEN}` },
|
||||
});
|
||||
check(apiResponse, {
|
||||
'API status is 200': (r) => r.status === 200,
|
||||
'API responds in <500ms': (r) => r.timings.duration < 500,
|
||||
});
|
||||
apiDuration.add(apiResponse.timings.duration);
|
||||
errorRate.add(apiResponse.status !== 200);
|
||||
|
||||
// Test 3: Search endpoint under load
|
||||
const searchResponse = http.get(`${__ENV.BASE_URL}/api/search?q=laptop&limit=100`);
|
||||
check(searchResponse, {
|
||||
'search status is 200': (r) => r.status === 200,
|
||||
'search responds in <1s': (r) => r.timings.duration < 1000,
|
||||
'search returns results': (r) => JSON.parse(r.body).results.length > 0,
|
||||
});
|
||||
errorRate.add(searchResponse.status !== 200);
|
||||
|
||||
sleep(1); // Realistic user think time
|
||||
}
|
||||
|
||||
// Threshold validation (run after test)
|
||||
export function handleSummary(data) {
|
||||
const p95Duration = data.metrics.http_req_duration.values['p(95)'];
|
||||
const p99ApiDuration = data.metrics.api_duration.values['p(99)'];
|
||||
const errorRateValue = data.metrics.errors.values.rate;
|
||||
|
||||
console.log(`P95 request duration: ${p95Duration.toFixed(2)}ms`);
|
||||
console.log(`P99 API duration: ${p99ApiDuration.toFixed(2)}ms`);
|
||||
console.log(`Error rate: ${(errorRateValue * 100).toFixed(2)}%`);
|
||||
|
||||
return {
|
||||
'summary.json': JSON.stringify(data),
|
||||
stdout: `
|
||||
Performance NFR Results:
|
||||
- P95 request duration: ${p95Duration < 500 ? '✅ PASS' : '❌ FAIL'} (${p95Duration.toFixed(2)}ms / 500ms threshold)
|
||||
- P99 API duration: ${p99ApiDuration < 1000 ? '✅ PASS' : '❌ FAIL'} (${p99ApiDuration.toFixed(2)}ms / 1000ms threshold)
|
||||
- Error rate: ${errorRateValue < 0.01 ? '✅ PASS' : '❌ FAIL'} (${(errorRateValue * 100).toFixed(2)}% / 1% threshold)
|
||||
`,
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
**Run k6 tests:**
|
||||
|
||||
```bash
|
||||
# Local smoke test (10 VUs, 30s)
|
||||
k6 run --vus 10 --duration 30s tests/nfr/performance.k6.js
|
||||
|
||||
# Full load test (stages defined in script)
|
||||
k6 run tests/nfr/performance.k6.js
|
||||
|
||||
# CI integration with thresholds
|
||||
k6 run --out json=performance-results.json tests/nfr/performance.k6.js
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **k6 is the right tool** for load testing (NOT Playwright)
|
||||
- SLO/SLA thresholds enforced automatically (`p(95)<500`, `rate<0.01`)
|
||||
- Realistic load simulation (ramp up, sustained load, spike testing)
|
||||
- Comprehensive metrics (p50, p95, p99, error rate, throughput)
|
||||
- CI-friendly (JSON output, exit codes based on thresholds)
|
||||
|
||||
**Performance NFR Criteria**:
|
||||
|
||||
- ✅ PASS: All SLO/SLA targets met with k6 profiling evidence (p95 < 500ms, error rate < 1%)
|
||||
- ⚠️ CONCERNS: Trending toward limits (e.g., p95 = 480ms approaching 500ms) or missing baselines
|
||||
- ❌ FAIL: SLO/SLA breached (e.g., p95 > 500ms) or error rate > 1%
|
||||
|
||||
**Performance Testing Levels (from Test Architect course):**
|
||||
|
||||
- **Load testing**: System behavior under expected load
|
||||
- **Stress testing**: System behavior under extreme load (breaking point)
|
||||
- **Spike testing**: Sudden load increases (traffic spikes)
|
||||
- **Endurance/Soak testing**: System behavior under sustained load (memory leaks, resource exhaustion)
|
||||
- **Benchmarking**: Baseline measurements for comparison
|
||||
|
||||
**Note**: Playwright can validate **perceived performance** (Core Web Vitals via Lighthouse), but k6 validates **system performance** (throughput, latency, resource limits under load)
|
||||
|
||||
---
|
||||
|
||||
### Example 3: Reliability NFR Validation (Playwright for UI Resilience)
|
||||
|
||||
**Context**: Automated reliability tests validating graceful degradation and recovery paths
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/nfr/reliability.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
test.describe('Reliability NFR: Error Handling & Recovery', () => {
|
||||
test('app remains functional when API returns 500 error', async ({ page, context }) => {
|
||||
// Mock API failure
|
||||
await context.route('**/api/products', (route) => {
|
||||
route.fulfill({ status: 500, body: JSON.stringify({ error: 'Internal Server Error' }) });
|
||||
});
|
||||
|
||||
await page.goto('/products');
|
||||
|
||||
// User sees error message (not blank page or crash)
|
||||
await expect(page.getByText('Unable to load products. Please try again.')).toBeVisible();
|
||||
await expect(page.getByRole('button', { name: 'Retry' })).toBeVisible();
|
||||
|
||||
// App navigation still works (graceful degradation)
|
||||
await page.getByRole('link', { name: 'Home' }).click();
|
||||
await expect(page).toHaveURL('/');
|
||||
});
|
||||
|
||||
test('API client retries on transient failures (3 attempts)', async ({ page, context }) => {
|
||||
let attemptCount = 0;
|
||||
|
||||
await context.route('**/api/checkout', (route) => {
|
||||
attemptCount++;
|
||||
|
||||
// Fail first 2 attempts, succeed on 3rd
|
||||
if (attemptCount < 3) {
|
||||
route.fulfill({ status: 503, body: JSON.stringify({ error: 'Service Unavailable' }) });
|
||||
} else {
|
||||
route.fulfill({ status: 200, body: JSON.stringify({ orderId: '12345' }) });
|
||||
}
|
||||
});
|
||||
|
||||
await page.goto('/checkout');
|
||||
await page.getByRole('button', { name: 'Place Order' }).click();
|
||||
|
||||
// Should succeed after 3 attempts
|
||||
await expect(page.getByText('Order placed successfully')).toBeVisible();
|
||||
expect(attemptCount).toBe(3);
|
||||
});
|
||||
|
||||
test('app handles network disconnection gracefully', async ({ page, context }) => {
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// Simulate offline mode
|
||||
await context.setOffline(true);
|
||||
|
||||
// Trigger action requiring network
|
||||
await page.getByRole('button', { name: 'Refresh Data' }).click();
|
||||
|
||||
// User sees offline indicator (not crash)
|
||||
await expect(page.getByText('You are offline. Changes will sync when reconnected.')).toBeVisible();
|
||||
|
||||
// Reconnect
|
||||
await context.setOffline(false);
|
||||
await page.getByRole('button', { name: 'Refresh Data' }).click();
|
||||
|
||||
// Data loads successfully
|
||||
await expect(page.getByText('Data updated')).toBeVisible();
|
||||
});
|
||||
|
||||
test('health check endpoint returns service status', async ({ request }) => {
|
||||
const response = await request.get('/api/health');
|
||||
|
||||
expect(response.status()).toBe(200);
|
||||
|
||||
const health = await response.json();
|
||||
expect(health).toHaveProperty('status', 'healthy');
|
||||
expect(health).toHaveProperty('timestamp');
|
||||
expect(health).toHaveProperty('services');
|
||||
|
||||
// Verify critical services are monitored
|
||||
expect(health.services).toHaveProperty('database');
|
||||
expect(health.services).toHaveProperty('cache');
|
||||
expect(health.services).toHaveProperty('queue');
|
||||
|
||||
// All services should be UP
|
||||
expect(health.services.database.status).toBe('UP');
|
||||
expect(health.services.cache.status).toBe('UP');
|
||||
expect(health.services.queue.status).toBe('UP');
|
||||
});
|
||||
|
||||
test('circuit breaker opens after 5 consecutive failures', async ({ page, context }) => {
|
||||
let failureCount = 0;
|
||||
|
||||
await context.route('**/api/recommendations', (route) => {
|
||||
failureCount++;
|
||||
route.fulfill({ status: 500, body: JSON.stringify({ error: 'Service Error' }) });
|
||||
});
|
||||
|
||||
await page.goto('/product/123');
|
||||
|
||||
// Wait for circuit breaker to open (fallback UI appears)
|
||||
await expect(page.getByText('Recommendations temporarily unavailable')).toBeVisible({ timeout: 10000 });
|
||||
|
||||
// Verify circuit breaker stopped making requests after threshold (should be ≤5)
|
||||
expect(failureCount).toBeLessThanOrEqual(5);
|
||||
});
|
||||
|
||||
test('rate limiting gracefully handles 429 responses', async ({ page, context }) => {
|
||||
let requestCount = 0;
|
||||
|
||||
await context.route('**/api/search', (route) => {
|
||||
requestCount++;
|
||||
|
||||
if (requestCount > 10) {
|
||||
// Rate limit exceeded
|
||||
route.fulfill({
|
||||
status: 429,
|
||||
headers: { 'Retry-After': '5' },
|
||||
body: JSON.stringify({ error: 'Rate limit exceeded' }),
|
||||
});
|
||||
} else {
|
||||
route.fulfill({ status: 200, body: JSON.stringify({ results: [] }) });
|
||||
}
|
||||
});
|
||||
|
||||
await page.goto('/search');
|
||||
|
||||
// Make 15 search requests rapidly
|
||||
for (let i = 0; i < 15; i++) {
|
||||
await page.getByPlaceholder('Search').fill(`query-${i}`);
|
||||
await page.getByRole('button', { name: 'Search' }).click();
|
||||
}
|
||||
|
||||
// User sees rate limit message (not crash)
|
||||
await expect(page.getByText('Too many requests. Please wait a moment.')).toBeVisible();
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Error handling: Graceful degradation (500 error → user-friendly message + retry button)
|
||||
- Retries: 3 attempts on transient failures (503 → eventual success)
|
||||
- Offline handling: Network disconnection detected (sync when reconnected)
|
||||
- Health checks: `/api/health` monitors database, cache, queue
|
||||
- Circuit breaker: Opens after 5 failures (fallback UI, stop retries)
|
||||
- Rate limiting: 429 response handled (Retry-After header respected)
|
||||
|
||||
**Reliability NFR Criteria**:
|
||||
|
||||
- ✅ PASS: Error handling, retries, health checks verified (all 6 tests green)
|
||||
- ⚠️ CONCERNS: Partial coverage (e.g., missing circuit breaker) or no telemetry
|
||||
- ❌ FAIL: No recovery path (500 error crashes app) or unresolved crash scenarios
|
||||
|
||||
---
|
||||
|
||||
### Example 4: Maintainability NFR Validation (CI Tools, Not Playwright)
|
||||
|
||||
**Context**: Use proper CI tools for code quality validation (coverage, duplication, vulnerabilities)
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```yaml
|
||||
# .github/workflows/nfr-maintainability.yml
|
||||
name: NFR - Maintainability
|
||||
|
||||
on: [push, pull_request]
|
||||
|
||||
jobs:
|
||||
test-coverage:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v4
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Run tests with coverage
|
||||
run: npm run test:coverage
|
||||
|
||||
- name: Check coverage threshold (80% minimum)
|
||||
run: |
|
||||
COVERAGE=$(jq '.total.lines.pct' coverage/coverage-summary.json)
|
||||
echo "Coverage: $COVERAGE%"
|
||||
if (( $(echo "$COVERAGE < 80" | bc -l) )); then
|
||||
echo "❌ FAIL: Coverage $COVERAGE% below 80% threshold"
|
||||
exit 1
|
||||
else
|
||||
echo "✅ PASS: Coverage $COVERAGE% meets 80% threshold"
|
||||
fi
|
||||
|
||||
code-duplication:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v4
|
||||
|
||||
- name: Check code duplication (<5% allowed)
|
||||
run: |
|
||||
npx jscpd src/ --threshold 5 --format json --output duplication.json
|
||||
DUPLICATION=$(jq '.statistics.total.percentage' duplication.json)
|
||||
echo "Duplication: $DUPLICATION%"
|
||||
if (( $(echo "$DUPLICATION >= 5" | bc -l) )); then
|
||||
echo "❌ FAIL: Duplication $DUPLICATION% exceeds 5% threshold"
|
||||
exit 1
|
||||
else
|
||||
echo "✅ PASS: Duplication $DUPLICATION% below 5% threshold"
|
||||
fi
|
||||
|
||||
vulnerability-scan:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v4
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Run npm audit (no critical/high vulnerabilities)
|
||||
run: |
|
||||
npm audit --json > audit.json || true
|
||||
CRITICAL=$(jq '.metadata.vulnerabilities.critical' audit.json)
|
||||
HIGH=$(jq '.metadata.vulnerabilities.high' audit.json)
|
||||
echo "Critical: $CRITICAL, High: $HIGH"
|
||||
if [ "$CRITICAL" -gt 0 ] || [ "$HIGH" -gt 0 ]; then
|
||||
echo "❌ FAIL: Found $CRITICAL critical and $HIGH high vulnerabilities"
|
||||
npm audit
|
||||
exit 1
|
||||
else
|
||||
echo "✅ PASS: No critical/high vulnerabilities"
|
||||
fi
|
||||
```
|
||||
|
||||
**Playwright Tests for Observability (E2E Validation):**
|
||||
|
||||
```typescript
|
||||
// tests/nfr/observability.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
test.describe('Maintainability NFR: Observability Validation', () => {
|
||||
test('critical errors are reported to monitoring service', async ({ page, context }) => {
|
||||
const sentryEvents: any[] = [];
|
||||
|
||||
// Mock Sentry SDK to verify error tracking
|
||||
await context.addInitScript(() => {
|
||||
(window as any).Sentry = {
|
||||
captureException: (error: Error) => {
|
||||
console.log('SENTRY_CAPTURE:', JSON.stringify({ message: error.message, stack: error.stack }));
|
||||
},
|
||||
};
|
||||
});
|
||||
|
||||
page.on('console', (msg) => {
|
||||
if (msg.text().includes('SENTRY_CAPTURE:')) {
|
||||
sentryEvents.push(JSON.parse(msg.text().replace('SENTRY_CAPTURE:', '')));
|
||||
}
|
||||
});
|
||||
|
||||
// Trigger error by mocking API failure
|
||||
await context.route('**/api/products', (route) => {
|
||||
route.fulfill({ status: 500, body: JSON.stringify({ error: 'Database Error' }) });
|
||||
});
|
||||
|
||||
await page.goto('/products');
|
||||
|
||||
// Wait for error UI and Sentry capture
|
||||
await expect(page.getByText('Unable to load products')).toBeVisible();
|
||||
|
||||
// Verify error was captured by monitoring
|
||||
expect(sentryEvents.length).toBeGreaterThan(0);
|
||||
expect(sentryEvents[0]).toHaveProperty('message');
|
||||
expect(sentryEvents[0]).toHaveProperty('stack');
|
||||
});
|
||||
|
||||
test('API response times are tracked in telemetry', async ({ request }) => {
|
||||
const response = await request.get('/api/products?limit=10');
|
||||
|
||||
expect(response.ok()).toBeTruthy();
|
||||
|
||||
// Verify Server-Timing header for APM (Application Performance Monitoring)
|
||||
const serverTiming = response.headers()['server-timing'];
|
||||
|
||||
expect(serverTiming).toBeTruthy();
|
||||
expect(serverTiming).toContain('db'); // Database query time
|
||||
expect(serverTiming).toContain('total'); // Total processing time
|
||||
});
|
||||
|
||||
test('structured logging present in application', async ({ request }) => {
|
||||
// Make API call that generates logs
|
||||
const response = await request.post('/api/orders', {
|
||||
data: { productId: '123', quantity: 2 },
|
||||
});
|
||||
|
||||
expect(response.ok()).toBeTruthy();
|
||||
|
||||
// Note: In real scenarios, validate logs in monitoring system (Datadog, CloudWatch)
|
||||
// This test validates the logging contract exists (Server-Timing, trace IDs in headers)
|
||||
const traceId = response.headers()['x-trace-id'];
|
||||
expect(traceId).toBeTruthy(); // Confirms structured logging with correlation IDs
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Coverage/duplication**: CI jobs (GitHub Actions), not Playwright tests
|
||||
- **Vulnerability scanning**: npm audit in CI, not Playwright tests
|
||||
- **Observability**: Playwright validates error tracking (Sentry) and telemetry headers
|
||||
- **Structured logging**: Validate logging contract (trace IDs, Server-Timing headers)
|
||||
- **Separation of concerns**: Build-time checks (coverage, audit) vs runtime checks (error tracking, telemetry)
|
||||
|
||||
**Maintainability NFR Criteria**:
|
||||
|
||||
- ✅ PASS: Clean code (80%+ coverage from CI, <5% duplication from CI), observability validated in E2E, no critical vulnerabilities from npm audit
|
||||
- ⚠️ CONCERNS: Duplication >5%, coverage 60-79%, or unclear ownership
|
||||
- ❌ FAIL: Absent tests (<60%), tangled implementations (>10% duplication), or no observability
|
||||
|
||||
---
|
||||
|
||||
## NFR Assessment Checklist
|
||||
|
||||
Before release gate:
|
||||
|
||||
- [ ] **Security** (Playwright E2E + Security Tools):
|
||||
- [ ] Auth/authz tests green (unauthenticated redirect, RBAC enforced)
|
||||
- [ ] Secrets never logged or exposed in errors
|
||||
- [ ] OWASP Top 10 validated (SQL injection blocked, XSS sanitized)
|
||||
- [ ] Security audit completed (vulnerability scan, penetration test if applicable)
|
||||
|
||||
- [ ] **Performance** (k6 Load Testing):
|
||||
- [ ] SLO/SLA targets met with k6 evidence (p95 <500ms, error rate <1%)
|
||||
- [ ] Load testing completed (expected load)
|
||||
- [ ] Stress testing completed (breaking point identified)
|
||||
- [ ] Spike testing completed (handles traffic spikes)
|
||||
- [ ] Endurance testing completed (no memory leaks under sustained load)
|
||||
|
||||
- [ ] **Reliability** (Playwright E2E + API Tests):
|
||||
- [ ] Error handling graceful (500 → user-friendly message + retry)
|
||||
- [ ] Retries implemented (3 attempts on transient failures)
|
||||
- [ ] Health checks monitored (/api/health endpoint)
|
||||
- [ ] Circuit breaker tested (opens after failure threshold)
|
||||
- [ ] Offline handling validated (network disconnection graceful)
|
||||
|
||||
- [ ] **Maintainability** (CI Tools):
|
||||
- [ ] Test coverage ≥80% (from CI coverage report)
|
||||
- [ ] Code duplication <5% (from jscpd CI job)
|
||||
- [ ] No critical/high vulnerabilities (from npm audit CI job)
|
||||
- [ ] Structured logging validated (Playwright validates telemetry headers)
|
||||
- [ ] Error tracking configured (Sentry/monitoring integration validated)
|
||||
|
||||
- [ ] **Ambiguous requirements**: Default to CONCERNS (force team to clarify thresholds and evidence)
|
||||
- [ ] **NFR criteria documented**: Measurable thresholds defined (not subjective "fast enough")
|
||||
- [ ] **Automated validation**: NFR tests run in CI pipeline (not manual checklists)
|
||||
- [ ] **Tool selection**: Right tool for each NFR (k6 for performance, Playwright for security/reliability E2E, CI tools for maintainability)
|
||||
|
||||
## NFR Gate Decision Matrix
|
||||
|
||||
| Category | PASS Criteria | CONCERNS Criteria | FAIL Criteria |
|
||||
| ------------------- | -------------------------------------------- | -------------------------------------------- | ---------------------------------------------- |
|
||||
| **Security** | Auth/authz, secret handling, OWASP verified | Minor gaps with clear owners | Critical exposure or missing controls |
|
||||
| **Performance** | Metrics meet SLO/SLA with profiling evidence | Trending toward limits or missing baselines | SLO/SLA breached or resource leaks detected |
|
||||
| **Reliability** | Error handling, retries, health checks OK | Partial coverage or missing telemetry | No recovery path or unresolved crash scenarios |
|
||||
| **Maintainability** | Clean code, tests, docs shipped together | Duplication, low coverage, unclear ownership | Absent tests, tangled code, no observability |
|
||||
|
||||
**Default**: If targets or evidence are undefined → **CONCERNS** (force team to clarify before sign-off)
|
||||
|
||||
## Integration Points
|
||||
|
||||
- **Used in workflows**: `*nfr-assess` (automated NFR validation), `*trace` (gate decision Phase 2), `*test-design` (NFR risk assessment via Utility Tree)
|
||||
- **Related fragments**: `risk-governance.md` (NFR risk scoring), `probability-impact.md` (NFR impact assessment), `test-quality.md` (maintainability standards), `test-levels-framework.md` (system-level testing for NFRs)
|
||||
- **Tools by NFR Category**:
|
||||
- **Security**: Playwright (E2E auth/authz), OWASP ZAP, Burp Suite, npm audit, Snyk
|
||||
- **Performance**: k6 (load/stress/spike/endurance), Lighthouse (Core Web Vitals), Artillery
|
||||
- **Reliability**: Playwright (E2E error handling), API tests (retries, health checks), Chaos Engineering tools
|
||||
- **Maintainability**: GitHub Actions (coverage, duplication, audit), jscpd, Playwright (observability validation)
|
||||
|
||||
_Source: Test Architect course (NFR testing approaches, Utility Tree, Quality Scenarios), ISO/IEC 25010 Software Quality Characteristics, OWASP Top 10, k6 documentation, SRE practices_
|
||||
@ -1,730 +0,0 @@
|
||||
# Playwright Configuration Guardrails
|
||||
|
||||
## Principle
|
||||
|
||||
Load environment configs via a central map (`envConfigMap`), standardize timeouts (action 15s, navigation 30s, expect 10s, test 60s), emit HTML + JUnit reporters, and store artifacts under `test-results/` for CI upload. Keep `.env.example`, `.nvmrc`, and browser dependencies versioned so local and CI runs stay aligned.
|
||||
|
||||
## Rationale
|
||||
|
||||
Environment-specific configuration prevents hardcoded URLs, timeouts, and credentials from leaking into tests. A central config map with fail-fast validation catches missing environments early. Standardized timeouts reduce flakiness while remaining long enough for real-world network conditions. Consistent artifact storage (`test-results/`, `playwright-report/`) enables CI pipelines to upload failure evidence automatically. Versioned dependencies (`.nvmrc`, `package.json` browser versions) eliminate "works on my machine" issues between local and CI environments.
|
||||
|
||||
## Pattern Examples
|
||||
|
||||
### Example 1: Environment-Based Configuration
|
||||
|
||||
**Context**: When testing against multiple environments (local, staging, production), use a central config map that loads environment-specific settings and fails fast if `TEST_ENV` is invalid.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// playwright.config.ts - Central config loader
|
||||
import { config as dotenvConfig } from 'dotenv';
|
||||
import path from 'path';
|
||||
|
||||
// Load .env from project root
|
||||
dotenvConfig({
|
||||
path: path.resolve(__dirname, '../../.env'),
|
||||
});
|
||||
|
||||
// Central environment config map
|
||||
const envConfigMap = {
|
||||
local: require('./playwright/config/local.config').default,
|
||||
staging: require('./playwright/config/staging.config').default,
|
||||
production: require('./playwright/config/production.config').default,
|
||||
};
|
||||
|
||||
const environment = process.env.TEST_ENV || 'local';
|
||||
|
||||
// Fail fast if environment not supported
|
||||
if (!Object.keys(envConfigMap).includes(environment)) {
|
||||
console.error(`❌ No configuration found for environment: ${environment}`);
|
||||
console.error(` Available environments: ${Object.keys(envConfigMap).join(', ')}`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
console.log(`✅ Running tests against: ${environment.toUpperCase()}`);
|
||||
|
||||
export default envConfigMap[environment as keyof typeof envConfigMap];
|
||||
```
|
||||
|
||||
```typescript
|
||||
// playwright/config/base.config.ts - Shared base configuration
|
||||
import { defineConfig } from '@playwright/test';
|
||||
import path from 'path';
|
||||
|
||||
export const baseConfig = defineConfig({
|
||||
testDir: path.resolve(__dirname, '../tests'),
|
||||
outputDir: path.resolve(__dirname, '../../test-results'),
|
||||
fullyParallel: true,
|
||||
forbidOnly: !!process.env.CI,
|
||||
retries: process.env.CI ? 2 : 0,
|
||||
workers: process.env.CI ? 1 : undefined,
|
||||
reporter: [
|
||||
['html', { outputFolder: 'playwright-report', open: 'never' }],
|
||||
['junit', { outputFile: 'test-results/results.xml' }],
|
||||
['list'],
|
||||
],
|
||||
use: {
|
||||
actionTimeout: 15000,
|
||||
navigationTimeout: 30000,
|
||||
trace: 'on-first-retry',
|
||||
screenshot: 'only-on-failure',
|
||||
video: 'retain-on-failure',
|
||||
},
|
||||
globalSetup: path.resolve(__dirname, '../support/global-setup.ts'),
|
||||
timeout: 60000,
|
||||
expect: { timeout: 10000 },
|
||||
});
|
||||
```
|
||||
|
||||
```typescript
|
||||
// playwright/config/local.config.ts - Local environment
|
||||
import { defineConfig } from '@playwright/test';
|
||||
import { baseConfig } from './base.config';
|
||||
|
||||
export default defineConfig({
|
||||
...baseConfig,
|
||||
use: {
|
||||
...baseConfig.use,
|
||||
baseURL: 'http://localhost:3000',
|
||||
video: 'off', // No video locally for speed
|
||||
},
|
||||
webServer: {
|
||||
command: 'npm run dev',
|
||||
url: 'http://localhost:3000',
|
||||
reuseExistingServer: !process.env.CI,
|
||||
timeout: 120000,
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
```typescript
|
||||
// playwright/config/staging.config.ts - Staging environment
|
||||
import { defineConfig } from '@playwright/test';
|
||||
import { baseConfig } from './base.config';
|
||||
|
||||
export default defineConfig({
|
||||
...baseConfig,
|
||||
use: {
|
||||
...baseConfig.use,
|
||||
baseURL: 'https://staging.example.com',
|
||||
ignoreHTTPSErrors: true, // Allow self-signed certs in staging
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
```typescript
|
||||
// playwright/config/production.config.ts - Production environment
|
||||
import { defineConfig } from '@playwright/test';
|
||||
import { baseConfig } from './base.config';
|
||||
|
||||
export default defineConfig({
|
||||
...baseConfig,
|
||||
retries: 3, // More retries in production
|
||||
use: {
|
||||
...baseConfig.use,
|
||||
baseURL: 'https://example.com',
|
||||
video: 'on', // Always record production failures
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
```bash
|
||||
# .env.example - Template for developers
|
||||
TEST_ENV=local
|
||||
API_KEY=your_api_key_here
|
||||
DATABASE_URL=postgresql://localhost:5432/test_db
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Central `envConfigMap` prevents environment misconfiguration
|
||||
- Fail-fast validation with clear error message (available envs listed)
|
||||
- Base config defines shared settings, environment configs override
|
||||
- `.env.example` provides template for required secrets
|
||||
- `TEST_ENV=local` as default for local development
|
||||
- Production config increases retries and enables video recording
|
||||
|
||||
### Example 2: Timeout Standards
|
||||
|
||||
**Context**: When tests fail due to inconsistent timeout settings, standardize timeouts across all tests: action 15s, navigation 30s, expect 10s, test 60s. Expose overrides through fixtures rather than inline literals.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// playwright/config/base.config.ts - Standardized timeouts
|
||||
import { defineConfig } from '@playwright/test';
|
||||
|
||||
export default defineConfig({
|
||||
// Global test timeout: 60 seconds
|
||||
timeout: 60000,
|
||||
|
||||
use: {
|
||||
// Action timeout: 15 seconds (click, fill, etc.)
|
||||
actionTimeout: 15000,
|
||||
|
||||
// Navigation timeout: 30 seconds (page.goto, page.reload)
|
||||
navigationTimeout: 30000,
|
||||
},
|
||||
|
||||
// Expect timeout: 10 seconds (all assertions)
|
||||
expect: {
|
||||
timeout: 10000,
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
```typescript
|
||||
// playwright/support/fixtures/timeout-fixture.ts - Timeout override fixture
|
||||
import { test as base } from '@playwright/test';
|
||||
|
||||
type TimeoutOptions = {
|
||||
extendedTimeout: (timeoutMs: number) => Promise<void>;
|
||||
};
|
||||
|
||||
export const test = base.extend<TimeoutOptions>({
|
||||
extendedTimeout: async ({}, use, testInfo) => {
|
||||
const originalTimeout = testInfo.timeout;
|
||||
|
||||
await use(async (timeoutMs: number) => {
|
||||
testInfo.setTimeout(timeoutMs);
|
||||
});
|
||||
|
||||
// Restore original timeout after test
|
||||
testInfo.setTimeout(originalTimeout);
|
||||
},
|
||||
});
|
||||
|
||||
export { expect } from '@playwright/test';
|
||||
```
|
||||
|
||||
```typescript
|
||||
// Usage in tests - Standard timeouts (implicit)
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
test('user can log in', async ({ page }) => {
|
||||
await page.goto('/login'); // Uses 30s navigation timeout
|
||||
await page.fill('[data-testid="email"]', 'test@example.com'); // Uses 15s action timeout
|
||||
await page.click('[data-testid="login-button"]'); // Uses 15s action timeout
|
||||
|
||||
await expect(page.getByText('Welcome')).toBeVisible(); // Uses 10s expect timeout
|
||||
});
|
||||
```
|
||||
|
||||
```typescript
|
||||
// Usage in tests - Per-test timeout override
|
||||
import { test, expect } from '../support/fixtures/timeout-fixture';
|
||||
|
||||
test('slow data processing operation', async ({ page, extendedTimeout }) => {
|
||||
// Override default 60s timeout for this slow test
|
||||
await extendedTimeout(180000); // 3 minutes
|
||||
|
||||
await page.goto('/data-processing');
|
||||
await page.click('[data-testid="process-large-file"]');
|
||||
|
||||
// Wait for long-running operation
|
||||
await expect(page.getByText('Processing complete')).toBeVisible({
|
||||
timeout: 120000, // 2 minutes for assertion
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
```typescript
|
||||
// Per-assertion timeout override (inline)
|
||||
test('API returns quickly', async ({ page }) => {
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// Override expect timeout for fast API (reduce flakiness detection)
|
||||
await expect(page.getByTestId('user-name')).toBeVisible({ timeout: 5000 }); // 5s instead of 10s
|
||||
|
||||
// Override expect timeout for slow external API
|
||||
await expect(page.getByTestId('weather-widget')).toBeVisible({ timeout: 20000 }); // 20s instead of 10s
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Standardized timeouts**: action 15s, navigation 30s, expect 10s, test 60s (global defaults)
|
||||
- Fixture-based override (`extendedTimeout`) for slow tests (preferred over inline)
|
||||
- Per-assertion timeout override via `{ timeout: X }` option (use sparingly)
|
||||
- Avoid hard waits (`page.waitForTimeout(3000)`) - use event-based waits instead
|
||||
- CI environments may need longer timeouts (handle in environment-specific config)
|
||||
|
||||
### Example 3: Artifact Output Configuration
|
||||
|
||||
**Context**: When debugging failures in CI, configure artifacts (screenshots, videos, traces, HTML reports) to be captured on failure and stored in consistent locations for upload.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// playwright.config.ts - Artifact configuration
|
||||
import { defineConfig } from '@playwright/test';
|
||||
import path from 'path';
|
||||
|
||||
export default defineConfig({
|
||||
// Output directory for test artifacts
|
||||
outputDir: path.resolve(__dirname, './test-results'),
|
||||
|
||||
use: {
|
||||
// Screenshot on failure only (saves space)
|
||||
screenshot: 'only-on-failure',
|
||||
|
||||
// Video recording on failure + retry
|
||||
video: 'retain-on-failure',
|
||||
|
||||
// Trace recording on first retry (best debugging data)
|
||||
trace: 'on-first-retry',
|
||||
},
|
||||
|
||||
reporter: [
|
||||
// HTML report (visual, interactive)
|
||||
[
|
||||
'html',
|
||||
{
|
||||
outputFolder: 'playwright-report',
|
||||
open: 'never', // Don't auto-open in CI
|
||||
},
|
||||
],
|
||||
|
||||
// JUnit XML (CI integration)
|
||||
[
|
||||
'junit',
|
||||
{
|
||||
outputFile: 'test-results/results.xml',
|
||||
},
|
||||
],
|
||||
|
||||
// List reporter (console output)
|
||||
['list'],
|
||||
],
|
||||
});
|
||||
```
|
||||
|
||||
```typescript
|
||||
// playwright/support/fixtures/artifact-fixture.ts - Custom artifact capture
|
||||
import { test as base } from '@playwright/test';
|
||||
import fs from 'fs';
|
||||
import path from 'path';
|
||||
|
||||
export const test = base.extend({
|
||||
// Auto-capture console logs on failure
|
||||
page: async ({ page }, use, testInfo) => {
|
||||
const logs: string[] = [];
|
||||
|
||||
page.on('console', (msg) => {
|
||||
logs.push(`[${msg.type()}] ${msg.text()}`);
|
||||
});
|
||||
|
||||
await use(page);
|
||||
|
||||
// Save logs on failure
|
||||
if (testInfo.status !== testInfo.expectedStatus) {
|
||||
const logsPath = path.join(testInfo.outputDir, 'console-logs.txt');
|
||||
fs.writeFileSync(logsPath, logs.join('\n'));
|
||||
testInfo.attachments.push({
|
||||
name: 'console-logs',
|
||||
contentType: 'text/plain',
|
||||
path: logsPath,
|
||||
});
|
||||
}
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
```yaml
|
||||
# .github/workflows/e2e.yml - CI artifact upload
|
||||
name: E2E Tests
|
||||
on: [push, pull_request]
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version-file: '.nvmrc'
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Install Playwright browsers
|
||||
run: npx playwright install --with-deps
|
||||
|
||||
- name: Run tests
|
||||
run: npm run test
|
||||
env:
|
||||
TEST_ENV: staging
|
||||
|
||||
# Upload test artifacts on failure
|
||||
- name: Upload test results
|
||||
if: failure()
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: test-results
|
||||
path: test-results/
|
||||
retention-days: 30
|
||||
|
||||
- name: Upload Playwright report
|
||||
if: failure()
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: playwright-report
|
||||
path: playwright-report/
|
||||
retention-days: 30
|
||||
```
|
||||
|
||||
```typescript
|
||||
// Example: Custom screenshot on specific condition
|
||||
test('capture screenshot on specific error', async ({ page }) => {
|
||||
await page.goto('/checkout');
|
||||
|
||||
try {
|
||||
await page.click('[data-testid="submit-payment"]');
|
||||
await expect(page.getByText('Order Confirmed')).toBeVisible();
|
||||
} catch (error) {
|
||||
// Capture custom screenshot with timestamp
|
||||
await page.screenshot({
|
||||
path: `test-results/payment-error-${Date.now()}.png`,
|
||||
fullPage: true,
|
||||
});
|
||||
throw error;
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- `screenshot: 'only-on-failure'` saves space (not every test)
|
||||
- `video: 'retain-on-failure'` captures full flow on failures
|
||||
- `trace: 'on-first-retry'` provides deep debugging data (network, DOM, console)
|
||||
- HTML report at `playwright-report/` (visual debugging)
|
||||
- JUnit XML at `test-results/results.xml` (CI integration)
|
||||
- CI uploads artifacts on failure with 30-day retention
|
||||
- Custom fixture can capture console logs, network logs, etc.
|
||||
|
||||
### Example 4: Parallelization Configuration
|
||||
|
||||
**Context**: When tests run slowly in CI, configure parallelization with worker count, sharding, and fully parallel execution to maximize speed while maintaining stability.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// playwright.config.ts - Parallelization settings
|
||||
import { defineConfig } from '@playwright/test';
|
||||
import os from 'os';
|
||||
|
||||
export default defineConfig({
|
||||
// Run tests in parallel within single file
|
||||
fullyParallel: true,
|
||||
|
||||
// Worker configuration
|
||||
workers: process.env.CI
|
||||
? 1 // Serial in CI for stability (or 2 for faster CI)
|
||||
: os.cpus().length - 1, // Parallel locally (leave 1 CPU for OS)
|
||||
|
||||
// Prevent accidentally committed .only() from blocking CI
|
||||
forbidOnly: !!process.env.CI,
|
||||
|
||||
// Retry failed tests in CI
|
||||
retries: process.env.CI ? 2 : 0,
|
||||
|
||||
// Shard configuration (split tests across multiple machines)
|
||||
shard:
|
||||
process.env.SHARD_INDEX && process.env.SHARD_TOTAL
|
||||
? {
|
||||
current: parseInt(process.env.SHARD_INDEX, 10),
|
||||
total: parseInt(process.env.SHARD_TOTAL, 10),
|
||||
}
|
||||
: undefined,
|
||||
});
|
||||
```
|
||||
|
||||
```yaml
|
||||
# .github/workflows/e2e-parallel.yml - Sharded CI execution
|
||||
name: E2E Tests (Parallel)
|
||||
on: [push, pull_request]
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
shard: [1, 2, 3, 4] # Split tests across 4 machines
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version-file: '.nvmrc'
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Install Playwright browsers
|
||||
run: npx playwright install --with-deps
|
||||
|
||||
- name: Run tests (shard ${{ matrix.shard }})
|
||||
run: npm run test
|
||||
env:
|
||||
SHARD_INDEX: ${{ matrix.shard }}
|
||||
SHARD_TOTAL: 4
|
||||
TEST_ENV: staging
|
||||
|
||||
- name: Upload test results
|
||||
if: failure()
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: test-results-shard-${{ matrix.shard }}
|
||||
path: test-results/
|
||||
```
|
||||
|
||||
```typescript
|
||||
// playwright/config/serial.config.ts - Serial execution for flaky tests
|
||||
import { defineConfig } from '@playwright/test';
|
||||
import { baseConfig } from './base.config';
|
||||
|
||||
export default defineConfig({
|
||||
...baseConfig,
|
||||
|
||||
// Disable parallel execution
|
||||
fullyParallel: false,
|
||||
workers: 1,
|
||||
|
||||
// Used for: authentication flows, database-dependent tests, feature flag tests
|
||||
});
|
||||
```
|
||||
|
||||
```typescript
|
||||
// Usage: Force serial execution for specific tests
|
||||
import { test } from '@playwright/test';
|
||||
|
||||
// Serial execution for auth tests (shared session state)
|
||||
test.describe.configure({ mode: 'serial' });
|
||||
|
||||
test.describe('Authentication Flow', () => {
|
||||
test('user can log in', async ({ page }) => {
|
||||
// First test in serial block
|
||||
});
|
||||
|
||||
test('user can access dashboard', async ({ page }) => {
|
||||
// Depends on previous test (serial)
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
```typescript
|
||||
// Usage: Parallel execution for independent tests (default)
|
||||
import { test } from '@playwright/test';
|
||||
|
||||
test.describe('Product Catalog', () => {
|
||||
test('can view product 1', async ({ page }) => {
|
||||
// Runs in parallel with other tests
|
||||
});
|
||||
|
||||
test('can view product 2', async ({ page }) => {
|
||||
// Runs in parallel with other tests
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- `fullyParallel: true` enables parallel execution within single test file
|
||||
- Workers: 1 in CI (stability), N-1 CPUs locally (speed)
|
||||
- Sharding splits tests across multiple CI machines (4x faster with 4 shards)
|
||||
- `test.describe.configure({ mode: 'serial' })` for dependent tests
|
||||
- `forbidOnly: true` in CI prevents `.only()` from blocking pipeline
|
||||
- Matrix strategy in CI runs shards concurrently
|
||||
|
||||
### Example 5: Project Configuration
|
||||
|
||||
**Context**: When testing across multiple browsers, devices, or configurations, use Playwright projects to run the same tests against different environments (chromium, firefox, webkit, mobile).
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// playwright.config.ts - Multiple browser projects
|
||||
import { defineConfig, devices } from '@playwright/test';
|
||||
|
||||
export default defineConfig({
|
||||
projects: [
|
||||
// Desktop browsers
|
||||
{
|
||||
name: 'chromium',
|
||||
use: { ...devices['Desktop Chrome'] },
|
||||
},
|
||||
{
|
||||
name: 'firefox',
|
||||
use: { ...devices['Desktop Firefox'] },
|
||||
},
|
||||
{
|
||||
name: 'webkit',
|
||||
use: { ...devices['Desktop Safari'] },
|
||||
},
|
||||
|
||||
// Mobile browsers
|
||||
{
|
||||
name: 'mobile-chrome',
|
||||
use: { ...devices['Pixel 5'] },
|
||||
},
|
||||
{
|
||||
name: 'mobile-safari',
|
||||
use: { ...devices['iPhone 13'] },
|
||||
},
|
||||
|
||||
// Tablet
|
||||
{
|
||||
name: 'tablet',
|
||||
use: { ...devices['iPad Pro'] },
|
||||
},
|
||||
],
|
||||
});
|
||||
```
|
||||
|
||||
```typescript
|
||||
// playwright.config.ts - Authenticated vs. unauthenticated projects
|
||||
import { defineConfig } from '@playwright/test';
|
||||
import path from 'path';
|
||||
|
||||
export default defineConfig({
|
||||
projects: [
|
||||
// Setup project (runs first, creates auth state)
|
||||
{
|
||||
name: 'setup',
|
||||
testMatch: /global-setup\.ts/,
|
||||
},
|
||||
|
||||
// Authenticated tests (reuse auth state)
|
||||
{
|
||||
name: 'authenticated',
|
||||
dependencies: ['setup'],
|
||||
use: {
|
||||
storageState: path.resolve(__dirname, './playwright/.auth/user.json'),
|
||||
},
|
||||
testMatch: /.*authenticated\.spec\.ts/,
|
||||
},
|
||||
|
||||
// Unauthenticated tests (public pages)
|
||||
{
|
||||
name: 'unauthenticated',
|
||||
testMatch: /.*unauthenticated\.spec\.ts/,
|
||||
},
|
||||
],
|
||||
});
|
||||
```
|
||||
|
||||
```typescript
|
||||
// playwright/support/global-setup.ts - Setup project for auth
|
||||
import { chromium, FullConfig } from '@playwright/test';
|
||||
import path from 'path';
|
||||
|
||||
async function globalSetup(config: FullConfig) {
|
||||
const browser = await chromium.launch();
|
||||
const page = await browser.newPage();
|
||||
|
||||
// Perform authentication
|
||||
await page.goto('http://localhost:3000/login');
|
||||
await page.fill('[data-testid="email"]', 'test@example.com');
|
||||
await page.fill('[data-testid="password"]', 'password123');
|
||||
await page.click('[data-testid="login-button"]');
|
||||
|
||||
// Wait for authentication to complete
|
||||
await page.waitForURL('**/dashboard');
|
||||
|
||||
// Save authentication state
|
||||
await page.context().storageState({
|
||||
path: path.resolve(__dirname, '../.auth/user.json'),
|
||||
});
|
||||
|
||||
await browser.close();
|
||||
}
|
||||
|
||||
export default globalSetup;
|
||||
```
|
||||
|
||||
```bash
|
||||
# Run specific project
|
||||
npx playwright test --project=chromium
|
||||
npx playwright test --project=mobile-chrome
|
||||
npx playwright test --project=authenticated
|
||||
|
||||
# Run multiple projects
|
||||
npx playwright test --project=chromium --project=firefox
|
||||
|
||||
# Run all projects (default)
|
||||
npx playwright test
|
||||
```
|
||||
|
||||
```typescript
|
||||
// Usage: Project-specific test
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
test('mobile navigation works', async ({ page, isMobile }) => {
|
||||
await page.goto('/');
|
||||
|
||||
if (isMobile) {
|
||||
// Open mobile menu
|
||||
await page.click('[data-testid="hamburger-menu"]');
|
||||
}
|
||||
|
||||
await page.click('[data-testid="products-link"]');
|
||||
await expect(page).toHaveURL(/.*products/);
|
||||
});
|
||||
```
|
||||
|
||||
```yaml
|
||||
# .github/workflows/e2e-cross-browser.yml - CI cross-browser testing
|
||||
name: E2E Tests (Cross-Browser)
|
||||
on: [push, pull_request]
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
project: [chromium, firefox, webkit, mobile-chrome]
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-node@v4
|
||||
- run: npm ci
|
||||
- run: npx playwright install --with-deps
|
||||
|
||||
- name: Run tests (${{ matrix.project }})
|
||||
run: npx playwright test --project=${{ matrix.project }}
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Projects enable testing across browsers, devices, and configurations
|
||||
- `devices` from `@playwright/test` provide preset configurations (Pixel 5, iPhone 13, etc.)
|
||||
- `dependencies` ensures setup project runs first (auth, data seeding)
|
||||
- `storageState` shares authentication across tests (0 seconds auth per test)
|
||||
- `testMatch` filters which tests run in which project
|
||||
- CI matrix strategy runs projects in parallel (4x faster with 4 projects)
|
||||
- `isMobile` context property for conditional logic in tests
|
||||
|
||||
## Integration Points
|
||||
|
||||
- **Used in workflows**: `*framework` (config setup), `*ci` (parallelization, artifact upload)
|
||||
- **Related fragments**:
|
||||
- `fixture-architecture.md` - Fixture-based timeout overrides
|
||||
- `ci-burn-in.md` - CI pipeline artifact upload
|
||||
- `test-quality.md` - Timeout standards (no hard waits)
|
||||
- `data-factories.md` - Per-test isolation (no shared global state)
|
||||
|
||||
## Configuration Checklist
|
||||
|
||||
**Before deploying tests, verify**:
|
||||
|
||||
- [ ] Environment config map with fail-fast validation
|
||||
- [ ] Standardized timeouts (action 15s, navigation 30s, expect 10s, test 60s)
|
||||
- [ ] Artifact storage at `test-results/` and `playwright-report/`
|
||||
- [ ] HTML + JUnit reporters configured
|
||||
- [ ] `.env.example`, `.nvmrc`, browser versions committed
|
||||
- [ ] Parallelization configured (workers, sharding)
|
||||
- [ ] Projects defined for cross-browser/device testing (if needed)
|
||||
- [ ] CI uploads artifacts on failure with 30-day retention
|
||||
|
||||
_Source: Playwright book repo, SEON configuration example, Murat testing philosophy (lines 216-271)._
|
||||
@ -1,601 +0,0 @@
|
||||
# Probability and Impact Scale
|
||||
|
||||
## Principle
|
||||
|
||||
Risk scoring uses a **probability × impact** matrix (1-9 scale) to prioritize testing efforts. Higher scores (6-9) demand immediate action; lower scores (1-3) require documentation only. This systematic approach ensures testing resources focus on the highest-value risks.
|
||||
|
||||
## Rationale
|
||||
|
||||
**The Problem**: Without quantifiable risk assessment, teams over-test low-value scenarios while missing critical risks. Gut feeling leads to inconsistent prioritization and missed edge cases.
|
||||
|
||||
**The Solution**: Standardize risk evaluation with a 3×3 matrix (probability: 1-3, impact: 1-3). Multiply to derive risk score (1-9). Automate classification (DOCUMENT, MONITOR, MITIGATE, BLOCK) based on thresholds. This approach surfaces hidden risks early and justifies testing decisions to stakeholders.
|
||||
|
||||
**Why This Matters**:
|
||||
|
||||
- Consistent risk language across product, engineering, and QA
|
||||
- Objective prioritization of test scenarios (not politics)
|
||||
- Automatic gate decisions (score=9 → FAIL until resolved)
|
||||
- Audit trail for compliance and retrospectives
|
||||
|
||||
## Pattern Examples
|
||||
|
||||
### Example 1: Probability-Impact Matrix Implementation (Automated Classification)
|
||||
|
||||
**Context**: Implement a reusable risk scoring system with automatic threshold classification
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// src/testing/risk-matrix.ts
|
||||
|
||||
/**
|
||||
* Probability levels:
|
||||
* 1 = Unlikely (standard implementation, low uncertainty)
|
||||
* 2 = Possible (edge cases or partial unknowns)
|
||||
* 3 = Likely (known issues, new integrations, high ambiguity)
|
||||
*/
|
||||
export type Probability = 1 | 2 | 3;
|
||||
|
||||
/**
|
||||
* Impact levels:
|
||||
* 1 = Minor (cosmetic issues or easy workarounds)
|
||||
* 2 = Degraded (partial feature loss or manual workaround)
|
||||
* 3 = Critical (blockers, data/security/regulatory exposure)
|
||||
*/
|
||||
export type Impact = 1 | 2 | 3;
|
||||
|
||||
/**
|
||||
* Risk score (probability × impact): 1-9
|
||||
*/
|
||||
export type RiskScore = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
|
||||
|
||||
/**
|
||||
* Action categories based on risk score thresholds
|
||||
*/
|
||||
export type RiskAction = 'DOCUMENT' | 'MONITOR' | 'MITIGATE' | 'BLOCK';
|
||||
|
||||
export type RiskAssessment = {
|
||||
probability: Probability;
|
||||
impact: Impact;
|
||||
score: RiskScore;
|
||||
action: RiskAction;
|
||||
reasoning: string;
|
||||
};
|
||||
|
||||
/**
|
||||
* Calculate risk score: probability × impact
|
||||
*/
|
||||
export function calculateRiskScore(probability: Probability, impact: Impact): RiskScore {
|
||||
return (probability * impact) as RiskScore;
|
||||
}
|
||||
|
||||
/**
|
||||
* Classify risk action based on score thresholds:
|
||||
* - 1-3: DOCUMENT (awareness only)
|
||||
* - 4-5: MONITOR (watch closely, plan mitigations)
|
||||
* - 6-8: MITIGATE (CONCERNS at gate until mitigated)
|
||||
* - 9: BLOCK (automatic FAIL until resolved or waived)
|
||||
*/
|
||||
export function classifyRiskAction(score: RiskScore): RiskAction {
|
||||
if (score >= 9) return 'BLOCK';
|
||||
if (score >= 6) return 'MITIGATE';
|
||||
if (score >= 4) return 'MONITOR';
|
||||
return 'DOCUMENT';
|
||||
}
|
||||
|
||||
/**
|
||||
* Full risk assessment with automatic classification
|
||||
*/
|
||||
export function assessRisk(params: { probability: Probability; impact: Impact; reasoning: string }): RiskAssessment {
|
||||
const { probability, impact, reasoning } = params;
|
||||
|
||||
const score = calculateRiskScore(probability, impact);
|
||||
const action = classifyRiskAction(score);
|
||||
|
||||
return { probability, impact, score, action, reasoning };
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate risk matrix visualization (3x3 grid)
|
||||
* Returns markdown table with color-coded scores
|
||||
*/
|
||||
export function generateRiskMatrix(): string {
|
||||
const matrix: string[][] = [];
|
||||
const header = ['Impact \\ Probability', 'Unlikely (1)', 'Possible (2)', 'Likely (3)'];
|
||||
matrix.push(header);
|
||||
|
||||
const impactLabels = ['Critical (3)', 'Degraded (2)', 'Minor (1)'];
|
||||
for (let impact = 3; impact >= 1; impact--) {
|
||||
const row = [impactLabels[3 - impact]];
|
||||
for (let probability = 1; probability <= 3; probability++) {
|
||||
const score = calculateRiskScore(probability as Probability, impact as Impact);
|
||||
const action = classifyRiskAction(score);
|
||||
const emoji = action === 'BLOCK' ? '🔴' : action === 'MITIGATE' ? '🟠' : action === 'MONITOR' ? '🟡' : '🟢';
|
||||
row.push(`${emoji} ${score}`);
|
||||
}
|
||||
matrix.push(row);
|
||||
}
|
||||
|
||||
return matrix.map((row) => `| ${row.join(' | ')} |`).join('\n');
|
||||
}
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Type-safe probability/impact (1-3 enforced at compile time)
|
||||
- Automatic action classification (DOCUMENT, MONITOR, MITIGATE, BLOCK)
|
||||
- Visual matrix generation for documentation
|
||||
- Risk score formula: `probability * impact` (max = 9)
|
||||
- Threshold-based decision rules (6-8 = MITIGATE, 9 = BLOCK)
|
||||
|
||||
---
|
||||
|
||||
### Example 2: Risk Assessment Workflow (Test Planning Integration)
|
||||
|
||||
**Context**: Apply risk matrix during test design to prioritize scenarios
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/e2e/test-planning/risk-assessment.ts
|
||||
import { assessRisk, generateRiskMatrix, type RiskAssessment } from '../../../src/testing/risk-matrix';
|
||||
|
||||
export type TestScenario = {
|
||||
id: string;
|
||||
title: string;
|
||||
feature: string;
|
||||
risk: RiskAssessment;
|
||||
testLevel: 'E2E' | 'API' | 'Unit';
|
||||
priority: 'P0' | 'P1' | 'P2' | 'P3';
|
||||
owner: string;
|
||||
};
|
||||
|
||||
/**
|
||||
* Assess test scenarios and auto-assign priority based on risk score
|
||||
*/
|
||||
export function assessTestScenarios(scenarios: Omit<TestScenario, 'risk' | 'priority'>[]): TestScenario[] {
|
||||
return scenarios.map((scenario) => {
|
||||
// Auto-assign priority based on risk score
|
||||
const priority = mapRiskToPriority(scenario.risk.score);
|
||||
return { ...scenario, priority };
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Map risk score to test priority (P0-P3)
|
||||
* P0: Critical (score 9) - blocks release
|
||||
* P1: High (score 6-8) - must fix before release
|
||||
* P2: Medium (score 4-5) - fix if time permits
|
||||
* P3: Low (score 1-3) - document and defer
|
||||
*/
|
||||
function mapRiskToPriority(score: number): 'P0' | 'P1' | 'P2' | 'P3' {
|
||||
if (score === 9) return 'P0';
|
||||
if (score >= 6) return 'P1';
|
||||
if (score >= 4) return 'P2';
|
||||
return 'P3';
|
||||
}
|
||||
|
||||
/**
|
||||
* Example: Payment flow risk assessment
|
||||
*/
|
||||
export const paymentScenarios: Array<Omit<TestScenario, 'priority'>> = [
|
||||
{
|
||||
id: 'PAY-001',
|
||||
title: 'Valid credit card payment completes successfully',
|
||||
feature: 'Checkout',
|
||||
risk: assessRisk({
|
||||
probability: 2, // Possible (standard Stripe integration)
|
||||
impact: 3, // Critical (revenue loss if broken)
|
||||
reasoning: 'Core revenue flow, but Stripe is well-tested',
|
||||
}),
|
||||
testLevel: 'E2E',
|
||||
owner: 'qa-team',
|
||||
},
|
||||
{
|
||||
id: 'PAY-002',
|
||||
title: 'Expired credit card shows user-friendly error',
|
||||
feature: 'Checkout',
|
||||
risk: assessRisk({
|
||||
probability: 3, // Likely (edge case handling often buggy)
|
||||
impact: 2, // Degraded (users see error, but can retry)
|
||||
reasoning: 'Error handling logic is custom and complex',
|
||||
}),
|
||||
testLevel: 'E2E',
|
||||
owner: 'qa-team',
|
||||
},
|
||||
{
|
||||
id: 'PAY-003',
|
||||
title: 'Payment confirmation email formatting is correct',
|
||||
feature: 'Email',
|
||||
risk: assessRisk({
|
||||
probability: 2, // Possible (template changes occasionally break)
|
||||
impact: 1, // Minor (cosmetic issue, email still sent)
|
||||
reasoning: 'Non-blocking, users get email regardless',
|
||||
}),
|
||||
testLevel: 'Unit',
|
||||
owner: 'dev-team',
|
||||
},
|
||||
{
|
||||
id: 'PAY-004',
|
||||
title: 'Payment fails gracefully when Stripe is down',
|
||||
feature: 'Checkout',
|
||||
risk: assessRisk({
|
||||
probability: 1, // Unlikely (Stripe has 99.99% uptime)
|
||||
impact: 3, // Critical (complete checkout failure)
|
||||
reasoning: 'Rare but catastrophic, requires retry mechanism',
|
||||
}),
|
||||
testLevel: 'API',
|
||||
owner: 'qa-team',
|
||||
},
|
||||
];
|
||||
|
||||
/**
|
||||
* Generate risk assessment report with priority distribution
|
||||
*/
|
||||
export function generateRiskReport(scenarios: TestScenario[]): string {
|
||||
const priorityCounts = scenarios.reduce(
|
||||
(acc, s) => {
|
||||
acc[s.priority] = (acc[s.priority] || 0) + 1;
|
||||
return acc;
|
||||
},
|
||||
{} as Record<string, number>,
|
||||
);
|
||||
|
||||
const actionCounts = scenarios.reduce(
|
||||
(acc, s) => {
|
||||
acc[s.risk.action] = (acc[s.risk.action] || 0) + 1;
|
||||
return acc;
|
||||
},
|
||||
{} as Record<string, number>,
|
||||
);
|
||||
|
||||
return `
|
||||
# Risk Assessment Report
|
||||
|
||||
## Risk Matrix
|
||||
${generateRiskMatrix()}
|
||||
|
||||
## Priority Distribution
|
||||
- **P0 (Blocker)**: ${priorityCounts.P0 || 0} scenarios
|
||||
- **P1 (High)**: ${priorityCounts.P1 || 0} scenarios
|
||||
- **P2 (Medium)**: ${priorityCounts.P2 || 0} scenarios
|
||||
- **P3 (Low)**: ${priorityCounts.P3 || 0} scenarios
|
||||
|
||||
## Action Required
|
||||
- **BLOCK**: ${actionCounts.BLOCK || 0} scenarios (auto-fail gate)
|
||||
- **MITIGATE**: ${actionCounts.MITIGATE || 0} scenarios (concerns at gate)
|
||||
- **MONITOR**: ${actionCounts.MONITOR || 0} scenarios (watch closely)
|
||||
- **DOCUMENT**: ${actionCounts.DOCUMENT || 0} scenarios (awareness only)
|
||||
|
||||
## Scenarios by Risk Score (Highest First)
|
||||
${scenarios
|
||||
.sort((a, b) => b.risk.score - a.risk.score)
|
||||
.map((s) => `- **[${s.priority}]** ${s.id}: ${s.title} (Score: ${s.risk.score} - ${s.risk.action})`)
|
||||
.join('\n')}
|
||||
`.trim();
|
||||
}
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Risk score → Priority mapping (P0-P3 automated)
|
||||
- Report generation with priority/action distribution
|
||||
- Scenarios sorted by risk score (highest first)
|
||||
- Visual matrix included in reports
|
||||
- Reusable across projects (extract to shared library)
|
||||
|
||||
---
|
||||
|
||||
### Example 3: Dynamic Risk Re-Assessment (Continuous Evaluation)
|
||||
|
||||
**Context**: Recalculate risk scores as project evolves (requirements change, mitigations implemented)
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// src/testing/risk-tracking.ts
|
||||
import { type RiskAssessment, assessRisk, type Probability, type Impact } from './risk-matrix';
|
||||
|
||||
export type RiskHistory = {
|
||||
timestamp: Date;
|
||||
assessment: RiskAssessment;
|
||||
changedBy: string;
|
||||
reason: string;
|
||||
};
|
||||
|
||||
export type TrackedRisk = {
|
||||
id: string;
|
||||
title: string;
|
||||
feature: string;
|
||||
currentRisk: RiskAssessment;
|
||||
history: RiskHistory[];
|
||||
mitigations: string[];
|
||||
status: 'OPEN' | 'MITIGATED' | 'WAIVED' | 'RESOLVED';
|
||||
};
|
||||
|
||||
export class RiskTracker {
|
||||
private risks: Map<string, TrackedRisk> = new Map();
|
||||
|
||||
/**
|
||||
* Add new risk to tracker
|
||||
*/
|
||||
addRisk(params: {
|
||||
id: string;
|
||||
title: string;
|
||||
feature: string;
|
||||
probability: Probability;
|
||||
impact: Impact;
|
||||
reasoning: string;
|
||||
changedBy: string;
|
||||
}): TrackedRisk {
|
||||
const { id, title, feature, probability, impact, reasoning, changedBy } = params;
|
||||
|
||||
const assessment = assessRisk({ probability, impact, reasoning });
|
||||
|
||||
const risk: TrackedRisk = {
|
||||
id,
|
||||
title,
|
||||
feature,
|
||||
currentRisk: assessment,
|
||||
history: [
|
||||
{
|
||||
timestamp: new Date(),
|
||||
assessment,
|
||||
changedBy,
|
||||
reason: 'Initial assessment',
|
||||
},
|
||||
],
|
||||
mitigations: [],
|
||||
status: 'OPEN',
|
||||
};
|
||||
|
||||
this.risks.set(id, risk);
|
||||
return risk;
|
||||
}
|
||||
|
||||
/**
|
||||
* Reassess risk (probability or impact changed)
|
||||
*/
|
||||
reassessRisk(params: {
|
||||
id: string;
|
||||
probability?: Probability;
|
||||
impact?: Impact;
|
||||
reasoning: string;
|
||||
changedBy: string;
|
||||
}): TrackedRisk | null {
|
||||
const { id, probability, impact, reasoning, changedBy } = params;
|
||||
const risk = this.risks.get(id);
|
||||
if (!risk) return null;
|
||||
|
||||
// Use existing values if not provided
|
||||
const newProbability = probability ?? risk.currentRisk.probability;
|
||||
const newImpact = impact ?? risk.currentRisk.impact;
|
||||
|
||||
const newAssessment = assessRisk({
|
||||
probability: newProbability,
|
||||
impact: newImpact,
|
||||
reasoning,
|
||||
});
|
||||
|
||||
risk.currentRisk = newAssessment;
|
||||
risk.history.push({
|
||||
timestamp: new Date(),
|
||||
assessment: newAssessment,
|
||||
changedBy,
|
||||
reason: reasoning,
|
||||
});
|
||||
|
||||
this.risks.set(id, risk);
|
||||
return risk;
|
||||
}
|
||||
|
||||
/**
|
||||
* Mark risk as mitigated (probability reduced)
|
||||
*/
|
||||
mitigateRisk(params: { id: string; newProbability: Probability; mitigation: string; changedBy: string }): TrackedRisk | null {
|
||||
const { id, newProbability, mitigation, changedBy } = params;
|
||||
const risk = this.reassessRisk({
|
||||
id,
|
||||
probability: newProbability,
|
||||
reasoning: `Mitigation implemented: ${mitigation}`,
|
||||
changedBy,
|
||||
});
|
||||
|
||||
if (risk) {
|
||||
risk.mitigations.push(mitigation);
|
||||
if (risk.currentRisk.action === 'DOCUMENT' || risk.currentRisk.action === 'MONITOR') {
|
||||
risk.status = 'MITIGATED';
|
||||
}
|
||||
}
|
||||
|
||||
return risk;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get risks requiring action (MITIGATE or BLOCK)
|
||||
*/
|
||||
getRisksRequiringAction(): TrackedRisk[] {
|
||||
return Array.from(this.risks.values()).filter(
|
||||
(r) => r.status === 'OPEN' && (r.currentRisk.action === 'MITIGATE' || r.currentRisk.action === 'BLOCK'),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate risk trend report (show changes over time)
|
||||
*/
|
||||
generateTrendReport(riskId: string): string | null {
|
||||
const risk = this.risks.get(riskId);
|
||||
if (!risk) return null;
|
||||
|
||||
return `
|
||||
# Risk Trend Report: ${risk.id}
|
||||
|
||||
**Title**: ${risk.title}
|
||||
**Feature**: ${risk.feature}
|
||||
**Status**: ${risk.status}
|
||||
|
||||
## Current Assessment
|
||||
- **Probability**: ${risk.currentRisk.probability}
|
||||
- **Impact**: ${risk.currentRisk.impact}
|
||||
- **Score**: ${risk.currentRisk.score}
|
||||
- **Action**: ${risk.currentRisk.action}
|
||||
- **Reasoning**: ${risk.currentRisk.reasoning}
|
||||
|
||||
## Mitigations Applied
|
||||
${risk.mitigations.length > 0 ? risk.mitigations.map((m) => `- ${m}`).join('\n') : '- None'}
|
||||
|
||||
## History (${risk.history.length} changes)
|
||||
${risk.history
|
||||
.reverse()
|
||||
.map((h) => `- **${h.timestamp.toISOString()}** by ${h.changedBy}: Score ${h.assessment.score} (${h.assessment.action}) - ${h.reason}`)
|
||||
.join('\n')}
|
||||
`.trim();
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Historical tracking (audit trail for risk changes)
|
||||
- Mitigation impact tracking (probability reduction)
|
||||
- Status lifecycle (OPEN → MITIGATED → RESOLVED)
|
||||
- Trend reports (show risk evolution over time)
|
||||
- Re-assessment triggers (requirements change, new info)
|
||||
|
||||
---
|
||||
|
||||
### Example 4: Risk Matrix in Gate Decision (Integration with Trace Workflow)
|
||||
|
||||
**Context**: Use probability-impact scores to drive gate decisions (PASS/CONCERNS/FAIL/WAIVED)
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// src/testing/gate-decision.ts
|
||||
import { type RiskScore, classifyRiskAction, type RiskAction } from './risk-matrix';
|
||||
import { type TrackedRisk } from './risk-tracking';
|
||||
|
||||
export type GateDecision = 'PASS' | 'CONCERNS' | 'FAIL' | 'WAIVED';
|
||||
|
||||
export type GateResult = {
|
||||
decision: GateDecision;
|
||||
blockers: TrackedRisk[]; // Score=9, action=BLOCK
|
||||
concerns: TrackedRisk[]; // Score 6-8, action=MITIGATE
|
||||
monitored: TrackedRisk[]; // Score 4-5, action=MONITOR
|
||||
documented: TrackedRisk[]; // Score 1-3, action=DOCUMENT
|
||||
summary: string;
|
||||
};
|
||||
|
||||
/**
|
||||
* Evaluate gate based on risk assessments
|
||||
*/
|
||||
export function evaluateGateFromRisks(risks: TrackedRisk[]): GateResult {
|
||||
const blockers = risks.filter((r) => r.currentRisk.action === 'BLOCK' && r.status === 'OPEN');
|
||||
const concerns = risks.filter((r) => r.currentRisk.action === 'MITIGATE' && r.status === 'OPEN');
|
||||
const monitored = risks.filter((r) => r.currentRisk.action === 'MONITOR');
|
||||
const documented = risks.filter((r) => r.currentRisk.action === 'DOCUMENT');
|
||||
|
||||
let decision: GateDecision;
|
||||
|
||||
if (blockers.length > 0) {
|
||||
decision = 'FAIL';
|
||||
} else if (concerns.length > 0) {
|
||||
decision = 'CONCERNS';
|
||||
} else {
|
||||
decision = 'PASS';
|
||||
}
|
||||
|
||||
const summary = generateGateSummary({ decision, blockers, concerns, monitored, documented });
|
||||
|
||||
return { decision, blockers, concerns, monitored, documented, summary };
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate gate decision summary
|
||||
*/
|
||||
function generateGateSummary(result: Omit<GateResult, 'summary'>): string {
|
||||
const { decision, blockers, concerns, monitored, documented } = result;
|
||||
|
||||
const lines: string[] = [`## Gate Decision: ${decision}`];
|
||||
|
||||
if (decision === 'FAIL') {
|
||||
lines.push(`\n**Blockers** (${blockers.length}): Automatic FAIL until resolved or waived`);
|
||||
blockers.forEach((r) => {
|
||||
lines.push(`- **${r.id}**: ${r.title} (Score: ${r.currentRisk.score})`);
|
||||
lines.push(` - Probability: ${r.currentRisk.probability}, Impact: ${r.currentRisk.impact}`);
|
||||
lines.push(` - Reasoning: ${r.currentRisk.reasoning}`);
|
||||
});
|
||||
}
|
||||
|
||||
if (concerns.length > 0) {
|
||||
lines.push(`\n**Concerns** (${concerns.length}): Address before release`);
|
||||
concerns.forEach((r) => {
|
||||
lines.push(`- **${r.id}**: ${r.title} (Score: ${r.currentRisk.score})`);
|
||||
lines.push(` - Mitigations: ${r.mitigations.join(', ') || 'None'}`);
|
||||
});
|
||||
}
|
||||
|
||||
if (monitored.length > 0) {
|
||||
lines.push(`\n**Monitored** (${monitored.length}): Watch closely`);
|
||||
monitored.forEach((r) => lines.push(`- **${r.id}**: ${r.title} (Score: ${r.currentRisk.score})`));
|
||||
}
|
||||
|
||||
if (documented.length > 0) {
|
||||
lines.push(`\n**Documented** (${documented.length}): Awareness only`);
|
||||
}
|
||||
|
||||
lines.push(`\n---\n`);
|
||||
lines.push(`**Next Steps**:`);
|
||||
if (decision === 'FAIL') {
|
||||
lines.push(`- Resolve blockers or request formal waiver`);
|
||||
} else if (decision === 'CONCERNS') {
|
||||
lines.push(`- Implement mitigations for high-risk scenarios (score 6-8)`);
|
||||
lines.push(`- Re-run gate after mitigations`);
|
||||
} else {
|
||||
lines.push(`- Proceed with release`);
|
||||
}
|
||||
|
||||
return lines.join('\n');
|
||||
}
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Gate decision driven by risk scores (not gut feeling)
|
||||
- Automatic FAIL for score=9 (blockers)
|
||||
- CONCERNS for score 6-8 (requires mitigation)
|
||||
- PASS only when no blockers/concerns
|
||||
- Actionable summary with next steps
|
||||
- Integration with trace workflow (Phase 2)
|
||||
|
||||
---
|
||||
|
||||
## Probability-Impact Threshold Summary
|
||||
|
||||
| Score | Action | Gate Impact | Typical Use Case |
|
||||
| ----- | -------- | -------------------- | -------------------------------------- |
|
||||
| 1-3 | DOCUMENT | None | Cosmetic issues, low-priority bugs |
|
||||
| 4-5 | MONITOR | None (watch closely) | Edge cases, partial unknowns |
|
||||
| 6-8 | MITIGATE | CONCERNS at gate | High-impact scenarios needing coverage |
|
||||
| 9 | BLOCK | Automatic FAIL | Critical blockers, must resolve |
|
||||
|
||||
## Risk Assessment Checklist
|
||||
|
||||
Before deploying risk matrix:
|
||||
|
||||
- [ ] **Probability scale defined**: 1 (unlikely), 2 (possible), 3 (likely) with clear examples
|
||||
- [ ] **Impact scale defined**: 1 (minor), 2 (degraded), 3 (critical) with concrete criteria
|
||||
- [ ] **Threshold rules documented**: Score → Action mapping (1-3 = DOCUMENT, 4-5 = MONITOR, 6-8 = MITIGATE, 9 = BLOCK)
|
||||
- [ ] **Gate integration**: Risk scores drive gate decisions (PASS/CONCERNS/FAIL/WAIVED)
|
||||
- [ ] **Re-assessment process**: Risks re-evaluated as project evolves (requirements change, mitigations applied)
|
||||
- [ ] **Audit trail**: Historical tracking for risk changes (who, when, why)
|
||||
- [ ] **Mitigation tracking**: Link mitigations to probability reduction (quantify impact)
|
||||
- [ ] **Reporting**: Risk matrix visualization, trend reports, gate summaries
|
||||
|
||||
## Integration Points
|
||||
|
||||
- **Used in workflows**: `*test-design` (initial risk assessment), `*trace` (gate decision Phase 2), `*nfr-assess` (security/performance risks)
|
||||
- **Related fragments**: `risk-governance.md` (risk scoring matrix, gate decision engine), `test-priorities-matrix.md` (P0-P3 mapping), `nfr-criteria.md` (impact assessment for NFRs)
|
||||
- **Tools**: TypeScript for type safety, markdown for reports, version control for audit trail
|
||||
|
||||
_Source: Murat risk model summary, gate decision patterns from production systems, probability-impact matrix from risk governance practices_
|
||||
@ -1,615 +0,0 @@
|
||||
# Risk Governance and Gatekeeping
|
||||
|
||||
## Principle
|
||||
|
||||
Risk governance transforms subjective "should we ship?" debates into objective, data-driven decisions. By scoring risk (probability × impact), classifying by category (TECH, SEC, PERF, etc.), and tracking mitigation ownership, teams create transparent quality gates that balance speed with safety.
|
||||
|
||||
## Rationale
|
||||
|
||||
**The Problem**: Without formal risk governance, releases become political—loud voices win, quiet risks hide, and teams discover critical issues in production. "We thought it was fine" isn't a release strategy.
|
||||
|
||||
**The Solution**: Risk scoring (1-3 scale for probability and impact, total 1-9) creates shared language. Scores ≥6 demand documented mitigation. Scores = 9 mandate gate failure. Every acceptance criterion maps to a test, and gaps require explicit waivers with owners and expiry dates.
|
||||
|
||||
**Why This Matters**:
|
||||
|
||||
- Removes ambiguity from release decisions (objective scores vs subjective opinions)
|
||||
- Creates audit trail for compliance (FDA, SOC2, ISO require documented risk management)
|
||||
- Identifies true blockers early (prevents last-minute production fires)
|
||||
- Distributes responsibility (owners, mitigation plans, deadlines for every risk >4)
|
||||
|
||||
## Pattern Examples
|
||||
|
||||
### Example 1: Risk Scoring Matrix with Automated Classification (TypeScript)
|
||||
|
||||
**Context**: Calculate risk scores automatically from test results and categorize by risk type
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// risk-scoring.ts - Risk classification and scoring system
|
||||
export const RISK_CATEGORIES = {
|
||||
TECH: 'TECH', // Technical debt, architecture fragility
|
||||
SEC: 'SEC', // Security vulnerabilities
|
||||
PERF: 'PERF', // Performance degradation
|
||||
DATA: 'DATA', // Data integrity, corruption
|
||||
BUS: 'BUS', // Business logic errors
|
||||
OPS: 'OPS', // Operational issues (deployment, monitoring)
|
||||
} as const;
|
||||
|
||||
export type RiskCategory = keyof typeof RISK_CATEGORIES;
|
||||
|
||||
export type RiskScore = {
|
||||
id: string;
|
||||
category: RiskCategory;
|
||||
title: string;
|
||||
description: string;
|
||||
probability: 1 | 2 | 3; // 1=Low, 2=Medium, 3=High
|
||||
impact: 1 | 2 | 3; // 1=Low, 2=Medium, 3=High
|
||||
score: number; // probability × impact (1-9)
|
||||
owner: string;
|
||||
mitigationPlan?: string;
|
||||
deadline?: Date;
|
||||
status: 'OPEN' | 'MITIGATED' | 'WAIVED' | 'ACCEPTED';
|
||||
waiverReason?: string;
|
||||
waiverApprover?: string;
|
||||
waiverExpiry?: Date;
|
||||
};
|
||||
|
||||
// Risk scoring rules
|
||||
export function calculateRiskScore(probability: 1 | 2 | 3, impact: 1 | 2 | 3): number {
|
||||
return probability * impact;
|
||||
}
|
||||
|
||||
export function requiresMitigation(score: number): boolean {
|
||||
return score >= 6; // Scores 6-9 demand action
|
||||
}
|
||||
|
||||
export function isCriticalBlocker(score: number): boolean {
|
||||
return score === 9; // Probability=3 AND Impact=3 → FAIL gate
|
||||
}
|
||||
|
||||
export function classifyRiskLevel(score: number): 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL' {
|
||||
if (score === 9) return 'CRITICAL';
|
||||
if (score >= 6) return 'HIGH';
|
||||
if (score >= 4) return 'MEDIUM';
|
||||
return 'LOW';
|
||||
}
|
||||
|
||||
// Example: Risk assessment from test failures
|
||||
export function assessTestFailureRisk(failure: {
|
||||
test: string;
|
||||
category: RiskCategory;
|
||||
affectedUsers: number;
|
||||
revenueImpact: number;
|
||||
securityVulnerability: boolean;
|
||||
}): RiskScore {
|
||||
// Probability based on test failure frequency (simplified)
|
||||
const probability: 1 | 2 | 3 = 3; // Test failed = High probability
|
||||
|
||||
// Impact based on business context
|
||||
let impact: 1 | 2 | 3 = 1;
|
||||
if (failure.securityVulnerability) impact = 3;
|
||||
else if (failure.revenueImpact > 10000) impact = 3;
|
||||
else if (failure.affectedUsers > 1000) impact = 2;
|
||||
else impact = 1;
|
||||
|
||||
const score = calculateRiskScore(probability, impact);
|
||||
|
||||
return {
|
||||
id: `risk-${Date.now()}`,
|
||||
category: failure.category,
|
||||
title: `Test failure: ${failure.test}`,
|
||||
description: `Affects ${failure.affectedUsers} users, $${failure.revenueImpact} revenue`,
|
||||
probability,
|
||||
impact,
|
||||
score,
|
||||
owner: 'unassigned',
|
||||
status: score === 9 ? 'OPEN' : 'OPEN',
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Objective scoring**: Probability (1-3) × Impact (1-3) = Score (1-9)
|
||||
- **Clear thresholds**: Score ≥6 requires mitigation, score = 9 blocks release
|
||||
- **Business context**: Revenue, users, security drive impact calculation
|
||||
- **Status tracking**: OPEN → MITIGATED → WAIVED → ACCEPTED lifecycle
|
||||
|
||||
---
|
||||
|
||||
### Example 2: Gate Decision Engine with Traceability Validation
|
||||
|
||||
**Context**: Automated gate decision based on risk scores and test coverage
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// gate-decision-engine.ts
|
||||
export type GateDecision = 'PASS' | 'CONCERNS' | 'FAIL' | 'WAIVED';
|
||||
|
||||
export type CoverageGap = {
|
||||
acceptanceCriteria: string;
|
||||
testMissing: string;
|
||||
reason: string;
|
||||
};
|
||||
|
||||
export type GateResult = {
|
||||
decision: GateDecision;
|
||||
timestamp: Date;
|
||||
criticalRisks: RiskScore[];
|
||||
highRisks: RiskScore[];
|
||||
coverageGaps: CoverageGap[];
|
||||
summary: string;
|
||||
recommendations: string[];
|
||||
};
|
||||
|
||||
export function evaluateGate(params: { risks: RiskScore[]; coverageGaps: CoverageGap[]; waiverApprover?: string }): GateResult {
|
||||
const { risks, coverageGaps, waiverApprover } = params;
|
||||
|
||||
// Categorize risks
|
||||
const criticalRisks = risks.filter((r) => r.score === 9 && r.status === 'OPEN');
|
||||
const highRisks = risks.filter((r) => r.score >= 6 && r.score < 9 && r.status === 'OPEN');
|
||||
const unresolvedGaps = coverageGaps.filter((g) => !g.reason);
|
||||
|
||||
// Decision logic
|
||||
let decision: GateDecision;
|
||||
|
||||
// FAIL: Critical blockers (score=9) or missing coverage
|
||||
if (criticalRisks.length > 0 || unresolvedGaps.length > 0) {
|
||||
decision = 'FAIL';
|
||||
}
|
||||
// WAIVED: All risks waived by authorized approver
|
||||
else if (risks.every((r) => r.status === 'WAIVED') && waiverApprover) {
|
||||
decision = 'WAIVED';
|
||||
}
|
||||
// CONCERNS: High risks (score 6-8) with mitigation plans
|
||||
else if (highRisks.length > 0 && highRisks.every((r) => r.mitigationPlan && r.owner !== 'unassigned')) {
|
||||
decision = 'CONCERNS';
|
||||
}
|
||||
// PASS: No critical issues, all risks mitigated or low
|
||||
else {
|
||||
decision = 'PASS';
|
||||
}
|
||||
|
||||
// Generate recommendations
|
||||
const recommendations: string[] = [];
|
||||
if (criticalRisks.length > 0) {
|
||||
recommendations.push(`🚨 ${criticalRisks.length} CRITICAL risk(s) must be mitigated before release`);
|
||||
}
|
||||
if (unresolvedGaps.length > 0) {
|
||||
recommendations.push(`📋 ${unresolvedGaps.length} acceptance criteria lack test coverage`);
|
||||
}
|
||||
if (highRisks.some((r) => !r.mitigationPlan)) {
|
||||
recommendations.push(`⚠️ High risks without mitigation plans: assign owners and deadlines`);
|
||||
}
|
||||
if (decision === 'PASS') {
|
||||
recommendations.push(`✅ All risks mitigated or acceptable. Ready for release.`);
|
||||
}
|
||||
|
||||
return {
|
||||
decision,
|
||||
timestamp: new Date(),
|
||||
criticalRisks,
|
||||
highRisks,
|
||||
coverageGaps: unresolvedGaps,
|
||||
summary: generateSummary(decision, risks, unresolvedGaps),
|
||||
recommendations,
|
||||
};
|
||||
}
|
||||
|
||||
function generateSummary(decision: GateDecision, risks: RiskScore[], gaps: CoverageGap[]): string {
|
||||
const total = risks.length;
|
||||
const critical = risks.filter((r) => r.score === 9).length;
|
||||
const high = risks.filter((r) => r.score >= 6 && r.score < 9).length;
|
||||
|
||||
return `Gate Decision: ${decision}. Total Risks: ${total} (${critical} critical, ${high} high). Coverage Gaps: ${gaps.length}.`;
|
||||
}
|
||||
```
|
||||
|
||||
**Usage Example**:
|
||||
|
||||
```typescript
|
||||
// Example: Running gate check before deployment
|
||||
import { assessTestFailureRisk, evaluateGate } from './gate-decision-engine';
|
||||
|
||||
// Collect risks from test results
|
||||
const risks: RiskScore[] = [
|
||||
assessTestFailureRisk({
|
||||
test: 'Payment processing with expired card',
|
||||
category: 'BUS',
|
||||
affectedUsers: 5000,
|
||||
revenueImpact: 50000,
|
||||
securityVulnerability: false,
|
||||
}),
|
||||
assessTestFailureRisk({
|
||||
test: 'SQL injection in search endpoint',
|
||||
category: 'SEC',
|
||||
affectedUsers: 10000,
|
||||
revenueImpact: 0,
|
||||
securityVulnerability: true,
|
||||
}),
|
||||
];
|
||||
|
||||
// Identify coverage gaps
|
||||
const coverageGaps: CoverageGap[] = [
|
||||
{
|
||||
acceptanceCriteria: 'User can reset password via email',
|
||||
testMissing: 'e2e/auth/password-reset.spec.ts',
|
||||
reason: '', // Empty = unresolved
|
||||
},
|
||||
];
|
||||
|
||||
// Evaluate gate
|
||||
const gateResult = evaluateGate({ risks, coverageGaps });
|
||||
|
||||
console.log(gateResult.decision); // 'FAIL'
|
||||
console.log(gateResult.summary);
|
||||
// "Gate Decision: FAIL. Total Risks: 2 (1 critical, 1 high). Coverage Gaps: 1."
|
||||
|
||||
console.log(gateResult.recommendations);
|
||||
// [
|
||||
// "🚨 1 CRITICAL risk(s) must be mitigated before release",
|
||||
// "📋 1 acceptance criteria lack test coverage"
|
||||
// ]
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Automated decision**: No human interpretation required
|
||||
- **Clear criteria**: FAIL = critical risks or gaps, CONCERNS = high risks with plans, PASS = low risks
|
||||
- **Actionable output**: Recommendations drive next steps
|
||||
- **Audit trail**: Timestamp, decision, and context for compliance
|
||||
|
||||
---
|
||||
|
||||
### Example 3: Risk Mitigation Workflow with Owner Tracking
|
||||
|
||||
**Context**: Track risk mitigation from identification to resolution
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// risk-mitigation.ts
|
||||
export type MitigationAction = {
|
||||
riskId: string;
|
||||
action: string;
|
||||
owner: string;
|
||||
deadline: Date;
|
||||
status: 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'BLOCKED';
|
||||
completedAt?: Date;
|
||||
blockedReason?: string;
|
||||
};
|
||||
|
||||
export class RiskMitigationTracker {
|
||||
private risks: Map<string, RiskScore> = new Map();
|
||||
private actions: Map<string, MitigationAction[]> = new Map();
|
||||
private history: Array<{ riskId: string; event: string; timestamp: Date }> = [];
|
||||
|
||||
// Register a new risk
|
||||
addRisk(risk: RiskScore): void {
|
||||
this.risks.set(risk.id, risk);
|
||||
this.logHistory(risk.id, `Risk registered: ${risk.title} (Score: ${risk.score})`);
|
||||
|
||||
// Auto-assign mitigation requirements for score ≥6
|
||||
if (requiresMitigation(risk.score) && !risk.mitigationPlan) {
|
||||
this.logHistory(risk.id, `⚠️ Mitigation required (score ${risk.score}). Assign owner and plan.`);
|
||||
}
|
||||
}
|
||||
|
||||
// Add mitigation action
|
||||
addMitigationAction(action: MitigationAction): void {
|
||||
const risk = this.risks.get(action.riskId);
|
||||
if (!risk) throw new Error(`Risk ${action.riskId} not found`);
|
||||
|
||||
const existingActions = this.actions.get(action.riskId) || [];
|
||||
existingActions.push(action);
|
||||
this.actions.set(action.riskId, existingActions);
|
||||
|
||||
this.logHistory(action.riskId, `Mitigation action added: ${action.action} (Owner: ${action.owner})`);
|
||||
}
|
||||
|
||||
// Complete mitigation action
|
||||
completeMitigation(riskId: string, actionIndex: number): void {
|
||||
const actions = this.actions.get(riskId);
|
||||
if (!actions || !actions[actionIndex]) throw new Error('Action not found');
|
||||
|
||||
actions[actionIndex].status = 'COMPLETED';
|
||||
actions[actionIndex].completedAt = new Date();
|
||||
|
||||
this.logHistory(riskId, `Mitigation completed: ${actions[actionIndex].action}`);
|
||||
|
||||
// If all actions completed, mark risk as MITIGATED
|
||||
if (actions.every((a) => a.status === 'COMPLETED')) {
|
||||
const risk = this.risks.get(riskId)!;
|
||||
risk.status = 'MITIGATED';
|
||||
this.logHistory(riskId, `✅ Risk mitigated. All actions complete.`);
|
||||
}
|
||||
}
|
||||
|
||||
// Request waiver for a risk
|
||||
requestWaiver(riskId: string, reason: string, approver: string, expiryDays: number): void {
|
||||
const risk = this.risks.get(riskId);
|
||||
if (!risk) throw new Error(`Risk ${riskId} not found`);
|
||||
|
||||
risk.status = 'WAIVED';
|
||||
risk.waiverReason = reason;
|
||||
risk.waiverApprover = approver;
|
||||
risk.waiverExpiry = new Date(Date.now() + expiryDays * 24 * 60 * 60 * 1000);
|
||||
|
||||
this.logHistory(riskId, `⚠️ Waiver granted by ${approver}. Expires: ${risk.waiverExpiry}`);
|
||||
}
|
||||
|
||||
// Generate risk report
|
||||
generateReport(): string {
|
||||
const allRisks = Array.from(this.risks.values());
|
||||
const critical = allRisks.filter((r) => r.score === 9 && r.status === 'OPEN');
|
||||
const high = allRisks.filter((r) => r.score >= 6 && r.score < 9 && r.status === 'OPEN');
|
||||
const mitigated = allRisks.filter((r) => r.status === 'MITIGATED');
|
||||
const waived = allRisks.filter((r) => r.status === 'WAIVED');
|
||||
|
||||
let report = `# Risk Mitigation Report\n\n`;
|
||||
report += `**Generated**: ${new Date().toISOString()}\n\n`;
|
||||
report += `## Summary\n`;
|
||||
report += `- Total Risks: ${allRisks.length}\n`;
|
||||
report += `- Critical (Score=9, OPEN): ${critical.length}\n`;
|
||||
report += `- High (Score 6-8, OPEN): ${high.length}\n`;
|
||||
report += `- Mitigated: ${mitigated.length}\n`;
|
||||
report += `- Waived: ${waived.length}\n\n`;
|
||||
|
||||
if (critical.length > 0) {
|
||||
report += `## 🚨 Critical Risks (BLOCKERS)\n\n`;
|
||||
critical.forEach((r) => {
|
||||
report += `- **${r.title}** (${r.category})\n`;
|
||||
report += ` - Score: ${r.score} (Probability: ${r.probability}, Impact: ${r.impact})\n`;
|
||||
report += ` - Owner: ${r.owner}\n`;
|
||||
report += ` - Mitigation: ${r.mitigationPlan || 'NOT ASSIGNED'}\n\n`;
|
||||
});
|
||||
}
|
||||
|
||||
if (high.length > 0) {
|
||||
report += `## ⚠️ High Risks\n\n`;
|
||||
high.forEach((r) => {
|
||||
report += `- **${r.title}** (${r.category})\n`;
|
||||
report += ` - Score: ${r.score}\n`;
|
||||
report += ` - Owner: ${r.owner}\n`;
|
||||
report += ` - Deadline: ${r.deadline?.toISOString().split('T')[0] || 'NOT SET'}\n\n`;
|
||||
});
|
||||
}
|
||||
|
||||
return report;
|
||||
}
|
||||
|
||||
private logHistory(riskId: string, event: string): void {
|
||||
this.history.push({ riskId, event, timestamp: new Date() });
|
||||
}
|
||||
|
||||
getHistory(riskId: string): Array<{ event: string; timestamp: Date }> {
|
||||
return this.history.filter((h) => h.riskId === riskId).map((h) => ({ event: h.event, timestamp: h.timestamp }));
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Usage Example**:
|
||||
|
||||
```typescript
|
||||
const tracker = new RiskMitigationTracker();
|
||||
|
||||
// Register critical security risk
|
||||
tracker.addRisk({
|
||||
id: 'risk-001',
|
||||
category: 'SEC',
|
||||
title: 'SQL injection vulnerability in user search',
|
||||
description: 'Unsanitized input allows arbitrary SQL execution',
|
||||
probability: 3,
|
||||
impact: 3,
|
||||
score: 9,
|
||||
owner: 'security-team',
|
||||
status: 'OPEN',
|
||||
});
|
||||
|
||||
// Add mitigation actions
|
||||
tracker.addMitigationAction({
|
||||
riskId: 'risk-001',
|
||||
action: 'Add parameterized queries to user-search endpoint',
|
||||
owner: 'alice@example.com',
|
||||
deadline: new Date('2025-10-20'),
|
||||
status: 'IN_PROGRESS',
|
||||
});
|
||||
|
||||
tracker.addMitigationAction({
|
||||
riskId: 'risk-001',
|
||||
action: 'Add WAF rule to block SQL injection patterns',
|
||||
owner: 'bob@example.com',
|
||||
deadline: new Date('2025-10-22'),
|
||||
status: 'PENDING',
|
||||
});
|
||||
|
||||
// Complete first action
|
||||
tracker.completeMitigation('risk-001', 0);
|
||||
|
||||
// Generate report
|
||||
console.log(tracker.generateReport());
|
||||
// Markdown report with critical risks, owners, deadlines
|
||||
|
||||
// View history
|
||||
console.log(tracker.getHistory('risk-001'));
|
||||
// [
|
||||
// { event: 'Risk registered: SQL injection...', timestamp: ... },
|
||||
// { event: 'Mitigation action added: Add parameterized queries...', timestamp: ... },
|
||||
// { event: 'Mitigation completed: Add parameterized queries...', timestamp: ... }
|
||||
// ]
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Ownership enforcement**: Every risk >4 requires owner assignment
|
||||
- **Deadline tracking**: Mitigation actions have explicit deadlines
|
||||
- **Audit trail**: Complete history of risk lifecycle (registered → mitigated)
|
||||
- **Automated reports**: Markdown output for Confluence/GitHub wikis
|
||||
|
||||
---
|
||||
|
||||
### Example 4: Coverage Traceability Matrix (Test-to-Requirement Mapping)
|
||||
|
||||
**Context**: Validate that every acceptance criterion maps to at least one test
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// coverage-traceability.ts
|
||||
export type AcceptanceCriterion = {
|
||||
id: string;
|
||||
story: string;
|
||||
criterion: string;
|
||||
priority: 'P0' | 'P1' | 'P2' | 'P3';
|
||||
};
|
||||
|
||||
export type TestCase = {
|
||||
file: string;
|
||||
name: string;
|
||||
criteriaIds: string[]; // Links to acceptance criteria
|
||||
};
|
||||
|
||||
export type CoverageMatrix = {
|
||||
criterion: AcceptanceCriterion;
|
||||
tests: TestCase[];
|
||||
covered: boolean;
|
||||
waiverReason?: string;
|
||||
};
|
||||
|
||||
export function buildCoverageMatrix(criteria: AcceptanceCriterion[], tests: TestCase[]): CoverageMatrix[] {
|
||||
return criteria.map((criterion) => {
|
||||
const matchingTests = tests.filter((t) => t.criteriaIds.includes(criterion.id));
|
||||
|
||||
return {
|
||||
criterion,
|
||||
tests: matchingTests,
|
||||
covered: matchingTests.length > 0,
|
||||
};
|
||||
});
|
||||
}
|
||||
|
||||
export function validateCoverage(matrix: CoverageMatrix[]): {
|
||||
gaps: CoverageMatrix[];
|
||||
passRate: number;
|
||||
} {
|
||||
const gaps = matrix.filter((m) => !m.covered && !m.waiverReason);
|
||||
const passRate = ((matrix.length - gaps.length) / matrix.length) * 100;
|
||||
|
||||
return { gaps, passRate };
|
||||
}
|
||||
|
||||
// Example: Extract criteria IDs from test names
|
||||
export function extractCriteriaFromTests(testFiles: string[]): TestCase[] {
|
||||
// Simplified: In real implementation, parse test files with AST
|
||||
// Here we simulate extraction from test names
|
||||
return [
|
||||
{
|
||||
file: 'tests/e2e/auth/login.spec.ts',
|
||||
name: 'should allow user to login with valid credentials',
|
||||
criteriaIds: ['AC-001', 'AC-002'], // Linked to acceptance criteria
|
||||
},
|
||||
{
|
||||
file: 'tests/e2e/auth/password-reset.spec.ts',
|
||||
name: 'should send password reset email',
|
||||
criteriaIds: ['AC-003'],
|
||||
},
|
||||
];
|
||||
}
|
||||
|
||||
// Generate Markdown traceability report
|
||||
export function generateTraceabilityReport(matrix: CoverageMatrix[]): string {
|
||||
let report = `# Requirements-to-Tests Traceability Matrix\n\n`;
|
||||
report += `**Generated**: ${new Date().toISOString()}\n\n`;
|
||||
|
||||
const { gaps, passRate } = validateCoverage(matrix);
|
||||
|
||||
report += `## Summary\n`;
|
||||
report += `- Total Criteria: ${matrix.length}\n`;
|
||||
report += `- Covered: ${matrix.filter((m) => m.covered).length}\n`;
|
||||
report += `- Gaps: ${gaps.length}\n`;
|
||||
report += `- Waived: ${matrix.filter((m) => m.waiverReason).length}\n`;
|
||||
report += `- Coverage Rate: ${passRate.toFixed(1)}%\n\n`;
|
||||
|
||||
if (gaps.length > 0) {
|
||||
report += `## ❌ Coverage Gaps (MUST RESOLVE)\n\n`;
|
||||
report += `| Story | Criterion | Priority | Tests |\n`;
|
||||
report += `|-------|-----------|----------|-------|\n`;
|
||||
gaps.forEach((m) => {
|
||||
report += `| ${m.criterion.story} | ${m.criterion.criterion} | ${m.criterion.priority} | None |\n`;
|
||||
});
|
||||
report += `\n`;
|
||||
}
|
||||
|
||||
report += `## ✅ Covered Criteria\n\n`;
|
||||
report += `| Story | Criterion | Tests |\n`;
|
||||
report += `|-------|-----------|-------|\n`;
|
||||
matrix
|
||||
.filter((m) => m.covered)
|
||||
.forEach((m) => {
|
||||
const testList = m.tests.map((t) => `\`${t.file}\``).join(', ');
|
||||
report += `| ${m.criterion.story} | ${m.criterion.criterion} | ${testList} |\n`;
|
||||
});
|
||||
|
||||
return report;
|
||||
}
|
||||
```
|
||||
|
||||
**Usage Example**:
|
||||
|
||||
```typescript
|
||||
// Define acceptance criteria
|
||||
const criteria: AcceptanceCriterion[] = [
|
||||
{ id: 'AC-001', story: 'US-123', criterion: 'User can login with email', priority: 'P0' },
|
||||
{ id: 'AC-002', story: 'US-123', criterion: 'User sees error on invalid password', priority: 'P0' },
|
||||
{ id: 'AC-003', story: 'US-124', criterion: 'User receives password reset email', priority: 'P1' },
|
||||
{ id: 'AC-004', story: 'US-125', criterion: 'User can update profile', priority: 'P2' }, // NO TEST
|
||||
];
|
||||
|
||||
// Extract tests
|
||||
const tests: TestCase[] = extractCriteriaFromTests(['tests/e2e/auth/login.spec.ts', 'tests/e2e/auth/password-reset.spec.ts']);
|
||||
|
||||
// Build matrix
|
||||
const matrix = buildCoverageMatrix(criteria, tests);
|
||||
|
||||
// Validate
|
||||
const { gaps, passRate } = validateCoverage(matrix);
|
||||
console.log(`Coverage: ${passRate.toFixed(1)}%`); // "Coverage: 75.0%"
|
||||
console.log(`Gaps: ${gaps.length}`); // "Gaps: 1" (AC-004 has no test)
|
||||
|
||||
// Generate report
|
||||
const report = generateTraceabilityReport(matrix);
|
||||
console.log(report);
|
||||
// Markdown table showing coverage gaps
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Bidirectional traceability**: Criteria → Tests and Tests → Criteria
|
||||
- **Gap detection**: Automatically identifies missing coverage
|
||||
- **Priority awareness**: P0 gaps are critical blockers
|
||||
- **Waiver support**: Allow explicit waivers for low-priority gaps
|
||||
|
||||
---
|
||||
|
||||
## Risk Governance Checklist
|
||||
|
||||
Before deploying to production, ensure:
|
||||
|
||||
- [ ] **Risk scoring complete**: All identified risks scored (Probability × Impact)
|
||||
- [ ] **Ownership assigned**: Every risk >4 has owner, mitigation plan, deadline
|
||||
- [ ] **Coverage validated**: Every acceptance criterion maps to at least one test
|
||||
- [ ] **Gate decision documented**: PASS/CONCERNS/FAIL/WAIVED with rationale
|
||||
- [ ] **Waivers approved**: All waivers have approver, reason, expiry date
|
||||
- [ ] **Audit trail captured**: Risk history log available for compliance review
|
||||
- [ ] **Traceability matrix**: Requirements-to-tests mapping up to date
|
||||
- [ ] **Critical risks resolved**: No score=9 risks in OPEN status
|
||||
|
||||
## Integration Points
|
||||
|
||||
- **Used in workflows**: `*trace` (Phase 2: gate decision), `*nfr-assess` (risk scoring), `*test-design` (risk identification)
|
||||
- **Related fragments**: `probability-impact.md` (scoring definitions), `test-priorities-matrix.md` (P0-P3 classification), `nfr-criteria.md` (non-functional risks)
|
||||
- **Tools**: Risk tracking dashboards (Jira, Linear), gate automation (CI/CD), traceability reports (Markdown, Confluence)
|
||||
|
||||
_Source: Murat risk governance notes, gate schema guidance, SEON production gate workflows, ISO 31000 risk management standards_
|
||||
@ -1,732 +0,0 @@
|
||||
# Selective and Targeted Test Execution
|
||||
|
||||
## Principle
|
||||
|
||||
Run only the tests you need, when you need them. Use tags/grep to slice suites by risk priority (not directory structure), filter by spec patterns or git diff to focus on impacted areas, and combine priority metadata (P0-P3) with change detection to optimize pre-commit vs. CI execution. Document the selection strategy clearly so teams understand when full regression is mandatory.
|
||||
|
||||
## Rationale
|
||||
|
||||
Running the entire test suite on every commit wastes time and resources. Smart test selection provides fast feedback (smoke tests in minutes, full regression in hours) while maintaining confidence. The "32+ ways of selective testing" philosophy balances speed with coverage: quick loops for developers, comprehensive validation before deployment. Poorly documented selection leads to confusion about when tests run and why.
|
||||
|
||||
## Pattern Examples
|
||||
|
||||
### Example 1: Tag-Based Execution with Priority Levels
|
||||
|
||||
**Context**: Organize tests by risk priority and execution stage using grep/tag patterns.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/e2e/checkout.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
/**
|
||||
* Tag-based test organization
|
||||
* - @smoke: Critical path tests (run on every commit, < 5 min)
|
||||
* - @regression: Full test suite (run pre-merge, < 30 min)
|
||||
* - @p0: Critical business functions (payment, auth, data integrity)
|
||||
* - @p1: Core features (primary user journeys)
|
||||
* - @p2: Secondary features (supporting functionality)
|
||||
* - @p3: Nice-to-have (cosmetic, non-critical)
|
||||
*/
|
||||
|
||||
test.describe('Checkout Flow', () => {
|
||||
// P0 + Smoke: Must run on every commit
|
||||
test('@smoke @p0 should complete purchase with valid payment', async ({ page }) => {
|
||||
await page.goto('/checkout');
|
||||
await page.getByTestId('card-number').fill('4242424242424242');
|
||||
await page.getByTestId('submit-payment').click();
|
||||
|
||||
await expect(page.getByTestId('order-confirmation')).toBeVisible();
|
||||
});
|
||||
|
||||
// P0 but not smoke: Run pre-merge
|
||||
test('@regression @p0 should handle payment decline gracefully', async ({ page }) => {
|
||||
await page.goto('/checkout');
|
||||
await page.getByTestId('card-number').fill('4000000000000002'); // Decline card
|
||||
await page.getByTestId('submit-payment').click();
|
||||
|
||||
await expect(page.getByTestId('payment-error')).toBeVisible();
|
||||
await expect(page.getByTestId('payment-error')).toContainText('declined');
|
||||
});
|
||||
|
||||
// P1 + Smoke: Important but not critical
|
||||
test('@smoke @p1 should apply discount code', async ({ page }) => {
|
||||
await page.goto('/checkout');
|
||||
await page.getByTestId('promo-code').fill('SAVE10');
|
||||
await page.getByTestId('apply-promo').click();
|
||||
|
||||
await expect(page.getByTestId('discount-applied')).toBeVisible();
|
||||
});
|
||||
|
||||
// P2: Run in full regression only
|
||||
test('@regression @p2 should remember saved payment methods', async ({ page }) => {
|
||||
await page.goto('/checkout');
|
||||
await expect(page.getByTestId('saved-cards')).toBeVisible();
|
||||
});
|
||||
|
||||
// P3: Low priority, run nightly or weekly
|
||||
test('@nightly @p3 should display checkout page analytics', async ({ page }) => {
|
||||
await page.goto('/checkout');
|
||||
const analyticsEvents = await page.evaluate(() => (window as any).__ANALYTICS__);
|
||||
expect(analyticsEvents).toBeDefined();
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**package.json scripts**:
|
||||
|
||||
```json
|
||||
{
|
||||
"scripts": {
|
||||
"test": "playwright test",
|
||||
"test:smoke": "playwright test --grep '@smoke'",
|
||||
"test:p0": "playwright test --grep '@p0'",
|
||||
"test:p0-p1": "playwright test --grep '@p0|@p1'",
|
||||
"test:regression": "playwright test --grep '@regression'",
|
||||
"test:nightly": "playwright test --grep '@nightly'",
|
||||
"test:not-slow": "playwright test --grep-invert '@slow'",
|
||||
"test:critical-smoke": "playwright test --grep '@smoke.*@p0'"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Cypress equivalent**:
|
||||
|
||||
```javascript
|
||||
// cypress/e2e/checkout.cy.ts
|
||||
describe('Checkout Flow', { tags: ['@checkout'] }, () => {
|
||||
it('should complete purchase', { tags: ['@smoke', '@p0'] }, () => {
|
||||
cy.visit('/checkout');
|
||||
cy.get('[data-cy="card-number"]').type('4242424242424242');
|
||||
cy.get('[data-cy="submit-payment"]').click();
|
||||
cy.get('[data-cy="order-confirmation"]').should('be.visible');
|
||||
});
|
||||
|
||||
it('should handle decline', { tags: ['@regression', '@p0'] }, () => {
|
||||
cy.visit('/checkout');
|
||||
cy.get('[data-cy="card-number"]').type('4000000000000002');
|
||||
cy.get('[data-cy="submit-payment"]').click();
|
||||
cy.get('[data-cy="payment-error"]').should('be.visible');
|
||||
});
|
||||
});
|
||||
|
||||
// cypress.config.ts
|
||||
export default defineConfig({
|
||||
e2e: {
|
||||
env: {
|
||||
grepTags: process.env.GREP_TAGS || '',
|
||||
grepFilterSpecs: true,
|
||||
},
|
||||
setupNodeEvents(on, config) {
|
||||
require('@cypress/grep/src/plugin')(config);
|
||||
return config;
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
**Usage**:
|
||||
|
||||
```bash
|
||||
# Playwright
|
||||
npm run test:smoke # Run all @smoke tests
|
||||
npm run test:p0 # Run all P0 tests
|
||||
npm run test -- --grep "@smoke.*@p0" # Run tests with BOTH tags
|
||||
|
||||
# Cypress (with @cypress/grep plugin)
|
||||
npx cypress run --env grepTags="@smoke"
|
||||
npx cypress run --env grepTags="@p0+@smoke" # AND logic
|
||||
npx cypress run --env grepTags="@p0 @p1" # OR logic
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Multiple tags per test**: Combine priority (@p0) with stage (@smoke)
|
||||
- **AND/OR logic**: Grep supports complex filtering
|
||||
- **Clear naming**: Tags document test importance
|
||||
- **Fast feedback**: @smoke runs < 5 min, full suite < 30 min
|
||||
- **CI integration**: Different jobs run different tag combinations
|
||||
|
||||
---
|
||||
|
||||
### Example 2: Spec Filter Pattern (File-Based Selection)
|
||||
|
||||
**Context**: Run tests by file path pattern or directory for targeted execution.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# scripts/selective-spec-runner.sh
|
||||
# Run tests based on spec file patterns
|
||||
|
||||
set -e
|
||||
|
||||
PATTERN=${1:-"**/*.spec.ts"}
|
||||
TEST_ENV=${TEST_ENV:-local}
|
||||
|
||||
echo "🎯 Selective Spec Runner"
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
echo "Pattern: $PATTERN"
|
||||
echo "Environment: $TEST_ENV"
|
||||
echo ""
|
||||
|
||||
# Pattern examples and their use cases
|
||||
case "$PATTERN" in
|
||||
"**/checkout*")
|
||||
echo "📦 Running checkout-related tests"
|
||||
npx playwright test --grep-files="**/checkout*"
|
||||
;;
|
||||
"**/auth*"|"**/login*"|"**/signup*")
|
||||
echo "🔐 Running authentication tests"
|
||||
npx playwright test --grep-files="**/auth*|**/login*|**/signup*"
|
||||
;;
|
||||
"tests/e2e/**")
|
||||
echo "🌐 Running all E2E tests"
|
||||
npx playwright test tests/e2e/
|
||||
;;
|
||||
"tests/integration/**")
|
||||
echo "🔌 Running all integration tests"
|
||||
npx playwright test tests/integration/
|
||||
;;
|
||||
"tests/component/**")
|
||||
echo "🧩 Running all component tests"
|
||||
npx playwright test tests/component/
|
||||
;;
|
||||
*)
|
||||
echo "🔍 Running tests matching pattern: $PATTERN"
|
||||
npx playwright test "$PATTERN"
|
||||
;;
|
||||
esac
|
||||
```
|
||||
|
||||
**Playwright config for file filtering**:
|
||||
|
||||
```typescript
|
||||
// playwright.config.ts
|
||||
import { defineConfig, devices } from '@playwright/test';
|
||||
|
||||
export default defineConfig({
|
||||
// ... other config
|
||||
|
||||
// Project-based organization
|
||||
projects: [
|
||||
{
|
||||
name: 'smoke',
|
||||
testMatch: /.*smoke.*\.spec\.ts/,
|
||||
retries: 0,
|
||||
},
|
||||
{
|
||||
name: 'e2e',
|
||||
testMatch: /tests\/e2e\/.*\.spec\.ts/,
|
||||
retries: 2,
|
||||
},
|
||||
{
|
||||
name: 'integration',
|
||||
testMatch: /tests\/integration\/.*\.spec\.ts/,
|
||||
retries: 1,
|
||||
},
|
||||
{
|
||||
name: 'component',
|
||||
testMatch: /tests\/component\/.*\.spec\.ts/,
|
||||
use: { ...devices['Desktop Chrome'] },
|
||||
},
|
||||
],
|
||||
});
|
||||
```
|
||||
|
||||
**Advanced pattern matching**:
|
||||
|
||||
```typescript
|
||||
// scripts/run-by-component.ts
|
||||
/**
|
||||
* Run tests related to specific component(s)
|
||||
* Usage: npm run test:component UserProfile,Settings
|
||||
*/
|
||||
|
||||
import { execSync } from 'child_process';
|
||||
|
||||
const components = process.argv[2]?.split(',') || [];
|
||||
|
||||
if (components.length === 0) {
|
||||
console.error('❌ No components specified');
|
||||
console.log('Usage: npm run test:component UserProfile,Settings');
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
// Convert component names to glob patterns
|
||||
const patterns = components.map((comp) => `**/*${comp}*.spec.ts`).join(' ');
|
||||
|
||||
console.log(`🧩 Running tests for components: ${components.join(', ')}`);
|
||||
console.log(`Patterns: ${patterns}`);
|
||||
|
||||
try {
|
||||
execSync(`npx playwright test ${patterns}`, {
|
||||
stdio: 'inherit',
|
||||
env: { ...process.env, CI: 'false' },
|
||||
});
|
||||
} catch (error) {
|
||||
process.exit(1);
|
||||
}
|
||||
```
|
||||
|
||||
**package.json scripts**:
|
||||
|
||||
```json
|
||||
{
|
||||
"scripts": {
|
||||
"test:checkout": "playwright test **/checkout*.spec.ts",
|
||||
"test:auth": "playwright test **/auth*.spec.ts **/login*.spec.ts",
|
||||
"test:e2e": "playwright test tests/e2e/",
|
||||
"test:integration": "playwright test tests/integration/",
|
||||
"test:component": "ts-node scripts/run-by-component.ts",
|
||||
"test:project": "playwright test --project",
|
||||
"test:smoke-project": "playwright test --project smoke"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Glob patterns**: Wildcards match file paths flexibly
|
||||
- **Project isolation**: Separate projects have different configs
|
||||
- **Component targeting**: Run tests for specific features
|
||||
- **Directory-based**: Organize tests by type (e2e, integration, component)
|
||||
- **CI optimization**: Run subsets in parallel CI jobs
|
||||
|
||||
---
|
||||
|
||||
### Example 3: Diff-Based Test Selection (Changed Files Only)
|
||||
|
||||
**Context**: Run only tests affected by code changes for maximum speed.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# scripts/test-changed-files.sh
|
||||
# Intelligent test selection based on git diff
|
||||
|
||||
set -e
|
||||
|
||||
BASE_BRANCH=${BASE_BRANCH:-main}
|
||||
TEST_ENV=${TEST_ENV:-local}
|
||||
|
||||
echo "🔍 Changed File Test Selector"
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
echo "Base branch: $BASE_BRANCH"
|
||||
echo "Environment: $TEST_ENV"
|
||||
echo ""
|
||||
|
||||
# Get changed files
|
||||
CHANGED_FILES=$(git diff --name-only $BASE_BRANCH...HEAD)
|
||||
|
||||
if [ -z "$CHANGED_FILES" ]; then
|
||||
echo "✅ No files changed. Skipping tests."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
echo "Changed files:"
|
||||
echo "$CHANGED_FILES" | sed 's/^/ - /'
|
||||
echo ""
|
||||
|
||||
# Arrays to collect test specs
|
||||
DIRECT_TEST_FILES=()
|
||||
RELATED_TEST_FILES=()
|
||||
RUN_ALL_TESTS=false
|
||||
|
||||
# Process each changed file
|
||||
while IFS= read -r file; do
|
||||
case "$file" in
|
||||
# Changed test files: run them directly
|
||||
*.spec.ts|*.spec.js|*.test.ts|*.test.js|*.cy.ts|*.cy.js)
|
||||
DIRECT_TEST_FILES+=("$file")
|
||||
;;
|
||||
|
||||
# Critical config changes: run ALL tests
|
||||
package.json|package-lock.json|playwright.config.ts|cypress.config.ts|tsconfig.json|.github/workflows/*)
|
||||
echo "⚠️ Critical file changed: $file"
|
||||
RUN_ALL_TESTS=true
|
||||
break
|
||||
;;
|
||||
|
||||
# Component changes: find related tests
|
||||
src/components/*.tsx|src/components/*.jsx)
|
||||
COMPONENT_NAME=$(basename "$file" | sed 's/\.[^.]*$//')
|
||||
echo "🧩 Component changed: $COMPONENT_NAME"
|
||||
|
||||
# Find tests matching component name
|
||||
FOUND_TESTS=$(find tests -name "*${COMPONENT_NAME}*.spec.ts" -o -name "*${COMPONENT_NAME}*.cy.ts" 2>/dev/null || true)
|
||||
if [ -n "$FOUND_TESTS" ]; then
|
||||
while IFS= read -r test_file; do
|
||||
RELATED_TEST_FILES+=("$test_file")
|
||||
done <<< "$FOUND_TESTS"
|
||||
fi
|
||||
;;
|
||||
|
||||
# Utility/lib changes: run integration + unit tests
|
||||
src/utils/*|src/lib/*|src/helpers/*)
|
||||
echo "⚙️ Utility file changed: $file"
|
||||
RELATED_TEST_FILES+=($(find tests/unit tests/integration -name "*.spec.ts" 2>/dev/null || true))
|
||||
;;
|
||||
|
||||
# API changes: run integration + e2e tests
|
||||
src/api/*|src/services/*|src/controllers/*)
|
||||
echo "🔌 API file changed: $file"
|
||||
RELATED_TEST_FILES+=($(find tests/integration tests/e2e -name "*.spec.ts" 2>/dev/null || true))
|
||||
;;
|
||||
|
||||
# Type changes: run all TypeScript tests
|
||||
*.d.ts|src/types/*)
|
||||
echo "📝 Type definition changed: $file"
|
||||
RUN_ALL_TESTS=true
|
||||
break
|
||||
;;
|
||||
|
||||
# Documentation only: skip tests
|
||||
*.md|docs/*|README*)
|
||||
echo "📄 Documentation changed: $file (no tests needed)"
|
||||
;;
|
||||
|
||||
*)
|
||||
echo "❓ Unclassified change: $file (running smoke tests)"
|
||||
RELATED_TEST_FILES+=($(find tests -name "*smoke*.spec.ts" 2>/dev/null || true))
|
||||
;;
|
||||
esac
|
||||
done <<< "$CHANGED_FILES"
|
||||
|
||||
# Execute tests based on analysis
|
||||
if [ "$RUN_ALL_TESTS" = true ]; then
|
||||
echo ""
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
echo "🚨 Running FULL test suite (critical changes detected)"
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
npm run test
|
||||
exit $?
|
||||
fi
|
||||
|
||||
# Combine and deduplicate test files
|
||||
ALL_TEST_FILES=(${DIRECT_TEST_FILES[@]} ${RELATED_TEST_FILES[@]})
|
||||
UNIQUE_TEST_FILES=($(echo "${ALL_TEST_FILES[@]}" | tr ' ' '\n' | sort -u))
|
||||
|
||||
if [ ${#UNIQUE_TEST_FILES[@]} -eq 0 ]; then
|
||||
echo ""
|
||||
echo "✅ No tests found for changed files. Running smoke tests."
|
||||
npm run test:smoke
|
||||
exit $?
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
echo "🎯 Running ${#UNIQUE_TEST_FILES[@]} test file(s)"
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
|
||||
for test_file in "${UNIQUE_TEST_FILES[@]}"; do
|
||||
echo " - $test_file"
|
||||
done
|
||||
|
||||
echo ""
|
||||
npm run test -- "${UNIQUE_TEST_FILES[@]}"
|
||||
```
|
||||
|
||||
**GitHub Actions integration**:
|
||||
|
||||
```yaml
|
||||
# .github/workflows/test-changed.yml
|
||||
name: Test Changed Files
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened, synchronize, reopened]
|
||||
|
||||
jobs:
|
||||
detect-and-test:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0 # Full history for accurate diff
|
||||
|
||||
- name: Get changed files
|
||||
id: changed-files
|
||||
uses: tj-actions/changed-files@v40
|
||||
with:
|
||||
files: |
|
||||
src/**
|
||||
tests/**
|
||||
*.config.ts
|
||||
files_ignore: |
|
||||
**/*.md
|
||||
docs/**
|
||||
|
||||
- name: Run tests for changed files
|
||||
if: steps.changed-files.outputs.any_changed == 'true'
|
||||
run: |
|
||||
echo "Changed files: ${{ steps.changed-files.outputs.all_changed_files }}"
|
||||
bash scripts/test-changed-files.sh
|
||||
env:
|
||||
BASE_BRANCH: ${{ github.base_ref }}
|
||||
TEST_ENV: staging
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- **Intelligent mapping**: Code changes → related tests
|
||||
- **Critical file detection**: Config changes = full suite
|
||||
- **Component mapping**: UI changes → component + E2E tests
|
||||
- **Fast feedback**: Run only what's needed (< 2 min typical)
|
||||
- **Safety net**: Unrecognized changes run smoke tests
|
||||
|
||||
---
|
||||
|
||||
### Example 4: Promotion Rules (Pre-Commit → CI → Staging → Production)
|
||||
|
||||
**Context**: Progressive test execution strategy across deployment stages.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// scripts/test-promotion-strategy.ts
|
||||
/**
|
||||
* Test Promotion Strategy
|
||||
* Defines which tests run at each stage of the development lifecycle
|
||||
*/
|
||||
|
||||
export type TestStage = 'pre-commit' | 'ci-pr' | 'ci-merge' | 'staging' | 'production';
|
||||
|
||||
export type TestPromotion = {
|
||||
stage: TestStage;
|
||||
description: string;
|
||||
testCommand: string;
|
||||
timebudget: string; // minutes
|
||||
required: boolean;
|
||||
failureAction: 'block' | 'warn' | 'alert';
|
||||
};
|
||||
|
||||
export const TEST_PROMOTION_RULES: Record<TestStage, TestPromotion> = {
|
||||
'pre-commit': {
|
||||
stage: 'pre-commit',
|
||||
description: 'Local developer checks before git commit',
|
||||
testCommand: 'npm run test:smoke',
|
||||
timebudget: '2',
|
||||
required: true,
|
||||
failureAction: 'block',
|
||||
},
|
||||
'ci-pr': {
|
||||
stage: 'ci-pr',
|
||||
description: 'CI checks on pull request creation/update',
|
||||
testCommand: 'npm run test:changed && npm run test:p0-p1',
|
||||
timebudget: '10',
|
||||
required: true,
|
||||
failureAction: 'block',
|
||||
},
|
||||
'ci-merge': {
|
||||
stage: 'ci-merge',
|
||||
description: 'Full regression before merge to main',
|
||||
testCommand: 'npm run test:regression',
|
||||
timebudget: '30',
|
||||
required: true,
|
||||
failureAction: 'block',
|
||||
},
|
||||
staging: {
|
||||
stage: 'staging',
|
||||
description: 'Post-deployment validation in staging environment',
|
||||
testCommand: 'npm run test:e2e -- --grep "@smoke"',
|
||||
timebudget: '15',
|
||||
required: true,
|
||||
failureAction: 'block',
|
||||
},
|
||||
production: {
|
||||
stage: 'production',
|
||||
description: 'Production smoke tests post-deployment',
|
||||
testCommand: 'npm run test:e2e:prod -- --grep "@smoke.*@p0"',
|
||||
timebudget: '5',
|
||||
required: false,
|
||||
failureAction: 'alert',
|
||||
},
|
||||
};
|
||||
|
||||
/**
|
||||
* Get tests to run for a specific stage
|
||||
*/
|
||||
export function getTestsForStage(stage: TestStage): TestPromotion {
|
||||
return TEST_PROMOTION_RULES[stage];
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate if tests can be promoted to next stage
|
||||
*/
|
||||
export function canPromote(currentStage: TestStage, testsPassed: boolean): boolean {
|
||||
const promotion = TEST_PROMOTION_RULES[currentStage];
|
||||
|
||||
if (!promotion.required) {
|
||||
return true; // Non-required tests don't block promotion
|
||||
}
|
||||
|
||||
return testsPassed;
|
||||
}
|
||||
```
|
||||
|
||||
**Husky pre-commit hook**:
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
# .husky/pre-commit
|
||||
# Run smoke tests before allowing commit
|
||||
|
||||
echo "🔍 Running pre-commit tests..."
|
||||
|
||||
npm run test:smoke
|
||||
|
||||
if [ $? -ne 0 ]; then
|
||||
echo ""
|
||||
echo "❌ Pre-commit tests failed!"
|
||||
echo "Please fix failures before committing."
|
||||
echo ""
|
||||
echo "To skip (NOT recommended): git commit --no-verify"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "✅ Pre-commit tests passed"
|
||||
```
|
||||
|
||||
**GitHub Actions workflow**:
|
||||
|
||||
```yaml
|
||||
# .github/workflows/test-promotion.yml
|
||||
name: Test Promotion Strategy
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
branches: [main]
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
# Stage 1: PR tests (changed + P0-P1)
|
||||
pr-tests:
|
||||
if: github.event_name == 'pull_request'
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 10
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Run PR-level tests
|
||||
run: |
|
||||
npm run test:changed
|
||||
npm run test:p0-p1
|
||||
|
||||
# Stage 2: Full regression (pre-merge)
|
||||
regression-tests:
|
||||
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 30
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Run full regression
|
||||
run: npm run test:regression
|
||||
|
||||
# Stage 3: Staging validation (post-deploy)
|
||||
staging-smoke:
|
||||
if: github.event_name == 'workflow_dispatch'
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 15
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Run staging smoke tests
|
||||
run: npm run test:e2e -- --grep "@smoke"
|
||||
env:
|
||||
TEST_ENV: staging
|
||||
|
||||
# Stage 4: Production smoke (post-deploy, non-blocking)
|
||||
production-smoke:
|
||||
if: github.event_name == 'workflow_dispatch'
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 5
|
||||
continue-on-error: true # Don't fail deployment if smoke tests fail
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Run production smoke tests
|
||||
run: npm run test:e2e:prod -- --grep "@smoke.*@p0"
|
||||
env:
|
||||
TEST_ENV: production
|
||||
|
||||
- name: Alert on failure
|
||||
if: failure()
|
||||
uses: 8398a7/action-slack@v3
|
||||
with:
|
||||
status: ${{ job.status }}
|
||||
text: '🚨 Production smoke tests failed!'
|
||||
webhook_url: ${{ secrets.SLACK_WEBHOOK }}
|
||||
```
|
||||
|
||||
**Selection strategy documentation**:
|
||||
|
||||
````markdown
|
||||
# Test Selection Strategy
|
||||
|
||||
## Test Promotion Stages
|
||||
|
||||
| Stage | Tests Run | Time Budget | Blocks Deploy | Failure Action |
|
||||
| ---------- | ------------------- | ----------- | ------------- | -------------- |
|
||||
| Pre-Commit | Smoke (@smoke) | 2 min | ✅ Yes | Block commit |
|
||||
| CI PR | Changed + P0-P1 | 10 min | ✅ Yes | Block merge |
|
||||
| CI Merge | Full regression | 30 min | ✅ Yes | Block deploy |
|
||||
| Staging | E2E smoke | 15 min | ✅ Yes | Rollback |
|
||||
| Production | Critical smoke only | 5 min | ❌ No | Alert team |
|
||||
|
||||
## When Full Regression Runs
|
||||
|
||||
Full regression suite (`npm run test:regression`) runs in these scenarios:
|
||||
|
||||
- ✅ Before merging to `main` (CI Merge stage)
|
||||
- ✅ Nightly builds (scheduled workflow)
|
||||
- ✅ Manual trigger (workflow_dispatch)
|
||||
- ✅ Release candidate testing
|
||||
|
||||
Full regression does NOT run on:
|
||||
|
||||
- ❌ Every PR commit (too slow)
|
||||
- ❌ Pre-commit hooks (too slow)
|
||||
- ❌ Production deployments (deploy-blocking)
|
||||
|
||||
## Override Scenarios
|
||||
|
||||
Skip tests (emergency only):
|
||||
|
||||
```bash
|
||||
git commit --no-verify # Skip pre-commit hook
|
||||
gh pr merge --admin # Force merge (requires admin)
|
||||
```
|
||||
````
|
||||
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
- **Progressive validation**: More tests at each stage
|
||||
- **Time budgets**: Clear expectations per stage
|
||||
- **Blocking vs. alerting**: Production tests don't block deploy
|
||||
- **Documentation**: Team knows when full regression runs
|
||||
- **Emergency overrides**: Documented but discouraged
|
||||
|
||||
---
|
||||
|
||||
## Test Selection Strategy Checklist
|
||||
|
||||
Before implementing selective testing, verify:
|
||||
|
||||
- [ ] **Tag strategy defined**: @smoke, @p0-p3, @regression documented
|
||||
- [ ] **Time budgets set**: Each stage has clear timeout (smoke < 5 min, full < 30 min)
|
||||
- [ ] **Changed file mapping**: Code changes → test selection logic implemented
|
||||
- [ ] **Promotion rules documented**: README explains when full regression runs
|
||||
- [ ] **CI integration**: GitHub Actions uses selective strategy
|
||||
- [ ] **Local parity**: Developers can run same selections locally
|
||||
- [ ] **Emergency overrides**: Skip mechanisms documented (--no-verify, admin merge)
|
||||
- [ ] **Metrics tracked**: Monitor test execution time and selection accuracy
|
||||
|
||||
## Integration Points
|
||||
|
||||
- Used in workflows: `*ci` (CI/CD setup), `*automate` (test generation with tags)
|
||||
- Related fragments: `ci-burn-in.md`, `test-priorities-matrix.md`, `test-quality.md`
|
||||
- Selection tools: Playwright --grep, Cypress @cypress/grep, git diff
|
||||
|
||||
_Source: 32+ selective testing strategies blog, Murat testing philosophy, SEON CI optimization_
|
||||
```
|
||||
@ -1,527 +0,0 @@
|
||||
# Selector Resilience
|
||||
|
||||
## Principle
|
||||
|
||||
Robust selectors follow a strict hierarchy: **data-testid > ARIA roles > text content > CSS/IDs** (last resort). Selectors must be resilient to UI changes (styling, layout, content updates) and remain human-readable for maintenance.
|
||||
|
||||
## Rationale
|
||||
|
||||
**The Problem**: Brittle selectors (CSS classes, nth-child, complex XPath) break when UI styling changes, elements are reordered, or design updates occur. This causes test maintenance burden and false negatives.
|
||||
|
||||
**The Solution**: Prioritize semantic selectors that reflect user intent (ARIA roles, accessible names, test IDs). Use dynamic filtering for lists instead of nth() indexes. Validate selectors during code review and refactor proactively.
|
||||
|
||||
**Why This Matters**:
|
||||
|
||||
- Prevents false test failures (UI refactoring doesn't break tests)
|
||||
- Improves accessibility (ARIA roles benefit both tests and screen readers)
|
||||
- Enhances readability (semantic selectors document user intent)
|
||||
- Reduces maintenance burden (robust selectors survive design changes)
|
||||
|
||||
## Pattern Examples
|
||||
|
||||
### Example 1: Selector Hierarchy (Priority Order with Examples)
|
||||
|
||||
**Context**: Choose the most resilient selector for each element type
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/selectors/hierarchy-examples.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
test.describe('Selector Hierarchy Best Practices', () => {
|
||||
test('Level 1: data-testid (BEST - most resilient)', async ({ page }) => {
|
||||
await page.goto('/login');
|
||||
|
||||
// ✅ Best: Dedicated test attribute (survives all UI changes)
|
||||
await page.getByTestId('email-input').fill('user@example.com');
|
||||
await page.getByTestId('password-input').fill('password123');
|
||||
await page.getByTestId('login-button').click();
|
||||
|
||||
await expect(page.getByTestId('welcome-message')).toBeVisible();
|
||||
|
||||
// Why it's best:
|
||||
// - Survives CSS refactoring (class name changes)
|
||||
// - Survives layout changes (element reordering)
|
||||
// - Survives content changes (button text updates)
|
||||
// - Explicit test contract (developer knows it's for testing)
|
||||
});
|
||||
|
||||
test('Level 2: ARIA roles and accessible names (GOOD - future-proof)', async ({ page }) => {
|
||||
await page.goto('/login');
|
||||
|
||||
// ✅ Good: Semantic HTML roles (benefits accessibility + tests)
|
||||
await page.getByRole('textbox', { name: 'Email' }).fill('user@example.com');
|
||||
await page.getByRole('textbox', { name: 'Password' }).fill('password123');
|
||||
await page.getByRole('button', { name: 'Sign In' }).click();
|
||||
|
||||
await expect(page.getByRole('heading', { name: 'Welcome' })).toBeVisible();
|
||||
|
||||
// Why it's good:
|
||||
// - Survives CSS refactoring
|
||||
// - Survives layout changes
|
||||
// - Enforces accessibility (screen reader compatible)
|
||||
// - Self-documenting (role + name = clear intent)
|
||||
});
|
||||
|
||||
test('Level 3: Text content (ACCEPTABLE - user-centric)', async ({ page }) => {
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// ✅ Acceptable: Text content (matches user perception)
|
||||
await page.getByText('Create New Order').click();
|
||||
await expect(page.getByText('Order Details')).toBeVisible();
|
||||
|
||||
// Why it's acceptable:
|
||||
// - User-centric (what user sees)
|
||||
// - Survives CSS/layout changes
|
||||
// - Breaks when copy changes (forces test update with content)
|
||||
|
||||
// ⚠️ Use with caution for dynamic/localized content:
|
||||
// - Avoid for content with variables: "User 123" (use regex instead)
|
||||
// - Avoid for i18n content (use data-testid or ARIA)
|
||||
});
|
||||
|
||||
test('Level 4: CSS classes/IDs (LAST RESORT - brittle)', async ({ page }) => {
|
||||
await page.goto('/login');
|
||||
|
||||
// ❌ Last resort: CSS class (breaks with styling updates)
|
||||
// await page.locator('.btn-primary').click()
|
||||
|
||||
// ❌ Last resort: ID (breaks if ID changes)
|
||||
// await page.locator('#login-form').fill(...)
|
||||
|
||||
// ✅ Better: Use data-testid or ARIA instead
|
||||
await page.getByTestId('login-button').click();
|
||||
|
||||
// Why CSS/ID is last resort:
|
||||
// - Breaks with CSS refactoring (class name changes)
|
||||
// - Breaks with HTML restructuring (ID changes)
|
||||
// - Not semantic (unclear what element does)
|
||||
// - Tight coupling between tests and styling
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Hierarchy: data-testid (best) > ARIA (good) > text (acceptable) > CSS/ID (last resort)
|
||||
- data-testid survives ALL UI changes (explicit test contract)
|
||||
- ARIA roles enforce accessibility (screen reader compatible)
|
||||
- Text content is user-centric (but breaks with copy changes)
|
||||
- CSS/ID are brittle (break with styling refactoring)
|
||||
|
||||
---
|
||||
|
||||
### Example 2: Dynamic Selector Patterns (Lists, Filters, Regex)
|
||||
|
||||
**Context**: Handle dynamic content, lists, and variable data with resilient selectors
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/selectors/dynamic-selectors.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
test.describe('Dynamic Selector Patterns', () => {
|
||||
test('regex for variable content (user IDs, timestamps)', async ({ page }) => {
|
||||
await page.goto('/users');
|
||||
|
||||
// ✅ Good: Regex pattern for dynamic user IDs
|
||||
await expect(page.getByText(/User \d+/)).toBeVisible();
|
||||
|
||||
// ✅ Good: Regex for timestamps
|
||||
await expect(page.getByText(/Last login: \d{4}-\d{2}-\d{2}/)).toBeVisible();
|
||||
|
||||
// ✅ Good: Regex for dynamic counts
|
||||
await expect(page.getByText(/\d+ items in cart/)).toBeVisible();
|
||||
});
|
||||
|
||||
test('partial text matching (case-insensitive, substring)', async ({ page }) => {
|
||||
await page.goto('/products');
|
||||
|
||||
// ✅ Good: Partial match (survives minor text changes)
|
||||
await page.getByText('Product', { exact: false }).first().click();
|
||||
|
||||
// ✅ Good: Case-insensitive (survives capitalization changes)
|
||||
await expect(page.getByText(/sign in/i)).toBeVisible();
|
||||
});
|
||||
|
||||
test('filter locators for lists (avoid brittle nth)', async ({ page }) => {
|
||||
await page.goto('/products');
|
||||
|
||||
// ❌ Bad: Index-based (breaks when order changes)
|
||||
// await page.locator('.product-card').nth(2).click()
|
||||
|
||||
// ✅ Good: Filter by content (resilient to reordering)
|
||||
await page.locator('[data-testid="product-card"]').filter({ hasText: 'Premium Plan' }).click();
|
||||
|
||||
// ✅ Good: Filter by attribute
|
||||
await page
|
||||
.locator('[data-testid="product-card"]')
|
||||
.filter({ has: page.locator('[data-status="active"]') })
|
||||
.first()
|
||||
.click();
|
||||
});
|
||||
|
||||
test('nth() only when absolutely necessary', async ({ page }) => {
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// ⚠️ Acceptable: nth(0) for first item (common pattern)
|
||||
const firstNotification = page.getByTestId('notification').nth(0);
|
||||
await expect(firstNotification).toContainText('Welcome');
|
||||
|
||||
// ❌ Bad: nth(5) for arbitrary index (fragile)
|
||||
// await page.getByTestId('notification').nth(5).click()
|
||||
|
||||
// ✅ Better: Use filter() with specific criteria
|
||||
await page.getByTestId('notification').filter({ hasText: 'Critical Alert' }).click();
|
||||
});
|
||||
|
||||
test('combine multiple locators for specificity', async ({ page }) => {
|
||||
await page.goto('/checkout');
|
||||
|
||||
// ✅ Good: Narrow scope with combined locators
|
||||
const shippingSection = page.getByTestId('shipping-section');
|
||||
await shippingSection.getByLabel('Address Line 1').fill('123 Main St');
|
||||
await shippingSection.getByLabel('City').fill('New York');
|
||||
|
||||
// Scoping prevents ambiguity (multiple "City" fields on page)
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Regex patterns handle variable content (IDs, timestamps, counts)
|
||||
- Partial matching survives minor text changes (`exact: false`)
|
||||
- `filter()` is more resilient than `nth()` (content-based vs index-based)
|
||||
- `nth(0)` acceptable for "first item", avoid arbitrary indexes
|
||||
- Combine locators to narrow scope (prevent ambiguity)
|
||||
|
||||
---
|
||||
|
||||
### Example 3: Selector Anti-Patterns (What NOT to Do)
|
||||
|
||||
**Context**: Common selector mistakes that cause brittle tests
|
||||
|
||||
**Problem Examples**:
|
||||
|
||||
```typescript
|
||||
// tests/selectors/anti-patterns.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
test.describe('Selector Anti-Patterns to Avoid', () => {
|
||||
test('❌ Anti-Pattern 1: CSS classes (brittle)', async ({ page }) => {
|
||||
await page.goto('/login');
|
||||
|
||||
// ❌ Bad: CSS class (breaks with design system updates)
|
||||
// await page.locator('.btn-primary').click()
|
||||
// await page.locator('.form-input-lg').fill('test@example.com')
|
||||
|
||||
// ✅ Good: Use data-testid or ARIA role
|
||||
await page.getByTestId('login-button').click();
|
||||
await page.getByRole('textbox', { name: 'Email' }).fill('test@example.com');
|
||||
});
|
||||
|
||||
test('❌ Anti-Pattern 2: Index-based nth() (fragile)', async ({ page }) => {
|
||||
await page.goto('/products');
|
||||
|
||||
// ❌ Bad: Index-based (breaks when product order changes)
|
||||
// await page.locator('.product-card').nth(3).click()
|
||||
|
||||
// ✅ Good: Content-based filter
|
||||
await page.locator('[data-testid="product-card"]').filter({ hasText: 'Laptop' }).click();
|
||||
});
|
||||
|
||||
test('❌ Anti-Pattern 3: Complex XPath (hard to maintain)', async ({ page }) => {
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// ❌ Bad: Complex XPath (unreadable, breaks with structure changes)
|
||||
// await page.locator('xpath=//div[@class="container"]//section[2]//button[contains(@class, "primary")]').click()
|
||||
|
||||
// ✅ Good: Semantic selector
|
||||
await page.getByRole('button', { name: 'Create Order' }).click();
|
||||
});
|
||||
|
||||
test('❌ Anti-Pattern 4: ID selectors (coupled to implementation)', async ({ page }) => {
|
||||
await page.goto('/settings');
|
||||
|
||||
// ❌ Bad: HTML ID (breaks if ID changes for accessibility/SEO)
|
||||
// await page.locator('#user-settings-form').fill(...)
|
||||
|
||||
// ✅ Good: data-testid or ARIA landmark
|
||||
await page.getByTestId('user-settings-form').getByLabel('Display Name').fill('John Doe');
|
||||
});
|
||||
|
||||
test('✅ Refactoring: Bad → Good Selector', async ({ page }) => {
|
||||
await page.goto('/checkout');
|
||||
|
||||
// Before (brittle):
|
||||
// await page.locator('.checkout-form > .payment-section > .btn-submit').click()
|
||||
|
||||
// After (resilient):
|
||||
await page.getByTestId('checkout-form').getByRole('button', { name: 'Complete Payment' }).click();
|
||||
|
||||
await expect(page.getByText('Payment successful')).toBeVisible();
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Why These Fail**:
|
||||
|
||||
- **CSS classes**: Change frequently with design updates (Tailwind, CSS modules)
|
||||
- **nth() indexes**: Fragile to element reordering (new features, A/B tests)
|
||||
- **Complex XPath**: Unreadable, breaks with HTML structure changes
|
||||
- **HTML IDs**: Not stable (accessibility improvements change IDs)
|
||||
|
||||
**Better Approach**: Use selector hierarchy (testid > ARIA > text)
|
||||
|
||||
---
|
||||
|
||||
### Example 4: Selector Debugging Techniques (Inspector, DevTools, MCP)
|
||||
|
||||
**Context**: Debug selector failures interactively to find better alternatives
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/selectors/debugging-techniques.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
test.describe('Selector Debugging Techniques', () => {
|
||||
test('use Playwright Inspector to test selectors', async ({ page }) => {
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// Pause test to open Inspector
|
||||
await page.pause();
|
||||
|
||||
// In Inspector console, test selectors:
|
||||
// page.getByTestId('user-menu') ✅ Works
|
||||
// page.getByRole('button', { name: 'Profile' }) ✅ Works
|
||||
// page.locator('.btn-primary') ❌ Brittle
|
||||
|
||||
// Use "Pick Locator" feature to generate selectors
|
||||
// Use "Record" mode to capture user interactions
|
||||
|
||||
await page.getByTestId('user-menu').click();
|
||||
await expect(page.getByRole('menu')).toBeVisible();
|
||||
});
|
||||
|
||||
test('use locator.all() to debug lists', async ({ page }) => {
|
||||
await page.goto('/products');
|
||||
|
||||
// Debug: How many products are visible?
|
||||
const products = await page.getByTestId('product-card').all();
|
||||
console.log(`Found ${products.length} products`);
|
||||
|
||||
// Debug: What text is in each product?
|
||||
for (const product of products) {
|
||||
const text = await product.textContent();
|
||||
console.log(`Product text: ${text}`);
|
||||
}
|
||||
|
||||
// Use findings to build better selector
|
||||
await page.getByTestId('product-card').filter({ hasText: 'Laptop' }).click();
|
||||
});
|
||||
|
||||
test('use DevTools console to test selectors', async ({ page }) => {
|
||||
await page.goto('/checkout');
|
||||
|
||||
// Open DevTools (manually or via page.pause())
|
||||
// Test selectors in console:
|
||||
// document.querySelectorAll('[data-testid="payment-method"]')
|
||||
// document.querySelector('#credit-card-input')
|
||||
|
||||
// Find robust selector through trial and error
|
||||
await page.getByTestId('payment-method').selectOption('credit-card');
|
||||
});
|
||||
|
||||
test('MCP browser_generate_locator (if available)', async ({ page }) => {
|
||||
await page.goto('/products');
|
||||
|
||||
// If Playwright MCP available, use browser_generate_locator:
|
||||
// 1. Click element in browser
|
||||
// 2. MCP generates optimal selector
|
||||
// 3. Copy into test
|
||||
|
||||
// Example output from MCP:
|
||||
// page.getByRole('link', { name: 'Product A' })
|
||||
|
||||
// Use generated selector
|
||||
await page.getByRole('link', { name: 'Product A' }).click();
|
||||
await expect(page).toHaveURL(/\/products\/\d+/);
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Playwright Inspector: Interactive selector testing with "Pick Locator" feature
|
||||
- `locator.all()`: Debug lists to understand structure and content
|
||||
- DevTools console: Test CSS selectors before adding to tests
|
||||
- MCP browser_generate_locator: Auto-generate optimal selectors (if MCP available)
|
||||
- Always validate selectors work before committing
|
||||
|
||||
---
|
||||
|
||||
### Example 2: Selector Refactoring Guide (Before/After Patterns)
|
||||
|
||||
**Context**: Systematically improve brittle selectors to resilient alternatives
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/selectors/refactoring-guide.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
test.describe('Selector Refactoring Patterns', () => {
|
||||
test('refactor: CSS class → data-testid', async ({ page }) => {
|
||||
await page.goto('/products');
|
||||
|
||||
// ❌ Before: CSS class (breaks with Tailwind updates)
|
||||
// await page.locator('.bg-blue-500.px-4.py-2.rounded').click()
|
||||
|
||||
// ✅ After: data-testid
|
||||
await page.getByTestId('add-to-cart-button').click();
|
||||
|
||||
// Implementation: Add data-testid to button component
|
||||
// <button className="bg-blue-500 px-4 py-2 rounded" data-testid="add-to-cart-button">
|
||||
});
|
||||
|
||||
test('refactor: nth() index → filter()', async ({ page }) => {
|
||||
await page.goto('/users');
|
||||
|
||||
// ❌ Before: Index-based (breaks when users reorder)
|
||||
// await page.locator('.user-row').nth(2).click()
|
||||
|
||||
// ✅ After: Content-based filter
|
||||
await page.locator('[data-testid="user-row"]').filter({ hasText: 'john@example.com' }).click();
|
||||
});
|
||||
|
||||
test('refactor: Complex XPath → ARIA role', async ({ page }) => {
|
||||
await page.goto('/checkout');
|
||||
|
||||
// ❌ Before: Complex XPath (unreadable, brittle)
|
||||
// await page.locator('xpath=//div[@id="payment"]//form//button[contains(@class, "submit")]').click()
|
||||
|
||||
// ✅ After: ARIA role
|
||||
await page.getByRole('button', { name: 'Complete Payment' }).click();
|
||||
});
|
||||
|
||||
test('refactor: ID selector → data-testid', async ({ page }) => {
|
||||
await page.goto('/settings');
|
||||
|
||||
// ❌ Before: HTML ID (changes with accessibility improvements)
|
||||
// await page.locator('#user-profile-section').getByLabel('Name').fill('John')
|
||||
|
||||
// ✅ After: data-testid + semantic label
|
||||
await page.getByTestId('user-profile-section').getByLabel('Display Name').fill('John Doe');
|
||||
});
|
||||
|
||||
test('refactor: Deeply nested CSS → scoped data-testid', async ({ page }) => {
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// ❌ Before: Deep nesting (breaks with structure changes)
|
||||
// await page.locator('.container .sidebar .menu .item:nth-child(3) a').click()
|
||||
|
||||
// ✅ After: Scoped data-testid
|
||||
const sidebar = page.getByTestId('sidebar');
|
||||
await sidebar.getByRole('link', { name: 'Settings' }).click();
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- CSS class → data-testid (survives design system updates)
|
||||
- nth() → filter() (content-based vs index-based)
|
||||
- Complex XPath → ARIA role (readable, semantic)
|
||||
- ID → data-testid (decouples from HTML structure)
|
||||
- Deep nesting → scoped locators (modular, maintainable)
|
||||
|
||||
---
|
||||
|
||||
### Example 3: Selector Best Practices Checklist
|
||||
|
||||
```typescript
|
||||
// tests/selectors/validation-checklist.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
/**
|
||||
* Selector Validation Checklist
|
||||
*
|
||||
* Before committing test, verify selectors meet these criteria:
|
||||
*/
|
||||
test.describe('Selector Best Practices Validation', () => {
|
||||
test('✅ 1. Prefer data-testid for interactive elements', async ({ page }) => {
|
||||
await page.goto('/login');
|
||||
|
||||
// Interactive elements (buttons, inputs, links) should use data-testid
|
||||
await page.getByTestId('email-input').fill('test@example.com');
|
||||
await page.getByTestId('login-button').click();
|
||||
});
|
||||
|
||||
test('✅ 2. Use ARIA roles for semantic elements', async ({ page }) => {
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// Semantic elements (headings, navigation, forms) use ARIA
|
||||
await expect(page.getByRole('heading', { name: 'Dashboard' })).toBeVisible();
|
||||
await page.getByRole('navigation').getByRole('link', { name: 'Settings' }).click();
|
||||
});
|
||||
|
||||
test('✅ 3. Avoid CSS classes (except when testing styles)', async ({ page }) => {
|
||||
await page.goto('/products');
|
||||
|
||||
// ❌ Never for interaction: page.locator('.btn-primary')
|
||||
// ✅ Only for visual regression: await expect(page.locator('.error-banner')).toHaveCSS('color', 'rgb(255, 0, 0)')
|
||||
});
|
||||
|
||||
test('✅ 4. Use filter() instead of nth() for lists', async ({ page }) => {
|
||||
await page.goto('/orders');
|
||||
|
||||
// List selection should be content-based
|
||||
await page.getByTestId('order-row').filter({ hasText: 'Order #12345' }).click();
|
||||
});
|
||||
|
||||
test('✅ 5. Selectors are human-readable', async ({ page }) => {
|
||||
await page.goto('/checkout');
|
||||
|
||||
// ✅ Good: Clear intent
|
||||
await page.getByTestId('shipping-address-form').getByLabel('Street Address').fill('123 Main St');
|
||||
|
||||
// ❌ Bad: Cryptic
|
||||
// await page.locator('div > div:nth-child(2) > input[type="text"]').fill('123 Main St')
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Validation Rules**:
|
||||
|
||||
1. **Interactive elements** (buttons, inputs) → data-testid
|
||||
2. **Semantic elements** (headings, nav, forms) → ARIA roles
|
||||
3. **CSS classes** → Avoid (except visual regression tests)
|
||||
4. **Lists** → filter() over nth() (content-based selection)
|
||||
5. **Readability** → Selectors document user intent (clear, semantic)
|
||||
|
||||
---
|
||||
|
||||
## Selector Resilience Checklist
|
||||
|
||||
Before deploying selectors:
|
||||
|
||||
- [ ] **Hierarchy followed**: data-testid (1st choice) > ARIA (2nd) > text (3rd) > CSS/ID (last resort)
|
||||
- [ ] **Interactive elements use data-testid**: Buttons, inputs, links have dedicated test attributes
|
||||
- [ ] **Semantic elements use ARIA**: Headings, navigation, forms use roles and accessible names
|
||||
- [ ] **No brittle patterns**: No CSS classes (except visual tests), no arbitrary nth(), no complex XPath
|
||||
- [ ] **Dynamic content handled**: Regex for IDs/timestamps, filter() for lists, partial matching for text
|
||||
- [ ] **Selectors are scoped**: Use container locators to narrow scope (prevent ambiguity)
|
||||
- [ ] **Human-readable**: Selectors document user intent (clear, semantic, maintainable)
|
||||
- [ ] **Validated in Inspector**: Test selectors interactively before committing (page.pause())
|
||||
|
||||
## Integration Points
|
||||
|
||||
- **Used in workflows**: `*atdd` (generate tests with robust selectors), `*automate` (healing selector failures), `*test-review` (validate selector quality)
|
||||
- **Related fragments**: `test-healing-patterns.md` (selector failure diagnosis), `fixture-architecture.md` (page object alternatives), `test-quality.md` (maintainability standards)
|
||||
- **Tools**: Playwright Inspector (Pick Locator), DevTools console, Playwright MCP browser_generate_locator (optional)
|
||||
|
||||
_Source: Playwright selector best practices, accessibility guidelines (ARIA), production test maintenance patterns_
|
||||
@ -1,644 +0,0 @@
|
||||
# Test Healing Patterns
|
||||
|
||||
## Principle
|
||||
|
||||
Common test failures follow predictable patterns (stale selectors, race conditions, dynamic data assertions, network errors, hard waits). **Automated healing** identifies failure signatures and applies pattern-based fixes. Manual healing captures these patterns for future automation.
|
||||
|
||||
## Rationale
|
||||
|
||||
**The Problem**: Test failures waste developer time on repetitive debugging. Teams manually fix the same selector issues, timing bugs, and data mismatches repeatedly across test suites.
|
||||
|
||||
**The Solution**: Catalog common failure patterns with diagnostic signatures and automated fixes. When a test fails, match the error message/stack trace against known patterns and apply the corresponding fix. This transforms test maintenance from reactive debugging to proactive pattern application.
|
||||
|
||||
**Why This Matters**:
|
||||
|
||||
- Reduces test maintenance time by 60-80% (pattern-based fixes vs manual debugging)
|
||||
- Prevents flakiness regression (same bug fixed once, applied everywhere)
|
||||
- Builds institutional knowledge (failure catalog grows over time)
|
||||
- Enables self-healing test suites (automate workflow validates and heals)
|
||||
|
||||
## Pattern Examples
|
||||
|
||||
### Example 1: Common Failure Pattern - Stale Selectors (Element Not Found)
|
||||
|
||||
**Context**: Test fails with "Element not found" or "Locator resolved to 0 elements" errors
|
||||
|
||||
**Diagnostic Signature**:
|
||||
|
||||
```typescript
|
||||
// src/testing/healing/selector-healing.ts
|
||||
|
||||
export type SelectorFailure = {
|
||||
errorMessage: string;
|
||||
stackTrace: string;
|
||||
selector: string;
|
||||
testFile: string;
|
||||
lineNumber: number;
|
||||
};
|
||||
|
||||
/**
|
||||
* Detect stale selector failures
|
||||
*/
|
||||
export function isSelectorFailure(error: Error): boolean {
|
||||
const patterns = [
|
||||
/locator.*resolved to 0 elements/i,
|
||||
/element not found/i,
|
||||
/waiting for locator.*to be visible/i,
|
||||
/selector.*did not match any elements/i,
|
||||
/unable to find element/i,
|
||||
];
|
||||
|
||||
return patterns.some((pattern) => pattern.test(error.message));
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract selector from error message
|
||||
*/
|
||||
export function extractSelector(errorMessage: string): string | null {
|
||||
// Playwright: "locator('button[type=\"submit\"]') resolved to 0 elements"
|
||||
const playwrightMatch = errorMessage.match(/locator\('([^']+)'\)/);
|
||||
if (playwrightMatch) return playwrightMatch[1];
|
||||
|
||||
// Cypress: "Timed out retrying: Expected to find element: '.submit-button'"
|
||||
const cypressMatch = errorMessage.match(/Expected to find element: ['"]([^'"]+)['"]/i);
|
||||
if (cypressMatch) return cypressMatch[1];
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Suggest better selector based on hierarchy
|
||||
*/
|
||||
export function suggestBetterSelector(badSelector: string): string {
|
||||
// If using CSS class → suggest data-testid
|
||||
if (badSelector.startsWith('.') || badSelector.includes('class=')) {
|
||||
const elementName = badSelector.match(/class=["']([^"']+)["']/)?.[1] || badSelector.slice(1);
|
||||
return `page.getByTestId('${elementName}') // Prefer data-testid over CSS class`;
|
||||
}
|
||||
|
||||
// If using ID → suggest data-testid
|
||||
if (badSelector.startsWith('#')) {
|
||||
return `page.getByTestId('${badSelector.slice(1)}') // Prefer data-testid over ID`;
|
||||
}
|
||||
|
||||
// If using nth() → suggest filter() or more specific selector
|
||||
if (badSelector.includes('.nth(')) {
|
||||
return `page.locator('${badSelector.split('.nth(')[0]}').filter({ hasText: 'specific text' }) // Avoid brittle nth(), use filter()`;
|
||||
}
|
||||
|
||||
// If using complex CSS → suggest ARIA role
|
||||
if (badSelector.includes('>') || badSelector.includes('+')) {
|
||||
return `page.getByRole('button', { name: 'Submit' }) // Prefer ARIA roles over complex CSS`;
|
||||
}
|
||||
|
||||
return `page.getByTestId('...') // Add data-testid attribute to element`;
|
||||
}
|
||||
```
|
||||
|
||||
**Healing Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/healing/selector-healing.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
import { isSelectorFailure, extractSelector, suggestBetterSelector } from '../../src/testing/healing/selector-healing';
|
||||
|
||||
test('heal stale selector failures automatically', async ({ page }) => {
|
||||
await page.goto('/dashboard');
|
||||
|
||||
try {
|
||||
// Original test with brittle CSS selector
|
||||
await page.locator('.btn-primary').click();
|
||||
} catch (error: any) {
|
||||
if (isSelectorFailure(error)) {
|
||||
const badSelector = extractSelector(error.message);
|
||||
const suggestion = badSelector ? suggestBetterSelector(badSelector) : null;
|
||||
|
||||
console.log('HEALING SUGGESTION:', suggestion);
|
||||
|
||||
// Apply healed selector
|
||||
await page.getByTestId('submit-button').click(); // Fixed!
|
||||
} else {
|
||||
throw error; // Not a selector issue, rethrow
|
||||
}
|
||||
}
|
||||
|
||||
await expect(page.getByText('Success')).toBeVisible();
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Diagnosis: Error message contains "locator resolved to 0 elements" or "element not found"
|
||||
- Fix: Replace brittle selector (CSS class, ID, nth) with robust alternative (data-testid, ARIA role)
|
||||
- Prevention: Follow selector hierarchy (data-testid > ARIA > text > CSS)
|
||||
- Automation: Pattern matching on error message + stack trace
|
||||
|
||||
---
|
||||
|
||||
### Example 2: Common Failure Pattern - Race Conditions (Timing Errors)
|
||||
|
||||
**Context**: Test fails with "timeout waiting for element" or "element not visible" errors
|
||||
|
||||
**Diagnostic Signature**:
|
||||
|
||||
```typescript
|
||||
// src/testing/healing/timing-healing.ts
|
||||
|
||||
export type TimingFailure = {
|
||||
errorMessage: string;
|
||||
testFile: string;
|
||||
lineNumber: number;
|
||||
actionType: 'click' | 'fill' | 'waitFor' | 'expect';
|
||||
};
|
||||
|
||||
/**
|
||||
* Detect race condition failures
|
||||
*/
|
||||
export function isTimingFailure(error: Error): boolean {
|
||||
const patterns = [
|
||||
/timeout.*waiting for/i,
|
||||
/element is not visible/i,
|
||||
/element is not attached to the dom/i,
|
||||
/waiting for element to be visible.*exceeded/i,
|
||||
/timed out retrying/i,
|
||||
/waitForLoadState.*timeout/i,
|
||||
];
|
||||
|
||||
return patterns.some((pattern) => pattern.test(error.message));
|
||||
}
|
||||
|
||||
/**
|
||||
* Detect hard wait anti-pattern
|
||||
*/
|
||||
export function hasHardWait(testCode: string): boolean {
|
||||
const hardWaitPatterns = [/page\.waitForTimeout\(/, /cy\.wait\(\d+\)/, /await.*sleep\(/, /setTimeout\(/];
|
||||
|
||||
return hardWaitPatterns.some((pattern) => pattern.test(testCode));
|
||||
}
|
||||
|
||||
/**
|
||||
* Suggest deterministic wait replacement
|
||||
*/
|
||||
export function suggestDeterministicWait(testCode: string): string {
|
||||
if (testCode.includes('page.waitForTimeout')) {
|
||||
return `
|
||||
// ❌ Bad: Hard wait (flaky)
|
||||
// await page.waitForTimeout(3000)
|
||||
|
||||
// ✅ Good: Wait for network response
|
||||
await page.waitForResponse(resp => resp.url().includes('/api/data') && resp.status() === 200)
|
||||
|
||||
// OR wait for element state
|
||||
await page.getByTestId('loading-spinner').waitFor({ state: 'detached' })
|
||||
`.trim();
|
||||
}
|
||||
|
||||
if (testCode.includes('cy.wait(') && /cy\.wait\(\d+\)/.test(testCode)) {
|
||||
return `
|
||||
// ❌ Bad: Hard wait (flaky)
|
||||
// cy.wait(3000)
|
||||
|
||||
// ✅ Good: Wait for aliased network request
|
||||
cy.intercept('GET', '/api/data').as('getData')
|
||||
cy.visit('/page')
|
||||
cy.wait('@getData')
|
||||
`.trim();
|
||||
}
|
||||
|
||||
return `
|
||||
// Add network-first interception BEFORE navigation:
|
||||
await page.route('**/api/**', route => route.continue())
|
||||
const responsePromise = page.waitForResponse('**/api/data')
|
||||
await page.goto('/page')
|
||||
await responsePromise
|
||||
`.trim();
|
||||
}
|
||||
```
|
||||
|
||||
**Healing Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/healing/timing-healing.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
import { isTimingFailure, hasHardWait, suggestDeterministicWait } from '../../src/testing/healing/timing-healing';
|
||||
|
||||
test('heal race condition with network-first pattern', async ({ page, context }) => {
|
||||
// Setup interception BEFORE navigation (prevent race)
|
||||
await context.route('**/api/products', (route) => {
|
||||
route.fulfill({
|
||||
status: 200,
|
||||
body: JSON.stringify({ products: [{ id: 1, name: 'Product A' }] }),
|
||||
});
|
||||
});
|
||||
|
||||
const responsePromise = page.waitForResponse('**/api/products');
|
||||
|
||||
await page.goto('/products');
|
||||
await responsePromise; // Deterministic wait
|
||||
|
||||
// Element now reliably visible (no race condition)
|
||||
await expect(page.getByText('Product A')).toBeVisible();
|
||||
});
|
||||
|
||||
test('heal hard wait with event-based wait', async ({ page }) => {
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// ❌ Original (flaky): await page.waitForTimeout(3000)
|
||||
|
||||
// ✅ Healed: Wait for spinner to disappear
|
||||
await page.getByTestId('loading-spinner').waitFor({ state: 'detached' });
|
||||
|
||||
// Element now reliably visible
|
||||
await expect(page.getByText('Dashboard loaded')).toBeVisible();
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Diagnosis: Error contains "timeout" or "not visible", often after navigation
|
||||
- Fix: Replace hard waits with network-first pattern or element state waits
|
||||
- Prevention: ALWAYS intercept before navigate, use waitForResponse()
|
||||
- Automation: Detect `page.waitForTimeout()` or `cy.wait(number)` in test code
|
||||
|
||||
---
|
||||
|
||||
### Example 3: Common Failure Pattern - Dynamic Data Assertions (Non-Deterministic IDs)
|
||||
|
||||
**Context**: Test fails with "Expected 'User 123' but received 'User 456'" or timestamp mismatches
|
||||
|
||||
**Diagnostic Signature**:
|
||||
|
||||
```typescript
|
||||
// src/testing/healing/data-healing.ts
|
||||
|
||||
export type DataFailure = {
|
||||
errorMessage: string;
|
||||
expectedValue: string;
|
||||
actualValue: string;
|
||||
testFile: string;
|
||||
lineNumber: number;
|
||||
};
|
||||
|
||||
/**
|
||||
* Detect dynamic data assertion failures
|
||||
*/
|
||||
export function isDynamicDataFailure(error: Error): boolean {
|
||||
const patterns = [
|
||||
/expected.*\d+.*received.*\d+/i, // ID mismatches
|
||||
/expected.*\d{4}-\d{2}-\d{2}.*received/i, // Date mismatches
|
||||
/expected.*user.*\d+/i, // Dynamic user IDs
|
||||
/expected.*order.*\d+/i, // Dynamic order IDs
|
||||
/expected.*to.*contain.*\d+/i, // Numeric assertions
|
||||
];
|
||||
|
||||
return patterns.some((pattern) => pattern.test(error.message));
|
||||
}
|
||||
|
||||
/**
|
||||
* Suggest flexible assertion pattern
|
||||
*/
|
||||
export function suggestFlexibleAssertion(errorMessage: string): string {
|
||||
if (/expected.*user.*\d+/i.test(errorMessage)) {
|
||||
return `
|
||||
// ❌ Bad: Hardcoded ID
|
||||
// await expect(page.getByText('User 123')).toBeVisible()
|
||||
|
||||
// ✅ Good: Regex pattern for any user ID
|
||||
await expect(page.getByText(/User \\d+/)).toBeVisible()
|
||||
|
||||
// OR use partial match
|
||||
await expect(page.locator('[data-testid="user-name"]')).toContainText('User')
|
||||
`.trim();
|
||||
}
|
||||
|
||||
if (/expected.*\d{4}-\d{2}-\d{2}/i.test(errorMessage)) {
|
||||
return `
|
||||
// ❌ Bad: Hardcoded date
|
||||
// await expect(page.getByText('2024-01-15')).toBeVisible()
|
||||
|
||||
// ✅ Good: Dynamic date validation
|
||||
const today = new Date().toISOString().split('T')[0]
|
||||
await expect(page.getByTestId('created-date')).toHaveText(today)
|
||||
|
||||
// OR use date format regex
|
||||
await expect(page.getByTestId('created-date')).toHaveText(/\\d{4}-\\d{2}-\\d{2}/)
|
||||
`.trim();
|
||||
}
|
||||
|
||||
if (/expected.*order.*\d+/i.test(errorMessage)) {
|
||||
return `
|
||||
// ❌ Bad: Hardcoded order ID
|
||||
// const orderId = '12345'
|
||||
|
||||
// ✅ Good: Capture dynamic order ID
|
||||
const orderText = await page.getByTestId('order-id').textContent()
|
||||
const orderId = orderText?.match(/Order #(\\d+)/)?.[1]
|
||||
expect(orderId).toBeTruthy()
|
||||
|
||||
// Use captured ID in later assertions
|
||||
await expect(page.getByText(\`Order #\${orderId} confirmed\`)).toBeVisible()
|
||||
`.trim();
|
||||
}
|
||||
|
||||
return `Use regex patterns, partial matching, or capture dynamic values instead of hardcoding`;
|
||||
}
|
||||
```
|
||||
|
||||
**Healing Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/healing/data-healing.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
test('heal dynamic ID assertion with regex', async ({ page }) => {
|
||||
await page.goto('/users');
|
||||
|
||||
// ❌ Original (fails with random IDs): await expect(page.getByText('User 123')).toBeVisible()
|
||||
|
||||
// ✅ Healed: Regex pattern matches any user ID
|
||||
await expect(page.getByText(/User \d+/)).toBeVisible();
|
||||
});
|
||||
|
||||
test('heal timestamp assertion with dynamic generation', async ({ page }) => {
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// ❌ Original (fails daily): await expect(page.getByText('2024-01-15')).toBeVisible()
|
||||
|
||||
// ✅ Healed: Generate expected date dynamically
|
||||
const today = new Date().toISOString().split('T')[0];
|
||||
await expect(page.getByTestId('last-updated')).toContainText(today);
|
||||
});
|
||||
|
||||
test('heal order ID assertion with capture', async ({ page, request }) => {
|
||||
// Create order via API (dynamic ID)
|
||||
const response = await request.post('/api/orders', {
|
||||
data: { productId: '123', quantity: 1 },
|
||||
});
|
||||
const { orderId } = await response.json();
|
||||
|
||||
// ✅ Healed: Use captured dynamic ID
|
||||
await page.goto(`/orders/${orderId}`);
|
||||
await expect(page.getByText(`Order #${orderId}`)).toBeVisible();
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Diagnosis: Error message shows expected vs actual value mismatch with IDs/timestamps
|
||||
- Fix: Use regex patterns (`/User \d+/`), partial matching, or capture dynamic values
|
||||
- Prevention: Never hardcode IDs, timestamps, or random data in assertions
|
||||
- Automation: Parse error message for expected/actual values, suggest regex patterns
|
||||
|
||||
---
|
||||
|
||||
### Example 4: Common Failure Pattern - Network Errors (Missing Route Interception)
|
||||
|
||||
**Context**: Test fails with "API call failed" or "500 error" during test execution
|
||||
|
||||
**Diagnostic Signature**:
|
||||
|
||||
```typescript
|
||||
// src/testing/healing/network-healing.ts
|
||||
|
||||
export type NetworkFailure = {
|
||||
errorMessage: string;
|
||||
url: string;
|
||||
statusCode: number;
|
||||
method: string;
|
||||
};
|
||||
|
||||
/**
|
||||
* Detect network failure
|
||||
*/
|
||||
export function isNetworkFailure(error: Error): boolean {
|
||||
const patterns = [
|
||||
/api.*call.*failed/i,
|
||||
/request.*failed/i,
|
||||
/network.*error/i,
|
||||
/500.*internal server error/i,
|
||||
/503.*service unavailable/i,
|
||||
/fetch.*failed/i,
|
||||
];
|
||||
|
||||
return patterns.some((pattern) => pattern.test(error.message));
|
||||
}
|
||||
|
||||
/**
|
||||
* Suggest route interception
|
||||
*/
|
||||
export function suggestRouteInterception(url: string, method: string): string {
|
||||
return `
|
||||
// ❌ Bad: Real API call (unreliable, slow, external dependency)
|
||||
|
||||
// ✅ Good: Mock API response with route interception
|
||||
await page.route('${url}', route => {
|
||||
route.fulfill({
|
||||
status: 200,
|
||||
contentType: 'application/json',
|
||||
body: JSON.stringify({
|
||||
// Mock response data
|
||||
id: 1,
|
||||
name: 'Test User',
|
||||
email: 'test@example.com'
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
// Then perform action
|
||||
await page.goto('/page')
|
||||
`.trim();
|
||||
}
|
||||
```
|
||||
|
||||
**Healing Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/healing/network-healing.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
test('heal network failure with route mocking', async ({ page, context }) => {
|
||||
// ✅ Healed: Mock API to prevent real network calls
|
||||
await context.route('**/api/products', (route) => {
|
||||
route.fulfill({
|
||||
status: 200,
|
||||
contentType: 'application/json',
|
||||
body: JSON.stringify({
|
||||
products: [
|
||||
{ id: 1, name: 'Product A', price: 29.99 },
|
||||
{ id: 2, name: 'Product B', price: 49.99 },
|
||||
],
|
||||
}),
|
||||
});
|
||||
});
|
||||
|
||||
await page.goto('/products');
|
||||
|
||||
// Test now reliable (no external API dependency)
|
||||
await expect(page.getByText('Product A')).toBeVisible();
|
||||
await expect(page.getByText('$29.99')).toBeVisible();
|
||||
});
|
||||
|
||||
test('heal 500 error with error state mocking', async ({ page, context }) => {
|
||||
// Mock API failure scenario
|
||||
await context.route('**/api/products', (route) => {
|
||||
route.fulfill({ status: 500, body: JSON.stringify({ error: 'Internal Server Error' }) });
|
||||
});
|
||||
|
||||
await page.goto('/products');
|
||||
|
||||
// Verify error handling (not crash)
|
||||
await expect(page.getByText('Unable to load products')).toBeVisible();
|
||||
await expect(page.getByRole('button', { name: 'Retry' })).toBeVisible();
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Diagnosis: Error message contains "API call failed", "500 error", or network-related failures
|
||||
- Fix: Add `page.route()` or `cy.intercept()` to mock API responses
|
||||
- Prevention: Mock ALL external dependencies (APIs, third-party services)
|
||||
- Automation: Extract URL from error message, generate route interception code
|
||||
|
||||
---
|
||||
|
||||
### Example 5: Common Failure Pattern - Hard Waits (Unreliable Timing)
|
||||
|
||||
**Context**: Test fails intermittently with "timeout exceeded" or passes/fails randomly
|
||||
|
||||
**Diagnostic Signature**:
|
||||
|
||||
```typescript
|
||||
// src/testing/healing/hard-wait-healing.ts
|
||||
|
||||
/**
|
||||
* Detect hard wait anti-pattern in test code
|
||||
*/
|
||||
export function detectHardWaits(testCode: string): Array<{ line: number; code: string }> {
|
||||
const lines = testCode.split('\n');
|
||||
const violations: Array<{ line: number; code: string }> = [];
|
||||
|
||||
lines.forEach((line, index) => {
|
||||
if (line.includes('page.waitForTimeout(') || /cy\.wait\(\d+\)/.test(line) || line.includes('sleep(') || line.includes('setTimeout(')) {
|
||||
violations.push({ line: index + 1, code: line.trim() });
|
||||
}
|
||||
});
|
||||
|
||||
return violations;
|
||||
}
|
||||
|
||||
/**
|
||||
* Suggest event-based wait replacement
|
||||
*/
|
||||
export function suggestEventBasedWait(hardWaitLine: string): string {
|
||||
if (hardWaitLine.includes('page.waitForTimeout')) {
|
||||
return `
|
||||
// ❌ Bad: Hard wait (flaky)
|
||||
${hardWaitLine}
|
||||
|
||||
// ✅ Good: Wait for network response
|
||||
await page.waitForResponse(resp => resp.url().includes('/api/') && resp.ok())
|
||||
|
||||
// OR wait for element state change
|
||||
await page.getByTestId('loading-spinner').waitFor({ state: 'detached' })
|
||||
await page.getByTestId('content').waitFor({ state: 'visible' })
|
||||
`.trim();
|
||||
}
|
||||
|
||||
if (/cy\.wait\(\d+\)/.test(hardWaitLine)) {
|
||||
return `
|
||||
// ❌ Bad: Hard wait (flaky)
|
||||
${hardWaitLine}
|
||||
|
||||
// ✅ Good: Wait for aliased request
|
||||
cy.intercept('GET', '/api/data').as('getData')
|
||||
cy.visit('/page')
|
||||
cy.wait('@getData') // Deterministic
|
||||
`.trim();
|
||||
}
|
||||
|
||||
return 'Replace hard waits with event-based waits (waitForResponse, waitFor state changes)';
|
||||
}
|
||||
```
|
||||
|
||||
**Healing Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/healing/hard-wait-healing.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
test('heal hard wait with deterministic wait', async ({ page }) => {
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// ❌ Original (flaky): await page.waitForTimeout(3000)
|
||||
|
||||
// ✅ Healed: Wait for loading spinner to disappear
|
||||
await page.getByTestId('loading-spinner').waitFor({ state: 'detached' });
|
||||
|
||||
// OR wait for specific network response
|
||||
await page.waitForResponse((resp) => resp.url().includes('/api/dashboard') && resp.ok());
|
||||
|
||||
await expect(page.getByText('Dashboard ready')).toBeVisible();
|
||||
});
|
||||
|
||||
test('heal implicit wait with explicit network wait', async ({ page }) => {
|
||||
const responsePromise = page.waitForResponse('**/api/products');
|
||||
|
||||
await page.goto('/products');
|
||||
|
||||
// ❌ Original (race condition): await page.getByText('Product A').click()
|
||||
|
||||
// ✅ Healed: Wait for network first
|
||||
await responsePromise;
|
||||
await page.getByText('Product A').click();
|
||||
|
||||
await expect(page).toHaveURL(/\/products\/\d+/);
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Diagnosis: Test code contains `page.waitForTimeout()` or `cy.wait(number)`
|
||||
- Fix: Replace with `waitForResponse()`, `waitFor({ state })`, or aliased intercepts
|
||||
- Prevention: NEVER use hard waits, always use event-based/response-based waits
|
||||
- Automation: Scan test code for hard wait patterns, suggest deterministic replacements
|
||||
|
||||
---
|
||||
|
||||
## Healing Pattern Catalog
|
||||
|
||||
| Failure Type | Diagnostic Signature | Healing Strategy | Prevention Pattern |
|
||||
| -------------- | --------------------------------------------- | ------------------------------------- | ----------------------------------------- |
|
||||
| Stale Selector | "locator resolved to 0 elements" | Replace with data-testid or ARIA role | Selector hierarchy (testid > ARIA > text) |
|
||||
| Race Condition | "timeout waiting for element" | Add network-first interception | Intercept before navigate |
|
||||
| Dynamic Data | "Expected 'User 123' but got 'User 456'" | Use regex or capture dynamic values | Never hardcode IDs/timestamps |
|
||||
| Network Error | "API call failed", "500 error" | Add route mocking | Mock all external dependencies |
|
||||
| Hard Wait | Test contains `waitForTimeout()` or `wait(n)` | Replace with event-based waits | Always use deterministic waits |
|
||||
|
||||
## Healing Workflow
|
||||
|
||||
1. **Run test** → Capture failure
|
||||
2. **Identify pattern** → Match error against diagnostic signatures
|
||||
3. **Apply fix** → Use pattern-based healing strategy
|
||||
4. **Re-run test** → Validate fix (max 3 iterations)
|
||||
5. **Mark unfixable** → Use `test.fixme()` if healing fails after 3 attempts
|
||||
|
||||
## Healing Checklist
|
||||
|
||||
Before enabling auto-healing in workflows:
|
||||
|
||||
- [ ] **Failure catalog documented**: Common patterns identified (selectors, timing, data, network, hard waits)
|
||||
- [ ] **Diagnostic signatures defined**: Error message patterns for each failure type
|
||||
- [ ] **Healing strategies documented**: Fix patterns for each failure type
|
||||
- [ ] **Prevention patterns documented**: Best practices to avoid recurrence
|
||||
- [ ] **Healing iteration limit set**: Max 3 attempts before marking test.fixme()
|
||||
- [ ] **MCP integration optional**: Graceful degradation without Playwright MCP
|
||||
- [ ] **Pattern-based fallback**: Use knowledge base patterns when MCP unavailable
|
||||
- [ ] **Healing report generated**: Document what was healed and how
|
||||
|
||||
## Integration Points
|
||||
|
||||
- **Used in workflows**: `*automate` (auto-healing after test generation), `*atdd` (optional healing for acceptance tests)
|
||||
- **Related fragments**: `selector-resilience.md` (selector debugging), `timing-debugging.md` (race condition fixes), `network-first.md` (interception patterns), `data-factories.md` (dynamic data handling)
|
||||
- **Tools**: Error message parsing, AST analysis for code patterns, Playwright MCP (optional), pattern matching
|
||||
|
||||
_Source: Playwright test-healer patterns, production test failure analysis, common anti-patterns from test-resources-for-ai_
|
||||
@ -1,473 +0,0 @@
|
||||
<!-- Powered by BMAD-CORE™ -->
|
||||
|
||||
# Test Levels Framework
|
||||
|
||||
Comprehensive guide for determining appropriate test levels (unit, integration, E2E) for different scenarios.
|
||||
|
||||
## Test Level Decision Matrix
|
||||
|
||||
### Unit Tests
|
||||
|
||||
**When to use:**
|
||||
|
||||
- Testing pure functions and business logic
|
||||
- Algorithm correctness
|
||||
- Input validation and data transformation
|
||||
- Error handling in isolated components
|
||||
- Complex calculations or state machines
|
||||
|
||||
**Characteristics:**
|
||||
|
||||
- Fast execution (immediate feedback)
|
||||
- No external dependencies (DB, API, file system)
|
||||
- Highly maintainable and stable
|
||||
- Easy to debug failures
|
||||
|
||||
**Example scenarios:**
|
||||
|
||||
```yaml
|
||||
unit_test:
|
||||
component: 'PriceCalculator'
|
||||
scenario: 'Calculate discount with multiple rules'
|
||||
justification: 'Complex business logic with multiple branches'
|
||||
mock_requirements: 'None - pure function'
|
||||
```
|
||||
|
||||
### Integration Tests
|
||||
|
||||
**When to use:**
|
||||
|
||||
- Component interaction verification
|
||||
- Database operations and transactions
|
||||
- API endpoint contracts
|
||||
- Service-to-service communication
|
||||
- Middleware and interceptor behavior
|
||||
|
||||
**Characteristics:**
|
||||
|
||||
- Moderate execution time
|
||||
- Tests component boundaries
|
||||
- May use test databases or containers
|
||||
- Validates system integration points
|
||||
|
||||
**Example scenarios:**
|
||||
|
||||
```yaml
|
||||
integration_test:
|
||||
components: ['UserService', 'AuthRepository']
|
||||
scenario: 'Create user with role assignment'
|
||||
justification: 'Critical data flow between service and persistence'
|
||||
test_environment: 'In-memory database'
|
||||
```
|
||||
|
||||
### End-to-End Tests
|
||||
|
||||
**When to use:**
|
||||
|
||||
- Critical user journeys
|
||||
- Cross-system workflows
|
||||
- Visual regression testing
|
||||
- Compliance and regulatory requirements
|
||||
- Final validation before release
|
||||
|
||||
**Characteristics:**
|
||||
|
||||
- Slower execution
|
||||
- Tests complete workflows
|
||||
- Requires full environment setup
|
||||
- Most realistic but most brittle
|
||||
|
||||
**Example scenarios:**
|
||||
|
||||
```yaml
|
||||
e2e_test:
|
||||
journey: 'Complete checkout process'
|
||||
scenario: 'User purchases with saved payment method'
|
||||
justification: 'Revenue-critical path requiring full validation'
|
||||
environment: 'Staging with test payment gateway'
|
||||
```
|
||||
|
||||
## Test Level Selection Rules
|
||||
|
||||
### Favor Unit Tests When:
|
||||
|
||||
- Logic can be isolated
|
||||
- No side effects involved
|
||||
- Fast feedback needed
|
||||
- High cyclomatic complexity
|
||||
|
||||
### Favor Integration Tests When:
|
||||
|
||||
- Testing persistence layer
|
||||
- Validating service contracts
|
||||
- Testing middleware/interceptors
|
||||
- Component boundaries critical
|
||||
|
||||
### Favor E2E Tests When:
|
||||
|
||||
- User-facing critical paths
|
||||
- Multi-system interactions
|
||||
- Regulatory compliance scenarios
|
||||
- Visual regression important
|
||||
|
||||
## Anti-patterns to Avoid
|
||||
|
||||
- E2E testing for business logic validation
|
||||
- Unit testing framework behavior
|
||||
- Integration testing third-party libraries
|
||||
- Duplicate coverage across levels
|
||||
|
||||
## Duplicate Coverage Guard
|
||||
|
||||
**Before adding any test, check:**
|
||||
|
||||
1. Is this already tested at a lower level?
|
||||
2. Can a unit test cover this instead of integration?
|
||||
3. Can an integration test cover this instead of E2E?
|
||||
|
||||
**Coverage overlap is only acceptable when:**
|
||||
|
||||
- Testing different aspects (unit: logic, integration: interaction, e2e: user experience)
|
||||
- Critical paths requiring defense in depth
|
||||
- Regression prevention for previously broken functionality
|
||||
|
||||
## Test Naming Conventions
|
||||
|
||||
- Unit: `test_{component}_{scenario}`
|
||||
- Integration: `test_{flow}_{interaction}`
|
||||
- E2E: `test_{journey}_{outcome}`
|
||||
|
||||
## Test ID Format
|
||||
|
||||
`{EPIC}.{STORY}-{LEVEL}-{SEQ}`
|
||||
|
||||
Examples:
|
||||
|
||||
- `1.3-UNIT-001`
|
||||
- `1.3-INT-002`
|
||||
- `1.3-E2E-001`
|
||||
|
||||
## Real Code Examples
|
||||
|
||||
### Example 1: E2E Test (Full User Journey)
|
||||
|
||||
**Scenario**: User logs in, navigates to dashboard, and places an order.
|
||||
|
||||
```typescript
|
||||
// tests/e2e/checkout-flow.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
import { createUser, createProduct } from '../test-utils/factories';
|
||||
|
||||
test.describe('Checkout Flow', () => {
|
||||
test('user can complete purchase with saved payment method', async ({ page, apiRequest }) => {
|
||||
// Setup: Seed data via API (fast!)
|
||||
const user = createUser({ email: 'buyer@example.com', hasSavedCard: true });
|
||||
const product = createProduct({ name: 'Widget', price: 29.99, stock: 10 });
|
||||
|
||||
await apiRequest.post('/api/users', { data: user });
|
||||
await apiRequest.post('/api/products', { data: product });
|
||||
|
||||
// Network-first: Intercept BEFORE action
|
||||
const loginPromise = page.waitForResponse('**/api/auth/login');
|
||||
const cartPromise = page.waitForResponse('**/api/cart');
|
||||
const orderPromise = page.waitForResponse('**/api/orders');
|
||||
|
||||
// Step 1: Login
|
||||
await page.goto('/login');
|
||||
await page.fill('[data-testid="email"]', user.email);
|
||||
await page.fill('[data-testid="password"]', 'password123');
|
||||
await page.click('[data-testid="login-button"]');
|
||||
await loginPromise;
|
||||
|
||||
// Assert: Dashboard visible
|
||||
await expect(page).toHaveURL('/dashboard');
|
||||
await expect(page.getByText(`Welcome, ${user.name}`)).toBeVisible();
|
||||
|
||||
// Step 2: Add product to cart
|
||||
await page.goto(`/products/${product.id}`);
|
||||
await page.click('[data-testid="add-to-cart"]');
|
||||
await cartPromise;
|
||||
await expect(page.getByText('Added to cart')).toBeVisible();
|
||||
|
||||
// Step 3: Checkout with saved payment
|
||||
await page.goto('/checkout');
|
||||
await expect(page.getByText('Visa ending in 1234')).toBeVisible(); // Saved card
|
||||
await page.click('[data-testid="use-saved-card"]');
|
||||
await page.click('[data-testid="place-order"]');
|
||||
await orderPromise;
|
||||
|
||||
// Assert: Order confirmation
|
||||
await expect(page.getByText('Order Confirmed')).toBeVisible();
|
||||
await expect(page.getByText(/Order #\d+/)).toBeVisible();
|
||||
await expect(page.getByText('$29.99')).toBeVisible();
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points (E2E)**:
|
||||
|
||||
- Tests complete user journey across multiple pages
|
||||
- API setup for data (fast), UI for assertions (user-centric)
|
||||
- Network-first interception to prevent flakiness
|
||||
- Validates critical revenue path end-to-end
|
||||
|
||||
### Example 2: Integration Test (API/Service Layer)
|
||||
|
||||
**Scenario**: UserService creates user and assigns role via AuthRepository.
|
||||
|
||||
```typescript
|
||||
// tests/integration/user-service.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
import { createUser } from '../test-utils/factories';
|
||||
|
||||
test.describe('UserService Integration', () => {
|
||||
test('should create user with admin role via API', async ({ request }) => {
|
||||
const userData = createUser({ role: 'admin' });
|
||||
|
||||
// Direct API call (no UI)
|
||||
const response = await request.post('/api/users', {
|
||||
data: userData,
|
||||
});
|
||||
|
||||
expect(response.status()).toBe(201);
|
||||
|
||||
const createdUser = await response.json();
|
||||
expect(createdUser.id).toBeTruthy();
|
||||
expect(createdUser.email).toBe(userData.email);
|
||||
expect(createdUser.role).toBe('admin');
|
||||
|
||||
// Verify database state
|
||||
const getResponse = await request.get(`/api/users/${createdUser.id}`);
|
||||
expect(getResponse.status()).toBe(200);
|
||||
|
||||
const fetchedUser = await getResponse.json();
|
||||
expect(fetchedUser.role).toBe('admin');
|
||||
expect(fetchedUser.permissions).toContain('user:delete');
|
||||
expect(fetchedUser.permissions).toContain('user:update');
|
||||
|
||||
// Cleanup
|
||||
await request.delete(`/api/users/${createdUser.id}`);
|
||||
});
|
||||
|
||||
test('should validate email uniqueness constraint', async ({ request }) => {
|
||||
const userData = createUser({ email: 'duplicate@example.com' });
|
||||
|
||||
// Create first user
|
||||
const response1 = await request.post('/api/users', { data: userData });
|
||||
expect(response1.status()).toBe(201);
|
||||
|
||||
const user1 = await response1.json();
|
||||
|
||||
// Attempt duplicate email
|
||||
const response2 = await request.post('/api/users', { data: userData });
|
||||
expect(response2.status()).toBe(409); // Conflict
|
||||
const error = await response2.json();
|
||||
expect(error.message).toContain('Email already exists');
|
||||
|
||||
// Cleanup
|
||||
await request.delete(`/api/users/${user1.id}`);
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points (Integration)**:
|
||||
|
||||
- Tests service layer + database interaction
|
||||
- No UI involved—pure API validation
|
||||
- Business logic focus (role assignment, constraints)
|
||||
- Faster than E2E, more realistic than unit tests
|
||||
|
||||
### Example 3: Component Test (Isolated UI Component)
|
||||
|
||||
**Scenario**: Test button component in isolation with props and user interactions.
|
||||
|
||||
```typescript
|
||||
// src/components/Button.cy.tsx (Cypress Component Test)
|
||||
import { Button } from './Button';
|
||||
|
||||
describe('Button Component', () => {
|
||||
it('should render with correct label', () => {
|
||||
cy.mount(<Button label="Click Me" />);
|
||||
cy.contains('Click Me').should('be.visible');
|
||||
});
|
||||
|
||||
it('should call onClick handler when clicked', () => {
|
||||
const onClickSpy = cy.stub().as('onClick');
|
||||
cy.mount(<Button label="Submit" onClick={onClickSpy} />);
|
||||
|
||||
cy.get('button').click();
|
||||
cy.get('@onClick').should('have.been.calledOnce');
|
||||
});
|
||||
|
||||
it('should be disabled when disabled prop is true', () => {
|
||||
cy.mount(<Button label="Disabled" disabled={true} />);
|
||||
cy.get('button').should('be.disabled');
|
||||
cy.get('button').should('have.attr', 'aria-disabled', 'true');
|
||||
});
|
||||
|
||||
it('should show loading spinner when loading', () => {
|
||||
cy.mount(<Button label="Loading" loading={true} />);
|
||||
cy.get('[data-testid="spinner"]').should('be.visible');
|
||||
cy.get('button').should('be.disabled');
|
||||
});
|
||||
|
||||
it('should apply variant styles correctly', () => {
|
||||
cy.mount(<Button label="Primary" variant="primary" />);
|
||||
cy.get('button').should('have.class', 'btn-primary');
|
||||
|
||||
cy.mount(<Button label="Secondary" variant="secondary" />);
|
||||
cy.get('button').should('have.class', 'btn-secondary');
|
||||
});
|
||||
});
|
||||
|
||||
// Playwright Component Test equivalent
|
||||
import { test, expect } from '@playwright/experimental-ct-react';
|
||||
import { Button } from './Button';
|
||||
|
||||
test.describe('Button Component', () => {
|
||||
test('should call onClick handler when clicked', async ({ mount }) => {
|
||||
let clicked = false;
|
||||
const component = await mount(
|
||||
<Button label="Submit" onClick={() => { clicked = true; }} />
|
||||
);
|
||||
|
||||
await component.getByRole('button').click();
|
||||
expect(clicked).toBe(true);
|
||||
});
|
||||
|
||||
test('should be disabled when loading', async ({ mount }) => {
|
||||
const component = await mount(<Button label="Loading" loading={true} />);
|
||||
await expect(component.getByRole('button')).toBeDisabled();
|
||||
await expect(component.getByTestId('spinner')).toBeVisible();
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points (Component)**:
|
||||
|
||||
- Tests UI component in isolation (no full app)
|
||||
- Props + user interactions + visual states
|
||||
- Faster than E2E, more realistic than unit tests for UI
|
||||
- Great for design system components
|
||||
|
||||
### Example 4: Unit Test (Pure Function)
|
||||
|
||||
**Scenario**: Test pure business logic function without framework dependencies.
|
||||
|
||||
```typescript
|
||||
// src/utils/price-calculator.test.ts (Jest/Vitest)
|
||||
import { calculateDiscount, applyTaxes, calculateTotal } from './price-calculator';
|
||||
|
||||
describe('PriceCalculator', () => {
|
||||
describe('calculateDiscount', () => {
|
||||
it('should apply percentage discount correctly', () => {
|
||||
const result = calculateDiscount(100, { type: 'percentage', value: 20 });
|
||||
expect(result).toBe(80);
|
||||
});
|
||||
|
||||
it('should apply fixed amount discount correctly', () => {
|
||||
const result = calculateDiscount(100, { type: 'fixed', value: 15 });
|
||||
expect(result).toBe(85);
|
||||
});
|
||||
|
||||
it('should not apply discount below zero', () => {
|
||||
const result = calculateDiscount(10, { type: 'fixed', value: 20 });
|
||||
expect(result).toBe(0);
|
||||
});
|
||||
|
||||
it('should handle no discount', () => {
|
||||
const result = calculateDiscount(100, { type: 'none', value: 0 });
|
||||
expect(result).toBe(100);
|
||||
});
|
||||
});
|
||||
|
||||
describe('applyTaxes', () => {
|
||||
it('should calculate tax correctly for US', () => {
|
||||
const result = applyTaxes(100, { country: 'US', rate: 0.08 });
|
||||
expect(result).toBe(108);
|
||||
});
|
||||
|
||||
it('should calculate tax correctly for EU (VAT)', () => {
|
||||
const result = applyTaxes(100, { country: 'DE', rate: 0.19 });
|
||||
expect(result).toBe(119);
|
||||
});
|
||||
|
||||
it('should handle zero tax rate', () => {
|
||||
const result = applyTaxes(100, { country: 'US', rate: 0 });
|
||||
expect(result).toBe(100);
|
||||
});
|
||||
});
|
||||
|
||||
describe('calculateTotal', () => {
|
||||
it('should calculate total with discount and taxes', () => {
|
||||
const items = [
|
||||
{ price: 50, quantity: 2 }, // 100
|
||||
{ price: 30, quantity: 1 }, // 30
|
||||
];
|
||||
const discount = { type: 'percentage', value: 10 }; // -13
|
||||
const tax = { country: 'US', rate: 0.08 }; // +9.36
|
||||
|
||||
const result = calculateTotal(items, discount, tax);
|
||||
expect(result).toBeCloseTo(126.36, 2);
|
||||
});
|
||||
|
||||
it('should handle empty items array', () => {
|
||||
const result = calculateTotal([], { type: 'none', value: 0 }, { country: 'US', rate: 0 });
|
||||
expect(result).toBe(0);
|
||||
});
|
||||
|
||||
it('should calculate correctly without discount or tax', () => {
|
||||
const items = [{ price: 25, quantity: 4 }];
|
||||
const result = calculateTotal(items, { type: 'none', value: 0 }, { country: 'US', rate: 0 });
|
||||
expect(result).toBe(100);
|
||||
});
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points (Unit)**:
|
||||
|
||||
- Pure function testing—no framework dependencies
|
||||
- Fast execution (milliseconds)
|
||||
- Edge case coverage (zero, negative, empty inputs)
|
||||
- High cyclomatic complexity handled at unit level
|
||||
|
||||
## When to Use Which Level
|
||||
|
||||
| Scenario | Unit | Integration | E2E |
|
||||
| ---------------------- | ------------- | ----------------- | ------------- |
|
||||
| Pure business logic | ✅ Primary | ❌ Overkill | ❌ Overkill |
|
||||
| Database operations | ❌ Can't test | ✅ Primary | ❌ Overkill |
|
||||
| API contracts | ❌ Can't test | ✅ Primary | ⚠️ Supplement |
|
||||
| User journeys | ❌ Can't test | ❌ Can't test | ✅ Primary |
|
||||
| Component props/events | ✅ Partial | ⚠️ Component test | ❌ Overkill |
|
||||
| Visual regression | ❌ Can't test | ⚠️ Component test | ✅ Primary |
|
||||
| Error handling (logic) | ✅ Primary | ⚠️ Integration | ❌ Overkill |
|
||||
| Error handling (UI) | ❌ Partial | ⚠️ Component test | ✅ Primary |
|
||||
|
||||
## Anti-Pattern Examples
|
||||
|
||||
**❌ BAD: E2E test for business logic**
|
||||
|
||||
```typescript
|
||||
// DON'T DO THIS
|
||||
test('calculate discount via UI', async ({ page }) => {
|
||||
await page.goto('/calculator');
|
||||
await page.fill('[data-testid="price"]', '100');
|
||||
await page.fill('[data-testid="discount"]', '20');
|
||||
await page.click('[data-testid="calculate"]');
|
||||
await expect(page.getByText('$80')).toBeVisible();
|
||||
});
|
||||
// Problem: Slow, brittle, tests logic that should be unit tested
|
||||
```
|
||||
|
||||
**✅ GOOD: Unit test for business logic**
|
||||
|
||||
```typescript
|
||||
test('calculate discount', () => {
|
||||
expect(calculateDiscount(100, 20)).toBe(80);
|
||||
});
|
||||
// Fast, reliable, isolated
|
||||
```
|
||||
|
||||
_Source: Murat Testing Philosophy (test pyramid), existing test-levels-framework.md structure._
|
||||
@ -1,373 +0,0 @@
|
||||
<!-- Powered by BMAD-CORE™ -->
|
||||
|
||||
# Test Priorities Matrix
|
||||
|
||||
Guide for prioritizing test scenarios based on risk, criticality, and business impact.
|
||||
|
||||
## Priority Levels
|
||||
|
||||
### P0 - Critical (Must Test)
|
||||
|
||||
**Criteria:**
|
||||
|
||||
- Revenue-impacting functionality
|
||||
- Security-critical paths
|
||||
- Data integrity operations
|
||||
- Regulatory compliance requirements
|
||||
- Previously broken functionality (regression prevention)
|
||||
|
||||
**Examples:**
|
||||
|
||||
- Payment processing
|
||||
- Authentication/authorization
|
||||
- User data creation/deletion
|
||||
- Financial calculations
|
||||
- GDPR/privacy compliance
|
||||
|
||||
**Testing Requirements:**
|
||||
|
||||
- Comprehensive coverage at all levels
|
||||
- Both happy and unhappy paths
|
||||
- Edge cases and error scenarios
|
||||
- Performance under load
|
||||
|
||||
### P1 - High (Should Test)
|
||||
|
||||
**Criteria:**
|
||||
|
||||
- Core user journeys
|
||||
- Frequently used features
|
||||
- Features with complex logic
|
||||
- Integration points between systems
|
||||
- Features affecting user experience
|
||||
|
||||
**Examples:**
|
||||
|
||||
- User registration flow
|
||||
- Search functionality
|
||||
- Data import/export
|
||||
- Notification systems
|
||||
- Dashboard displays
|
||||
|
||||
**Testing Requirements:**
|
||||
|
||||
- Primary happy paths required
|
||||
- Key error scenarios
|
||||
- Critical edge cases
|
||||
- Basic performance validation
|
||||
|
||||
### P2 - Medium (Nice to Test)
|
||||
|
||||
**Criteria:**
|
||||
|
||||
- Secondary features
|
||||
- Admin functionality
|
||||
- Reporting features
|
||||
- Configuration options
|
||||
- UI polish and aesthetics
|
||||
|
||||
**Examples:**
|
||||
|
||||
- Admin settings panels
|
||||
- Report generation
|
||||
- Theme customization
|
||||
- Help documentation
|
||||
- Analytics tracking
|
||||
|
||||
**Testing Requirements:**
|
||||
|
||||
- Happy path coverage
|
||||
- Basic error handling
|
||||
- Can defer edge cases
|
||||
|
||||
### P3 - Low (Test if Time Permits)
|
||||
|
||||
**Criteria:**
|
||||
|
||||
- Rarely used features
|
||||
- Nice-to-have functionality
|
||||
- Cosmetic issues
|
||||
- Non-critical optimizations
|
||||
|
||||
**Examples:**
|
||||
|
||||
- Advanced preferences
|
||||
- Legacy feature support
|
||||
- Experimental features
|
||||
- Debug utilities
|
||||
|
||||
**Testing Requirements:**
|
||||
|
||||
- Smoke tests only
|
||||
- Can rely on manual testing
|
||||
- Document known limitations
|
||||
|
||||
## Risk-Based Priority Adjustments
|
||||
|
||||
### Increase Priority When:
|
||||
|
||||
- High user impact (affects >50% of users)
|
||||
- High financial impact (>$10K potential loss)
|
||||
- Security vulnerability potential
|
||||
- Compliance/legal requirements
|
||||
- Customer-reported issues
|
||||
- Complex implementation (>500 LOC)
|
||||
- Multiple system dependencies
|
||||
|
||||
### Decrease Priority When:
|
||||
|
||||
- Feature flag protected
|
||||
- Gradual rollout planned
|
||||
- Strong monitoring in place
|
||||
- Easy rollback capability
|
||||
- Low usage metrics
|
||||
- Simple implementation
|
||||
- Well-isolated component
|
||||
|
||||
## Test Coverage by Priority
|
||||
|
||||
| Priority | Unit Coverage | Integration Coverage | E2E Coverage |
|
||||
| -------- | ------------- | -------------------- | ------------------ |
|
||||
| P0 | >90% | >80% | All critical paths |
|
||||
| P1 | >80% | >60% | Main happy paths |
|
||||
| P2 | >60% | >40% | Smoke tests |
|
||||
| P3 | Best effort | Best effort | Manual only |
|
||||
|
||||
## Priority Assignment Rules
|
||||
|
||||
1. **Start with business impact** - What happens if this fails?
|
||||
2. **Consider probability** - How likely is failure?
|
||||
3. **Factor in detectability** - Would we know if it failed?
|
||||
4. **Account for recoverability** - Can we fix it quickly?
|
||||
|
||||
## Priority Decision Tree
|
||||
|
||||
```
|
||||
Is it revenue-critical?
|
||||
├─ YES → P0
|
||||
└─ NO → Does it affect core user journey?
|
||||
├─ YES → Is it high-risk?
|
||||
│ ├─ YES → P0
|
||||
│ └─ NO → P1
|
||||
└─ NO → Is it frequently used?
|
||||
├─ YES → P1
|
||||
└─ NO → Is it customer-facing?
|
||||
├─ YES → P2
|
||||
└─ NO → P3
|
||||
```
|
||||
|
||||
## Test Execution Order
|
||||
|
||||
1. Execute P0 tests first (fail fast on critical issues)
|
||||
2. Execute P1 tests second (core functionality)
|
||||
3. Execute P2 tests if time permits
|
||||
4. P3 tests only in full regression cycles
|
||||
|
||||
## Continuous Adjustment
|
||||
|
||||
Review and adjust priorities based on:
|
||||
|
||||
- Production incident patterns
|
||||
- User feedback and complaints
|
||||
- Usage analytics
|
||||
- Test failure history
|
||||
- Business priority changes
|
||||
|
||||
---
|
||||
|
||||
## Automated Priority Classification
|
||||
|
||||
### Example: Priority Calculator (Risk-Based Automation)
|
||||
|
||||
```typescript
|
||||
// src/testing/priority-calculator.ts
|
||||
|
||||
export type Priority = 'P0' | 'P1' | 'P2' | 'P3';
|
||||
|
||||
export type PriorityFactors = {
|
||||
revenueImpact: 'critical' | 'high' | 'medium' | 'low' | 'none';
|
||||
userImpact: 'all' | 'majority' | 'some' | 'few' | 'minimal';
|
||||
securityRisk: boolean;
|
||||
complianceRequired: boolean;
|
||||
previousFailure: boolean;
|
||||
complexity: 'high' | 'medium' | 'low';
|
||||
usage: 'frequent' | 'regular' | 'occasional' | 'rare';
|
||||
};
|
||||
|
||||
/**
|
||||
* Calculate test priority based on multiple factors
|
||||
* Mirrors the priority decision tree with objective criteria
|
||||
*/
|
||||
export function calculatePriority(factors: PriorityFactors): Priority {
|
||||
const { revenueImpact, userImpact, securityRisk, complianceRequired, previousFailure, complexity, usage } = factors;
|
||||
|
||||
// P0: Revenue-critical, security, or compliance
|
||||
if (revenueImpact === 'critical' || securityRisk || complianceRequired || (previousFailure && revenueImpact === 'high')) {
|
||||
return 'P0';
|
||||
}
|
||||
|
||||
// P0: High revenue + high complexity + frequent usage
|
||||
if (revenueImpact === 'high' && complexity === 'high' && usage === 'frequent') {
|
||||
return 'P0';
|
||||
}
|
||||
|
||||
// P1: Core user journey (majority impacted + frequent usage)
|
||||
if (userImpact === 'all' || userImpact === 'majority') {
|
||||
if (usage === 'frequent' || complexity === 'high') {
|
||||
return 'P1';
|
||||
}
|
||||
}
|
||||
|
||||
// P1: High revenue OR high complexity with regular usage
|
||||
if ((revenueImpact === 'high' && usage === 'regular') || (complexity === 'high' && usage === 'frequent')) {
|
||||
return 'P1';
|
||||
}
|
||||
|
||||
// P2: Secondary features (some impact, occasional usage)
|
||||
if (userImpact === 'some' || usage === 'occasional') {
|
||||
return 'P2';
|
||||
}
|
||||
|
||||
// P3: Rarely used, low impact
|
||||
return 'P3';
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate priority justification (for audit trail)
|
||||
*/
|
||||
export function justifyPriority(factors: PriorityFactors): string {
|
||||
const priority = calculatePriority(factors);
|
||||
const reasons: string[] = [];
|
||||
|
||||
if (factors.revenueImpact === 'critical') reasons.push('critical revenue impact');
|
||||
if (factors.securityRisk) reasons.push('security-critical');
|
||||
if (factors.complianceRequired) reasons.push('compliance requirement');
|
||||
if (factors.previousFailure) reasons.push('regression prevention');
|
||||
if (factors.userImpact === 'all' || factors.userImpact === 'majority') {
|
||||
reasons.push(`impacts ${factors.userImpact} users`);
|
||||
}
|
||||
if (factors.complexity === 'high') reasons.push('high complexity');
|
||||
if (factors.usage === 'frequent') reasons.push('frequently used');
|
||||
|
||||
return `${priority}: ${reasons.join(', ')}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Example: Payment scenario priority calculation
|
||||
*/
|
||||
const paymentScenario: PriorityFactors = {
|
||||
revenueImpact: 'critical',
|
||||
userImpact: 'all',
|
||||
securityRisk: true,
|
||||
complianceRequired: true,
|
||||
previousFailure: false,
|
||||
complexity: 'high',
|
||||
usage: 'frequent',
|
||||
};
|
||||
|
||||
console.log(calculatePriority(paymentScenario)); // 'P0'
|
||||
console.log(justifyPriority(paymentScenario));
|
||||
// 'P0: critical revenue impact, security-critical, compliance requirement, impacts all users, high complexity, frequently used'
|
||||
```
|
||||
|
||||
### Example: Test Suite Tagging Strategy
|
||||
|
||||
```typescript
|
||||
// tests/e2e/checkout.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
// Tag tests with priority for selective execution
|
||||
test.describe('Checkout Flow', () => {
|
||||
test('valid payment completes successfully @p0 @smoke @revenue', async ({ page }) => {
|
||||
// P0: Revenue-critical happy path
|
||||
await page.goto('/checkout');
|
||||
await page.getByTestId('payment-method').selectOption('credit-card');
|
||||
await page.getByTestId('card-number').fill('4242424242424242');
|
||||
await page.getByRole('button', { name: 'Place Order' }).click();
|
||||
|
||||
await expect(page.getByText('Order confirmed')).toBeVisible();
|
||||
});
|
||||
|
||||
test('expired card shows user-friendly error @p1 @error-handling', async ({ page }) => {
|
||||
// P1: Core error scenario (frequent user impact)
|
||||
await page.goto('/checkout');
|
||||
await page.getByTestId('payment-method').selectOption('credit-card');
|
||||
await page.getByTestId('card-number').fill('4000000000000069'); // Test card: expired
|
||||
await page.getByRole('button', { name: 'Place Order' }).click();
|
||||
|
||||
await expect(page.getByText('Card expired. Please use a different card.')).toBeVisible();
|
||||
});
|
||||
|
||||
test('coupon code applies discount correctly @p2', async ({ page }) => {
|
||||
// P2: Secondary feature (nice-to-have)
|
||||
await page.goto('/checkout');
|
||||
await page.getByTestId('coupon-code').fill('SAVE10');
|
||||
await page.getByRole('button', { name: 'Apply' }).click();
|
||||
|
||||
await expect(page.getByText('10% discount applied')).toBeVisible();
|
||||
});
|
||||
|
||||
test('gift message formatting preserved @p3', async ({ page }) => {
|
||||
// P3: Cosmetic feature (rarely used)
|
||||
await page.goto('/checkout');
|
||||
await page.getByTestId('gift-message').fill('Happy Birthday!\n\nWith love.');
|
||||
await page.getByRole('button', { name: 'Place Order' }).click();
|
||||
|
||||
// Message formatting preserved (linebreaks intact)
|
||||
await expect(page.getByTestId('order-summary')).toContainText('Happy Birthday!');
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Run tests by priority:**
|
||||
|
||||
```bash
|
||||
# P0 only (smoke tests, 2-5 min)
|
||||
npx playwright test --grep @p0
|
||||
|
||||
# P0 + P1 (core functionality, 10-15 min)
|
||||
npx playwright test --grep "@p0|@p1"
|
||||
|
||||
# Full regression (all priorities, 30+ min)
|
||||
npx playwright test
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Integration with Risk Scoring
|
||||
|
||||
Priority should align with risk score from `probability-impact.md`:
|
||||
|
||||
| Risk Score | Typical Priority | Rationale |
|
||||
| ---------- | ---------------- | ------------------------------------------ |
|
||||
| 9 | P0 | Critical blocker (probability=3, impact=3) |
|
||||
| 6-8 | P0 or P1 | High risk (requires mitigation) |
|
||||
| 4-5 | P1 or P2 | Medium risk (monitor closely) |
|
||||
| 1-3 | P2 or P3 | Low risk (document and defer) |
|
||||
|
||||
**Example**: Risk score 9 (checkout API failure) → P0 priority → comprehensive coverage required.
|
||||
|
||||
---
|
||||
|
||||
## Priority Checklist
|
||||
|
||||
Before finalizing test priorities:
|
||||
|
||||
- [ ] **Revenue impact assessed**: Payment, subscription, billing features → P0
|
||||
- [ ] **Security risks identified**: Auth, data exposure, injection attacks → P0
|
||||
- [ ] **Compliance requirements documented**: GDPR, PCI-DSS, SOC2 → P0
|
||||
- [ ] **User impact quantified**: >50% users → P0/P1, <10% → P2/P3
|
||||
- [ ] **Previous failures reviewed**: Regression prevention → increase priority
|
||||
- [ ] **Complexity evaluated**: >500 LOC or multiple dependencies → increase priority
|
||||
- [ ] **Usage metrics consulted**: Frequent use → P0/P1, rare use → P2/P3
|
||||
- [ ] **Monitoring coverage confirmed**: Strong monitoring → can decrease priority
|
||||
- [ ] **Rollback capability verified**: Easy rollback → can decrease priority
|
||||
- [ ] **Priorities tagged in tests**: @p0, @p1, @p2, @p3 for selective execution
|
||||
|
||||
## Integration Points
|
||||
|
||||
- **Used in workflows**: `*automate` (priority-based test generation), `*test-design` (scenario prioritization), `*trace` (coverage validation by priority)
|
||||
- **Related fragments**: `risk-governance.md` (risk scoring), `probability-impact.md` (impact assessment), `selective-testing.md` (tag-based execution)
|
||||
- **Tools**: Playwright/Cypress grep for tag filtering, CI scripts for priority-based execution
|
||||
|
||||
_Source: Risk-based testing practices, test prioritization strategies, production incident analysis_
|
||||
@ -1,664 +0,0 @@
|
||||
# Test Quality Definition of Done
|
||||
|
||||
## Principle
|
||||
|
||||
Tests must be deterministic, isolated, explicit, focused, and fast. Every test should execute in under 1.5 minutes, contain fewer than 300 lines, avoid hard waits and conditionals, keep assertions visible in test bodies, and clean up after itself for parallel execution.
|
||||
|
||||
## Rationale
|
||||
|
||||
Quality tests provide reliable signal about application health. Flaky tests erode confidence and waste engineering time. Tests that use hard waits (`waitForTimeout(3000)`) are non-deterministic and slow. Tests with hidden assertions or conditional logic become unmaintainable. Large tests (>300 lines) are hard to understand and debug. Slow tests (>1.5 min) block CI pipelines. Self-cleaning tests prevent state pollution in parallel runs.
|
||||
|
||||
## Pattern Examples
|
||||
|
||||
### Example 1: Deterministic Test Pattern
|
||||
|
||||
**Context**: When writing tests, eliminate all sources of non-determinism: hard waits, conditionals controlling flow, try-catch for flow control, and random data without seeds.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// ❌ BAD: Non-deterministic test with conditionals and hard waits
|
||||
test('user can view dashboard - FLAKY', async ({ page }) => {
|
||||
await page.goto('/dashboard');
|
||||
await page.waitForTimeout(3000); // NEVER - arbitrary wait
|
||||
|
||||
// Conditional flow control - test behavior varies
|
||||
if (await page.locator('[data-testid="welcome-banner"]').isVisible()) {
|
||||
await page.click('[data-testid="dismiss-banner"]');
|
||||
await page.waitForTimeout(500);
|
||||
}
|
||||
|
||||
// Try-catch for flow control - hides real issues
|
||||
try {
|
||||
await page.click('[data-testid="load-more"]');
|
||||
} catch (e) {
|
||||
// Silently continue - test passes even if button missing
|
||||
}
|
||||
|
||||
// Random data without control
|
||||
const randomEmail = `user${Math.random()}@example.com`;
|
||||
await expect(page.getByText(randomEmail)).toBeVisible(); // Will fail randomly
|
||||
});
|
||||
|
||||
// ✅ GOOD: Deterministic test with explicit waits
|
||||
test('user can view dashboard', async ({ page, apiRequest }) => {
|
||||
const user = createUser({ email: 'test@example.com', hasSeenWelcome: true });
|
||||
|
||||
// Setup via API (fast, controlled)
|
||||
await apiRequest.post('/api/users', { data: user });
|
||||
|
||||
// Network-first: Intercept BEFORE navigate
|
||||
const dashboardPromise = page.waitForResponse((resp) => resp.url().includes('/api/dashboard') && resp.status() === 200);
|
||||
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// Wait for actual response, not arbitrary time
|
||||
const dashboardResponse = await dashboardPromise;
|
||||
const dashboard = await dashboardResponse.json();
|
||||
|
||||
// Explicit assertions with controlled data
|
||||
await expect(page.getByText(`Welcome, ${user.name}`)).toBeVisible();
|
||||
await expect(page.getByTestId('dashboard-items')).toHaveCount(dashboard.items.length);
|
||||
|
||||
// No conditionals - test always executes same path
|
||||
// No try-catch - failures bubble up clearly
|
||||
});
|
||||
|
||||
// Cypress equivalent
|
||||
describe('Dashboard', () => {
|
||||
it('should display user dashboard', () => {
|
||||
const user = createUser({ email: 'test@example.com', hasSeenWelcome: true });
|
||||
|
||||
// Setup via task (fast, controlled)
|
||||
cy.task('db:seed', { users: [user] });
|
||||
|
||||
// Network-first interception
|
||||
cy.intercept('GET', '**/api/dashboard').as('getDashboard');
|
||||
|
||||
cy.visit('/dashboard');
|
||||
|
||||
// Deterministic wait for response
|
||||
cy.wait('@getDashboard').then((interception) => {
|
||||
const dashboard = interception.response.body;
|
||||
|
||||
// Explicit assertions
|
||||
cy.contains(`Welcome, ${user.name}`).should('be.visible');
|
||||
cy.get('[data-cy="dashboard-items"]').should('have.length', dashboard.items.length);
|
||||
});
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Replace `waitForTimeout()` with `waitForResponse()` or element state checks
|
||||
- Never use if/else to control test flow - tests should be deterministic
|
||||
- Avoid try-catch for flow control - let failures bubble up clearly
|
||||
- Use factory functions with controlled data, not `Math.random()`
|
||||
- Network-first pattern prevents race conditions
|
||||
|
||||
### Example 2: Isolated Test with Cleanup
|
||||
|
||||
**Context**: When tests create data, they must clean up after themselves to prevent state pollution in parallel runs. Use fixture auto-cleanup or explicit teardown.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// ❌ BAD: Test leaves data behind, pollutes other tests
|
||||
test('admin can create user - POLLUTES STATE', async ({ page, apiRequest }) => {
|
||||
await page.goto('/admin/users');
|
||||
|
||||
// Hardcoded email - collides in parallel runs
|
||||
await page.fill('[data-testid="email"]', 'newuser@example.com');
|
||||
await page.fill('[data-testid="name"]', 'New User');
|
||||
await page.click('[data-testid="create-user"]');
|
||||
|
||||
await expect(page.getByText('User created')).toBeVisible();
|
||||
|
||||
// NO CLEANUP - user remains in database
|
||||
// Next test run fails: "Email already exists"
|
||||
});
|
||||
|
||||
// ✅ GOOD: Test cleans up with fixture auto-cleanup
|
||||
// playwright/support/fixtures/database-fixture.ts
|
||||
import { test as base } from '@playwright/test';
|
||||
import { deleteRecord, seedDatabase } from '../helpers/db-helpers';
|
||||
|
||||
type DatabaseFixture = {
|
||||
seedUser: (userData: Partial<User>) => Promise<User>;
|
||||
};
|
||||
|
||||
export const test = base.extend<DatabaseFixture>({
|
||||
seedUser: async ({}, use) => {
|
||||
const createdUsers: string[] = [];
|
||||
|
||||
const seedUser = async (userData: Partial<User>) => {
|
||||
const user = await seedDatabase('users', userData);
|
||||
createdUsers.push(user.id); // Track for cleanup
|
||||
return user;
|
||||
};
|
||||
|
||||
await use(seedUser);
|
||||
|
||||
// Auto-cleanup: Delete all users created during test
|
||||
for (const userId of createdUsers) {
|
||||
await deleteRecord('users', userId);
|
||||
}
|
||||
createdUsers.length = 0;
|
||||
},
|
||||
});
|
||||
|
||||
// Use the fixture
|
||||
test('admin can create user', async ({ page, seedUser }) => {
|
||||
// Create admin with unique data
|
||||
const admin = await seedUser({
|
||||
email: faker.internet.email(), // Unique each run
|
||||
role: 'admin',
|
||||
});
|
||||
|
||||
await page.goto('/admin/users');
|
||||
|
||||
const newUserEmail = faker.internet.email(); // Unique
|
||||
await page.fill('[data-testid="email"]', newUserEmail);
|
||||
await page.fill('[data-testid="name"]', 'New User');
|
||||
await page.click('[data-testid="create-user"]');
|
||||
|
||||
await expect(page.getByText('User created')).toBeVisible();
|
||||
|
||||
// Verify in database
|
||||
const createdUser = await seedUser({ email: newUserEmail });
|
||||
expect(createdUser.email).toBe(newUserEmail);
|
||||
|
||||
// Auto-cleanup happens via fixture teardown
|
||||
});
|
||||
|
||||
// Cypress equivalent with explicit cleanup
|
||||
describe('Admin User Management', () => {
|
||||
const createdUserIds: string[] = [];
|
||||
|
||||
afterEach(() => {
|
||||
// Cleanup: Delete all users created during test
|
||||
createdUserIds.forEach((userId) => {
|
||||
cy.task('db:delete', { table: 'users', id: userId });
|
||||
});
|
||||
createdUserIds.length = 0;
|
||||
});
|
||||
|
||||
it('should create user', () => {
|
||||
const admin = createUser({ role: 'admin' });
|
||||
const newUser = createUser(); // Unique data via faker
|
||||
|
||||
cy.task('db:seed', { users: [admin] }).then((result: any) => {
|
||||
createdUserIds.push(result.users[0].id);
|
||||
});
|
||||
|
||||
cy.visit('/admin/users');
|
||||
cy.get('[data-cy="email"]').type(newUser.email);
|
||||
cy.get('[data-cy="name"]').type(newUser.name);
|
||||
cy.get('[data-cy="create-user"]').click();
|
||||
|
||||
cy.contains('User created').should('be.visible');
|
||||
|
||||
// Track for cleanup
|
||||
cy.task('db:findByEmail', newUser.email).then((user: any) => {
|
||||
createdUserIds.push(user.id);
|
||||
});
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Use fixtures with auto-cleanup via teardown (after `use()`)
|
||||
- Track all created resources in array during test execution
|
||||
- Use `faker` for unique data - prevents parallel collisions
|
||||
- Cypress: Use `afterEach()` with explicit cleanup
|
||||
- Never hardcode IDs or emails - always generate unique values
|
||||
|
||||
### Example 3: Explicit Assertions in Tests
|
||||
|
||||
**Context**: When validating test results, keep assertions visible in test bodies. Never hide assertions in helper functions - this obscures test intent and makes failures harder to diagnose.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// ❌ BAD: Assertions hidden in helper functions
|
||||
// helpers/api-validators.ts
|
||||
export async function validateUserCreation(response: Response, expectedEmail: string) {
|
||||
const user = await response.json();
|
||||
expect(response.status()).toBe(201);
|
||||
expect(user.email).toBe(expectedEmail);
|
||||
expect(user.id).toBeTruthy();
|
||||
expect(user.createdAt).toBeTruthy();
|
||||
// Hidden assertions - not visible in test
|
||||
}
|
||||
|
||||
test('create user via API - OPAQUE', async ({ request }) => {
|
||||
const userData = createUser({ email: 'test@example.com' });
|
||||
|
||||
const response = await request.post('/api/users', { data: userData });
|
||||
|
||||
// What assertions are running? Have to check helper.
|
||||
await validateUserCreation(response, userData.email);
|
||||
// When this fails, error is: "validateUserCreation failed" - NOT helpful
|
||||
});
|
||||
|
||||
// ✅ GOOD: Assertions explicit in test
|
||||
test('create user via API', async ({ request }) => {
|
||||
const userData = createUser({ email: 'test@example.com' });
|
||||
|
||||
const response = await request.post('/api/users', { data: userData });
|
||||
|
||||
// All assertions visible - clear test intent
|
||||
expect(response.status()).toBe(201);
|
||||
|
||||
const createdUser = await response.json();
|
||||
expect(createdUser.id).toBeTruthy();
|
||||
expect(createdUser.email).toBe(userData.email);
|
||||
expect(createdUser.name).toBe(userData.name);
|
||||
expect(createdUser.role).toBe('user');
|
||||
expect(createdUser.createdAt).toBeTruthy();
|
||||
expect(createdUser.isActive).toBe(true);
|
||||
|
||||
// When this fails, error is: "Expected role to be 'user', got 'admin'" - HELPFUL
|
||||
});
|
||||
|
||||
// ✅ ACCEPTABLE: Helper for data extraction, NOT assertions
|
||||
// helpers/api-extractors.ts
|
||||
export async function extractUserFromResponse(response: Response): Promise<User> {
|
||||
const user = await response.json();
|
||||
return user; // Just extracts, no assertions
|
||||
}
|
||||
|
||||
test('create user with extraction helper', async ({ request }) => {
|
||||
const userData = createUser({ email: 'test@example.com' });
|
||||
|
||||
const response = await request.post('/api/users', { data: userData });
|
||||
|
||||
// Extract data with helper (OK)
|
||||
const createdUser = await extractUserFromResponse(response);
|
||||
|
||||
// But keep assertions in test (REQUIRED)
|
||||
expect(response.status()).toBe(201);
|
||||
expect(createdUser.email).toBe(userData.email);
|
||||
expect(createdUser.role).toBe('user');
|
||||
});
|
||||
|
||||
// Cypress equivalent
|
||||
describe('User API', () => {
|
||||
it('should create user with explicit assertions', () => {
|
||||
const userData = createUser({ email: 'test@example.com' });
|
||||
|
||||
cy.request('POST', '/api/users', userData).then((response) => {
|
||||
// All assertions visible in test
|
||||
expect(response.status).to.equal(201);
|
||||
expect(response.body.id).to.exist;
|
||||
expect(response.body.email).to.equal(userData.email);
|
||||
expect(response.body.name).to.equal(userData.name);
|
||||
expect(response.body.role).to.equal('user');
|
||||
expect(response.body.createdAt).to.exist;
|
||||
expect(response.body.isActive).to.be.true;
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
// ✅ GOOD: Parametrized tests for soft assertions (bulk validation)
|
||||
test.describe('User creation validation', () => {
|
||||
const testCases = [
|
||||
{ field: 'email', value: 'test@example.com', expected: 'test@example.com' },
|
||||
{ field: 'name', value: 'Test User', expected: 'Test User' },
|
||||
{ field: 'role', value: 'admin', expected: 'admin' },
|
||||
{ field: 'isActive', value: true, expected: true },
|
||||
];
|
||||
|
||||
for (const { field, value, expected } of testCases) {
|
||||
test(`should set ${field} correctly`, async ({ request }) => {
|
||||
const userData = createUser({ [field]: value });
|
||||
|
||||
const response = await request.post('/api/users', { data: userData });
|
||||
const user = await response.json();
|
||||
|
||||
// Parametrized assertion - still explicit
|
||||
expect(user[field]).toBe(expected);
|
||||
});
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Never hide `expect()` calls in helper functions
|
||||
- Helpers can extract/transform data, but assertions stay in tests
|
||||
- Parametrized tests are acceptable for bulk validation (still explicit)
|
||||
- Explicit assertions make failures actionable: "Expected X, got Y"
|
||||
- Hidden assertions produce vague failures: "Helper function failed"
|
||||
|
||||
### Example 4: Test Length Limits
|
||||
|
||||
**Context**: When tests grow beyond 300 lines, they become hard to understand, debug, and maintain. Refactor long tests by extracting setup helpers, splitting scenarios, or using fixtures.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// ❌ BAD: 400-line monolithic test (truncated for example)
|
||||
test('complete user journey - TOO LONG', async ({ page, request }) => {
|
||||
// 50 lines of setup
|
||||
const admin = createUser({ role: 'admin' });
|
||||
await request.post('/api/users', { data: admin });
|
||||
await page.goto('/login');
|
||||
await page.fill('[data-testid="email"]', admin.email);
|
||||
await page.fill('[data-testid="password"]', 'password123');
|
||||
await page.click('[data-testid="login"]');
|
||||
await expect(page).toHaveURL('/dashboard');
|
||||
|
||||
// 100 lines of user creation
|
||||
await page.goto('/admin/users');
|
||||
const newUser = createUser();
|
||||
await page.fill('[data-testid="email"]', newUser.email);
|
||||
// ... 95 more lines of form filling, validation, etc.
|
||||
|
||||
// 100 lines of permissions assignment
|
||||
await page.click('[data-testid="assign-permissions"]');
|
||||
// ... 95 more lines
|
||||
|
||||
// 100 lines of notification preferences
|
||||
await page.click('[data-testid="notification-settings"]');
|
||||
// ... 95 more lines
|
||||
|
||||
// 50 lines of cleanup
|
||||
await request.delete(`/api/users/${newUser.id}`);
|
||||
// ... 45 more lines
|
||||
|
||||
// TOTAL: 400 lines - impossible to understand or debug
|
||||
});
|
||||
|
||||
// ✅ GOOD: Split into focused tests with shared fixture
|
||||
// playwright/support/fixtures/admin-fixture.ts
|
||||
export const test = base.extend({
|
||||
adminPage: async ({ page, request }, use) => {
|
||||
// Shared setup: Login as admin
|
||||
const admin = createUser({ role: 'admin' });
|
||||
await request.post('/api/users', { data: admin });
|
||||
|
||||
await page.goto('/login');
|
||||
await page.fill('[data-testid="email"]', admin.email);
|
||||
await page.fill('[data-testid="password"]', 'password123');
|
||||
await page.click('[data-testid="login"]');
|
||||
await expect(page).toHaveURL('/dashboard');
|
||||
|
||||
await use(page); // Provide logged-in page
|
||||
|
||||
// Cleanup handled by fixture
|
||||
},
|
||||
});
|
||||
|
||||
// Test 1: User creation (50 lines)
|
||||
test('admin can create user', async ({ adminPage, seedUser }) => {
|
||||
await adminPage.goto('/admin/users');
|
||||
|
||||
const newUser = createUser();
|
||||
await adminPage.fill('[data-testid="email"]', newUser.email);
|
||||
await adminPage.fill('[data-testid="name"]', newUser.name);
|
||||
await adminPage.click('[data-testid="role-dropdown"]');
|
||||
await adminPage.click('[data-testid="role-user"]');
|
||||
await adminPage.click('[data-testid="create-user"]');
|
||||
|
||||
await expect(adminPage.getByText('User created')).toBeVisible();
|
||||
await expect(adminPage.getByText(newUser.email)).toBeVisible();
|
||||
|
||||
// Verify in database
|
||||
const created = await seedUser({ email: newUser.email });
|
||||
expect(created.role).toBe('user');
|
||||
});
|
||||
|
||||
// Test 2: Permission assignment (60 lines)
|
||||
test('admin can assign permissions', async ({ adminPage, seedUser }) => {
|
||||
const user = await seedUser({ email: faker.internet.email() });
|
||||
|
||||
await adminPage.goto(`/admin/users/${user.id}`);
|
||||
await adminPage.click('[data-testid="assign-permissions"]');
|
||||
await adminPage.check('[data-testid="permission-read"]');
|
||||
await adminPage.check('[data-testid="permission-write"]');
|
||||
await adminPage.click('[data-testid="save-permissions"]');
|
||||
|
||||
await expect(adminPage.getByText('Permissions updated')).toBeVisible();
|
||||
|
||||
// Verify permissions assigned
|
||||
const response = await adminPage.request.get(`/api/users/${user.id}`);
|
||||
const updated = await response.json();
|
||||
expect(updated.permissions).toContain('read');
|
||||
expect(updated.permissions).toContain('write');
|
||||
});
|
||||
|
||||
// Test 3: Notification preferences (70 lines)
|
||||
test('admin can update notification preferences', async ({ adminPage, seedUser }) => {
|
||||
const user = await seedUser({ email: faker.internet.email() });
|
||||
|
||||
await adminPage.goto(`/admin/users/${user.id}/notifications`);
|
||||
await adminPage.check('[data-testid="email-notifications"]');
|
||||
await adminPage.uncheck('[data-testid="sms-notifications"]');
|
||||
await adminPage.selectOption('[data-testid="frequency"]', 'daily');
|
||||
await adminPage.click('[data-testid="save-preferences"]');
|
||||
|
||||
await expect(adminPage.getByText('Preferences saved')).toBeVisible();
|
||||
|
||||
// Verify preferences
|
||||
const response = await adminPage.request.get(`/api/users/${user.id}/preferences`);
|
||||
const prefs = await response.json();
|
||||
expect(prefs.emailEnabled).toBe(true);
|
||||
expect(prefs.smsEnabled).toBe(false);
|
||||
expect(prefs.frequency).toBe('daily');
|
||||
});
|
||||
|
||||
// TOTAL: 3 tests × 60 lines avg = 180 lines
|
||||
// Each test is focused, debuggable, and under 300 lines
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Split monolithic tests into focused scenarios (<300 lines each)
|
||||
- Extract common setup into fixtures (auto-runs for each test)
|
||||
- Each test validates one concern (user creation, permissions, preferences)
|
||||
- Failures are easier to diagnose: "Permission assignment failed" vs "Complete journey failed"
|
||||
- Tests can run in parallel (isolated concerns)
|
||||
|
||||
### Example 5: Execution Time Optimization
|
||||
|
||||
**Context**: When tests take longer than 1.5 minutes, they slow CI pipelines and feedback loops. Optimize by using API setup instead of UI navigation, parallelizing independent operations, and avoiding unnecessary waits.
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// ❌ BAD: 4-minute test (slow setup, sequential operations)
|
||||
test('user completes order - SLOW (4 min)', async ({ page }) => {
|
||||
// Step 1: Manual signup via UI (90 seconds)
|
||||
await page.goto('/signup');
|
||||
await page.fill('[data-testid="email"]', 'buyer@example.com');
|
||||
await page.fill('[data-testid="password"]', 'password123');
|
||||
await page.fill('[data-testid="confirm-password"]', 'password123');
|
||||
await page.fill('[data-testid="name"]', 'Buyer User');
|
||||
await page.click('[data-testid="signup"]');
|
||||
await page.waitForURL('/verify-email'); // Wait for email verification
|
||||
// ... manual email verification flow
|
||||
|
||||
// Step 2: Manual product creation via UI (60 seconds)
|
||||
await page.goto('/admin/products');
|
||||
await page.fill('[data-testid="product-name"]', 'Widget');
|
||||
// ... 20 more fields
|
||||
await page.click('[data-testid="create-product"]');
|
||||
|
||||
// Step 3: Navigate to checkout (30 seconds)
|
||||
await page.goto('/products');
|
||||
await page.waitForTimeout(5000); // Unnecessary hard wait
|
||||
await page.click('[data-testid="product-widget"]');
|
||||
await page.waitForTimeout(3000); // Unnecessary
|
||||
await page.click('[data-testid="add-to-cart"]');
|
||||
await page.waitForTimeout(2000); // Unnecessary
|
||||
|
||||
// Step 4: Complete checkout (40 seconds)
|
||||
await page.goto('/checkout');
|
||||
await page.waitForTimeout(5000); // Unnecessary
|
||||
await page.fill('[data-testid="credit-card"]', '4111111111111111');
|
||||
// ... more form filling
|
||||
await page.click('[data-testid="submit-order"]');
|
||||
await page.waitForTimeout(10000); // Unnecessary
|
||||
|
||||
await expect(page.getByText('Order Confirmed')).toBeVisible();
|
||||
|
||||
// TOTAL: ~240 seconds (4 minutes)
|
||||
});
|
||||
|
||||
// ✅ GOOD: 45-second test (API setup, parallel ops, deterministic waits)
|
||||
test('user completes order', async ({ page, apiRequest }) => {
|
||||
// Step 1: API setup (parallel, 5 seconds total)
|
||||
const [user, product] = await Promise.all([
|
||||
// Create user via API (fast)
|
||||
apiRequest
|
||||
.post('/api/users', {
|
||||
data: createUser({
|
||||
email: 'buyer@example.com',
|
||||
emailVerified: true, // Skip verification
|
||||
}),
|
||||
})
|
||||
.then((r) => r.json()),
|
||||
|
||||
// Create product via API (fast)
|
||||
apiRequest
|
||||
.post('/api/products', {
|
||||
data: createProduct({
|
||||
name: 'Widget',
|
||||
price: 29.99,
|
||||
stock: 10,
|
||||
}),
|
||||
})
|
||||
.then((r) => r.json()),
|
||||
]);
|
||||
|
||||
// Step 2: Auth setup via storage state (instant, 0 seconds)
|
||||
await page.context().addCookies([
|
||||
{
|
||||
name: 'auth_token',
|
||||
value: user.token,
|
||||
domain: 'localhost',
|
||||
path: '/',
|
||||
},
|
||||
]);
|
||||
|
||||
// Step 3: Network-first interception BEFORE navigation (10 seconds)
|
||||
const cartPromise = page.waitForResponse('**/api/cart');
|
||||
const orderPromise = page.waitForResponse('**/api/orders');
|
||||
|
||||
await page.goto(`/products/${product.id}`);
|
||||
await page.click('[data-testid="add-to-cart"]');
|
||||
await cartPromise; // Deterministic wait (no hard wait)
|
||||
|
||||
// Step 4: Checkout with network waits (30 seconds)
|
||||
await page.goto('/checkout');
|
||||
await page.fill('[data-testid="credit-card"]', '4111111111111111');
|
||||
await page.fill('[data-testid="cvv"]', '123');
|
||||
await page.fill('[data-testid="expiry"]', '12/25');
|
||||
await page.click('[data-testid="submit-order"]');
|
||||
await orderPromise; // Deterministic wait (no hard wait)
|
||||
|
||||
await expect(page.getByText('Order Confirmed')).toBeVisible();
|
||||
await expect(page.getByText(`Order #${product.id}`)).toBeVisible();
|
||||
|
||||
// TOTAL: ~45 seconds (6x faster)
|
||||
});
|
||||
|
||||
// Cypress equivalent
|
||||
describe('Order Flow', () => {
|
||||
it('should complete purchase quickly', () => {
|
||||
// Step 1: API setup (parallel, fast)
|
||||
const user = createUser({ emailVerified: true });
|
||||
const product = createProduct({ name: 'Widget', price: 29.99 });
|
||||
|
||||
cy.task('db:seed', { users: [user], products: [product] });
|
||||
|
||||
// Step 2: Auth setup via session (instant)
|
||||
cy.setCookie('auth_token', user.token);
|
||||
|
||||
// Step 3: Network-first interception
|
||||
cy.intercept('POST', '**/api/cart').as('addToCart');
|
||||
cy.intercept('POST', '**/api/orders').as('createOrder');
|
||||
|
||||
cy.visit(`/products/${product.id}`);
|
||||
cy.get('[data-cy="add-to-cart"]').click();
|
||||
cy.wait('@addToCart'); // Deterministic wait
|
||||
|
||||
// Step 4: Checkout
|
||||
cy.visit('/checkout');
|
||||
cy.get('[data-cy="credit-card"]').type('4111111111111111');
|
||||
cy.get('[data-cy="cvv"]').type('123');
|
||||
cy.get('[data-cy="expiry"]').type('12/25');
|
||||
cy.get('[data-cy="submit-order"]').click();
|
||||
cy.wait('@createOrder'); // Deterministic wait
|
||||
|
||||
cy.contains('Order Confirmed').should('be.visible');
|
||||
cy.contains(`Order #${product.id}`).should('be.visible');
|
||||
});
|
||||
});
|
||||
|
||||
// Additional optimization: Shared auth state (0 seconds per test)
|
||||
// playwright/support/global-setup.ts
|
||||
export default async function globalSetup() {
|
||||
const browser = await chromium.launch();
|
||||
const page = await browser.newPage();
|
||||
|
||||
// Create admin user once for all tests
|
||||
const admin = createUser({ role: 'admin', emailVerified: true });
|
||||
await page.request.post('/api/users', { data: admin });
|
||||
|
||||
// Login once, save session
|
||||
await page.goto('/login');
|
||||
await page.fill('[data-testid="email"]', admin.email);
|
||||
await page.fill('[data-testid="password"]', 'password123');
|
||||
await page.click('[data-testid="login"]');
|
||||
|
||||
// Save auth state for reuse
|
||||
await page.context().storageState({ path: 'playwright/.auth/admin.json' });
|
||||
|
||||
await browser.close();
|
||||
}
|
||||
|
||||
// Use shared auth in tests (instant)
|
||||
test.use({ storageState: 'playwright/.auth/admin.json' });
|
||||
|
||||
test('admin action', async ({ page }) => {
|
||||
// Already logged in - no auth overhead (0 seconds)
|
||||
await page.goto('/admin');
|
||||
// ... test logic
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Use API for data setup (10-50x faster than UI)
|
||||
- Run independent operations in parallel (`Promise.all`)
|
||||
- Replace hard waits with deterministic waits (`waitForResponse`)
|
||||
- Reuse auth sessions via `storageState` (Playwright) or `setCookie` (Cypress)
|
||||
- Skip unnecessary flows (email verification, multi-step signups)
|
||||
|
||||
## Integration Points
|
||||
|
||||
- **Used in workflows**: `*atdd` (test generation quality), `*automate` (test expansion quality), `*test-review` (quality validation)
|
||||
- **Related fragments**:
|
||||
- `network-first.md` - Deterministic waiting strategies
|
||||
- `data-factories.md` - Isolated, parallel-safe data patterns
|
||||
- `fixture-architecture.md` - Setup extraction and cleanup
|
||||
- `test-levels-framework.md` - Choosing appropriate test granularity for speed
|
||||
|
||||
## Core Quality Checklist
|
||||
|
||||
Every test must pass these criteria:
|
||||
|
||||
- [ ] **No Hard Waits** - Use `waitForResponse`, `waitForLoadState`, or element state (not `waitForTimeout`)
|
||||
- [ ] **No Conditionals** - Tests execute the same path every time (no if/else, try/catch for flow control)
|
||||
- [ ] **< 300 Lines** - Keep tests focused; split large tests or extract setup to fixtures
|
||||
- [ ] **< 1.5 Minutes** - Optimize with API setup, parallel operations, and shared auth
|
||||
- [ ] **Self-Cleaning** - Use fixtures with auto-cleanup or explicit `afterEach()` teardown
|
||||
- [ ] **Explicit Assertions** - Keep `expect()` calls in test bodies, not hidden in helpers
|
||||
- [ ] **Unique Data** - Use `faker` for dynamic data; never hardcode IDs or emails
|
||||
- [ ] **Parallel-Safe** - Tests don't share state; run successfully with `--workers=4`
|
||||
|
||||
_Source: Murat quality checklist, Definition of Done requirements (lines 370-381, 406-422)._
|
||||
@ -1,372 +0,0 @@
|
||||
# Timing Debugging and Race Condition Fixes
|
||||
|
||||
## Principle
|
||||
|
||||
Race conditions arise when tests make assumptions about asynchronous timing (network, animations, state updates). **Deterministic waiting** eliminates flakiness by explicitly waiting for observable events (network responses, element state changes) instead of arbitrary timeouts.
|
||||
|
||||
## Rationale
|
||||
|
||||
**The Problem**: Tests pass locally but fail in CI (different timing), or pass/fail randomly (race conditions). Hard waits (`waitForTimeout`, `sleep`) mask timing issues without solving them.
|
||||
|
||||
**The Solution**: Replace all hard waits with event-based waits (`waitForResponse`, `waitFor({ state })`). Implement network-first pattern (intercept before navigate). Use explicit state checks (loading spinner detached, data loaded). This makes tests deterministic regardless of network speed or system load.
|
||||
|
||||
**Why This Matters**:
|
||||
|
||||
- Eliminates flaky tests (0 tolerance for timing-based failures)
|
||||
- Works consistently across environments (local, CI, production-like)
|
||||
- Faster test execution (no unnecessary waits)
|
||||
- Clearer test intent (explicit about what we're waiting for)
|
||||
|
||||
## Pattern Examples
|
||||
|
||||
### Example 1: Race Condition Identification (Network-First Pattern)
|
||||
|
||||
**Context**: Prevent race conditions by intercepting network requests before navigation
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/timing/race-condition-prevention.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
test.describe('Race Condition Prevention Patterns', () => {
|
||||
test('❌ Anti-Pattern: Navigate then intercept (race condition)', async ({ page, context }) => {
|
||||
// BAD: Navigation starts before interception ready
|
||||
await page.goto('/products'); // ⚠️ Race! API might load before route is set
|
||||
|
||||
await context.route('**/api/products', (route) => {
|
||||
route.fulfill({ status: 200, body: JSON.stringify({ products: [] }) });
|
||||
});
|
||||
|
||||
// Test may see real API response or mock (non-deterministic)
|
||||
});
|
||||
|
||||
test('✅ Pattern: Intercept BEFORE navigate (deterministic)', async ({ page, context }) => {
|
||||
// GOOD: Interception ready before navigation
|
||||
await context.route('**/api/products', (route) => {
|
||||
route.fulfill({
|
||||
status: 200,
|
||||
contentType: 'application/json',
|
||||
body: JSON.stringify({
|
||||
products: [
|
||||
{ id: 1, name: 'Product A', price: 29.99 },
|
||||
{ id: 2, name: 'Product B', price: 49.99 },
|
||||
],
|
||||
}),
|
||||
});
|
||||
});
|
||||
|
||||
const responsePromise = page.waitForResponse('**/api/products');
|
||||
|
||||
await page.goto('/products'); // Navigation happens AFTER route is ready
|
||||
await responsePromise; // Explicit wait for network
|
||||
|
||||
// Test sees mock response reliably (deterministic)
|
||||
await expect(page.getByText('Product A')).toBeVisible();
|
||||
});
|
||||
|
||||
test('✅ Pattern: Wait for element state change (loading → loaded)', async ({ page }) => {
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// Wait for loading indicator to appear (confirms load started)
|
||||
await page.getByTestId('loading-spinner').waitFor({ state: 'visible' });
|
||||
|
||||
// Wait for loading indicator to disappear (confirms load complete)
|
||||
await page.getByTestId('loading-spinner').waitFor({ state: 'detached' });
|
||||
|
||||
// Content now reliably visible
|
||||
await expect(page.getByTestId('dashboard-data')).toBeVisible();
|
||||
});
|
||||
|
||||
test('✅ Pattern: Explicit visibility check (not just presence)', async ({ page }) => {
|
||||
await page.goto('/modal-demo');
|
||||
|
||||
await page.getByRole('button', { name: 'Open Modal' }).click();
|
||||
|
||||
// ❌ Bad: Element exists but may not be visible yet
|
||||
// await expect(page.getByTestId('modal')).toBeAttached()
|
||||
|
||||
// ✅ Good: Wait for visibility (accounts for animations)
|
||||
await expect(page.getByTestId('modal')).toBeVisible();
|
||||
await expect(page.getByRole('heading', { name: 'Modal Title' })).toBeVisible();
|
||||
});
|
||||
|
||||
test('❌ Anti-Pattern: waitForLoadState("networkidle") in SPAs', async ({ page }) => {
|
||||
// ⚠️ Deprecated for SPAs (WebSocket connections never idle)
|
||||
// await page.goto('/dashboard')
|
||||
// await page.waitForLoadState('networkidle') // May timeout in SPAs
|
||||
|
||||
// ✅ Better: Wait for specific API response
|
||||
const responsePromise = page.waitForResponse('**/api/dashboard');
|
||||
await page.goto('/dashboard');
|
||||
await responsePromise;
|
||||
|
||||
await expect(page.getByText('Dashboard loaded')).toBeVisible();
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- Network-first: ALWAYS intercept before navigate (prevents race conditions)
|
||||
- State changes: Wait for loading spinner detached (explicit load completion)
|
||||
- Visibility vs presence: `toBeVisible()` accounts for animations, `toBeAttached()` doesn't
|
||||
- Avoid networkidle: Unreliable in SPAs (WebSocket, polling connections)
|
||||
- Explicit waits: Document exactly what we're waiting for
|
||||
|
||||
---
|
||||
|
||||
### Example 2: Deterministic Waiting Patterns (Event-Based, Not Time-Based)
|
||||
|
||||
**Context**: Replace all hard waits with observable event waits
|
||||
|
||||
**Implementation**:
|
||||
|
||||
```typescript
|
||||
// tests/timing/deterministic-waits.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
test.describe('Deterministic Waiting Patterns', () => {
|
||||
test('waitForResponse() with URL pattern', async ({ page }) => {
|
||||
const responsePromise = page.waitForResponse('**/api/products');
|
||||
|
||||
await page.goto('/products');
|
||||
await responsePromise; // Deterministic (waits for exact API call)
|
||||
|
||||
await expect(page.getByText('Products loaded')).toBeVisible();
|
||||
});
|
||||
|
||||
test('waitForResponse() with predicate function', async ({ page }) => {
|
||||
const responsePromise = page.waitForResponse((resp) => resp.url().includes('/api/search') && resp.status() === 200);
|
||||
|
||||
await page.goto('/search');
|
||||
await page.getByPlaceholder('Search').fill('laptop');
|
||||
await page.getByRole('button', { name: 'Search' }).click();
|
||||
|
||||
await responsePromise; // Wait for successful search response
|
||||
|
||||
await expect(page.getByTestId('search-results')).toBeVisible();
|
||||
});
|
||||
|
||||
test('waitForFunction() for custom conditions', async ({ page }) => {
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// Wait for custom JavaScript condition
|
||||
await page.waitForFunction(() => {
|
||||
const element = document.querySelector('[data-testid="user-count"]');
|
||||
return element && parseInt(element.textContent || '0') > 0;
|
||||
});
|
||||
|
||||
// User count now loaded
|
||||
await expect(page.getByTestId('user-count')).not.toHaveText('0');
|
||||
});
|
||||
|
||||
test('waitFor() element state (attached, visible, hidden, detached)', async ({ page }) => {
|
||||
await page.goto('/products');
|
||||
|
||||
// Wait for element to be attached to DOM
|
||||
await page.getByTestId('product-list').waitFor({ state: 'attached' });
|
||||
|
||||
// Wait for element to be visible (animations complete)
|
||||
await page.getByTestId('product-list').waitFor({ state: 'visible' });
|
||||
|
||||
// Perform action
|
||||
await page.getByText('Product A').click();
|
||||
|
||||
// Wait for modal to be hidden (close animation complete)
|
||||
await page.getByTestId('modal').waitFor({ state: 'hidden' });
|
||||
});
|
||||
|
||||
test('Cypress: cy.wait() with aliased intercepts', async () => {
|
||||
// Cypress example (not Playwright)
|
||||
/*
|
||||
cy.intercept('GET', '/api/products').as('getProducts')
|
||||
cy.visit('/products')
|
||||
cy.wait('@getProducts') // Deterministic wait for specific request
|
||||
|
||||
cy.get('[data-testid="product-list"]').should('be.visible')
|
||||
*/
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Key Points**:
|
||||
|
||||
- `waitForResponse()`: Wait for specific API calls (URL pattern or predicate)
|
||||
- `waitForFunction()`: Wait for custom JavaScript conditions
|
||||
- `waitFor({ state })`: Wait for element state changes (attached, visible, hidden, detached)
|
||||
- Cypress `cy.wait('@alias')`: Deterministic wait for aliased intercepts
|
||||
- All waits are event-based (not time-based)
|
||||
|
||||
---
|
||||
|
||||
### Example 3: Timing Anti-Patterns (What NEVER to Do)
|
||||
|
||||
**Context**: Common timing mistakes that cause flakiness
|
||||
|
||||
**Problem Examples**:
|
||||
|
||||
```typescript
|
||||
// tests/timing/anti-patterns.spec.ts
|
||||
import { test, expect } from '@playwright/test';
|
||||
|
||||
test.describe('Timing Anti-Patterns to Avoid', () => {
|
||||
test('❌ NEVER: page.waitForTimeout() (arbitrary delay)', async ({ page }) => {
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// ❌ Bad: Arbitrary 3-second wait (flaky)
|
||||
// await page.waitForTimeout(3000)
|
||||
// Problem: Might be too short (CI slower) or too long (wastes time)
|
||||
|
||||
// ✅ Good: Wait for observable event
|
||||
await page.waitForResponse('**/api/dashboard');
|
||||
await expect(page.getByText('Dashboard loaded')).toBeVisible();
|
||||
});
|
||||
|
||||
test('❌ NEVER: cy.wait(number) without alias (arbitrary delay)', async () => {
|
||||
// Cypress example
|
||||
/*
|
||||
// ❌ Bad: Arbitrary delay
|
||||
cy.visit('/products')
|
||||
cy.wait(2000) // Flaky!
|
||||
|
||||
// ✅ Good: Wait for specific request
|
||||
cy.intercept('GET', '/api/products').as('getProducts')
|
||||
cy.visit('/products')
|
||||
cy.wait('@getProducts') // Deterministic
|
||||
*/
|
||||
});
|
||||
|
||||
test('❌ NEVER: Multiple hard waits in sequence (compounding delays)', async ({ page }) => {
|
||||
await page.goto('/checkout');
|
||||
|
||||
// ❌ Bad: Stacked hard waits (6+ seconds wasted)
|
||||
// await page.waitForTimeout(2000) // Wait for form
|
||||
// await page.getByTestId('email').fill('test@example.com')
|
||||
// await page.waitForTimeout(1000) // Wait for validation
|
||||
// await page.getByTestId('submit').click()
|
||||
// await page.waitForTimeout(3000) // Wait for redirect
|
||||
|
||||
// ✅ Good: Event-based waits (no wasted time)
|
||||
await page.getByTestId('checkout-form').waitFor({ state: 'visible' });
|
||||
await page.getByTestId('email').fill('test@example.com');
|
||||
await page.waitForResponse('**/api/validate-email');
|
||||
await page.getByTestId('submit').click();
|
||||
await page.waitForURL('**/confirmation');
|
||||
});
|
||||
|
||||
test('❌ NEVER: waitForLoadState("networkidle") in SPAs', async ({ page }) => {
|
||||
// ❌ Bad: Unreliable in SPAs (WebSocket connections never idle)
|
||||
// await page.goto('/dashboard')
|
||||
// await page.waitForLoadState('networkidle') // Timeout in SPAs!
|
||||
|
||||
// ✅ Good: Wait for specific API responses
|
||||
await page.goto('/dashboard');
|
||||
await page.waitForResponse('**/api/dashboard');
|
||||
await page.waitForResponse('**/api/user');
|
||||
await expect(page.getByTestId('dashboard-content')).toBeVisible();
|
||||
});
|
||||
|
||||
test('❌ NEVER: Sleep/setTimeout in tests', async ({ page }) => {
|
||||
await page.goto('/products');
|
||||
|
||||
// ❌ Bad: Node.js sleep (blocks test thread)
|
||||
// await new Promise(resolve => setTimeout(resolve, 2000))
|
||||
|
||||
// ✅ Good: Playwright auto-waits for element
|
||||
await expect(page.getByText('Products loaded')).toBeVisible();
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
**Why These Fail**:
|
||||
|
||||
- **Hard waits**: Arbitrary timeouts (too short → flaky, too long → slow)
|
||||
- **Stacked waits**: Compound delays (wasteful, unreliable)
|
||||
- **networkidle**: Broken in SPAs (WebSocket/polling never idle)
|
||||
- **Sleep**: Blocks execution (wastes time, doesn't solve race conditions)
|
||||
|
||||
**Better Approach**: Use event-based waits from examples above
|
||||
|
||||
---
|
||||
|
||||
## Async Debugging Techniques
|
||||
|
||||
### Technique 1: Promise Chain Analysis
|
||||
|
||||
```typescript
|
||||
test('debug async waterfall with console logs', async ({ page }) => {
|
||||
console.log('1. Starting navigation...');
|
||||
await page.goto('/products');
|
||||
|
||||
console.log('2. Waiting for API response...');
|
||||
const response = await page.waitForResponse('**/api/products');
|
||||
console.log('3. API responded:', response.status());
|
||||
|
||||
console.log('4. Waiting for UI update...');
|
||||
await expect(page.getByText('Products loaded')).toBeVisible();
|
||||
console.log('5. Test complete');
|
||||
|
||||
// Console output shows exactly where timing issue occurs
|
||||
});
|
||||
```
|
||||
|
||||
### Technique 2: Network Waterfall Inspection (DevTools)
|
||||
|
||||
```typescript
|
||||
test('inspect network timing with trace viewer', async ({ page }) => {
|
||||
await page.goto('/dashboard');
|
||||
|
||||
// Generate trace for analysis
|
||||
// npx playwright test --trace on
|
||||
// npx playwright show-trace trace.zip
|
||||
|
||||
// In trace viewer:
|
||||
// 1. Check Network tab for API call timing
|
||||
// 2. Identify slow requests (>1s response time)
|
||||
// 3. Find race conditions (overlapping requests)
|
||||
// 4. Verify request order (dependencies)
|
||||
});
|
||||
```
|
||||
|
||||
### Technique 3: Trace Viewer for Timing Visualization
|
||||
|
||||
```typescript
|
||||
test('use trace viewer to debug timing', async ({ page }) => {
|
||||
// Run with trace: npx playwright test --trace on
|
||||
|
||||
await page.goto('/checkout');
|
||||
await page.getByTestId('submit').click();
|
||||
|
||||
// In trace viewer, examine:
|
||||
// - Timeline: See exact timing of each action
|
||||
// - Snapshots: Hover to see DOM state at each moment
|
||||
// - Network: Identify slow/failed requests
|
||||
// - Console: Check for async errors
|
||||
|
||||
await expect(page.getByText('Success')).toBeVisible();
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Race Condition Checklist
|
||||
|
||||
Before deploying tests:
|
||||
|
||||
- [ ] **Network-first pattern**: All routes intercepted BEFORE navigation (no race conditions)
|
||||
- [ ] **Explicit waits**: Every navigation followed by `waitForResponse()` or state check
|
||||
- [ ] **No hard waits**: Zero instances of `waitForTimeout()`, `cy.wait(number)`, `sleep()`
|
||||
- [ ] **Element state waits**: Loading spinners use `waitFor({ state: 'detached' })`
|
||||
- [ ] **Visibility checks**: Use `toBeVisible()` (accounts for animations), not just `toBeAttached()`
|
||||
- [ ] **Response validation**: Wait for successful responses (`resp.ok()` or `status === 200`)
|
||||
- [ ] **Trace viewer analysis**: Generate traces to identify timing issues (network waterfall, console errors)
|
||||
- [ ] **CI/local parity**: Tests pass reliably in both environments (no timing assumptions)
|
||||
|
||||
## Integration Points
|
||||
|
||||
- **Used in workflows**: `*automate` (healing timing failures), `*test-review` (detect hard wait anti-patterns), `*framework` (configure timeout standards)
|
||||
- **Related fragments**: `test-healing-patterns.md` (race condition diagnosis), `network-first.md` (interception patterns), `playwright-config.md` (timeout configuration), `visual-debugging.md` (trace viewer analysis)
|
||||
- **Tools**: Playwright Inspector (`--debug`), Trace Viewer (`--trace on`), DevTools Network tab
|
||||
|
||||
_Source: Playwright timing best practices, network-first pattern from test-resources-for-ai, production race condition debugging_
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user