ClickHelp Technical Writing Blog

Parallel structure, also called parallelism or parallel construction, is something you are likely to remember from school. Parallel structure in writing means that sentences or elements within sentences have a similar grammar pattern. Such repetition serves several purposes. In literature Continue reading »

Does authoring help topics make you an author? We believe it does. And although maybe everything you are creating along the lines of technical documentation becomes the property of the company you are working for, it is more about how Continue reading »

You will certainly meet people in this world who say things like 'I don't care how this user manual looks as long as it is well-written and contains answers to my questions.' It is great to know that some people Continue reading »

When a customer opens a user manual, the idea that the text is lying or it is trying to manipulate them will hardly ever cross their mind. Who would want to lie in technical documentation and why? The grim statement Continue reading »

While technical documentation is mostly associated with text, it is much more than this. Without visual content technical texts are boring and hard to comprehend. Using diagrams in help topics is a great way to improve your content. However, you Continue reading »

People like to think that they got rid of Waterfall for good, while in reality, many companies are still performing somewhere in between Waterfall and Agile. Nevertheless, even if you feel like you can't call what your company is doing Continue reading »

In continuous integration, software developers submit code to a shared repository several times a day. The main idea behind it is catching issues at the earliest stages and fixing them. And, in theory, you can have new releases daily. This Continue reading »

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 Continue reading »

Modern businesses love everything seamless. Like, Continuous Integration is a new go-to for software engineers. The underlying principle is sharing code as often as possible, ideally, several times a day. This means new releases become more frequent than ever and Continue reading »

Having the same role for a long time, doing similar routine tasks can make you feel stuck. When you have pretty much figured what you do, the question of what you should do to become better at it arises. Easy Continue reading »