Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Creating articles

Updated on January 21, 2021

Share your knowledge and make our client-facing documentation better by adding your content through a user-friendly and intuitive Drupal editor.

Before you begin:

Contact [email protected] for access to the authoring environment.

  1. Go to Pega Community.

  2. In the header of the page, clickManageContent.

  3. On the Content page, click the Add content button.

  4. On the New Content page, click the Article link.

  5. On the Create Article page, in the Title field, describe the article subject in a maximum of 40-60 characters, including spaces:

    • For tasks, start with a gerund (-ing), for example Adding a case.
    • For concepts and references, make the title a noun or noun phrase, for example Situational Layer Cake architecture.
    Use sentence case. Avoid starting the title with About, Intro to, Overview of, or How to.
  6. In the Body text editor field, add your content:

    1. Add an introduction with an explanation on the business value and on why the article is important to the user, in 1-2 sentences (approximately 50 words).

      This text appears in Community search results.
      Note: Do not add the section label.
      For example: Start processing assignments from multiple applications within one window by registering your applications in the Pega Process Fabric Hub.
    2. Optional:

      To provide additional context and background information for a task, add an additional paragraph below the short description.

      For example: The worklist synchronizes with your applications in real time, so you receive a notification immediately after an application routes an assignment to you.
    3. Optional:

      To include a short, one-sentence description of what tasks users must complete before they perform this task, add the Before you begin section, and provide links to relevant Community articles or other content if applicable.

      For example: Ensure that the connection between your applications and the Pega Process Fabric Hub is secure. For more information, see <link>.
    4. Add the Procedure section with an ordered list of actions that users complete as part of this task, starting each step with an imperative verb.

      Note: The preferred range of steps is 5-8 in one article.
      For example:
      1. In the Records panel, click DecisionText Analyzer.
      2. Click the Advanced tab.
      3. In the Sentiment settings section, enter the minimum and maximum score to define the score range for the neutral sentiment, or keep the default values of -0.25 and 0.25.
    5. Optional:

      To include a short one-sentence description of an optimal result, an unexpected result, or an important outcome of the task, add the Results section, and then describe the outcome of the task.

      This section is especially helpful in complex tasks.
      For example: Pega Process Fabric Hub redirects you to an application that includes your assignment. You can work on the assignment directly in the application context.
    6. Optional:

      To provide an example of the task or concept that includes a specific scenario, add the Example section, and then describe a use case with sample values.

      For example: To understand this configuration, analyze the following text with the default sentiment score values:
      Your company provides very good service. 
      Still, the prices are too high. I have a neutral opinion about you. 
      The first sentence has positive sentiment, the second negative, the last one neutral. The overall sentiment for the whole text is neutral because the sentiment score equals 0.03, which belongs to the neutral sentiment score range (-0.25 to 0.25).
    7. Optional:

      To include a short, one-sentence description of what tasks users must complete after they perform this task, add the What to do next section, and provide links to relevant Community articles or other content if applicable.

      For example: Verify your changes to the mobile app with the Pega Mobile Preview app. For more information, see <link>.
  7. Optional:

    To add links to other published Community articles or content, in the Related content section, click the Add related content button, start typing the title of an article, and then select the article.

  8. In the Taxonomy section, categorize the article:

    1. In the Product Version Range category, select the start and end of the version range to which the article applies.

    2. In the Platform Capability category, select the product capability name to which the article belongs.

    3. In the Article Type field, specify the content type.

      Use the following values:
      • For tasks, enter Procedure.
      • For concepts, enter Overview.
      • For references, enter Reference.
  9. When you finish editing your article, at the bottom of the page, click the Save button.

Result: Your content is ready for the peer review by the Tech Doc capability owner.

  • Claiming user stories

    Start working on your content by identifying a subject area in which you want to share your expertise.

  • Sending content for peer review

    When you finish your article, share your work with the Tech Doc capability owner so that they can review your content.

Have a question? Get answers now.

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

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us