You are here: Project delivery > Application documents > Documenting your application > Generating an application document

Generating an application document

You can use the Document Application tool to generate an application document. By creating a document that provides information about your application, such as business processes and correspondence, you can share your development designs with stakeholders.

  1. Click Designer Studio > Application > Tools > Document to open the Document Application tool.

  2. Click Application document.

  3. In the Application field, select an application to document.

  4. Optional: To limit the scope of the generated document to the application that you select, clear the Include related built-on application layer assets check box.

    This option is not available when an application is built directly on PegaRULES.

  5. In the Level of detail list, select a scope for the document.

  6. Optional: Refine the scope of the document.

    1. Click Customize.

    2. On the Rulesets tab, select the check box next to a ruleset to include it in the document.

    3. On the Case/Supporting types tab, select the check box next to a case type or specification category to include it in the document.

    4. On the Document sections tab, select the check box next to an information category to include it in the document.

    5.  On the Case type assets tab, select the check box next to an attribute of a case type to include it in the document.

    6. Click Submit.

  7. Optional: To create a document for more technical audiences, add supporting information.

    1. In the Chapter titles list, select Use rule name.

    2. Select the Show class and ruleset references check box.

      Select the Provide links to rule forms check box.

  8. Click Generate document.