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.
> Kevin wrote:
>>
>> Our documentation group decided to liven up our
>> Friday by having a minor word choice dispute.
>>
>> We have a series of procedures and each procedure is
>> numbered. We are divided as to whether we should have
>> the headings be Step 1, Step 2, Step 3... or
>> Task 1, Task 2, Task 3....
>>
Our mainframe software installation manuals were about 50 pages long
and very complicated. I broke each of the separate items into
action-oriented tasks, with each task consisting of several steps to
complete the procedure defined in the task. For example,
Task 1. Unload the Install Tape
Step 1. Modify the XXXX job, substituting your site name for
XYZ in the variables shown in italics.
Step 2. Submit the XXXX job, blah blah blah.
etc...
Using this method really helps the support folks when a customer
calls, because it's pretty easy to figure out *exactly* where they
were in the installation process when something blew up/went wrong.
kat
-----------------------------------------------------------------
Kathleen Nosbisch Recently laid off & temporarily contracting
bjg2 -at- nexagen -dot- com Looking for full-time job in Colorado!
-----------------------------------------------------------------
