Documenting development artifacts in the desktop Process Designer (deprecated)

As you develop your process application, you might want to capture information about the artifacts that you are creating. Each artifact in IBM® Process Designer has a documentation field for this purpose. You can enter text or links to external resources such as web sites or attachments.

Procedure

To enter documentation for an artifact:

  1. Open the artifact in Process Designer.
  2. Switch to the Overview tab.
  3. Enter your text in the Documentation field.

What to do next

Restriction: The documentation field allows a maximum of 200,000 characters, including hidden formatting characters. Long documentation that approaches this limit can impact performance. Consider the following options:
  • Reduce the size of the documentation.
  • Simplify the formatting, such as removing tables and text formatting.
  • Move the documentation content to a separate file and link to or attach the file. See Linking to external information.
Parent topic: Creating BPDs in the desktop Process Designer (deprecated)