The Microsoft Writing Style Guide defines the style guidelines for technical writing at Pega. However, remember about some exceptions to those guidelines.
Apply the following guidelines despite their contradiction with the Microsoft Manual of Style:
- Do not use contractions.
- Do not use em dashes.
- Do not end sentences or clauses with prepositions.
- Do not use the first-person plural (
- Do not use the phrase
we recommend; instead, state the benefit of doing something in a certain way.
To improve performance, turn off all background applications.
- To indicate that users enter text into a field, use
- Do not add any styling or DITA elements to mentions of keyboard keys.
deprecatedis acceptable in all types of text, while
obsoleteshould always be avoided.
- block list, blocked list, and variations on this term in the sense of
not allowedare all to be avoided. To
blockin a general sense is still acceptable.
- Do not write
the following:without also adding a noun.
- User interface element reference
When referring to specific user interface elements, remember to follow the established guidelines so that your content is correct, consistent with our writing standards, and easy to follow.
- Additional style guidelines
To create consistent documentation of good quality, ensure that you