ClickHelp Technical Writing Blog

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 »

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 »

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

All technical writers are famous for being meticulous about grammar, style, and punctuation. Reviewers and editors are even more scrupulous. If we count the time wasted on checking grammar in user guides, it will probably drive us to the conclusion Continue reading »

Sometimes, you need to become a technical writing pioneer. This often happens at startups or, perhaps, your company decided to terminate contracts with outsourcing help authoring companies and wants to start its own thing going. Being the first technical writer Continue reading »

Technical documentation teams can have different approaches to doing many things. A lot of the stuff can be altered in help authoring, leaving that to personal preference, but when it comes to choosing a place to store user manuals, one Continue reading »