Documentation for the end user

For complex workflows, you should provide documentation for the end users.

Include the following information in your documentation:

  • Introduction (detailing the workflow's functionality)
  • Levels and info areas involved
  • How to access the workflow
  • Links to other areas or workflows of relevance

You should document the following information for each level:

  • How levels are embedded in the workflow
  • How the level is accessed
  • What information is displayed on the screen
  • The functions of fields in the level
  • Actions and how they are triggered

In contrast to the documentation for workflow designers, the end user documentation should not be concerned with the internal workings of the workflow (parameters, indexes, etc.).