ClickHelp Technical Writing Blog

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

Category Archives: Education

Single Sign-On for Dummies

Single Sign-On for Dummies

Single sign-on is a buzzword, and it has been in the computer-based industries for a while now. But, what is the exact mechanism behind single sign-on? Why do we trust it so much? There are a lot of questions around Continue reading »

How to Organize Your Workplace

How to Organize Your Workplace

Take a look at your workspace. What are your thoughts? Do you feel encouraged and full of productive energy to create superb technical documentation when you are looking at it? If the answer is ‘yes’, then this article is probably Continue reading »

How to Write Technical Style Guides

How to Write Technical Style Guides

We all can agree that content should be the primary focus of a technical writer. But, we also can’t just leave out other aspects of creating technical documentation. This is why we would like to focus on styling and formatting Continue reading »

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 »

×

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