Skip to main content

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

Guidelines for topic and article file names, titles, and locations

Updated on January 21, 2021

DITA topics and Community articles are distinct content containers, each with a unique title and purpose. The title of a topic or article reflects the content type that they include. Additionally, because DITA help topics are opened directly from Pega Platform, they have restrictions on the file name and location.

Topic or article typeTitle formatRulesExamples
Taskgerund Focus on the action, not the tool. Use plural nouns unless the object that you mention is a unique one or you can change only one such item in a single task. Do not use about, or how to.
  • Creating case types
  • Adding content to a mobile app
  • Uploading custom font files
Concept - parent (1st outline level)gerund
Note: The first outline level must be task-oriented. If a concept is a parent topic on the first level of an outline, consider how you can improve the structure to change that.
Focus on what users can learn, starting the title with such gerunds as understanding, learning about, or exploring.
  • Getting started with DMSample
  • Understanding project roles and personas
  • Learning about guidelines for designing apps
Concept - child (2nd and additional outline levels)noun or noun phraseFocus on what users can learn. Do not use overview.
  • Cases in business processes
  • Robotic automation as a data page source
  • Pulse
Referencenoun or noun phraseFocus on what users might need to look up.
  • Case parameters
  • Constants in expressions
Release notenoun, noun phrase, or clauseFocus on what has changed in terms of functionality.
  • Support for new case types
  • Cases now support stages
What's NewimperativeFocus on what users can achieve (business value). Add the release number in parentheses.
  • Improve your custom predictive models through machine learning as a service (8.3)
  • Process high-volume interactions more efficiently (8.3)
Glossaryterm nameUse lowercase for common words, and match spelling for industry terms, and abbreviations.
  • case type
  • Case Type Explorer
  • case worker

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