Skip to main content

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

Exceptions to Microsoft Writing Style Guide

Updated on January 21, 2021

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 (we).
  • Do not use the phrase we recommend; instead, state the benefit of doing something in a certain way.

    For example: To improve performance, turn off all background applications.

  • To indicate that users enter text into a field, use enter instead of type.
  • Do not add any styling or DITA elements to mentions of keyboard keys.
  • deprecated is acceptable in all types of text, while obsolete should always be avoided.
  • block list, blocked list, and variations on this term in the sense of allowed and not allowed are all to be avoided. To block in 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

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