Documentation topic types (CTRT)

Each topic on a page should be one of the following topic types:

Even if a page is short, the page usually starts with a concept and then includes a task or reference topic.

The tech writing team sometimes uses the acronym CTRT to refer to the topic types. The acronym refers to the first letter of each topic type.

Other page and topic types

In addition to the four primary topic types, you can use the following:

Pages and topics to avoid

You should avoid:

  • Pages that are exclusively links to other pages. The only exception are top-level pages that aid with navigation.
  • Topics that have one or two sentences only. In these cases:
    • Incorporate the information in another topic.
    • If the sentence links to another page, use a Related topics link instead.

Topic title guidelines

In general, for topic titles:

  • Be clear and direct. Make every word count.
  • Use fewer than 70 characters when possible. The markdownlint rule: line-length (MD013)
  • Use articles and prepositions.
  • Follow capitalization guidelines.
  • Do not repeat text from earlier topic titles. For example, if the page is about merge requests, instead of Troubleshooting merge requests, use only Troubleshooting.
  • Avoid using hyphens to separate information. For example, instead of Internal analytics - Architecture, use Internal analytics architecture or Architecture of internal analytics.

See also guidelines for heading levels in Markdown.

If inline links are not sufficient, you can create a topic called Related topics and include an unordered list of related topics. This topic should be above the Troubleshooting section.

Links in this section should be brief and scannable. They are usually not full sentences, and so should not end in a period. 

## Related topics

- [CI/CD variables](link-to-topic.md)
- [Environment variables](link-to-topic.md)