Technical Writing Blog

A new sneak peek post and even more excitement comes with it! We are going to tackle a very important topic in the upcoming ClickHelp release – your user’s satisfaction with the technical docs you create. You sure have a general idea about how readable your user manuals are. But, does this idea have any…

Today, we are really excited to give you this exclusive sneak peek into the ClickHelp March release. We have prepared numerous product enhancements and feature updates, and we are eager to share them with our clients! More sneak peek posts are coming in the following weeks. Reviewing is a crucial part of technical writing. And,…

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 order, they didn’t have to organize a search party for that old I-was-sure-it-was-in-that-drawer user manual….

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 not for you; but you could still give it a read, because the right answer…

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 stands out as a pretty unique product due to specifics of the field. Therefore, we…

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 this crazy pace, we will eventually end up with hundreds of billions. This is quite…

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 design is a process of developing and delivering learning materials and everything in between –…

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 of your users docs in our article. Color Scheme While printed technical docs tend to…

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 software company. It stores vital information on features, use cases, and code examples. So, every…

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 – they are all using the same product or service. If we take a step back…