Technical Writing Blog

How do you know if your technical documentation is any good? And, most importantly, how do you fix it if it’s not good enough? Well, there are certain key points that you will need to analyze to make sure your team creates top-shelf user manuals. We wrote a post on bad and good documentation examples…

We have been living in 2019 for four months now, so the predictions for this year are over. It’s high time to start analyzing what trends are actually unfolding in the techcomm community worldwide. New Formats and Platforms in Tech Writing When a new technology appears, it requires to be documented, of course. A new…

The main aim of technical writing is to help users achieve their goals by using a product. It’s possible only through clear and easy-to-interpret documentation. That’s why there are so many different types of documentation. Whether you’re a novice or experienced tech writer, you should know the most popular types of documentation because every type…

It is very important to make user manuals accessible to as many people as possible. Technical documentation is something we refer to pretty often in our daily lives because of all the technology around us. So, comfortable living implies being able to get access to user manuals and be able to read them. And, we…

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…