One of the issues we’ve been promoting for many years is the importance for Technical Authors to publish their user guides and online Help on the Web. A surprisingly large amount of companies still don’t offer Web versions, for reasons that include:
It’s too difficult
Our competitors might read it and reverse-engineer our product
Support/Training/Marketing will object
The problem with this approach is that others are likely step in and fulfil this need. One such person is Kyle Wiens, CEO of ifixit.com, who I saw present at the STC Summit 2012 conference last week.
Kyle has built a multi-million dollar business on the back of offering repair manuals that manufacturers choose not to put on the Web. The manuals are available free-of-charge, with ifixit.com making money from selling spare parts.
Wiens said that if machines in other industries — for example, tractors used by farmers — were to break down over a handful of years and couldn’t be easily repaired, consumers would openly revolt. “In industries where consumers really care about a quality, long-lasting product, there’s no way companies can get away with it,” he said. more
We’ve suggested in the past that organisations publish Help for their competitors’ products, so they can engage with their future customers.
Publishing to the Web provides a path to publishing to mobile devices and tablets. It also means, finally, Technical Author can measure the value of what they produce – how many people want to read it and what they think of it.
Regardless of the objections from other departments, this is probably the single most important thing a Technical Author can do.
Workflowy is a one-list-to-rule-them-all organization tool that takes an unusual approach to providing User Assistance.
Like with many other Web applications, the site contains a “how-to” video and a list of keyboard shortcuts. However, it also sends users an email that’s essentially the information you’d expect to find in a user guide or online Help file:
Hi there, new WorkFlowy user!
Mike and Jesse, creators of WorkFlowy, here. WorkFlowy is a super-powerful tool that’s going to clear your mind, hone your focus, increase your productivity, and bring peace to the Middle East. (We’ll get back to you on the last one.)
What should you be using WorkFlowy for? WorkFlowy is a single sheet of paper to hold your whole brain. The idea: put EVERYTHING you want to keep track of into it. Notes about your trip to Tahiti, stuff you need to get done in the next week, a list of your favorite Transylvanian romance novels, your Ph.D. thesis outline – they’re all fair game.
If you haven’t already, might we suggest you get started? Do it right now, before you forget.
Create top-level items called ‘Personal’ and ‘Work’.
Click the bullet point next to ‘Personal’ to zoom in.
Create a ‘Chores’ item. List under it everything you need to do in the next week.
Create a ‘Goals’ item. List under it everything you want to get done in the next month and year.
Zoom out and start on the ‘Work’ section.
This should be enough to get you started. WorkFlowy is free-form and you can use it however you like.
We’ll be getting back to you with more info on WorkFlowy’s features.
Does this approach work? It’s too early for us to tell. If you need to dip in and out of the Help, then you’ll need to store the emails somewhere and work out the best way to search the emails for the information you need. It depends really on the amount of Help that’s needed/provided for an application such as this.
This interview will form part of Cherryleaf’s Learning Zone for technical writers. The Learning Zone has been our “skunkworks” project for 2010, which we’ve been mentioning for a while now. All the initial content has been uploaded and reviewed, and we have additional content ready to be added. We’ve a few things to sort out before we can go live: User feedback/pre-release review (we’re looking for volunteers) and some shopping cart and folder security protection tasks.