Technical Writing Blog
1.42K subscribers
568 photos
1 file
566 links
ClickHelp β€” online documentation tool for technical writers and teams. Create, translate, and publish documentation easily in one portal!

Get your FREE trial πŸ‘‰ https://goo.gl/NahsT2
Download Telegram
When you add maps, graphs, charts, infographics, dashboards, etc. to text, you are doing a big favor to readers and yourself. Using visualization techniques as a complementary tool to explain written text brings a lot of value. Your user manuals become more readable.

Further on, we are going to give you tips on how to efficiently implement data visualization in technical docs πŸ–

https://bit.ly/3a1iEjs
Technical documentation is very complicated as it is. Don't let your readers get lost in it! Give them a helping hand - navigation. Ideally, readers don't need to be conscious of navigation elements they use. Moving between help topics should feel intuitive and seamless.

This can be achieved if you have the right toolset at hand and know how to apply different navigation elements right. In this post, we will go through all basic navigation elements to give you a full picture of the possible means to direct readers.

https://bit.ly/2I4GnTS
There are certain issues that are very common for technical documentation teams all over the world. We will not only name them in this blog post but will also provide comprehensive solutions. Let's begin πŸ‘‡

https://is.gd/ywSFzr
And what do you think what the main problem of documentation is?
Anonymous Poll
30%
You Don't Have a User Manual
34%
Documentation is Outdated
51%
Nobody Reads it
According to a poll we set up, technical writers' biggest concern is that people don't read documentation. Imagine how frustrating this is - all the work you put in just to learn it was pointless. This sounds demotivating.
Let's try to understand what is stopping people from reading the manuals and how the industry needs to change to attract readers.
https://is.gd/c1mtMS
One of various things technical writers can do is compose questionnaires and write interview questions. Users are the perfect candidates for being interviewed! Goals of these interviews can vary, we will talk about that in a moment. For now, we would like to point out that users can be your best advocates and they have a lot of valuable data to share.

Let's see what steps you should take to create superb user interviews.

https://bit.ly/3aOrIZz
You can create a truly awesome user manual. Hundreds of topics that describe every product feature thoroughly. Navigation elements that are conveniently located throughout the documentation. Your readability score is high. You’ve configured styles and scripts in your online documentation portal according to your needs.

It’s been going great, except... How are you going to update and maintain all this? We have an answer. Global Find and Replace!

Learn more here: https://bit.ly/2QfAJTA
We hear the term "topic-based authoring" quite a lot. ClickHelp is software for help writers that supports the topic-based approach. But how did it come to be? What makes topic-based authoring superior in modern techcomm? And, finally, how is it different from modular help writing?

Let's try figuring this out.

https://bit.ly/2wfsAYf
Don’t be cruel to your user manuals. Treat them well and your efforts will pay off. Happy customers will be the currency!

https://bit.ly/2UllR7e
If you think of it, dozens or even hundreds of criteria can be used to determine the quality of technical documentation. This blog is actually more than us listing some criteria, this is an exhaustive guide you can follow to find areas of improvement.

https://bit.ly/2UiWMeB