Back
to top

    Technical Writing Blog

    Grow your technical writing expertise with industry news, best practices, articles, product updates

    Learning technical writing: adaptation and evolution

    Learning technical writing: adaptation and evolution

    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…

    Continue reading »
    Posted in Technical Writing on 8/16/2015

    June 2015 Update – MS Word & HTML Import, Version History

    June 2015 Update – MS Word & HTML Import, Version History

    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…

    Continue reading »
    Posted in ClickHelp News on 6/28/2015

    March 2015 Update – Web Help, Domain Mapping, REST API

    March 2015 Update – Web Help, Domain Mapping, REST API

    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…

    Continue reading »
    Posted in ClickHelp News on 4/10/2015

    SlideShare Presentations in User Manuals

    SlideShare Presentations in User Manuals

    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…

    Continue reading »
    Posted in Documentation UX on 2/25/2015

    January 2015 Update – CHM Export, Permissions, Search and more

    January 2015 Update – CHM Export, Permissions, Search and more

    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…

    Continue reading »
    Posted in ClickHelp News on 1/21/2015

    Guest Blog: Why a Manual?

    Guest Blog: Why a Manual?

    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…

    Continue reading »
    Posted in Technical Writing on 1/6/2015

    October 2014 Update – Ready design, smart links and more

    October 2014 Update – Ready design, smart links and more

    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….

    Continue reading »
    Posted in ClickHelp News on 10/20/2014

    Responsive HTML Tutorial. Part 4 – Responsive Styles

    Responsive HTML Tutorial. Part 4 – Responsive Styles

    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…

    Continue reading »
    Posted in HTML & CSS tips on 8/15/2014

    Free Documentation Tool for Small Teams

    Free Documentation Tool for Small Teams

    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!

    Continue reading »
    Posted in ClickHelp Features on 7/22/2014

    Responsive HTML Tutorial. Part 3 – Problems and Solutions

    Responsive HTML Tutorial. Part 3 – Problems and Solutions

    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…

    Continue reading »
    Posted in HTML & CSS tips on 6/4/2014