ClickHelp Technical Writing Blog

What Is DITA? DITA is short for The Darwin Information Typing Architecture. It comprises the principles of specialization and inheritance that are much like the Darwinian theory. “Information typing” means the classification of information into topics, not “typing” as in Continue reading »

An FAQ is a list of frequently asked questions about a product or a service. They can be found on websites, occupy special forum sections, or be part of an online documentation portal. Fun fact - an FAQ section doesn’t Continue reading »

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

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

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

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

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

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

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