ClickHelp Technical Writing Blog

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 »

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

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

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

There are strong reasons for having a documentation plan. The main one being - setting up a clear and open help authoring process. Creating a documentation plan means giving every team member an exhaustive reference point. The whole team will Continue reading »

According to a poll we set up among the techcomm people, successful update of user manuals is among the most troublesome areas of help authoring. What you need to understand is that building reliable and clear processes for documentation maintenance Continue reading »

Technical writing is mostly associated with user manuals, software documentation, and the like. However, technical writing is an essential part of every industry now. That’s why, in this blog post, we want to describe some unexpected documentation examples that will Continue reading »