TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
I'm hoping that some of you can advise me on an idea I just
had:
I write the documentation for a software package. The package
is not that complex to computer users, but to novice users, it
can be a little daunting. We have our manual, which describes
each procedure in text, followed by a numbered step-by-step
instruction set.
My question: have any of you created a smaller quick-fix
tip-sheet, or whatever you want to call it, that just lists the
steps needed to perform each task? Sort of like a cheat-sheet
manual.
For example:
To add a new device to our application, you can
-add the new device
-edit the device's info
-delete the device from the system
-query the device
The manual has full explanations of how to do all these steps,
but I'm wondering if it would be beneficial to have a separate
booklet listing just the basics of adding, editing, and deleting
devices from our system.
This would be applied to about 20 different "things or concepts"
in our app. The booklet could have one page devoted to each
thing, in this case, one page would be devoted to Devices.
