Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.gitlab.com/development/documentation/topic_types/ below:

Documentation topic types (CTRT) | GitLab Docs

Help us learn about your current experience with the documentation.

.

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

• Concept
• Task
• Reference
• Troubleshooting

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.

For an overview, see Editing for style and topic type.

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

• Page type: Tutorial
• Page type: Get started
• Page type: Top-level
• Page type: Prompt example
• Topic type: Related topics
• Page or topic type: Glossaries

You should avoid:

• Pages that are exclusively links to other pages. The only exceptions 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.

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 section 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)

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4