Technical Writing Blog

Technical writers can help with many business-related things to make a company successful. For one, they create internal documentation, like process documentation, that keeps everything together. They can write whitepapers, memos, develop educational materials, etc. Today we are going to talk about yet another type of technical documentation – a request for proposal. Any company…

There’s always something to improve in any given help writing process. This post will help you learn how to improve software manuals creation. Software documentation is similar to many other help writing projects, but it has its unique features. Take a look at the following tips to step up your game. 1. Pay Closer Attention…

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

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…

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…

Would you like to start your own tech writing agency? This is a big decision and a lot of thinking needs to happen. Understandably, this is not a solution for everyone and this is completely fine. However, if you are entertaining the possibility, this post can be useful for you – we are going to…

Technical documentation is viewed as something handy and nobody would ever doubt that it is necessary to have one. On the other hand, technical writers are faced with the reality of people underestimating what they are doing. We’ve painted a dreadful picture of a post-apocalyptic world where tech writers don’t exist anymore. But, sometimes, it…