Home > Documentation > Knowledge Management > Information Architecture > IDF (TCS) > Building a User Guide (TCS)

MindTouch
Copyright (c) 2006-2014 MindTouch Inc.
http://mindtouch.com

This file and accompanying files are licensed under the MindTouch Master Subscription Agreement (MSA).

At any time, you shall not, directly or indirectly: (i) sublicense, resell, rent, lease, distribute, market, commercialize or otherwise transfer rights or usage to: (a) the Software, (b) any modified version or derivative work of the Software created by you or for you, or (c) MindTouch Open Source (which includes all non-supported versions of MindTouch-developed software), for any purpose including timesharing or service bureau purposes; (ii) remove or alter any copyright, trademark or proprietary notice in the Software; (iii) transfer, use or export the Software in violation of any applicable laws or regulations of any government or governmental agency; (iv) use or run on any of your hardware, or have deployed for use, any production version of MindTouch Open Source; (v) use any of the Support Services, Error corrections, Updates or Upgrades, for the MindTouch Open Source software or for any Server for which Support Services are not then purchased as provided hereunder; or (vi) reverse engineer, decompile or modify any encrypted or encoded portion of the Software.

A complete copy of the MSA is available at http://www.mindtouch.com/msa

Building a User Guide (TCS)

This article applies to:Only MindTouch TCS

Overview

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.

 

=media_1302039541804.png

From anywhere within MindTouch, select New Page.

User Guide Template

=media_1302039635258.png

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

Customize your Page

=media_1302039859725.png

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.

Last modified
06:35, 21 Mar 2014

Tags

Classifications

Intermediate
MindTouch TCS