BRD Generation
Builder can generate a complete Business Requirements Document from a short project description — before any code is written.
When to use it
Use BRD generation when you need:
- A formal document for stakeholder sign-off before development starts
- A structured requirements spec to feed into the pipeline
- An audit trail of what was agreed before the build
Generate a BRD
bash
POST /api/brd/generatejson
{
"project_name": "customer-portal",
"description": "A self-service portal for customers to manage their subscriptions, view invoices, and raise support tickets",
"include_sections": [
"executive_summary",
"functional_requirements",
"non_functional_requirements",
"data_model",
"api_contracts",
"acceptance_criteria"
]
}The response is a structured Markdown document streamed back in real time.
BRD sections
| Section | Description |
|---|---|
executive_summary | Business context, goals, success metrics |
functional_requirements | User stories with acceptance criteria |
non_functional_requirements | Performance, security, scalability targets |
data_model | Entity relationship overview |
api_contracts | High-level API surface with request/response shapes |
acceptance_criteria | Definition of done for each feature |
compliance | Relevant regulatory requirements (auto-detected) |
Enhance an existing BRD
bash
POST /api/brd/enhancejson
{
"project_name": "customer-portal",
"brd_content": "... existing BRD markdown ...",
"feedback": "Add a section on data retention and GDPR compliance"
}Using a BRD as pipeline input
Once a BRD is approved, pass it directly as the prompt to the pipeline:
json
{
"prompt": "... BRD content ...",
"goal": "production",
"project_name": "customer-portal",
"hitl_enabled": true,
"hitl_phases": ["planning"]
}The IdeationAgent recognises structured BRD format and uses the functional requirements directly instead of re-deriving them.