We’re in the freedom business. We like users to be free to use the software and not shackled by confusion. We like software makers to be free to design and develop and not worry about how their users learn. We want support people to share their internal troubleshooting steps with users, thus freeing themselves to bite into meatier issues. And, of course, we want Tech Pubs folks to set their desktop files free and get them to the cloud. With the latest MindTouch TCS release we’ve made it possible for authors of great content using products like Adobe RoboHelp, Adobe FrameMaker and Madcap Flare to easily set their static content free on the Web. Here are the three easy steps to converting your CHM file-based help into a MindTouch TCS site.
Step 1: Import a CHM
Step 2: Add Tags and Overviews
You’ll notice on the main User Guide page for the CHM import that the hierarchy was maintained from the CHM file, but you’ll also notice some of the Topics have an Overview that says “Explain what the feature is or what its….” This is the Overview for the Topic Page. If you click on any Topic page and then click Edit you can modify this overview by editing the Overview section:
Now that you’ve modified the Overview, users will be able to see the summary of the articles from the User Guide page. Next we’ll change some of the tagging of the articles so that we correctly identify their article type. To change the Article Type scroll to the bottom of an Article and right below the Tags section there is a call out for Article type: Click the Feature Overview and you’ll be presented with multiple options for the article type including Tutorial, References, and Troubleshooting:
Once you have selected an Article Type then you can also add additional tags to the articles. When you add additional tags then the IDF templates (Intelligent Documentation Framework) Templates will then automatically relate content based on the tags. I’m going to add the tag tools to this and a couple of articles. To add the tag, put your cursor in the text field that says “Enter new tag value here” and type tools and then hit Enter:
Do this to a couple more pages and then refresh one of the articles. You’ll notice at the bottom of the article in the Related section that all of the articles tagged with tools shows up:
Now that you’ve added some overviews and tags you can now open your documentation up for your community to access it.
Step 3: Capture Analytics
Now that your content is live, your users can engage with it and actively provide feedback. As users navigate through articles they can provide feedback on the usefulness of the articles along with providing feedback on where the articles can be improved. Also you are able to capture what users are searching for within your content, along with what they are and aren’t finding. This along with additional analytics will provide great insight into where your documentation needs to grow and where you can make tweaks to ensure your documentation is helping your users become experts. You can access the Behavioral analytics by clicking on Reports at the top of the screen:
This will then expose Community Scoring, Aging Report, and Search Analytics to help you make decisions around your documentation:
If you have questions on how you can move additional data into MindTouch or need help with getting your MindTouch TCS site setup, please feel free to contact us.