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.
When you are instructing in a user guide filled with multi-step
procedures, what are the prefered methods for formating a one step
process?
For example, to perform one task with this product all one needs to do
is press Q on the keyboard.
Co-workers protest my using the normal procedure paragraph formatting.
They don't like a procedure consisting of one step only. One co-worker
suggests standard body text like this:
To blah-blah-blah, press Q on the keyboard.
So, it's a one line paragraph usually flanked by longer paragraphs.
The usual dingbat that visually clues you a procedure follows is
missing. The step gets lost.
What's the happy medium here? Is a one step procedure "legal"? I don't
want to use a bullet.
Help!
Please send responses to kellyk -at- cyberoptics -dot- com
