Skip to main content

Style Guide

Suggest edit Updated on January 21, 2021

Follow these style guidelines to ensure that your documentation is correct, consistent, and engaging.

Follow this concise checklist to learn the basic guidelines for writing technical documentation. For more detailed guidance on language, grammar, media, hyperlinks, and so on, review other topics in this guide.

Technical documentation style cheat sheet

  • Best practices

    Apply the following best practices to create consistent and engaging technical documentation.

  • Language and grammar

    This section contains information about standard grammar and style conventions.

  • Media

    Various media types make your content visually appealing. You can use a variety of visual aids that you can create in Snagit, Camtasia, or Loom to facilitate understanding, to keep the process or tutorial flow interesting, and to cater for the needs of users with different learning styles. Follow these guidelines to efficiently enrich your documents with meaningful visuals.

  • Hyperlinks and cross-references

    Use hyperlinks and cross-references to provide a user with links to related resources. You can also point the user to a different place in the document.

  • Structure

    Create documentation that is clearly organized and logically arranged by following our structure advice.

  • Pega-specific references

    This section contains information about writing about Pega-specific ideas.

Did you find this content helpful? YesNo

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

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