Flowdrom Documentation
Welcome to the Flowdrom documentation site.
Quick Links
About Flowdrom
Flowdrom is a web-based tool for creating transaction timing diagrams and sequence charts. It uses JSON-based definitions to generate visual diagrams that can be exported as SVG or PNG files.
Access
inventiview.github.io/flowdrom
The user guide will be at:
flowdrom/user-guide
Source code:
https://github.com/inventiview/flowdrom
Tips for Creating Effective Diagrams
- Start Simple: Begin with basic request-response patterns and add complexity gradually
- Use Sub-lanes Wisely: Use
component.lane or lane.component for internal details without cluttering
- Medium Lanes for Infrastructure: Use
_MEDIUM_ notation for buses, networks, or interconnects
- Fractional Timing: Use decimal values (0.5, 1.25, 2.75) for precise timing relationships
- Use Consistent Colors: Establish a color scheme for different types of messages
- Group Related Lanes: Use lane groups for complex systems
- Let Info Boxes Auto-Position: Trust the collision detection - it will find clear space
- Include Legends: Always provide legends for diagrams with multiple message types
- Realistic Timing: Use fractional intervals to show actual relative durations
- State Visibility: Show important state changes to clarify system behavior
Common Use Cases
- API Documentation: Show request/response flows
- System Architecture: Illustrate component interactions
- Protocol Specifications: Document message sequences
- Debugging: Visualize problem scenarios
- Cache Coherency: Show memory consistency protocols
- Microservices: Document inter-service communication
- Error Handling: Illustrate failure and recovery patterns
For more advanced features and customization options, refer to the source code at github.com/inventiview/flowdrom.