ClickHelp Documentation

Authoring

Creating online documentation can become challenging without the proper documentation tool. Each authoring process is a unique experience requiring various features, and we designed ClickHelp to cover the overwhelming majority of tasks you might face.

ClickHelp is a flexible, versatile tool for content creation and editing, and in this section, you will find information on how to use it.

Editing Your Content

First of all, ClickHelp offers you a powerful Editor which allows you to author help topics easily on different levels, thanks to the Design and HTML Source views.

The Design and HTML Source views features

The Design View offers you a user-friendly interface for editing your content, similar to what you see in word processing software tools like MS Office Word or Google Sheets. It allows you to use all the familiar text editing and styling functions such as making your text bold or italic, changing fonts, creating lists, etc., as well as work with different types of content, such as images/GIFs, videos, links, code samples, tables, tabs, etc. It is even possible to embed external data like diagrams or math equations. You can read all about the mentioned functionality in the Topic Editor section. 

In ClickHelp, you can find several ready-to-use elements used to draw a reader's attention, like Info and Warning boxes, or to hide some data into an expandable box, like Show More Box, Text Popup, and Dropdown Text. You can also create your custom template elements and save pieces of content that you will be able to quickly insert into your topics using the Quick Parts functionality. Read more about using these elements in the following section: Add Ready Elements.

It is also worth mentioning that you can add to your topics built-in navigation elements, such as:

Read more about using these elements in the following section: Add Navigation Elements.

The HTML Source View lets you edit the HTML code of your topics conveniently and provides multiple helpful functions like markup error detection, tags/attributes auto-suggestion, and Auto Formatting. Read more about it here: Topic Editor - HTML Source View.

Single-Sourcing

Another important functionality that will help you in your authoring process is Single-Sourcing. It allows the creation of various variants of documentation from a single project. This functionality comes in handy for different tasks: you can exclude and include topics for different user groups, create a version of your documentation containing notes for technical writers, create printed outputs, and so on.

Several features comprise the Single-Sourcing functionality:

  • Content Snippets. You can use them when you need to reuse the same piece of content in different topics or projects. They allow you to keep and maintain the source content in one place while reusing it in as many other places as you want.
    For example
    It can be useful for headers, footers, disclaimers, or any other repeating content that needs to be the same across your documents.
  • Output Tags. If you want a part of your content to be present in one output and excluded from the other, you can use the Conditional Content that works based on Output Tags. It allows you to get different outputs from the same source. 
    For example
    You might need it for creating different versions of your documentation for different audiences: when you need to deliver a regular version to your readers and a version with technical notes for your technical writers.
  • Variables. They are useful when you need to put a short piece of text in many places across the documentation and have a way to update this text in a centralized manner.
    For example
    You can use a variable as a version number of your application. Then, when the version changes, you will only need to update it in one place instead of manually going through all your topics.
  • Topic Master Page. Used to customize a topic template: to add a custom header and footer, to integrate third-party tools or external fonts, to add SEO meta tags to all topics of specific projects or a whole portal at once. 

You can read more about the mentioned and other features in the following section of our User Manual: Single-Sourcing and Dynamic Output.

Other Features

In addition to Topic Editor and Single-Sourcing, ClickHelp has several additional features that can help you with the authoring.

Utilizing Index Keywords can ease navigation across your documentation for both authors and readers.

Adding SEO meta tags can help you to get marketing benefits and place your documentation higher in the results of the search engines.

Copying a topic can save you time when you need to duplicate the topic's content in another project.

Built-in Spell Checker can help you to catch typos and correct mistakes on the fly.

Reading this section of our User Manual, you will find information about all the mentioned features and get to know more.