Skip to content

Create user documentation for Document Builder agents #508

@WilliamBerryiii

Description

@WilliamBerryiii

Summary

Five Document Builder agents with 4-7 phase workflows, 4 template files, and 3 distinct persistence patterns have zero user-facing documentation. The agents catalog lists them as "Planned" at Phase 3 priority.

Agent Inventory

Agent Phases Template Persistence Lines
BRD Builder 7 docs/templates/brd-template.md JSON state file ~480
PRD Builder 7 Inline (embedded in agent) JSON state file ~600
ADR Creation Coach 4 docs/templates/adr-template-solutions.md Draft markdown file ~350
Security Plan Creator 5 docs/templates/security-plan-template.md Planning markdown file ~400
Arch Diagram Builder 4 None (inline conventions) None ~200

Template Files

Template Consumer Substitution
docs/templates/brd-template.md BRD Builder {{placeholder}} mustache
docs/templates/adr-template-solutions.md ADR Creation Coach YAML guide + skeleton
docs/templates/security-plan-template.md Security Plan Creator Section-by-section fill
docs/templates/rca-template.md incident-response.prompt.md (not an agent) Google SRE format

Session Persistence Patterns

Pattern Agents State Location
JSON state files BRD, PRD BRD/PRD session tracking directories
Markdown working files ADR, Security Plan ADR/plan draft directories
None Arch Diagram Single-session only

BRD/PRD Twin Pattern

BRD Builder and PRD Builder share:

  • Identical 7-phase workflow (Assess → Discover → Create → Elicit/Build → Integrate → Validate → Finalize)
  • Identical JSON state schema (questionsAsked, answeredQuestions, referencesProcessed, nextActions, qualityChecks, userPreferences)
  • Emoji-based refinement checklists
  • Reference integration with conflict resolution
  • Post-summarization recovery workflow
  • Output mode selection (summary, section, full, diff)

Key difference: BRD uses an external template file; PRD embeds its template inline.

Plugin Distribution

  • BRD, PRD, ADR, Arch Diagram: project-planning collection
  • Security Plan: security-planning collection

Catalog Inaccuracy

docs/agents/README.md lists "Root Cause Analyses" among the Document Builders, but no RCA agent exists. That capability is provided by incident-response.prompt.md (a prompt, not an agent). This entry should be corrected.

Recommended Documentation Structure

docs/agents/document-builders/
├── README.md                    # Hub: overview, comparison table, when to use which
├── brd-builder.md               # BRD usage guide with session management
├── prd-builder.md               # PRD usage guide with template walkthrough
├── adr-creation.md              # ADR coaching guide with modes
├── security-plan-creator.md     # Security plan workflow with threat model
└── arch-diagram-builder.md      # IaC parsing and ASCII diagram generation

Acceptance Criteria

  • docs/agents/document-builders/README.md created with overview and comparison table
  • Per-agent guide pages created for all 5 Document Builder agents
  • Session persistence patterns documented for each agent
  • BRD/PRD twin workflow pattern documented with shared features and differences
  • docs/agents/README.md updated: remove RCA from agents list, update status from "Planned"
  • Template usage documented for each agent that uses one

Metadata

Metadata

Labels

agentsCustom chat agents (.agent.md)documentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions