ClickHelp Technical Writing Blog

Quite a while ago, technical documentation became accessible online for many products. And, it was an important step in the evolution of technical writing. People didn't have to store printed technical documentation anymore. In case a device was out of Continue reading »

Take a look at your workspace. What are your thoughts? Do you feel encouraged and full of productive energy to create superb technical documentation when you are looking at it? If the answer is ‘yes’, then this article is probably Continue reading »

API is on top of its game now. The market is growing, the products are being developed and improved. This means that API documentation will be in the center of attention in the years to come, as well. API documentation Continue reading »

The IoT market is currently exploding with millions of devices online daily. In a couple of years, we will be talking about billions of such devices. And, since there are no viable reasons for the IoT to stop developing at Continue reading »

Instructional design is perceived as something separate from technical writing. Let's take a closer look at this field and see for ourselves whether a line should be really drawn between techcomm specialists and instructional designers. Definition of Instructional Design Instructional Continue reading »

We all can agree that content should be the primary focus of a technical writer. But, we also can’t just leave out other aspects of creating technical documentation. This is why we would like to focus on styling and formatting Continue reading »

Today we are going to talk about how technical writing influences software development. And, why technical writers are, actually, inseparable from a product life cycle. User Manuals Help Keep it Together In general, technical documentation creates the backbone of a Continue reading »

Technical writing is the means of helping people to understand how something works. Are these people just random? No, not at all. With each user manual, there is at least one obvious thing that its readers have in common  Continue reading »

Are your user manuals good or bad? Let’s run them through our quick checklist. Don’t get discouraged if it turns out to be not perfect, this article contains a lot of ideas to follow that can change your user manuals Continue reading »

This post is part 2 of the article series on the topic that most tech writers will find relevant. We are going to talk about the most dreaded challenges and difficulties a technical writer faces. We’ve come up with some Continue reading »