Technical Writing Blog

ClickHelp is a tool for technical writers that offers enormous possibilities. We would like for each user to be able to use our software to its full potential. To help with that, I’ve come up with a list of mistakes to avoid when using ClickHelp. This list is perfect for our new clients, but even…

Let’s talk about versioning user manuals today. This concept has far more use cases than one might think. We will name some of the most popular ones and talk about the means ClickHelp, a cloud solution for help writing, offers to solve this! ClickHelp is based around the idea of reusing content and creating multiple…

Remember when you had to actually install software on your PC to write technical documentation. That wasn’t entirely terrible, but if you think about it… you had to worry about so many unnecessary things like system requirements, enough free space, security, and many more. Working from home wasn’t such a big thing until recently, but…

You can create a truly awesome user manual. Hundreds of topics that describe every product feature thoroughly. Navigation elements that are conveniently located throughout the documentation. Your readability score is high. You’ve configured styles and scripts in your online documentation portal according to your needs. It’s been going great, except… How are you going to…

ClickHelp has grown a lot for the past few years in terms of clients and feature-wise. If you think about it, these two facts are connected. Listening to our clients and fine-tuning our development road map based on the feedback is how we prefer to move forward. Although ClickHelp is a pretty straightforward help authoring…

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….