Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 2.54 KB

README.md

File metadata and controls

50 lines (32 loc) · 2.54 KB
Raw

Use Cases

This directory contains a collection of high-level use cases that demonstrate the capabilities and potential applications of the Serverless Workflow DSL. Each use case provides insights into how to effectively implement workflows in various scenarios, helping newcomers understand the framework's power and flexibility.

Purpose

The primary purpose of these use cases is to:

  • Educate Newcomers: Provide clear examples of utilizing Serverless Workflow DSL for real-world applications.
  • Inspire Innovation: Showcase the diverse workflow automation and orchestration possibilities.
  • Facilitate Best Practices: Encourage consistent structure and documentation, making it easier to share knowledge and experiences within the community.

Structure

Each use case in this directory MUST follow a specific structure to ensure clarity and consistency. The structure is as follows:

File Structure

./my-cool-use-case      👈 The name of the use case. It must be lowercase and contain exclusively alphanumeric characters, except for '-'.
    /README.md          👈 Documentation of the use case's details and workflow.
    /diagram.png        👈 Visual representation of the use case workflow (optional).
    /...                👈 Additional files relevant to the use case documentation.

Case Structure

Overview

  • System: A brief description of the system involved in the use case.
  • Actors: Identify the main participants or roles interacting with the system.
  • Goals: Outline the objectives that the use case aims to achieve.
  • Preconditions: Any conditions that must be met before the workflow can be executed.

Scenario

  • Triggers: Events that initiate the workflow.
  • Flow Breakdown: Detailed step-by-step workflow breakdown, including key actions and decisions made throughout the process.
  • Visualization: Optional diagrams or flowcharts that illustrate the workflow's structure and progression.
  • Example: A YAML example of the workflow using Serverless Workflow DSL, demonstrating how the concepts discussed are implemented.

Conclusion

  • A summary of the benefits and insights gained from the use case, reinforcing why Serverless Workflow is a suitable choice for the described scenario.

Contributing

We invite everyone to submit their own use cases to enrich this directory and help others learn from their experiences.

If you would like to contribute, please refer to the contributing.md for guidelines on how to contribute to the Serverless Workflow project.