A reader asks,
I caught your blog online and have been enjoying reading through the posts. I was wondering if you came across any information regarding creating usable online help for touch-screen applications. I found one article that talked about using RoboHelp to create drop-down hotspots and context-sensivitity to lessen the need for the standard clickable TOC navigation (since on a touch screen, you wouldn't have the benefit of a keyboard and mouse). What we have right now can be improved. We have a hyperlinked TOC that is just too small for anyone to click on. We have Frame and will be getting RoboHelp. We want to be able to leverage the same source file to create the online help and a printed guide.
Just wondered if you've encountered or heard about anyone writing for touch-screen apps.
You might look at how the iPhone delivers help. RoboHelp won't give you anything special that other online help authoring tools don't already deliver. If you're planning to use a lot of drop-down hotspots, RoboHelp's only advantage is that it allows you to embed Captivate movies inside hotspots. However, RoboHelp's hotspots lack twisties (little triangles that twist down when clicked), so they're not as user friendly. Still, RoboHelp is a fine application for delivering online help.
If you're hoping to single source a printed manual and online help, you need a different tool (unless you're good with Word macros). Madcap Flare does a much better job than RoboHelp. AuthorIt also does well.
But single sourcing seems a tangent from your initial question about touch-screen help. For touch-screen help, I recommend keeping the topics short, because I imagine the user is frequently standing or mobile. I also recommend supplying both a printed manual and quick reference guide, since the touch-screen interface may be too small to accommodate long text or graphics in a comfortable way.
If you do include help in the application, yes, make sure it's context sensitive, because the user probably can't open a help window and resize it next to the application interface. An online help file does offer searchability on the fly, but if the user can't type on a keyboard, there's little point in that, so make sure your printed manual has a good index.
Finally, all the touch-screen devices I've ever used have been small, so the help content may not single source anyway. For example, if you're writing instructions for a touch-screen panel that controls a projector, the application's help may be brief, such as 3-4 sentences only. But the printed manual may elaborate with more detail, including screenshots, diagrams, and longer explanations. If that's the case (that the online help and manual don't single source), then your RoboHelp/Frame solution will work fine.
Get new posts delivered straight to your inbox.
I'm a technical writer based in the California San Francisco Bay area. Topics I write about on this blog include technical writing, authoring and publishing tools, API documentation, tech comm trends, visual communication, technical writing career advice, information architecture and findability, developer documentation, and more. If you're a professional or aspiring technical writer, be sure to subscribe to email updates using the form above. You can learn more about me here.