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.
Maybe I didn't make myself clear--the tasks we write about aren't
intrinsic in our software. For example, our customers
(telecommunications network operators) need to be able to produce Locked
and Disabled Object reports. We provide procedures in our user manuals
that describe how to use our software in order to produce a Locked and
Disabled Object report. Nowhere in the GUI is there an option that says
"Locked and Disabled Object report," and I doubt anyone would ask why
they need to do one--it's in their job description. To produce
task-oriented documentation, you need to do interviews with the
customers to find out just what exactly they do every day, then write
procedures for those tasks. But then, this isn't your typical
one-size-fits-all software package.
A task-oriented user guide for Word might possibly include these
chapters:
1. How to put together a letter
2. How to put together a manuscript for publication in (name of
publication)
3. How to use the same source text to produce both a brochure and a
newsletter
4. Shortcut techniques that make text entry easier (styles, for example)
etc.
> -----Original Message-----
> From: Bruce Byfield [SMTP:bbyfield -at- axionet -dot- com]
> Sent: Thursday, March 27, 2003 5:18 PM
> To: Anita Legsdin
> Cc: TECHWR-L
> Subject: Re: Marcom as TechCom
>
> I don't think so. You can give descriptions of task after task without
>
> ever mentioning why someone would want to do each task - I've seen
> dozens of manuals that do exactly that.
>
> To take a simple example, you could explain how to use styles in a
> word
> processor, but if you don't explain why someone might want to use
> styles, then the information is of limited use.
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Order RoboHelp X3 and receive a $100 mail-in rebate, plus FREE
RoboScreenCapture, WebHelp Merge Module and iMarkupSoftware, for a total
giveaway value of $473! Order here: http://www.ehelp.com/techwr-l
Help celebrate TECHWR-L's 10th Anniversary starting this month!
Check out the contests at http://www.raycomm.com/techwhirl/special/contests/
Happy birthday to you, happy birthday to you, happy birthday TECHWR-L....
---
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.
