By Jim R Tyson, on 8 February 2018
For a while now, I have been quietly promoting StepShot Manuals (StepShot for short) to my colleagues in ISD. StepShot is a rapid documentation development tool. Which is not nearly as bad as it sounds. StepShot allows you to record an on-screen process – for example, formatting a table in Word or filling out an expenses form – taking screenshots, adding callouts and annotations and writing explanations as you go.
Some key uses for StepShot include
- rapid development of training materials and technical documentation
- developing test scripts for UAT
- recording test results or bugs
- creating knowledgebase articles
- recording process for business analysis and process review
If you have ever done these jobs, then you might have combined several tools, for example
a screenshot tool (Windows has one built in), Word, an image editor (Paint or Photoshop), with a workflow like this: take all your screenshots, insert them into word editing, cropping etc as you go, adding explanatory text.
Stepshot brings all this together in one tool. You set it up to record the activity and select to create a screenshot for mouse clicks or keyboard actions or to use a specific hot key combination for screenshots. As you go through the activity recording images you can also give each a descriptive title and a comment. When you stop recording StepShot opens its editing tool. This latter looks a bit like PowerPoint: your images are listed vertically down the left while the main window allows you to edit an image and add text.
Click to see the animation!
This is already a vast improvement on hacking documents together with separate applications, none of them specifically designed for the job, but wait there’s more! StepShot can export your document when you have finished, as Word, PDF, HTML, XML or DITA and can publish directly to Confluence, SharePoint or WordPress. (If they add a PowerPoint option I’ll throw a party). There are simple built in templates for output and with a little effort you can create a customised or branded template.
So, currently about a dozen people at UCL have taken up a license (UCL staff members can contact ISD Training Administration for licensing information. To use StepShot you do need admin rights on your Windows or Mac PC.). It has been used to create training materials for lecturecast (published on Confluence), it has been used in UAT creating test scripts, it has been used by software testers to record bugs and communicate them to developers. No one currently using it has had more than a two minute informal introduction to the product but people seem to pick up its basic use very quickly. Users report that they enjoy using it as well. The most commone response using it for the first time has been about the immense time savings you can achieve and next about the simplicity of use. One or two people have commented that they don’t really like the look of the output, but this is largely because they haven’t learned how to customise output. I have offered a short workshop on customisation and hope to run it again.
I have created a Microsoft Team site and I will be keeping in touch with people using it since I have been asked to feedback our experience to the developers.