Technical Writing Blog

Receiving feedback is crucial for all companies. This is the best way of finding out what route you should take in your product development, which help topics are poorely written, or what questions remain open after reading a user manual. How do I Get User Feedback? Product documentation is a perfect platform for getting feedback…

‘Getting things done online’ seems to be the main trend in the product documentation field now. And, this is not only a matter of user manuals – all text editing goes online. Millions of people create documents in web applications like Google Docs. Even though it lacks some MS Office functionality, this service has become…

Many software companies who develop Windows desktop applications still ship their software help systems in the CHM format (Windows Help File, HTML Help). In this post, we’ll talk about an alternative format (Web Help) and the transition path. If you look at the CHM format (Microsoft Compiled HTML Help), you will realize that it is…

We are proud to present the latest version of our modern online documentation solution – the October 2015 update of ClickHelp! This release adds a lot of usability improvements. Now you have better content pasting modes for WYSIWYG to handle content coming from MS Word and External web pages; extended YouTube video support and the…

Many of us come into technical writing from different and often unrelated writing fields. I, for one, have a degree in journalism, and for the past ten years I have been writing fiction and poetry, while also working with Web content and development. At first I thought that technical writing would be boring, though possibly…

With this version of our documentation tool, it becomes much easier to track the topic changes using the unlimited version history! You can now import your existing content from HTML, MS Word and OpenOffice preserving the styles and the sections structure. And now ClickHelp supports logging in to your documentation portal through SSO – OpenID…

Did you ever want to develop documentation online and host it on your own server? Or include it in your product as HTML files? This is exactly what ClickHelp is now offering with the Web Help and CHM output formats. Did you ever thought of managing your Power Readers in an automated manner? Yes, this…

Many companies use SlideShare as a stage for their marketing activities and specifically the content marketing. However, people also host technical content there and you can do the same. Of course, you would need to present your content in a form that differs from what technical writers normally use – a presentation. But if you…

The Janaury 2015 release of ClickHelp adds many important functions to our online documentation tool. We believe that our clients will love the new functions that will help them implement even better online documentation easier. Check this post to learn about a few interesting features we introduced in the latest version. CHM Export ClickHelp has…

Do you plan on bringing a product to the market soon? There’s a good chance that this product should be equipped with a manual. Automatically you will face various issues. This blog briefly discusses some of these common questions about manuals. Why a manual? For many products, it is mandatory to include a manual. But…