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

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.

You must to post a comment.
Last Modified
06:35, 21 Mar 2014

Page Rating

1 of 1 found this page helpful.

Tags

Complexity:
Version:
 
http://success.mindtouch.com/Documentation/Knowledge/Information_Architecture/IDF_(TCS)/001_Building_a_User_Guide
success.mindtouch.com
crawl=CC-MAIN-2014-15
47872
application/http; msgtype=response
sha1:B23A6GILAPOEDSTW2RDG43WDXE4LPYWC
<urn:uuid:af6fde56-953b-4781-b631-713e36f9152b>
2014-04-24T04:20:24Z
54.83.51.146
sha1:X4AZLHVLHR6CJVNDGKBAFWMYURBJXKME
<urn:uuid:99c22012-c182-4858-b590-1db17f4a4ed5>
http://success.mindtouch.com/Documentation/Knowledge/Information_Architecture/IDF_(TCS)/001_Building_a_User_Guide
response
<urn:uuid:cb4a2dc5-94a7-414f-9f16-8e66f411a255>
robots: classic
hostname: ip-10-147-4-33.ec2.internal
software: Nutch 1.6 (CC)/CC WarcExport 1.0
isPartOf: CC-MAIN-2014-15
operator: CommonCrawl Admin
description: Wide crawl of the web with URLs provided by Blekko for April 2014
publisher: CommonCrawl
format: WARC File Format 1.0
conformsTo: http://bibnum.bnf.fr/WARC/WARC_ISO_28500_version1_latestdraft.pdf