Event-Driven Architecture Overview Template
Documenting event-driven patterns, event brokers, schemas, and choreography or orchestration models
The Event-Driven Architecture Overview template provides a structured approach to documenting event-driven patterns, event brokers, schemas, and choreography or orchestration models.
Template Sections
This template includes 7 sections.
Overview
Describe the event-driven architecture strategy, the business drivers for adopting EDA, and the scope of event-driven...
Event Architecture Diagram
Diagram section
Core Event Specification
Document a key event type: its name, schema, producer, consumers, delivery guarantee, and ordering requirements
Choreography vs Orchestration
Document which event coordination model is used (choreography, orchestration, or hybrid) and the rationale for the...
Event Processing Requirements
Define throughput targets, maximum acceptable latency, ordering guarantees, and delivery semantics (at-least-once,...
Event Processing Failure
Document what happens when events fail to process: dead-letter handling, retry policy, poison message strategy, and...
Event Monitoring and Governance
Describe event naming conventions, schema evolution rules, consumer lag monitoring, and ownership model
Section Details
Block Types Used
| Section | Block Type | Purpose |
|---|---|---|
| Overview | Rich Text | Describe the event-driven architecture strategy, the business drivers for... |
| Event Architecture Diagram | Diagram | Diagram section |
| Core Event Specification | Event Specification | Document a key event type: its name, schema, producer, consumers, delivery... |
| Choreography vs Orchestration | Architecture Pattern | Document which event coordination model is used (choreography, orchestration,... |
| Event Processing Requirements | Non-Functional Requirement | Define throughput targets, maximum acceptable latency, ordering guarantees, and... |
| Event Processing Failure | Failure Scenario | Document what happens when events fail to process: dead-letter handling, retry... |
| Event Monitoring and Governance | Operational Note | Describe event naming conventions, schema evolution rules, consumer lag... |
Getting Started
Application and Integration Architecture Templates
27 templates for application and integration architecture documentation.
Documentation Templates
188 page templates across seven categories, 88 diagram templates across seven categories, plus seven general-purpose document templates.