Home - Pronovix/WalkHub GitHub Wiki

Welcome to the WalkHub wiki! Feel free to add features or to extend the discussion. If you would like to become a contributor to the wiki, get in touch.

About the project

WalkHub creates a framework for integrated tutorials that guide users through an interface, one step at a time. Just like a GPS in a car enables you to reach your destination without first having to learn the road you want to take, Walkthroughs give people just enough information at just the right time so that they can successfully complete tasks faster with much less effort.

The Walkthrough technology uses the Selenium testing format, an open standard widely used for regression testing in browser-based software projects. WalkHub itself is built on top of Drupal, an open source content management system (CMS) that has already achieved considerable traction in the enterprise world. For the actual player, we currently use Joyride.JS, an open source JavaScript library that already allows developers to create stepped contextual help (UX tours). These three components together with the features we’ve developed to integrate them and enable collaboration form an open source product that could be integrated into any organization’s documentation system.

You can use WalkHub through a proxy on the walkhub.net site, or install your own WalkHub components:

  • WalkHub distribution: Install the WalkHub distribution to create your own WalkHub.
  • WalkHub client: Install the WalkHub client to play walkthroughs on your site without using the proxy feature.
  • WalkHub JS: Use the WalkHub JavaScript on your non-Drupal site.

User guide

Style guide

In contrast with most other stepped contextual help solutions, by default steps in Walkthroughs don’t have a title. The text field for content entry is kept small on purpose to encourage writers to add instructions only relevant to a specific step.

  • Writers should give each step a description that is a maximum of two short sentences (and ideally just one).
  • Each step should only address one concept or the one thing that the user can do at that point.
  • A step must only reference the exact item it's pointing to (no mention of other items on the page, other pages, and so on).
  • Technical terms and jargon should be avoided unless it is fundamental to understanding the step.
  • A step should not contain anything that doesn't help the reader understand the object that the step is pointing to (no titles for instance).

Marketing materials

A set of materials you can use to promote WalkHub. This is where we will be collaborating on the materials for our Free Open Walkthrough Franchise, read my blogpost for an introduction to this concept. The purpose of this project is to create a shared evangelist toolkit that we can use to promote the project. By all means, use it to sell consulting services built on top of the project.

##Find out more