Technical Writing Blog

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…

We’ve been working hard over the past months to bring a new ClickHelp version to the documentation teams using ClickHelp. We have made conditional output more straightforward, improved the WYSIWYG editor a lot to make it easier to use, made the branding functionality more powerful with a ready CSS example to use, and much more….

This article continues our post series on creating responsive online documentation. In the previous parts of this series, we have learned about mobile emulators and typical issues related to screen sizes. Now, it is time for some practice. We suppose that you have already identified issues in your content and in this post we will…

ClickHelp Free – a no-cost plan of our online documentation tool! With this plan, you can put some of your user manuals online today, at no charge. Start getting noticed on the web with your documentation, it is easy!

This article continues our post series on creating responsive online documentation. The first part considered free screen and mobile emulation tools – a “must read” for technical writers who care about mobile look of their content. Then we talked about automatically detecting mobile-specific issues in online documentation. It is time to get to solving mobile…

Last time, we talked about screen emulation tools to help you test your web content on different devices. In this post, we will make the next step and take a look at the tools helping you detect any UI issues specific to mobile device browsers. Note: Although we consider responsive markup in the context of…

It’s not a secret for anyone that mobile Internet can be quite slow. The page loading speed is very important for mobile-oriented pages. And it’s not a secret either that Google is using the site speed as a SEO factor. Also, it is well-known that people tend to leave a web site if it does…

Creating documentation for online publishing can be tricky not only for novice technical writers, but also for those focused on printable outputs. There are important conceptual differences between HTML and PDF (or other printable formats). One of the most obvious challenges is

Have you ever thought of what your online documentation looks like when viewed on a 1920×1080 monitor or opened from an iPhone? Well, today you definitely should. It is not a secret for anyone that mobile browsers usage grows rapidly and having a mobile website becomes a must for every online business. But did you…

Many online documentation formats are related to HTML in one way or another. At that, many online documentation topics are using the same visual layout – a header container with information and quick links; and the topic body in a scrollable container. Looks simple and typical. But have you ever tried to implement this layout…