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.
Subject:RE: Help on Procedure Writing From:Tom Murrell <trmurrell -at- yahoo -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 5 Dec 2001 09:58:21 -0800 (PST)
--- John Fleming <johntwrl -at- hotmail -dot- com> wrote (in part):
>
> As a personal observation of procedure writing, when writing a procedure,
> make sure you include all the relevant information needed by a person to
> complete the task. You will need to emphaisize the what rather than the
> why.
John's advice is really good. To which I would add one other small, little
thing. Don't accept a procedure from someone else and simply put it in your
document. TEST IT. In my experience, the biggest problem with procedures is
that no one ever actually tried to do it.
Do the procedure, and you'll find out what's missing that a user will need.
__________________________________________________
Do You Yahoo!?
Buy the perfect holiday gifts at Yahoo! Shopping. http://shopping.yahoo.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/techwr
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.