This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Design

1: Architecture
2: Design patterns
3: System documentation

Elegant designs clarify system behaviour.

1 - Architecture

Requirements

Choose a suitable overarching design.
Enforce system-wide consistency with domain-driven design.
Define components.

Examples

Overarching design:
- Event-driven architecture
Domain-driven design:
- Ubiquitous language
Components:
- Microservices

See also

API integrations

Data integrations

Messaging systems

2 - Design patterns

Requirements

Implement features with Gang of Four design patterns.
Integrate components with integration patterns.
Apply SOLID principles.

Examples

Gang of Four patterns:
- Factory method pattern
Integration patterns:
- Event message
SOLID principles:
- Single responsibility principle

See also

API integrations

Data integrations

Messaging systems

3 - System documentation

Requirements

Illustrate components with a modelling tool.
Document interface contracts.
Provide a dedicated website for documentation.

Examples

Modelling tool:
- PlantUML
Interface contracts:
- Swagger API documentation
Dedicated website:
- Antora

See also

API documentation