ClickHelp Technical Writing Blog

Stories for technical writers, web developers and web designers willing to grow

Category Archives: Education

Metrics in Technical Writing (Part 2)

Metrics in Technical Writing (Part 2)

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 »

API Documentation Guidelines

API Documentation Guidelines

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 »

Create a Perfect Help Topic

Create a Perfect Help Topic

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 »

Best Practices for Technical Writers

Best Practices for Technical Writers

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 »

Proofreading Tips for Technical Writers

Proofreading Tips for Technical Writers

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 »

Choosing a Technical Writing Tool

Choosing a Technical Writing Tool

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 »

×

Mind if we email you once a month?

Professionals never stop learning. Join thousands of experts subscribed to our blog to get tips, ideas and stories from us once per month.
Learn more on ClickHelp
×
By using this site, you agree to our Security Policy and Terms of Use.     Learn more