Skip to content

Topic types

Topic type is an optional label that describes what a topic is for. Types are user-defined. You can create any types that make sense for your project (guide, how-to, reference, tutorial, FAQ, release note, or anything else).

Type is metadata only. It does not change how content renders, what you can write, or how the editor behaves.

Setting the type

Open the Properties panel in the editor. Click Add type to assign a type, or click an existing type badge to change it. The field is a text input with an autocomplete list (placeholder "e.g. guide, reference"). You can:

  • Select from types already used in your project (shown as suggestions)

  • Type any new value to create a type on the fly

  • Remove the type by clicking the × next to the badge

Values are lowercased when saved, so "Guide" and "guide" are the same type. New topics have no type by default. Assign one when it is useful; leave it empty when it is not.

Types in the topic list

Topics with a type show it as a subtitle in the topic list. Topics without a type show no subtitle.

Types in DITA export

When exporting to DITA, Topicary maps your topic type to the appropriate DITA element:

Your topic type

DITA element

Notes

concept

<concept>

DITA Concept specialization

task

<task>

DITA Task specialization

reference

<reference>

DITA Reference specialization

Any other value or no type

<topic>

Base DITA topic (unspecialized)

If your project uses non-DITA type names such as guide, how-to, or tutorial, topics export as generic <topic> elements. This is valid DITA and works with all DITA-compatible tools.

Custom topic type definitions

On the Business plan, Admins can create project-specific topic types with structured field schemas in the Content & AI section of Settings. Custom type definitions let you attach metadata fields (such as product area, difficulty level, or target audience), assign colors for visual identification in the topic list, and enforce consistent categorization across the project.

Common type systems

You do not need to follow any specific framework. Here are some popular approaches teams use:

  • Diataxis: tutorial, how-to, reference, explanation

  • DITA-style: concept, task, reference

  • Simple: guide, reference

  • None: skip types entirely and organize by map structure alone


See also

Was this page helpful?