Skip to main content

Documenting Drupal collaboratively with interactive tutorials

CEO, Co-Founder
Feb 05, 2013

A few months ago at a product sprint at our company, Peter Arato showed me his proof of concept for a walkthrough broadcasting module that you could use on your Drupal presentations. It was pretty neat. So I asked Peter to make a prototype for a browser extension that would let you walk through a tutorial, step by step, with some description to explain what each step was about. A few months ago, at a Drupal meet-up, @KristofCoomans suggested that it would be even neater if we could use Selenium to generate the tutorials. That was an awesome idea. So we rebuilt our tool around this concept and this time around we also used Joyride.JS a JS library for site tours, that recently INT3C blogged about on the planet. The result is a tool that makes it really easy to create an interactive web tutorial: -Record a test with Selenium IDE in Firefox -Paste the test code in a walkthrough node on our Drupal site in a new walkthrough node -Add titles and descriptions -Enjoy your tutorial! Our tool is currently built on 3 technologies: -Drupal to store the tutorials, steps and comments and to serve them to the Joyride player -Selenium IDE to record automated tests that will be turned into tutorials, that also gives more options to identify selectors. -A JS library that extends the Joyride.JS plugin so that it can take advantage of Selenium's selectors and that can drive some of the automation we are working on for the auto-play feature. With our tool we believe that we could make it much easier to make, share and collaborate on tutorials; so that it becomes a no-brainer to contribute what we build for ourselves or our customers. Check out the results in our demo movie:

 

 

 

We will only use your email address to send you information about this product. You can unsubscribe anytime by clicking the unsubscribe button in your confirmation email.

Kristof Van Tomme is an open source strategist and architect. He is the CEO and co-founder of Pronovix. He’s got a degree in bioengineering and is a regular speaker at conferences in the API, developer relations, and technical writing communities. He is the host of the Developer Success & the Business of APIs and the API Resilience podcasts.

Newsletter

Articles on devportals, DX and API docs, event recaps, webinars, and more. Sign up to be up to date with the latest trends and best practices.

 

Subscribe