ClickHelp Technical Writing Blog

Do you have any second thoughts when spelling out things like two million three hundred thousand kilos? Or, on the contrary, when you prefer numerals in sentences like: Creating a new documentation portal will take you no longer than 1 Continue reading »

We recently posted an article on using parallelism in technical writing and this was kind of thought-provoking. Parallel structure is one of the most commonly used literary devices and while its role is a bit different in literature and help Continue reading »

Developing good habits and getting rid of the bad ones is something that applies not only to our personal lives but our careers as well. Today we'd like to talk about good habits that technical writers can work on to Continue reading »

If you are concerned about your user manuals looking bad, this article will give you certain focus points improving which can turn the situation around. How far you want to take it depends on your subjective opinion regarding this matter Continue reading »

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 »