ClickHelp Technical Writing Blog

Giving names to images/sections/help topics is something tech writers do a lot. To find just the right name is important - this is what defines an object. Understandably, certain guidelines exist for the file naming process. When you work on Continue reading »

Technical writers can help with many business-related things to make a company successful. For one, they create internal documentation, like process documentation, that keeps everything together. They can write whitepapers, memos, develop educational materials, etc. Today we are going to Continue reading »

Technical writers are the people behind orchestrating a flawless user experience alongside other teams. Where will a user go if they have questions? They could go to Support, of course, but technical documentation is step one. Users will most likely Continue reading »

There’s always something to improve in any given help writing process. This post will help you learn how to improve software manuals creation. Software documentation is similar to many other help writing projects, but it has its unique features. Take Continue reading »

How can one make sure that their project, a software project, for instance, is going to be a success? No one will give you a recipe that works 100% of the time, but there are ways to increase the chances Continue reading »

If you are reading this, there’s a high chance you are a technical writer experiencing signs of burnout and willing to do something about it. Let’s first define what burnout is by singling out some of the red flags you Continue reading »

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 »