Chapter 10 Other helpful features

Learning Objectives. This chapter will demonstrate how to: Add other helpful features that help usability of a tool. Determine which of these features are most useful for your particular context.

10.1 The goal of these “other features”

There are some features that can increase the usability of your tool, but would probably not work well as standalone documentation. The extent to which these other kinds of documentation are applicable to your software tool, is dependent on your own context and resources.

In this chapter, we will discuss these other features and when you might want to consider adding them to your set of documentation.

10.2 FAQs

As your user base grows and you start to get recurring questions, you may want to try to head off future users asking the same questions by incorporating clarifications into your documentation. Ideally you would make sure the most frequently asked questions would be addressed in the getting started section or perhaps your how-to examples.

But, there may be other recurring questions that you don’t have a logical place to describe the answer to, but would be helpful for users to know about. In this instance, a FAQ page may be what you need.

FAQ’S can easily get disorganized and out of hand as they grow. Try to keep similar questions underneath larger headings.

More reading on FAQ pages:

10.3 Cheatsheets

If your tool has a lot of items that are handy but tough to keep track of a cheatsheet may be especially helpful for your users.
Cheatsheets are like reference guides but shorter (one or two pages) and more aesthetically pleasing. Users like cheatsheets for handy referencing! Ideally your cheatsheet won’t be identical to your reference guide but instead will highlight the most commonly used/most helpful items!

More reading on cheatsheets:

10.4 Videos

Particularly, if your tool has a graphics user interface, sometimes videos can be the best way to demonstrate getting started information. Videos are not scannable so in general, shouldn’t be depended on as the main source of information. Your users may have a quick question they want answered quickly and videos require time to watch. Users may be frustrated if the video didn’t answer their question after watching it, if there is no other form of documentation.

That being said, videos are very helpful for GUI’s in particular or for introducing basic concepts. And the majority of users who like visuals will appreciate that aspect of videos.

More reading on making videos:

10.5 Forums/Knowledge Base

Forums and knowledge bases can be a handy way to keep public records of questions and answers and reduce the number of times your team has to respond to a repeated question. Forums are mostly useful if your tool grows a big user base (hooray!) and your team has trouble keeping up with inquiries. Advanced users may also be able to help answer questions of newer users which further frees up your team for other issues. Making this knowledge base be searchable can reduce the support load of your team.

If you don’t have the resources to host your own forum, a Slack channel could serve similar purposes or you can look into the options discussed in these articles:

More reading on knowledge bases and forums:

10.6 Exercise: Determine which (if any) of these features would work well for your tool

Now that we’ve discussed some of other features that are helpful for your users, think about which of these might be helpful for your own tool, keeping mind your current documentation set up, user base, and general format. The answer might be multiple or none of these features – only you and your team can answer this!


Afgan, Enis, Dannon Baker, Bérénice Batut, Marius van den Beek, Dave Bouvier, Martin Čech, John Chilton, et al. 2018. “The Galaxy Platform for Accessible, Reproducible and Collaborative Biomedical Analyses: 2018 Update.” Nucleic Acids Research 46 (W1): W537–44. https://doi.org/10.1093/nar/gky379.
Budd, Aidan, Manuel Corpas, Michelle D. Brazas, Jonathan C. Fuller, Jeremy Goecks, Nicola J. Mulder, Magali Michaut, B. F. Francis Ouellette, Aleksandra Pawlik, and Niklas Blomberg. 2015. “A Quick Guide for Building a Successful Bioinformatics Community.” Edited by Amarda Shehu. PLOS Computational Biology 11 (2): e1003972. https://doi.org/10.1371/journal.pcbi.1003972.
Herothemes. 2020. “8 Best Knowledge Base Software Compared (Pros & Cons).” https://herothemes.com/blog/best-knowledge-base-software/.
Moon, Garrett. 2011. “10 Tips for Creating a Killer FAQ Page.” https://www.socialmediatoday.com/content/10-tips-creating-killer-faq-page.
Rehan, Adnan. 2019. “Build Online Community and Forum with These 8 Best Software.” https://geekflare.com/online-community-software/.
RStudio Team. 2020. RStudio: Integrated Development Environment for r. Boston, MA: RStudio, PBC. http://www.rstudio.com/.
Simon, Justin. 2020. “The Ultimate Guide to Easily Make Instructional Videos.” https://www.techsmith.com/blog/instructional-videos/.
Trounce, David. 2019. “7 Great Tools for Creating Your Own Video Tutorials.” https://helpdeskgeek.com/free-tools-review/7-great-tools-for-creating-your-own-video-tutorials/.
Wilson, Lee. 2020. “25 of the Best Examples of Effective FAQ Pages.” https://www.searchenginejournal.com/best-faq-page-examples/267709/.