Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

unify on workflow engine terminology #5176

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

christinaausley
Copy link
Contributor

Description

Closes https://github.com/camunda/documentation-team/issues/52 -- standardizes on "workflow engine" rather than process automation engine, BPM engine, and BPMN engine.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support. (add bug or support label)
  • This is already available but undocumented and should be released within a week. (add available & undocumented label)
  • This is on a specific schedule and the assignee will coordinate a release with the DevEx team. (create draft PR and/or add hold label)
  • This is part of a scheduled alpha or minor. (add alpha or minor label)
  • There is no urgency with this change (add low prio label)

PR Checklist

  • My changes are for an upcoming minor release and:
    • are in the /docs directory (version 8.8).
    • are in the /versioned_docs/version-8.7/ directory (version 8.7).
  • My changes are for an already released minor and are in a /versioned_docs directory.

@christinaausley christinaausley added component:zeebe Issues related with Zeebe project component:docs Documentation improvements, including new or updated content labels Mar 6, 2025
@christinaausley christinaausley requested a review from a team March 6, 2025 15:06
@christinaausley christinaausley self-assigned this Mar 6, 2025
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about "business process execution engine"? I noticed it on the glossary page, should this be adjusted to? If not, how are they different?

I'm also not sure how often we use the other terms. Should those be added as glossary terms pointing to workflow engine as synonyms?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@akeller We use that in two instances:

in manual-tasks.md:

Manual tasks are part of human task orchestration, but differ from user tasks which define an actionable task assisted by a business process execution engine or software application.

in user-tasks.md:

A user task is used to model work that needs to be done by a human and is assisted by a business process execution engine or software application. This differs from manual tasks, which are not assisted by external tooling.

These got looped in when we did the user task/manual task differentiation work. I think it can be replaced with "workflow engine" in both places and removed from the glossary.

Copy link
Member

@akeller akeller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 non-blocking feedback to remove Camunda and Camunda 8 in the same sentence.

@@ -303,6 +303,10 @@ A worker executes a job. In the Zeebe nomenclature, these are also referred to a

See [process](#process).

### Workflow engine

A workflow engine is an essential part of any process automation tool. We call it an “engine” because it drives business processes from start to finish, no matter how complex the process and decision logic need to be. At Camunda, [Zeebe](/components/zeebe/zeebe-overview.md) is the workflow engine powering Camunda 8.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A workflow engine is an essential part of any process automation tool. We call it an “engine” because it drives business processes from start to finish, no matter how complex the process and decision logic need to be. At Camunda, [Zeebe](/components/zeebe/zeebe-overview.md) is the workflow engine powering Camunda 8.
A workflow engine is an essential part of any process automation tool. We call it an “engine” because it drives business processes from start to finish, no matter how complex the process and decision logic need to be. [Zeebe](/components/zeebe/zeebe-overview.md) is the workflow engine powering Camunda 8.

Just felt a little redundant. If this wasn't docs, I would rewrite the first two sentences with a ; but I think it's fine.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content component:zeebe Issues related with Zeebe project
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

2 participants