Question Re: How to document a Workflow? in Technology Q&A

How to document a Workflow?

SusanSi — Thu, 10 May 2012 20:01:07 GMT

Hi All,

We recently formed a new workflow team, and we’ve been busy working on several new projects. As a new team, one of the things we’ve struggled with is how to properly document the new workflow projects. Our goal is to create a technical document that could be used by anyone needing to understand how the process works from a technical perspective. I would really appreciate guidance from anyone who has already been down this road.

Thanks,

Susan

Re: How to document a Workflow?

Former Member — Fri, 11 May 2012 00:10:33 GMT

Hello,

It is a lot of work. I usually make a Word document with screenshots from the Workflow Builder amongst a description of each step, listing everything that is non-default. I also add separate sections for each task, each custom object or class used and how the workflow is started.

I'm working on a report that will generate most of the data necessary. It is a lot of work to extract it manually. Once it's done it is very useful.

regards

Rick Bakker / hanabi technology

Re: How to document a Workflow?

paul_bakker2 — Fri, 11 May 2012 00:13:32 GMT

Hi,

Apart from the usual flow diagrams, we usually document:

a description of all WS workflows
a description of all TS standard tasks, and the methods they execute
the 'possible agent' settings for all dialog tasks
the 'responsible agent' determination procedures for dialog tasks
the workflow triggering events, their parameters, and (very important) where they are raised
the BOR objects, with all their attributes and methods
ditto for ABAP classes
the event linkage configuration
deadline handling
error handling

Hope this helps!

Paul Bakker

Re: How to document a Workflow?

SusanSi — Fri, 11 May 2012 17:31:08 GMT

Hi Rick,

Thank you so much for your suggestions. This will help me get started.

Thanks,

Susan

Re: How to document a Workflow?

SusanSi — Fri, 11 May 2012 17:34:01 GMT

Hi Paul,

Thank you so much. This sounds like a lot of work, but I'm sure it's extremely helpful.

Thanks,

Susan