Table of Contents

Specifying the content of application documentation

Provide guidance and methodology information to developers and other stakeholders by defining which information the application documentation includes. As a result, you can provide relevant details about your software and the methodology that your team implements.

For example, you can define the business goals that you want your application to meet and provide additional relevant materials by adding attachments to your application overview.

Defining the content of documentation in Dev Studio is suited to advanced developers or developers that use legacy document types. To implement low-code solutions, prepare application documentation in App Studio. For more information, see Creating project documents for stakeholders.
  1. In the header of Dev Studio, click the name of the application, and then click Definition.

  2. Click the Documentation tab.

  3. In the Application guides section, add guides that you want developers to follow during creating applications.

    You can add a security checklist to ensure that developers provide secure applications. At design time, developers can view and tick tasks that they complete while they develop an application, as in the following figure:
    Security checklist
  4. In the Supporting specification types section, describe the functionalities that you want to implement:

    1. In the Name field, enter a label for the specification.

    2. In the Short description field, provide brief information about the functionality.

    3. Optional:

      To add more specifications, click Add specification, and then repeat steps 4.a through 4.b.

    To take advantage of the latest Pega Platform tools, use features instead of specifications. For more information, see Adopting feature-driven development and Tracking feature-driven development.
  5. In the Business objectives section, in the Description field, briefly describe a goal that you want to achieve in your application.

    Enter Review loan requests from VIP customers.
    You can also provide business objectives in a low-code way in App Studio. For more information, see Editing application details in App Studio.
  6. In the Releases section, click Add item, and then in the field, provide a new release version for your application.

  7. Optional:

    To change the value of the release version that Pega Platform provides by default, click the field for the release, and then provide a value.

    The following figure shows custom release versions for an application:
    Application releases
  8. Optional:

    To provide a more detailed timeline of your application development, in the Iterations section, click Add item, and then provide an iteration for your application.

  9. In the Attachments section, provide reference materials about your application development and planned design, by clicking Add/Edit attachments, and then attaching content:

    • To attach a file, in the Attach files section, drag a file or click Select file(s) and navigate to the file that you want to add, and then click Submit.
    • To attach a URL, in the Enter a link section, provide a URL and a short description of the URL content, and then click Submit.
    The attached content is available in the Overview section of your application.
  10. In the Organization section, specify the organizational owner for your application:

    1. Click Update.

    2. In the Update Organizational Unit dialog box, select the organization, division, and unit that own your application.

    3. Click Submit.

    The following figure shows an application that belongs to an HR department in an Administration division for a UPlusTelco company:
    Application organizational ownership
    The organizational structure impacts the routing and reporting in your application of, for example, notifications to managers.
  11. In the DCO settings section, in the Project Methodology list, select a methodology that you want to implement during application development, for example, select Scrum.

  12. Click Save.

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.