MindTouch TCS Intelligent Documentation Framework (IDF) Guide

No headers

View tutorials for:

Beginner tutorials

User Guides

Creating User Guides: Explains how to start using the MindTouch templates for technical documentation, starting with the User Guide template.
Creating Topic Pages: Explains how to create topic pages that organize a user guide and describe the concepts, methods, and technology of a feature.
Adding a Reference Page: Explains how to write reference pages that contain information that readers typically look up rather than memorize.
Adding a Tutorial Page: Explains how to write a page that walks someone through a self-paced learning exercise using a feature in the product.
Adding a Troubleshooting Page: Explains how to create a section of troubleshooting pages that describe potential problems and offer solutions to resolve them.

FAQs

Creating a List of Frequently Asked Questions (FAQs): Explains how to write FAQ pages and bundle them into an FAQ collection.

Tags

Tagging Pages for Discovery: Explains how to use the provided template tags to create a technical documentation or support site.

Templates

Creating Pages Using the Provided Page Templates: Explains how to use the default page templates to write new pages.

Intermediate tutorials

User Guides

Organizing User Guides: Explains how to organize a user guide using the collection templates.

Content Reports

Generating a Content Report for a User Guide: Explains how to analyze a site's content using the provided content reports—Quality, Aging, and Search—for a specific hierarchy in the site.
Downloading Report Data as a CSV File: Explains how to run a report and download the data for that point in time.

Tags

Tagging Pages for Workflow 1 of 1 found this helpful: Explains how to use the provided template tags to mark pages for workflow, including a draft stage.

Advanced tutorials

Content Reports

Identifying Least Helpful Tutorials: Shows you how to identify which tutorials are low performing based on ratings, comments, and page views.
Identifying Most Active Pages in a User Guide: Explains how to use content reports to determine which pages are read the most, rated the highest, and generally the most active.
Identifying Stale Pages: Explains how to use the Aging report to identify outdated content.
Understanding How Your Audience Discovers Content: Explains how to run content reports that give you search data and historical information over time to gather keywords and phrases from a user's perspective.

Templates

Customizing the Page Templates 2 of 2 found this helpful: Explains how to customize page templates for your information.
Adding Page Templates 1 of 2 found this helpful: Explains how to add page templates, which contain text that can be added to pages, to your site.

Add a Troubleshooting Page

Troubleshooting pages are for users to identify reasons and fixes for problems. To mark a troubleshooting page, add the tag article:task-troubleshooting to any page.

View references for:

Features
Samples

Features

Getting Started

MindTouch Benefits: Describes the MindTouch technologies used in the Intelligent Documentation Framework.

Content Reports

Query Syntax for Reports: Describes in detail the available search queries that you can enter in the MindTouch system especially for content reports.

Tags

Tag Descriptions 2 of 2 found this helpful: Describes in detail the available tags and groupings of tags.

Templates

Template Descriptions: Describes in detail the default templates available for technical and support documentation.

Samples

Getting Started

Sample Style Guide 1 of 1 found this helpful: Provides the basic writing guidelines for a site.

This guide provides an overview and guidance for using the MindTouch Intelligent Documentation Framework (IDF) for technical documentation, such as technical support sites, learning materials, or user manuals. In addition, it contains recommendations on best practices, tutorials for getting started, and troubleshooting information for common situations.

Table of Contents

Introduction

Getting Started

Effective Crowdsourcing Techniques

User Guides

Content Reports

FAQs