by Ann Green, Content Manager at ClickHelp.com — professional technical writing tool

If you write API documentation and need to learn some examples, here, I gather some great ones.

GitHub API Documentation

GitHub developer helps you build your app on GitHub’s platform. Not sure where to start? They’ve put together some handy guides and reference documentation you can use to start building.

Github’s docs are minimalistic, the team isn’t trying to put too much information on one page. They provide a simple menu at the top-right with links to reference material, guides, and libraries, and then it’s down to well-ordered articles. …


by Ann Green, Content Manager at ClickHelp.com — professional technical writing tool

If you need to learn something new or ask a piece of advice, the best way to do it is to ask other professionals. Slack is the right platform for this purpose. Here, I gathered some channels on technical writing, design, journalism, and the like.

Their Slack network has lots of people hanging out and chatting about documentation. It’s the best way to connect with the community and to stay in touch with folks you’ve met at their conferences and meetups.

Everyone who joins the Slack will be…


by Ann Green, Content Manager at ClickHelp.com — professional technical writing tool

Like any other document, the design of your knowledge base is incredibly important. Customers want answers to their questions quickly, and your task is not only to write clear content for your knowledge base but also to design it thoroughly. Here, I gathered some tips on knowledge base design.

  • Think over the place. The content of knowledge base should be in one place. If the types of content are different, think over the structure but topics should not be in the different parts of your website. …


by Ann Green, Content Manager at ClickHelp.com — professional technical writing tool

A multi-version manual is created for different versions of your software. The main specific of a multi-version manual is that you don’t update the previous version of your manual but you create a new one. In this post, I want to tell you about how you can create a multi-version manual and what features your HAT should provide, so you can create it easily.

How to Create Multi-version Documentation

In this section, I use ClickHelp as an example for creating a multi-version manual. So, here is how it works in ClickHelp:

  • For example…


by Ann Green, Content Manager at ClickHelp.com — professional technical writing tool

There are not many free technical writing ebooks on the Internet that cover a wide range of questions. Nowadays, technical writing is a complex phenomenon, it implies not only writing itself but also SEO optimization, using different metrics to improve the content, mobile optimization and much more.

Here, I gathered some fee ebooks on different technical writing tips that are not only about writing.


by Ann Green, Content Manager at ClickHelp.com — professional technical writing tool

Season of Docs brings technical writers and open source projects together for a few months to work on open source documentation. 2019 was the first year of Season of Docs, bringing together open source organizations and technical writers to create 44 successful documentation projects!

So, Google Open Source has announced the 2020 edition of Season of Docs!

Docs are key to open source success

Survey after survey show the importance of good documentation in how developers choose and use open source:

  • 72% of surveyed developers say “Established policies and documentation” is a key decision factor…


by Ann Green, Content Manager at ClickHelp.com — professional technical writing tool

Because of quarantine, we have to build a new skill…work at home. Read these tips to make this process faster.

Figure out your routine

The majority of us are not used to working at home. We all have our daily office routine, and the quarantine period when we should work at home can be challenging. That’s why it’s essential to find your routine to work productively.

Instituting a morning “heading-to-work” routine will help you gear up for the day. Even if your desk is only a few feet away from your bed…


by Ann Green, Content Manager at ClickHelp.com — professional technical writing tool

Web designer creates interactive websites from old books. Just have a look at the examples!

Ann Green

Content Manager at ClickHelp. In my blog, I write about technical writing.

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store