Technical Writing Blog

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…

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 that this is one of the most important parts of the process. Wait, what?… Did…

Let’s talk about versioning user manuals today. This concept has far more use cases than one might think. We will name some of the most popular ones and talk about the means ClickHelp, a cloud solution for help writing, offers to solve this! ClickHelp is based around the idea of reusing content and creating multiple…

The Threat While the entire world is moving in the direction of secure Internet connections and using HTTPS for almost all web sites, people may become less cautious believing that they are secured. This introduces attackers with easier ways to steal private information or take over users’ machines control. Mixed content web sites are looking…

Do you enjoy reading as much as I do? The best part about books is that you can find one for any cause. Our today’s cause is technical writing. And, there are a lot of great books directly about tech writing, or there are the ones that can provide you with knowledge in other spheres…

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 in a company has a lot of challenges. But don’t fret – as long as…

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 needs to be really careful. Today, we will talk about using a CMS for delivering…