documentation Best Practices Guide for Workflow/Activity Writing

Best Practices Guide for Workflow/Activity Writing

Open cretz opened this issue 3 years ago • 1 comments

Is your feature request related to a problem? Please describe.

We don't have a best practices guide for writing workflows and activities.

Describe the solution you'd like

We have docs on what you can do, but we don't have much on what you should do. We need to collect our suggestions/recommendations in one place for easy reference. Some things just off the top of my head:

Use activity heartbeats on anything but the shortest activity
Consider using schedule to close timeout instead of start to close or you can miss activities that are slow to be picked up
Use single-object requests and responses for workflows/activities for future proofing (like gRPC req/resp...also can use proto if need to cross language)
In Go, if you set a workflow/activity name when registering for disambiguation, use the string when executing it
Don't over-complicate workflows
Etc

There are many many more and what I have here may not even be what we recommend.

Consolidating from:https://temporalio.atlassian.net/browse/EDU-1745

A couple users have been uncertain how much to put in a single Activity versus breaking it into multiple Activities.