Skip to main content


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

Top 10 things to remember

Updated on March 30, 2023

Keep the following items in mind as you create your content for Pega Academy.

  1. Write at a 10th grade (or lower) reading level — for help with this, check out the Hemingway App.
  2. Choose clear and concise titles. They should be specific enough for the topic to stand alone. For more information about naming your content, see Overview of Pega Academy content structure.
  3. Use present (not past or future) tense; use the imperative when appropriate — for example, "click SEND," not "you will click the SEND button."
  4. Avoid adverbs (-ly) whenever possible. If you rely on adverbs to make your point, you can probably use stronger verbs and nouns.
  5. Use sentence case for headlines, except for the first word and proper terms that require capitalization.
  6. Use correct tags for terms that stand out (bold, italics, and so on). Consult the article Navigating the Pega Academy text editor if you are unsure about the tagging format.
  7. Do not write in the first person (“we” or "I"). Instead, refer to the reader as "you" or, less commonly, "the user."
  8. Do not use contractions — for example, instead of "don't," write "do not."
  9. Do not use negative construction, particularly for test questions — for example, write "Which of the following statements is correct?" instead of "All of the follow statements are true except..." or "Which of the following statements are not true?"
  10. Use active voice whenever possible.
    Note: Sometimes passive usage is unavoidable, especially when the object is the focus and the identity behind the action remains uncertain.

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.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us