Technical Writing Blog

How can one make sure that their project, a software project, for instance, is going to be a success? No one will give you a recipe that works 100% of the time, but there are ways to increase the chances. Before the actual development starts, technical specifications should be established. How will this help? Well,…

If you are reading this, there’s a high chance you are a technical writer experiencing signs of burnout and willing to do something about it. Let’s first define what burnout is by singling out some of the red flags you should pay attention to. So, you most probably hit burnout when: You lack motivation to…

I recently wrote an article on how to compose a tech writing portfolio. The next logical step is actually making it available for future employers. Several things need to be considered: Ease of set up How much knowledge and skills you would require to set it up. Ease of updating existing samples To own a…

When you are starting a new documentation project, you might be looking for guidance. So, in this post, you will find a user manual template that works best for software documentation. The provided guidelines can be applied to other types of user manuals, as well. Without further ado, a software user manual template you can…

Technical documents can contain different data, and numbers can be often spotted there. Especially when we are talking about reports and scientific articles. Since every detail in technical writing is important, understanding the ground rules of using numbers in user manuals is vital. Also, numbers come in various types, and each has specific best practices…

What makes people cringe when reading technical articles? Typos would be the most common answer, I think, along with any small inconsistencies that make a text look unprofessional and untrustworthy. Proofreading is supposed to filter out such things. However, we are only humans, and a proofreader can make mistakes, too. But, how to make this…

An FAQ is a list of frequently asked questions about a product or a service. They can be found on websites, occupy special forum sections, or be part of an online documentation portal. Fun fact – an FAQ section doesn’t necessarily cover questions that are frequently asked. It can be just any descriptive or technical…

Can you land a job in technical writing providing no writing samples at all? I believe so, yes. But this will likely be an entry-level role. Hiring you for something more serious, your potential employers would like to see some of your work. And, today, we are going to be talking about the best practices…

At first glance, this blog post is more fitted for people currently fulfilling the position of a manager in a documentation team. However, if you are a technical writer now, you might as well get a promotion one day to become a manager, so this material could be of interest to you, too. Or, this…

Technical writing is a complex process that requires proper orchestration. We can see how it is evolving with time, too. Technical writing is now more integrated into user experience than ever before. The thing about integration – you can’t do this on a micro level, you need the bigger picture. We mean, you could, but…