Common topics

Last Updated : Apr 02, 2025 |

A common topic is a DITA topic that can store content that we expect to reuse in other publications of same product or another product. Depending on the content, you may reuse the entire topic, a paragraph, tip, or other content element in the topic.

Common topics with reusable elements are not included in a deliverable or ditamap. These common topics are used as containers to hold product-specific or other common text elements that we meant to reuse in other topics.

Location of common topics

Common topics are usually stored in folders named Common in the repository. Common folders exist at multiple levels, according to the expected type of reuse for the content.

Cross-project common topics

Cross-project topics are intended for use in all projects or a large number of projects. Cross-project common topics include the following content:

  • Reusable elements for the names of Avaya products, applications, or snap-ins, such as Applications, Product names, or Snap-in names. These files are stored in Tridion Docs under Common DITA Supporting Content/Products Applications and Languages/topics.

  • Legal page elements, such as Notices. The file is stored in Tridion Docs under Common DITA Supporting Content/Legal/Legal page/topics.

  • Common document titles: each project should maintain a list of their document titles under Common DITA Supporting Content/Project document titles.

  • Glossary topics: The editors maintain common glossary topics in Tridion Docs under Avaya Standards Processes and Glossary Terms from where all writers can reuse. When you’re building a glossary, you must check if the terms you need are already available. If not, you can provide the content to the editors and request them to create glossary topics.

Project-level common topics

Project-level common topics are intended for use in the deliverables for a single project. These common topics must include project-specific terms, names, and phrases that may change and need be referenced into multiple topics or components. The project team maintains these topics in a Common subfolder of the project folder in the repository.

Project-level common topics can include one or more of the following types of content:

  • Product or application features

  • List of project deliverables

  • Frequently used admonishments or other content elements

  • Standard troubleshooting topics

Deliverable-level common topics

Deliverable-level common topics are intended for use in a single deliverable. These common topics can include steps, admonishments, or descriptions that may change and need be referenced into multiple topics or components. The deliverable or component owner can maintain these topics in the deliverable folder or in the Common subfolder of the project folder in the repository.

Deliverable-level common topics can include one or more of the following types of content:

  • Frequently used descriptions or admonishments

  • Frequently used steps in a task, such as opening a settings dialog box.

  • Names of application elements, such as dialog boxes, windows, and pages.

  • Reusable information for alarm topics