dbis_core/docs/diagrams/README.md

# DBIS Diagram Library

This directory contains reusable diagram components and templates for DBIS architecture documentation.

## Diagram Types

### System Architecture Diagrams
- High-level system overviews
- Component interaction diagrams
- Network topology diagrams

### Sequence Diagrams
- Process flow sequences
- Service interaction diagrams
- Message flow diagrams

### State Machine Diagrams
- Transaction state transitions
- Settlement state machines
- Compliance state flows

## Diagram Standards

### ASCII Art Conventions

**Boxes**:
```
┌─────────────┐
│   Content   │
└─────────────┘
```

**Flow Direction**:
- `▼` - Down
- `▲` - Up
- `▶` - Right
- `◀` - Left

**Branches**:
```
    ├─── Branch 1
    ├─── Branch 2
    └─── Branch 3
```

**Connections**:
- `│` - Vertical line
- `─` - Horizontal line
- `└` - Bottom-left corner
- `┌` - Top-left corner
- `┐` - Top-right corner
- `┘` - Bottom-right corner

## Reusable Components

### Payment Flow Template
```
┌─────────────┐
│   Payment   │
│  Initiator  │
└──────┬──────┘
       │
       ▼
┌─────────────┐
│  Processing │
└──────┬──────┘
       │
       ▼
┌─────────────┐
│  Settlement │
└─────────────┘
```

### Settlement Flow Template
```
┌─────────────┐
│  Settlement │
│   Request   │
└──────┬──────┘
       │
       ▼
┌─────────────┐
│   Ledger    │
│   Posting   │
└──────┬──────┘
       │
       ▼
┌─────────────┐
│  Finality   │
└─────────────┘
```

### Multi-Layer Architecture Template
```
┌─────────────────┐
│   Layer 3       │
└────────┬────────┘
         │
┌────────▼────────┐
│   Layer 2       │
└────────┬────────┘
         │
┌────────▼────────┐
│   Layer 1       │
└─────────────────┘
```

## Usage Guidelines

1. **Consistency**: Use standard ASCII characters for all diagrams
2. **Clarity**: Keep diagrams simple and focused
3. **Labels**: Always label components clearly
4. **Flow**: Show clear flow direction with arrows
5. **Spacing**: Maintain consistent spacing for readability

## Examples

See individual flow documentation files for complete diagram examples:
- [GPN Payment Flow](../flows/gpn-payment-flow.md)
- [GSS Settlement Flow](../flows/gss-settlement-flow.md)
- [Atomic Settlement Flow](../flows/atomic-settlement-flow.md)

---

**Related Documentation**:
- [Architecture Atlas](../architecture-atlas.md)
- [Flow Documentation](../flows/README.md)