Share via


Help Files in Workflow Applications

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

You can implement help for your application as HTML files on your application's Web site.

For an example of help information, see the HTML Help files associated with the Issue Tracking sample. You can find the Help folder in the Issue Tracking Web site that is created when you create an instance of the Issue Tracking sample template. You can copy these files directly, or you can customize them using any HTML editor.

The following table provides suggestions for the types of Help topics you might want to make available to users.

User tasks Provide information about
Selecting workflow states What each state means in the business process.
Changing workflow states What workflow events are, how to use the events and transitions available in the application, and which application roles and permissions are associated with the events.
Using row-level permissions How to use row-level permissions, how to set row-level permissions in an application, and what permissions are available.

The more complicated your workflow application is, the more help users might require to use the application. Whenever possible, you should provide information about any potential problems or issues that users might see.

See Also

Developing a User Interface for SQL Server | User Interface Considerations | Row-Level Permissions and the Workflow User Interface | Creating User Interfaces | User Information for Workflow Applications | Using Alternative User Interfaces