Microcontent

What is Microcontent?

This Answer Box is one example of microcontent that you will be familiar with from using Google

It is also used to create questions and answers for chatbot engines such as this.

What Can I Use it for in RoboHelp?

Within Your Project

Microcontent can be used to create FAQ topics for all outputs and to create Answer Boxes similar to the one above when users search.

Microhelp

You can create small files that developers can access in an app, with or without links to the main help. The files can be in various formats as described in Microhelp Output.

Chatbots

You can create content for a chatbot engine.

Terminology

Microcontent - There are many definitions that can be found but what they all boil down to is, not surprisingly, small pieces of information that assist readers.

Intents - Each intent is a piece of information intended to assist the user. The term comes from the chatbot world. It might be the answer to a question entered as a search or included in an FAQ page or it might be a small HTM file created for a developer to include in their software.

Microcontent Groups are groups of intents (pieces of information) that address similar areas.

Microcontent Within a Project

This section will describe creating microcontent for FAQ pages and Answer Boxes. There are two ways to create a Microcontent Group.

Method 1

  1. Click Microcontent in the Project Toolbar on the left.
  2. Click the + icon.
  3. The New Microcontent Group dialog will open. Enter the required name, FAQs for this example.
  4. Click Done.
  5. The editing table will open in the authoring area. See The Editing Table below.

Using this method, Adobe RoboHelp will add the group to the Microcontent folder. This folder will be created the first time you create a group.

Method 2

  1. Click in the blank area of the Contents panel or on any folder.
  2. Right click and select New Microcontent Group.
  3. The New Microcontent Group dialog will open. Enter the required name, FAQs for this example.
  4. Click Done.
  5. The editing table will open in the authoring area. See The Editing Table below.

Using this method, Adobe RoboHelp will add the FAQs group wherever you chose to add it.

Creating the Intents and the Responses

The authoring area will have a single row table by default where you enter the intents for the microcontent group. In this example an FAQ page is being created. You can also create Answer Boxes as described later in this topic.

In a new group, click in the left column of the table and enter the name of the intent.For this purpose it will be the question you want to appear in the FAQ topic, such as "Do I get paid when I am ill?"

In the right column, you enter the response (answer). Whilst the left column is text only, the response on the right can be formatted in the same way as any topic. Note though that if you will be using the group for any other purpose such as Microhelp or Chatbot outputs, you must respect their requirements.

You can add dropdowns, expanding text, variables and snippets. You can include cross references and hyperlinks to topics but do not link to other microcontent.

The key thing is to keep it brief. There is no limit imposed but it should not be more than a sentence or two.

 As the intents and responses are within a table, you may have border formatting issues if you also use tables within a response. Unless you have advanced CSS skills, it may be easier not to use tables within the responses.
Enclose snippets in a P tag to see the content.

To add further intents to the group, tab from the right column to add further rows or use the context menu which has other options such as Insert Above.

Using Existing Topic Content

Create a new intent as above leaving the right column blank, then select the required content in a topic and right click. Select Add to Microcontent from the context menu and select the required group and intent.

If the content within the selected area of the topic later changes, that automatically gets picked up in the intent.

You will not be able to edit that in the microcontent table. Changes must be made in the source topic.

The Intent Properties

  • With the cursor in a row in the Intent column on the left. the properties of the intent will be shown on the right.
  • With the cursor in a row in the Response column on the right. the properties of the response will be shown on the right.

Name

This will be whatever is entered in the left column.

Phrases

Phrases are not required for FAQ type topics or Answer Boxes.

Keywords

Phrases are not required for FAQ type topics or Answer Boxes.

ID

You can enter Map IDs for use with the Microhelp output.

Condition Tags

You can apply condition tags so that a particular intent within a group is not included when the output has the selected tag(s) applied.

Adding the FAQ Page to a Frameless Output

Locate the required microcontent. Add the MC file to the TOC.

Using this group shown above, when you generate the FAQs will appear in the TOC and will be shown as below.

Answer Boxes

By using a single row intent and response such as this where dropdown text and twisties have been used, you can create an answer box.

In Microcontent

  1. Create a group with one intent and response as shown below using dropdown. In this example twisties have been added to the style.
  2. Select the properties of the group and select the Hide from Search check box.
  3. Add the group to the TOC and select the Hide in Output check box.

By selecting those options, the Answer Box will only be shown in response to a search.

Creating Microhelp

You can create small files that your developers can link to within the app. These will be very small and sit standalone on a server.

This output does not require phrases and keywords added. If they are defined because the Intents are used for a chatbot output, they will be ignored for this purpose.

Microhelp Output describes how this is done and the file types that can be created.

Creating Content For Chatbots

You can create responses that can be integrated with whichever chatbot engine you use.

This output does require phrases and and may need keywords depending on the chatbot engine used. If keywords are defined because the intents are used for other chatbot engines that do require them, they will be ignored for engines that do not require them.

Chatbot Output describes how the content is generated for your chatbot engine.