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

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 –…

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…

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 more today. Check out the first part of this short series here. Whom am I…

There are two career paths that seem quite similar in terms of work processes, at least at first sight: technical writing and content writing. These two do overlap, but, actually, they are based on different concepts. So, which path should you choose if you feel like creating texts is your thing? Let’s find out what…

There are many ways to make your technical documentation better. In this article, we are going to provide you with some general guidelines that are, sadly, often forgotten or overlooked. Let’s start! Get Comfortable Yes, this first advice might seem weird, but, actually, your mental and physical state directly influences your productivity. Make sure your…

We have been mentioning readability on this blog quite a lot recently. No wonder, with modern trends like UX writing, this has become a real point of concern for may technical writing teams. Luckily, readability is not that abstract, it can be actually broken down into pretty specific elements. Today, we are going to talk…