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.
- 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.
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.
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.