Technical Writing Blog

Cybersecurity was a hot topic for many movies in the 1990s. Hackers were always lurking on the Internet to steal the top secrets. Although it was displayed incorrectly, for the most part, the danger was really there. Before the Internet became our closest companion, following us wherever we go, security felt simpler – just turn…

Giving names to images/sections/help topics is something tech writers do a lot. To find just the right name is important – this is what defines an object. Understandably, certain guidelines exist for the file naming process. When you work on many projects, you will have to come up with a kind of style guide for…

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…

Technical writers are the people behind orchestrating a flawless user experience alongside other teams. Where will a user go if they have questions? They could go to Support, of course, but technical documentation is step one. Users will most likely Google their query and naturally end up on your online documentation page. This sounds like…

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

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…