ClickHelp 3 Minute Overview

Watch a 3-minute overview of ClickHelp - modern online documentation tool. Learn how you can import CHM and Word documents, and use our topic editor to write the content directly in a web browser.

You can use ClickHelp under Windows, Linux, or Mac OS X. This is a true online documentation solution - work anywhere, work as a team, manage your online content easily.

No installation. Sign up and try ClickHelp for free in a few minutes!

Topic Editor: Overview and Topic Links

Learn more about the ClickHelp Topic editor - this is the main content creation tool technical writers use on a daily basis. In this video, you will see an overview of all ribbon tabs of the editor to find out how you can style your content, how you insert videos and screen shots, how to handle tables, how to assign topics to authors and change statuses,and much more. Also, you will learn about different types of links you can easily insert into your documentation: topic links, web page links, file links, anchor links, mailto links. With ClickHelp, many operations are quick and easy, making documentation writing faster!

Adding Images and Video in Topics

Technical writers spend a lot of time creating nice screen shots for documentation and inserting them into user manuals. Learn how this can be done in ClickHelp - uploading images to the portal Storage via drag&drop, changing the style of the inserted images. On top of this, you will learn how to insert YouTube and Vimeo videos into your online documentation - this is a great way to expand the information delivery methods beyond the text content. Use the benefits of being online - deliver your content in multiple ways.

Styling Your Content

ClickHelp allows you to create beautiful online user manuals. With the powerful CSS styling, you can make any changes to your documentation styles in a centralized manner. Easily control the heading styles, the list styles, the color of the hyperlinks, and much more.

Watch this tutorial video to see a few practical examples of the content styling. Learn how to configure the font and background color of your help topics using CSS, how to properly generate the font-family value, create a custom design for your bulleted lists.

Using Ready Box Elements

Documentation experts often use ready blocks to speed up documentation writing and standardize the look of the elements across the documents. User manuals often have information boxes, warning boxes, or expandable sections. In this video, you will learn how you can use these standard blocks in ClickHelp with one click. They make your documentation look more professional. You will also learn how you can style these elements and what they can look like on top of the styles the ready documentation templates provide by default. Pick your style and use in your user documentation, or change it to make it look unique - the power of CSS3 is available to you!

Many technical writers are familiar with the See Also blocks in user documentation. This is a block of relevant links you suggest to the reader in addition to the information a help topic provides. ClickHelp provides a special dynamic element you can use - the See Also block. It makes it easier to give links to other topics in the same section, or to child topics of some section. In the video, you will also learn about the navigation links you can insert in your documentation - the Next, Previous and Top links. They are also dynamic and they will update if you change the order of topics. This is very useful when creating ste-by-step guides and tutorials, since you don't have to update the Next/Previous links manually when you add a new step or change the steps order. Try ClickHelp for free

Navigation Elements in Topics: Mini-TOC and Breadcrumbs

When the documentation grows, the Table of Contents gets several hierarchy levels to reflect the logical structure of the content. To help the readers, we recommend using the Breadcrumbs element at the top of the topics to visually identify where the reader is in terms of the documentation structure. The best approach is to use a Content Snippet for the topic headers and put the Breadcrumb element there.

For long help topics, using Mini-TOC with a list of topic sections is very useful - this helps the reader quickly jump to the needed section of a topic. This video will demonstrate how to use the Breadcrumbs and the Mini-TOC elements in your user documentation.

Variables in Topic Content

Very often, user documentation has text elements that are repeated multiple times across many help topics. Some examples include: product name and version, contact phone, company address, etc. When such small part of information changes, technical writers have to update all documents in the user manuals to reflect the changes. This a tedious and error-prone approach, which makes authors spend their time inefficiently. In ClickHelp, you can use Variables to manage repeated values in a centralized manner, and update them easily. Define Variables on the project or global level, insert them into the help topics, update the values easily! Learn how to do this by watching this video. Try ClickHelp for free

Using Content Snippets

Technical writers often need to repeat the same text snippet in multiple places of a user manual. It may be a set of typical steps, some pre-requisites information block, a warning about an unsafe operation, or something else. To avoid copying the content all over the place, ClickHelp offers the Content Snippets functionality. With this function, you can easily reuse the existing content in multiple places of your online documentation. Content snippets allow adding another topic's content as a reference - the content is not copied, it is pulled dynamically. This means that the source topic changes propagate to all other topics that use it as a Content Snippet. This is a very good way to make the content maintenance easier and avoid mistakes. Watch this video to see how the Content Snippets can be used in practice to make your life easier.

Conditional Blocks

In ClickHelp, you can create several different outputs from the same project, depending on the audience of the user manual you are working on. Conditional blocks are used inside a topic content to mark some sections as conditional - they may be included or excluded from the final output depending on the publishing settings. Using this single-sourcing mechanism, you can create multiple manual that are slightly different from each other - Beginner and Pro manuals, User and Admin references, Employee and Manager guides, etc. Watch this video to learn more on this mechanism. Try ClickHelp for free

Meet Our Clients

×

Have Not Found What You Need?

Ask us and get an answer within 24 hours!
All channels are monitored 24x7.
Your e-mail (for our response):*
Subject:*
Inquiry text:*
×

Mind if we email you once a month?

Professionals never stop learning. Join thousands of experts subscribed to our blog to get tips, ideas and stories from us once per month.
Learn more on ClickHelp