Technical Writing Blog

In this blog, we are mostly talking about classic user manuals and use those as a general example. Today we are going to look closer at two very popular use cases that are a bit different – FAQs and knowledge bases. Specifically, we will talk about how to make the most of them using ClickHelp….

The API industry keeps growing, and many companies require software for technical writing that would allow creating more comprehensive API technical documentation. No doubt, you can create API documentation even in plain text, but would it be readable? Modern techcomm specialists are striving for more efficient and user-friendly docs, so, certain requirements exist that a…

Documentation branding – a lot of people are doing it, but few know why it is such a necessity. In this post, we will touch upon the main goals of documentation branding and also equip you with the right tool to style your docs in an efficient manner. Why Branding Your Technical Documentation is Good…

Online documentation was a very logical next step for technical writing. The Internet has become so easily accessible that looking up something online seems like a natural part of our lives. So, storing documentation online is not only a matter of convenience; by now, it has become common sense. Help authoring tools like ClickHelp allow…

We have been developing our help authoring tool, ClickHelp, for quite some time now. It has been a long journey of learning to prioritize things, to listen to feedback and apply it. Different workflows require different functionality, so we have been learning how to balance out our technical writing tool and make it more flexible….

Documentation delivery is quite an important process and can be provided in different formats. You can send out PDF files, send printed documentation or host your documentation online. Having online documentation is very useful, as you can instantly share any topic with a user and they can open it right in their web browser. But…

ClickHelp Aurora Polaris has been released recently. While you are already enjoying all the improvements and new functionality, we will keep describing the awesome changes and enhancements the new tool version brings. We would like you to get maximum benefit out of this release! This product update is a huge event for ClickHelp, some changes…

We are about to provide you with another exclusive insight into the next ClickHelp product release! Today, we will share details of an exciting feature that will become available this March. ClickHelp users are getting the possibility of updating/adding any amount of help topics to their docs instead of preparing the whole project for an…

As the March ClickHelp release approaches, the ClickHelp team is getting more and more excited as we are eager to share with you all the awesome things we have been working on for the last several months. This sneak peek blog post is dedicated to drastic functionality improvements of taxonomies, full-text search, and navigation. Keep…

A new sneak peek post and even more excitement comes with it! We are going to tackle a very important topic in the upcoming ClickHelp release – your user’s satisfaction with the technical docs you create. You sure have a general idea about how readable your user manuals are. But, does this idea have any…