Commenting Workflow Definitions Efficiently

Posted by Kevin Sweeney on Feb 5, 2014 10:17:24 AM

 

 

Commenting Workflow Definitions Efficiently Commenting Workflow Definitions Efficiently

 

Every programmer knows the importance of adding workflow comments to your software programming code.  It is a pretty fair bet that every software programmer has at least one story where they had to debug software code written by someone who failed to comment correctly.   If we were honest with ourselves, perhaps we would have to admit that occasionally we were the person who neglected to comment the code.  Maybe we commented certain modules better than others.  Maybe we simply ran out of time.  Whatever the reason, we know that it happens and we know how difficult it is to work with code that is not commented.

My list of helpful guidelines when adding workflow comments to your BPM workflow designs:

  1. Apply the KISS principle to your work.  Keep your program simple.
  2. Comment what function this section of code performs
  3. Comment whenever variables are involved, including input / output information.
  4. Edit or repair all code errors as you discover them.
  5. Use consistent (customer or department approved), naming conventions.

Process designers should also use workflow comments within their design.  With very large workflow definitions, you must comment sections or modules of the overall process.

Workflow comments provide process information to others that gives greater depth to the graphic symbols on the screen.  Additionally, workflow comments can be used as a method to detail sections of the process that are "future expansion" or "Yet to be Defined" type of items, something in the process that needs to be fixed or remedied  later.

 

Commenting Workflow Definitions Commenting Workflow Definitions Right Within Your Workflow Designer

 

Did you know that with cDevWorkflow (Version 7.5) you and your team can add workflow comments to your process within the designer?  Just drag the comment icon from the toolbar and drop it anywhere within the design canvas to create a workflow comment.  And just like all of our tools, simply click on that comment icon to add your workflow comment text.

A small sampling of the Workflow Technology for BPM Solutions contained within our cDevWorkflow product offering can be found here: Workflow Technology That Works.

[hs_form id="9"]

Learn more about our Process Automation & IT, QA Services or Software Development products and solutions on the Web!  Visit us at: Innovative Process Solutions

Topics: Workflow comment, workflow design comments, workflow comments, BPM Design, Blog, workflow approval comments, BPM Workflow Design