ClickHelp Technical Writing Blog

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 Continue reading »

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 Continue reading »

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 Continue reading »

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 Continue reading »

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 Continue reading »

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 Continue reading »

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 Continue reading »

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 Continue reading »

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 Continue reading »

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 Continue reading »