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.
--- Radwa Darwish <radwa -dot- darwish -at- microtech -dot- com -dot- eg> wrote:
[SNIP]
> The thing is that my boss, who is the software development manager, doesn't
> like the "How to...?" approach and wants me to replace it with a listing of
> each field, edit box or grid and a brief on its usage. I am not quite sure
> that this way will be effective enough and I need your help....Any
> suggestions any innovative techniques or any standardized documentation
> process to adhere to.
Pardon me for putting this bluntly, but I suspect your boss also knows that you
have limited technical writing knowledge. Here's the blunt part: Do what your
boss wants. What I think is right, what I know of "innovative techniques or any
standardized documentation process" are irrelevant. Someone on the list
mentioned "The Golden Rule" on a different thread. This is a classic case.
If your boss were open to negotiation on these issues, I doubt you would be
turning to this list. No doubt any of a dozen people will suggest (in addition
to the fact that I'm a heartless no-good) different strategies for doing the
documentation and different strategies for negotiating with your boss. MY
suspicion is that your boss will most appreciate your doing well what the boss wants.
__________________________________________________
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.