Skip to main content

The MindTouch building blocks

This page applies to:MindTouch Responsive

Your MindTouch site consists of various content templates (i.e. content containers) that serve a distinct purpose. With the MindTouch content framework, creating a structured and organized documentation community is easy. The prescribed structure ensures the stability of your framework and the proper functioning of your site. Review the content types below to ensure you create a logical separation and organization of your content and enable your users to quickly find the information they are looking for.
 

Get to know your building blocks  


Content type Description
Category The highest level of content under the framework. Examples of categories include specific languages, personas, product suites and versions.
Guide  Subsection of a category. It is the primary place for organizing content in a product suite or version, for example.
Topic Subcategory of a guide, similar to a chapter of a book, that deals with a more defined theme.
Reference Explains associated functions/definitions that relate to a feature or topic.
How-to Frequently contains step-by-step instructions that lead to a clear end goal or objective.

 

The  MindTouch content structure


Before you start structuring your content, it helps to have a clear vision of how you want to form your users' search experience. Always keep in mind, though, that no matter how you structure your site, MindTouch allows you to move content easily and without breaking any links or hierarchies. So there is nothing wrong with changing your mind. 

When you change your mind and switch content types, MindTouch does not convert the content type code. For example, if you change a category into a guide, the embedded code will still be the category code. You must copy the DekiScript code block from a guide (open a guide in Edit mode and copy the code block) into your newly converted content type to ensure it behaves as a guide.

Standard structure

As you are building out your content, use the following hierarchy structure to ensure that the unique capabilities of the MindTouch content framework is properly leveraged:

► Category (e.g. language/persona/product suite/version)

► Guide

► Topic

► How-to

► Reference
 

You may add how-tos and references directly underneath guides. It is not necessary to add topics underneath a guide. But be aware that once your content grows, you likely will end up creating topics to organize your articles by subject and afford your users a more efficient search experience.

Expanded structure

It is possible to nest multiple categories if, for example, you needed to organize your content by language or persona, then product suite, and then version:

► Category (language/persona)

► Category (product suite)

► Category (version)

► Guide

► Topic

► How-to

► Reference
 

You may add how-tos and references directly underneath guides. It is not necessary to add topics underneath a guide. But be aware that once your content grows, you likely will end up creating topics to organize your articles by subject and afford your users a more efficient search experience.

Add multiple topics

To add multiple topics, simply go up to the guide page and add a new topic, as below:

► Guide

► Topic

► Reference

► How-to

► Topic

► Reference

► How-to
 

You may add how-tos and references directly underneath guides. It is not necessary to add topics underneath a guide. But be aware that once your content grows, you likely will end up creating topics to organize your articles by subject and afford your users a more efficient search experience

 

What's next?


After planning your content architecture, the first step to building your content architecture is to create your categories.