Technical Writing Blog

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…

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…

We have awesome news! A new ClickHelp release is here! This blog post will take you on a journey to get to know ClickHelp Gecko better – I am sure you are going to love it. We know we are good at finding the right balance between implementing the features our clients would like to…

ClickHelp is a tool for technical writers that offers enormous possibilities. We would like for each user to be able to use our software to its full potential. To help with that, I’ve come up with a list of mistakes to avoid when using ClickHelp. This list is perfect for our new clients, but even…

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…