ClickHelp Technical Writing Blog

Technical writing requires tools for measurement and analysis like any other work process. Although, it is quite difficult to decide what metrics to use considering specifics of this field. We began discussing this topic a while ago and figured out Continue reading »

Punctuation in English is considered by many somewhat optional. But quotation marks are an exception here - you can’t skip them in such cases like a direct quote, for example. Quotation marks usage is often found confusing as British English Continue reading »

An API without a good user manual is next to useless. Developers would like a clear view of an API, code examples, detailed explanation of calls and parameters. And, they are not the only people visiting an API documentation portal Continue reading »

What is a perfect help topic? It is a topic that delivers a solution to its readers in the most efficient manner. Creating such topics means paying attention to their every element and analyzing them. Further, you will find practical Continue reading »

Creating user manuals is a difficult task on its own. Making them good is even more difficult. If while reading these first two sentences you thought to yourself, ‘Well, my technical documentation is quite good, actually’ - you might be Continue reading »

User documentation is the face your company shows to the world. Having quality manuals is just as important as having a great support team. Remember, a lot of issues get deflected without actual involvement of support if documentation is okay Continue reading »

This post has been created in order to help technical writers find useful resources for professional growth. Here you will find resources for both experienced tech writers and those who have just started their professional journey. Top Online Technical Writing Continue reading »

Technical writing and communication involves communicating complex information to specific audiences with clarity and accuracy. The key word here is communication, which is a term for two-side interactions. But in case of technical writing, the addressee side is shrouded in Continue reading »

Almost any product has some kind of documentation to go with it. It might be just a warning or brief usage instructions. And, still, even then, there’s supposed to be a person allocated to write these two lines, and, more Continue reading »

The times when technical writers were using Notepad or MS Word to create user manuals are over. Now, we have a big and dynamic market of technical writing tools. But, the more solutions emerge - the more difficult it is Continue reading »