When reviewing reference content, 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?
- What is this information related to?
- Why should the user care?
- When would the user need this information?
- What values does the user use?
- When does this information apply?
- What commands, parameters, options, are available and when would the user use them?
- 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 reference topics.
- Is the topic written for a global audience? For more information, see Content for a global audience.
- Are all the 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.
Previous topic Concept topics Next topic Don't document the obvious