Re: HOW TOs?

Subject: Re: HOW TOs?
From: Steven Brown <stevenabrown -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 28 Feb 2002 07:50:01 -0800 (PST)

Radwa,

As others have pointed out, your instincts are strong;
you're going to be a good technical writer!

Generally, a task-focused document is better than one
that is feature-focused. Since your boss is the
software manager, it's not surprising to hear that he
wants one that is feature focused, because that's how
he thinks -- like a programmer, not an end-user.
That's the position I'm in. All of the documentation I
inherited was written by the person who helped design
the system, so the procedures are buried in a lot of
explanatory information and marketing-speak.

Maybe you should follow your boss's suggestion for
now, and as someone else suggested, write the "how to"
procedures separately for future use. After the
documentation is published, conduct a survey of your
users to determine what they like and don't like about
it. (If you're a sly cat, you can ask them if they'd
like to see procedural instructions. Who'd say no?)

Steven Brown
Senior Technical Writer


__________________________________________________
Do You Yahoo!?
Yahoo! Greetings - Send FREE e-cards for every occasion!
http://greetings.yahoo.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Now's a great time to buy RoboHelp! You'll get SnagIt screen capture
software and a $200 onsite training voucher FREE when you buy RoboHelp
Office or RoboHelp Enterprise. Hurry, this offer expires February 28, 2002. www.ehelp.com/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.



References:
HOW TOs?: From: Radwa Darwish

Previous by Author: Re: How to keep a senior manager busy for hours on end.....
Next by Author: Re: Task-based documentation-best practice
Previous by Thread: Re: HOW TOs?
Next by Thread: Re: HOW TOs?


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads