ClickHelp Technical Writing Blog

From time to time, in this blog, we turn to analyzing the job market for tech writers, to provide you, our readers, with fresh and precise info on who's hiring. And, well, the industries at the top of the list Continue reading »

If you think of it, dozens or even hundreds of criteria can be used to determine the quality of technical documentation. This blog is actually more than us listing some criteria, this is an exhaustive guide you can follow to Continue reading »

Don’t be cruel to your user manuals. Treat them well and your efforts will pay off. Happy customers will be the currency! Not Taking Mobile Readers Into Account The share of mobile traffic for 2019 was more than 50%. That Continue reading »

We hear the term "topic-based authoring" quite a lot. ClickHelp is software for help writers that supports the topic-based approach. But how did it come to be? What makes topic-based authoring superior in modern techcomm? And, finally, how is it Continue reading »

One of various things technical writers can do is compose questionnaires and write interview questions. Users are the perfect candidates for being interviewed! Goals of these interviews can vary, we will talk about that in a moment. For now, we Continue reading »

Our previous post was addressed to problems with technical documentation. So, we set up a poll on our Telegram Channel. According to it, technical writers' biggest concern is that people don't read documentation. Imagine how frustrating this is - all Continue reading »

There are certain issues that are very common for technical documentation teams all over the world. We will not only name them in this blog post but will also provide comprehensive solutions. Let's begin. You Don't Have a User Manual Continue reading »

Technical documentation is very complicated as it is. Don't let your readers get lost in it! Give them a helping hand - navigation. Ideally, readers don't need to be conscious of navigation elements they use. Moving between help topics should Continue reading »

Why do we recommend using visual elements in technical documentation? Well, the answer is simple - the human brain is very good at distinguishing colors and understanding patterns. So, when you add maps, graphs, charts, infographics, dashboards, etc. to text Continue reading »

Sometimes, we get so used to looking at things from a certain perspective that it is getting increasingly harder to see how it may look for others. For instance, no matter how important it is for technical writers to think Continue reading »