How to document a Workflow?

[SusanSi]

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

[paul_bakker2 · Accepted solution]

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

[SusanSi · Accepted solution]

Hi Paul,

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

Thanks,

Susan