Workflow Principles
Author:
Fluent Commerce
Changed on:
16 Nov 2023
Overview
Best Practices for Workflow Design: Keep in Mind These Principles.
Key points
- Be conservative in what you send; be liberal in what you accept.
- Don't over-engineer, and keep workflows simple so they are easier to maintain.
- Take time to name descriptively Rulesets and write their descriptions.
Robustness
Be conservative in what you send; be liberal in what you accept. This principle means that you should be careful and specific when sending data to other systems, Workflows, or components but be lenient and flexible when accepting it.
Clear and concise language
Avoid using technical jargon or complex language that may be difficult for later users to understand. Use simple, concise, and consistent language that is easy to understand. For example:
- A Ruleset's purpose should be clear and simple just by reading its name.
- A helpful description should enrich the name
- See the Workflow naming convention for more information
Start with the end in mind
Define the desired outcome of the workflow before creating it so that you can design it to achieve that outcome. Before designing a Workflow, you should understand the entity states and the corresponding business logic executed when an entity is in that state or during related state transitions.
