ClickHelp’s Summer Refresh: A Few Updates To Better Your API Documentation And User Experience

As summer comes to an end, ClickHelp is rolling out a refreshing wave of updates to enhance your documentation experience. From expanded notification features to improved API documentation capabilities, this release brings a cool breeze of functionality to power readers and casual users alike.

Let’s take a look at the key improvements.

• API Documentation: Better Impor
• AnswerGenius: Enhanced Search Quality
• Topic Update Notifications for Readers
• Cosmetic Improvements

API Documentation: Better Import

We keep working to make ClickHelp the better platform for hosting API documentation, and here’s another step on the way: from now on, it’s possible to easily import your documents from Readme.io to your ClickHelp portal.

Why would you change the tool, though? As an all-in-one documentation platform, ClickHelp helps you manage all your content from internal guides to API docs in a single portal and provides you with a better way to keep it up to date:

• From small snippets to whole topics, the reusable content feature is included from the start, no matter the plan you choose.
• ClickHelp allows you to publish multiple projects and versions in different formats that can be password-protected or open to the public.
• A wide variety for ready-made blocks (code samples, definition examples, etc.) improves the whole working process, making it quicker and letting you focus on more pressing matters.
• You can pick one of three possible options when importing a definition:
  • All your methods together in a single topic.
  • A few topics, each grouping a few methods according to the way you’ve generated the definition.
  • Each method becomes a separate topic.

The import process is stress free in general, thanks to our Wizard. By the way, our free trial is a great way to check it yourself.

AnswerGenius: Enhanced Search Quality

Our little AI-assistant is growing up, becoming more clever and capable. Now it provides more precise, well-structured answers, and not in the form of plain text only, but concise lists as well.
Also, now AnswerGenius can search through the publications with restricted access, but only for those of Power Readers who have access to them. And only if you turn the option on.

Topic Update Notifications for Readers

We’re improving the Watchers functionality to keep users better informed about documentation changes while maintaining necessary access controls.

There’s a lot of different documentation scenarios. Some of your docs are password-protected and for internal use only, while the others are public. Some users have full access to everything, the others are restricted. To address the various needs and cater to a wide range of possible situations, we’ve implemented a few important changes.

In short,

• Power Readers Access: The authorized external users with access to published content can now subscribe to topic update notifications. This feature was only available to internal contributors with admin access.
• Public Version History: Readers can access a comprehensive version history for each topic, allowing easy comparison between different versions.

Cosmetic Improvements

At ClickHelp, we want you to enjoy using our platform not only from a technical point of view, but also aesthetically. That’s why this update brings you a few minor, but significant UX improvements.

• New Font: It’s more clear, easy to read, and provides you with a unified look across different platforms and devices.
• Improved Settings Design: better navigation, less cognitive load.
  
• Improved Publishing Wizard: the same functionality, but easier on the eyes.
  
• Improved Import Wizard: now, with icons and context help.
  

* * *
Ready to find out more about our cloud-based documentation platform? Here’s a free trial or a live demo for you.