How to Create FAQ and Knowledge Base in ClickHelp

Creating FAQs in ClickHelp

  • You can create your FAQ as one topic or dedicate a whole project to this. The choice is yours, but please, don’t make help topic titles to be too long if you create a whole project for FAQ. Also think about how easy it would be for readers to find the FAQ section depending on the choice. In ClickHelp, if you have a separate project, it will be automatically placed right on the main documentation portal page when, surely, all readers will see it.
  • Another point to think through is the overall style of communication through FAQ. When you get this figured out, add notes to your style guide for technical writers to ensure that even FAQ items written by different people will look and feel the same. Agree upon things like average length, term usage, how detailed answers are supposed to be, etc.
  • Use anchors and titles for questions. This way you can quickly share a link to a specific section.
  • ClickHelp has a couple of useful features to make your FAQ section look better: Show More and Dropdown Text. Using these helps a lot when either the answers or the whole page are too long. You can quickly hide some of the text to make your FAQ more readable.
  • In ClickHelp, you can publish topics one by one as soon as they are ready. That works great for FAQ. Namely, in the scenario where an FAQ section is part of a bigger project, each new help topic you add can go into production immediately.

Building Knowledge Base in ClickHelp

  • Figure out your audience first as your further steps will be different depending on this. If you are creating an internal KB, then the Restricted Access options are the first to look at in ClickHelp. Be mindful of the fact that the Restricted Access options can be set up differently for different publications. If you have multiple audiences, ClickHelp allows sharing and reusing a lot of content between them with Variables, Content Snippets, etc.
  • Decide whether you want the knowledge base to be structured or just be a set of help topics with search as the main navigation tool. In ClickHelp, there’s the possibility of hiding the TOC via CSS branding settings.
  • To make working with a knowledge base more efficient, in ClickHelp you can change help topic statuses and take advantage of the Reviewer Role.

Conclusion

--

--

--

ClickHelp - Professional Online Technical Writing Tool. Check it out: https://clickhelp.com/online-documentation-tool/

Love podcasts or audiobooks? Learn on the go with our new app.

Recommended from Medium

Why is Your User Manual Bad?

The Case for CloseKnit

CloseKnit Neighbourhood.

Project Update: Modular Objects & Prefabs

Ultimate Checklist For Ecommerce App Development

User Interface Exploration

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
ClickHelp

ClickHelp

ClickHelp - Professional Online Technical Writing Tool. Check it out: https://clickhelp.com/online-documentation-tool/

More from Medium

Screwed Up By Samsung

Mobile Apps & Various Technologies Transforming The Education System

Mobile App Development

How to Use Slack for Project Management

Shopify Product Scraper