Technical Writing Blog

Implementing password-protected user guides is something that any company may need. You may ask why someone would need to hide their online user documentation behind a login page? The answer is simple. Documentation can be different. Let’s say we talk about a coffee machine manual – it has to be public. The more users have…

One of the most common things users say about technical documentation is that it describes the information they already know. This fact reduces the value of the content to the minimum. Now, when thousands of software products and cloud services appear every day, some things and features seem to be common and widely spread. There…

Being a technical writer means getting writing tasks from other departments, not only your manager. It’s not like you don’t have enough on your plate already, but since you are really good at creating documentation, helping other teams out seems only natural. So, cross-team communication is an important part of this role. What’s more interesting…

Robots are often described as some kind of intruders in fiction books, movies, and games. They are soulless creatures that were invented by humans with the best intentions in mind, but it rarely ends well. If there’s no apocalypse, then there’s the robots-taking-our-jobs idea. And, quite frankly, it is not too far from the truth….

This is the era of SaaS. The idea of software has changed a lot for the past I’d say ten years. Sure, we still install software on our PC’s and laptops, but we tend to use services much more: Google Mail, Twitter, Facebook, YouTube – we all enjoy them every day. This means that technical…

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…