Skip to main content

Module maintainers: get your module documented with Walkthrough.it for free

Senior Technical Writer
Aug 06, 2013

Module maintainers: now is your chance to get your module documented with Walkthrough.it for free! After the community voted Commerce Kickstart from a list of distributions to win the Walkthrough documentation prize, we now would like to collaborate with module maintainers to level up their documentation by using the capabilities of Walkthrough.it. Having walkthroughs for your module documentation has a lot of advantages over the traditional approach, as you can

  • have your own “GPS for your module”, not only showing your users where to go, but taking them there
  • guide your users through complex configuration tasks real-time, without them having to look at a separate document
  • have the best of what traditional and video tutorials offer: an interactive step-by-step tour of different workflows
  • create documentation way faster than writing steps and annotating screenshots
  • decrease the number of items in your issue queue by answering frequently asked questions with easy-to-understand walkthroughs
  • easily update the walkthrough in case you have changed something in your module
  • show your users some best practices
  • automate tasks
  • turn your Selenium tests into walkthroughs
  • enhance user experience by quickly demoing the features of your module

If you team up with us, we will create some walkthroughs for you. All you have to do is send us Selenium tests of your module or a text script of steps to include. If you’re interested, strike up a conversation with our community manager, Kata Nagygyörgy at

You can also find us on Walkhub.net, our community page, on Facebook and Twitter @Walkhub. If you would like to see Walkthrough.it in action, check out our short video about recording walkthroughs:

Diána is a Senior Technical Writer at Pronovix. She is specialized in API documentation, topic-based authoring, and contextual help solutions. She writes, edits and reviews software documentation, website copy, user documents, and publications. She also enjoys working as a Program Monitor for NHK World TV and Arirang TV. She graduated as a programmer, then went on earning system administrator and system analyst and designer degrees. She's fluent in English and German, and worked as a translator for a publishing company translating books from German to Hungarian. She's the Hungarian translator of Basecamp. Before becoming a writer, she worked with international clients like Sony Pictures Television, Da Vinci Learning and The Walt Disney Company as a key account manager in integrated marketing campaigns focusing on digital media.

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