Skip to main content

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

Task topics

Updated on January 21, 2021

When reviewing tasks, focus on the following areas:

  • Does the topic follow the title, style, and writing guidelines?
  • Does the topic answer the following questions:
    • What is the business purpose and use case for this topic and is that reflected in the title and the short description?
    • Why should the user care?
    • Why would the user want to do this?
    • When would the user want to do this?
    • Who would want to do this?
    • Where, in the product, does the user do this?
    • How does the user do this, what are the specific steps?
      • Is each step a step? Is every step an action for the user to take?
      • Is each step specific?
      • Can you determine the purpose of each task step?
  • Does the content follow our tagging guidelines?
  • Does the topic contain related links to other content? Are the related links sufficient for a user who has started consuming information from this topic?
  • Are there any spacing, spelling, typographical, or grammatical errors?
  • Is the writing succinct and to-the-point or is it unnecessarily wordy?
  • Does the short description follow our guidelines and provide an effective description of the content of the topic? For more information, see Short descriptions for task topics.
  • Is it written for a global audience? For more information, see Content for a global audience.
  • Are all product names correct and complete (no acronyms or short forms)?
  • For Pega Community articles, are Pega products correctly trademarked, for example: Pega Platform™? For more information, see Trademarking and copyright rules.
  • Do all constructions (for example, lists and tables) use parallel structure?
  • Are callout colors for images correct? Do the images have a caption? For more information, see Using callouts.

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