31 lines
678 B
Markdown
31 lines
678 B
Markdown
|
# Business Flow: [Flow Name]
|
||
|
|
|
||
|
|
## 1. Overview
|
||
|
|
[Description of the business objective this flow achieves.]
|
||
|
|
|
||
|
|
## 2. Involved Services
|
||
|
|
- **Service A**: [Role in this flow]
|
||
|
|
- **Service B**: [Role in this flow]
|
||
|
|
|
||
|
|
## 3. Sequence Diagram (Mermaid)
|
||
|
|
```mermaid
|
||
|
|
sequenceDiagram
|
||
|
|
participant A as Service A
|
||
|
|
participant B as Service B
|
||
|
|
|
||
|
|
A->>B: Request
|
||
|
|
B-->>A: Response
|
||
|
|
```
|
||
|
|
|
||
|
|
## 4. Detailed Step-by-Step
|
||
|
|
1. **[Step 1]**: [Detailed description]
|
||
|
|
2. **[Step 2]**: [Detailed description]
|
||
|
|
|
||
|
|
## 5. Error Handling & Edge Cases
|
||
|
|
- **Failure at Step X**: [What happens?]
|
||
|
|
- **Timeout**: [How is it handled?]
|
||
|
|
|
||
|
|
## 6. Related Documentation
|
||
|
|
- [Link to Service A doc]
|
||
|
|
- [Link to Service B doc]
|