Skip to main content
Concord Academy

Building a User Guide

When you're ready to build a user guide, organization is going to be key.  To begin you will need to set up your Guide template - consider this your book cover and table of contents.

Goal

MindTouch utilizes prebuilt Templates to help you build your technical documenation quickly and efficiently.  To begin building a User Guide you first need to build the first page of your guide that will eventually be your table of contents.

Guide (User Guide)
A guide is the highest level of the MindTouch IDF Framework and represents the 1st  level of your content hierarchy.  One User Guide can contain other guides as well.

A guide is a collection of articles that are organized by Article Type (Topic, Tutorials, References, and Troubleshooting).  A guide contains many articles.

 

Article

An article is a body of content (1 Page) that contains knowledge and represents the 2nd level of your content hierarchy. 

An article can take the form of certain Article Types such as Topic, Tutorial, Reference, Troubleshooting, and FAQ.  An article can contain many Sub-Articles.  An article belongs to one Guide.

There are three types of Articles:

 

Topic
A topic is a type of Article. A Feature Page is a kind of Topic. Topic Pages Create automatic outlining links, in the Guide Contents tab of the User Guide, under the Topics section header.

 

Tutorial
A Tutorial is a type of Article.  There are three levels of tutorial, which create automatic outlining with section headers under the Tutorials tab of the User Guide.

 

Reference
A Reference is a type of Article. Reference pages create automatic outlining links, in the References tab of the User Guide, under two section headers, Feature and Sample.

 

 

The following is an easy-to-download image to print and hang prominently on a wall, next to your computer:

Building pages:

 

Find the location in CA Connect that you want to start building your content.

From the editing toolbar on CA Connect, click on the New Page button.

 

 

 

 

This will bring up a list of templates, select User Guide and click on Create New Page.

(The list of templates available to you may differ).

 

Customize your Page

Time to get creative.

1. Choose the title of your new Guide [you'll be able to change this later if needed].

2. Enter a description of the guide.

3. Add your tags [for more on adding tags see [Tagging]

4. Don't forget to always save your updates.

What's Next

Now that you've seen how to begin a User Guide, let's start adding pages.