📔Template Workflow
Workflow Name
Purpose
[Explain the purpose of the workflow and what it aims to achieve. Clearly define the goals for the user.]
Prerequisites
[Detail any required setups, data, integrations, or tools needed for the workflow to function properly.]
How it Works
[Explain the step-by-step process of the workflow in an easy-to-understand manner. Include details on inputs, processing, and outputs.]
Inputs
[List the data inputs required for this workflow, their format, and any relevant details.]
Processing
[Describe how the workflow processes the inputs and what operations are performed.]
Outputs
[Explain the expected output from the workflow, including the format and what the user can do with it.]
Usage
[Provide instructions on how users can start and execute the workflow within the product.]
Example
[Include a practical example to demonstrate how this workflow works in real-world use cases.]
Advanced Features (Optional)
[Detail any advanced configurations or customizations users can perform to enhance the workflow.]
Troubleshooting
[List common issues, limitations, or problems users may encounter and how to resolve them.]
Logs
[Explain where users can find workflow logs, if applicable.]
Related Workflows
[Mention any other workflows that can be combined with or complement this one.]
Diataxis framework: [Link to the framework's documentation or reference material].
Last updated