Flow detailed descriptions
in progress
Tim Gaweco
in progress
Tim Gaweco
planned
Jacob Shadbolt
Hey all - I'm designing a new flow editor/experience. What type of information would you want to add? Is it just text or anything else?
Tim Gaweco
under review
M
Matias Pavez
+1, we are currently tracking flow details in a separate document -> decreases readability or usefulness of the feature (since we could just document the flow in the separate document).
Jacob Shadbolt
Matias Pavez Where is this document and what information is missing that IcePanel flows currently doesn't support?
M
Matias Pavez
Jacob Shadbolt
We’re currently evaluating how to model end-user interactions in our context diagrams using Flows. For example, a user initiates the system, which then communicates with another system, and so forth.
Our goal is to make these Flows easily understandable for the entire team—especially newcomers and those without the full context. Here’s our current approach:
- Carefully craft Flow titles and steps so they’re self-explanatory.
- Maintain a separate Wiki page for each Flow, which includes:
- A brief overview (about one paragraph)
- Pre- and post-conditions (about one paragraph each)
- A step-by-step description (usually optional)
- A sequence diagram exported from IcePanel
However, the concern is that for most users, the Wiki documentation alone will suffice. This means the Flows in IcePanel might only be used by a small group of maintainers responsible for generating those exports.