Technical Writing Blog

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…

The sports industry is rarely named among the top places for tech writers to work. But, actually, there’s a lot of technical communication going on there. Today, let’s take a look at what a technical writer is needed for in the sports industry. User Manuals and Standards for Sports Equipment Technologically speaking, sports equipment can…

Millennials are here. This is how generations work – one minute they are toddlers, the next – your company’s executives. We are talking about practically the whole world and it is hard to believe that people from different cultures and backgrounds could have any resemblance. But with globalization orchestrating our lives there’s not that much…

The ability to work with SMEs efficiently makes a huge difference in technical writing. A lot of things like depth, clarity, and precision of descriptions in user manuals depend on how well you communicate your requests to an SME and how successful you are at interpreting and follow-up questions. Today, we will try to come…

Remember when you had to actually install software on your PC to write technical documentation. That wasn’t entirely terrible, but if you think about it… you had to worry about so many unnecessary things like system requirements, enough free space, security, and many more. Working from home wasn’t such a big thing until recently, but…

Readability is something your readers should not concern themselves about. It is your job, as a technical writer, to make sure that ‘OMG this is so difficult to read’ never crosses their mind. This is not something, however, that can be approached mindlessly and solved just like that. To improve readability, first, you need a…