Technical Writing Blog

There are strong reasons for having a documentation plan. The main one being – setting up a clear and open help authoring process. Creating a documentation plan means giving every team member an exhaustive reference point. The whole team will act within the guidelines of the plan and that ensures consistency and efficiency. Structure of…

According to a poll we set up among the techcomm people, successful update of user manuals is among the most troublesome areas of help authoring. What you need to understand is that building reliable and clear processes for documentation maintenance is the key to success here. This article will explain how to set up the…

Technical writing is mostly associated with user manuals, software documentation, and the like. However, technical writing is an essential part of every industry now. That’s why, in this blog post, we want to describe some unexpected documentation examples that will bust misconceptions. Information Technology (IT) Writing Speaking of IT, this sphere is more than just…

From time to time, in this blog, we turn to analyzing the job market for tech writers, to provide you, our readers, with fresh and precise info on who’s hiring. And, well, the industries at the top of the list are pretty much the same: IT, engineering, spacecraft, gas and oil, medicine, and a couple…

Are you currently writing help topics from home? The chances are high that you are. Fortunately, technical writers seem to be less affected by all the wfh stuff since online help authoring tools allow working on user manuals from any place with the internet connection. And, also, some tech writers have been freelancing for a…

‘Who owns the information, he owns the world’ is a famous quote that has never been more accurate than now. Humanity depends on data. And, the questions of how and where to store it and who to trust are the burning ones. Losing important data is the worst that can happen. The simple truth that…

Companies all over the globe are sending employees to work from home. Even when this wasn’t an option before. This is an unexpected turn of events for many businesses. But, also, we are now more prepared for remote working than ever before, thanks to SaaS. SaaS means ‘software-as-a-service’. So, clients don’t need to install anything…

If you think of it, dozens or even hundreds of criteria can be used to determine the quality of technical documentation. This blog is actually more than us listing some criteria, this is an exhaustive guide you can follow to find areas of improvement. We will look at this subject from two perspectives – from…

Don’t be cruel to your user manuals. Treat them well and your efforts will pay off. Happy customers will be the currency! Not Taking Mobile Readers Into Account The share of mobile traffic for 2019 was more than 50%. That says something. Technical documentation is perhaps not the resource with the highest mobile traffic numbers,…

We hear the term “topic-based authoring” quite a lot. ClickHelp is software for help writers that supports the topic-based approach. But how did it come to be? What makes topic-based authoring superior in modern techcomm? And, finally, how is it different from modular help writing? Let’s try figuring this out. Predecessor of Topic-Based Authoring For…