Commit bfdc9f3
authored
feat(agents): add brd-builder.agent.md for building BRDs (#122)
# Pull Request
## Description
Added a comprehensive agent definition that guides users through
creating Business Requirements Documents (BRDs) with structured Q&A
workflows, reference integration, and session state management.
- **feat**(_agents_): Created `brd-builder.agent.md` providing a
Business Analyst expert agent for iterative BRD creation
- Implements 7-phase process: Assess, Discover, Create, Elicit,
Integrate, Validate, Finalize
- Supports session continuity with JSON state tracking in
`.copilot-tracking/brd-sessions/`
- Includes emoji-based refinement questions checklist for requirements
gathering
- Provides reference integration with conflict resolution hierarchy
- Contains complete BRD template with 14 sections covering context,
requirements, processes, risks, and implementation
- **chore**(_vscode_): Added `.github/agents` directory to VS Code chat
mode file locations
🏗️ - Generated by Copilot
## Type of Change
Select all that apply:
**Code & Documentation:**
- [ ] Bug fix (non-breaking change fixing an issue)
- [x] New feature (non-breaking change adding functionality)
- [ ] Breaking change (fix or feature causing existing functionality to
change)
- [ ] Documentation update
**Infrastructure & Configuration:**
- [ ] GitHub Actions workflow
- [ ] Linting configuration (markdown, PowerShell, etc.)
- [ ] Security configuration
- [ ] DevContainer configuration
- [ ] Dependency update
**AI Artifacts:**
- [x] Reviewed contribution with `prompt-builder` chatmode and addressed
all feedback
- [ ] Copilot instructions (`.github/instructions/*.instructions.md`)
- [ ] Copilot prompt (`.github/prompts/*.prompt.md`)
- [x] Copilot chatmode (`.github/chatmodes/*.chatmode.md`)
> **Note for AI Artifact Contributors**:
>
> - **Chatmodes**: Research, indexing/referencing other project (using
standard VS Code GitHub Copilot/MCP tools), planning, and general
implementation chatmodes likely already exist. Review
`.github/chatmodes/` before creating new ones.
> - **Model Versions**: Only contributions targeting the **latest
Anthropic and OpenAI models** will be accepted. Older model versions
(e.g., GPT-3.5, Claude 3) will be rejected.
> - See [Chatmodes Not
Accepted](../docs/contributing-chatmodes.md#chatmodes-not-accepted) and
[Model Version
Requirements](../docs/contributing-ai-artifacts-common.md#model-version-requirements).
**Other:**
- [ ] Script/automation (`.ps1`, `.sh`, `.py`)
- [ ] Other (please describe):
## Sample Prompts (for AI Artifact Contributions)
**User Request:**
```text
Initiative: a new digital onboarding portal for small-business banking customers.
Please guide me through your structured question process, maintain a refinement checklist, and progressively draft the BRD as we go.
Start by asking me the minimum questions you need to name the BRD, define basic context, and create the initial BRD skeleton. Then show me the first draft sections as you fill them in.
```
**Execution Flow:**
````markdown
I'll help you create a BRD for the small-business banking digital onboarding portal. Let me start with the essential context questions to establish the foundation.
---
## 🚀 BRD Builder: Small-Business Banking Digital Onboarding Portal
Let me gather the minimum information needed to create your BRD file and establish basic context.
---
### Refinement Questions Checklist
#### 1. 🎯 **Business Initiative Context**
* 1.a. [ ] ❓ **Initiative name**: What would you like to call this initiative? (e.g., "SMB Digital Onboarding Portal", "Small Business Customer Onboarding Transformation")
* 1.b. [ ] ❓ **Business problem**: What specific problem or pain point does this portal solve? (e.g., slow onboarding times, high abandonment rates, manual processes)
* 1.c. [ ] ❓ **Business driver**: What's driving this initiative? (regulatory requirement, competitive pressure, cost reduction, customer experience improvement, growth enablement)
#### 2. 📋 **Scope Boundaries**
* 2.a. [ ] ❓ **Business unit / sponsor**: Which business unit owns this initiative, and who is the executive sponsor?
* 2.b. [ ] ❓ **Target customers**: What defines a "small-business" customer for this portal? (revenue thresholds, employee count, business type)
---
**Please answer these 5 questions**, and I'll immediately create:
1. The BRD file at `docs/brds/<initiative-name>-brd.md`
2. The session state file for continuity
3. The initial skeleton with your context filled in
Once created, I'll show you the first draft sections and continue with deeper requirements elicitation.
````
**Output Artifacts:**
````markdown
<!-- markdownlint-disable-file -->
<!-- markdown-table-prettify-ignore-start -->
# SMB Digital Onboarding Portal – Business Requirements Document (BRD)
Version 0.1 | Status Draft | Owner TBD | Sponsor TBD | Date 2025-12-03 | Business Unit Small Business Banking
## Progress Tracker
| Phase | Done | Gaps | Updated |
| -------------------- | ---- | ----------------------------------------- | ---------- |
| Business Context | 40% | Strategic alignment details | 2025-12-03 |
| Problem & Drivers | 50% | Quantified impact data | 2025-12-03 |
| Objectives & Metrics | 0% | All objectives and KPIs | — |
| Stakeholders | 10% | Full stakeholder mapping | 2025-12-03 |
| Scope | 20% | Detailed in/out scope items | 2025-12-03 |
| Processes | 0% | As-is and to-be process documentation | — |
| Requirements | 0% | All business requirements | — |
| Data & Reporting | 0% | Data needs and reporting requirements | — |
| Risks & Dependencies | 0% | Risk identification and dependencies | — |
| Implementation | 0% | Phasing and change management | — |
Unresolved Critical Questions: 5 | TBDs: 8
---
## Document Control
| Version | Date | Author | Summary of Changes | Approved By |
| ------- | ---------- | ----------- | ------------------------ | ----------- |
| 0.1 | 2025-12-03 | BRD Builder | Initial draft skeleton | — |
---
## 1. Business Context & Background
### 1.1 Overview
This initiative establishes a new digital onboarding portal for small-business banking customers, enabling streamlined account opening, identity verification, and initial product setup through a modern self-service digital experience.
### 1.2 Strategic Alignment
...
````
<!-- What files/content are created? Show first 10-20 lines as preview
-->
**Success Indicators:**
- The user works with the agent to build a high quality BRD document.
For detailed contribution requirements, see:
- **Common Standards**:
[docs/contributing-ai-artifacts-common.md](../docs/contributing-ai-artifacts-common.md)
- Shared standards for XML blocks, markdown quality, RFC 2119,
validation, and testing
- **Chatmodes**:
[docs/contributing-chatmodes.md](../docs/contributing-chatmodes.md) -
Agent configurations with tools and behavior patterns
- **Prompts**:
[docs/contributing-prompts.md](../docs/contributing-prompts.md) -
Workflow-specific guidance with template variables
- **Instructions**:
[docs/contributing-instructions.md](../docs/contributing-instructions.md)
- Technology-specific standards with glob patterns
## Testing
- I interacted with the agent and built and worked in a couple BRDs.
## Checklist
### Required Checks
- [ ] Documentation is updated (if applicable)
- [x] Files follow existing naming conventions
- [ x Changes are backwards compatible (if applicable)
### AI Artifact Contributions
<!-- If contributing a chatmode, prompt, or instruction, complete these
checks -->
- [x] Used `prompt-builder` chatmode to review contribution
- [x] Addressed all feedback from `prompt-builder` review
- [x] Verified contribution follows common standards and type-specific
requirements
### Required Automated Checks
The following validation commands must pass before merging:
- [x] Markdown linting: `npm run lint:md`
- [ ] Spell checking: `npm run spell-check`
- [ ] Frontmatter validation: `npm run lint:frontmatter`
- [ ] Link validation: `npm run lint:md-links`
- [ ] PowerShell analysis: `npm run lint:ps`
## Security Considerations
<!-- 1 parent e5b6e8f commit bfdc9f3
File tree
2 files changed
+572
-0
lines changed- .github/chatmodes
- docs/templates
2 files changed
+572
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
| 271 | + | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
| 283 | + | |
| 284 | + | |
0 commit comments