RE: What then is the SME/TW functional relationship?

Subject: RE: What then is the SME/TW functional relationship?
From: greg -dot- hamill -at- teradyne -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 1 Mar 2002 09:47:20 -0500

>Because I work in software, the stuff I write about is often only
>thinly-defined and partially implemented when I begin writing about it. I
>get a copy of the software or a profile on the system running the software
>while it's still in development. I try to do things with it. I crash the
>system, just like the engineers do<G>. I try to figure things out, based
>my experience with other systems and on my reading of whatever I can get
>eyeballs on that appears relevant. I talk to and listen to a lot of
>engineers, especially those in QA. We use whiteboards a lot. I constantly
>refine the docs, just as the engineers/implementors refine the software.

>Because the software is changing as I write about it, I must rely on SMEs
>verify that the docs I write accurately reflect the state of the product
>the time we ship Beta and final products. This doesn't mean that I don't
>know the product. Rather, it's a way of making sure that we catch, or at
>least minimize, any discrepancies between what I've written and what they
>understand about the product.

Just my $0.02,

In response to Marguerite's "thinly-defined" material, I coined a new word
last year (or at least I hadn't heard it before). We all writer "vaporDoc"
on uncompleted vaporware.

Our work here is identical. Your second note on changing software is a good
description of any evolving company. Time constraints imposed upon us and
on the SMEs are immediate, constantly changing, and pushed forward as often
as backward.


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.

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 for more resources and info.

Previous by Author: RE: The Big Lie (was 'Are You a Writer?')
Next by Author: I suppose this is my most frustrating grammar error
Previous by Thread: Tech writing and McDonald's...?
Next by Thread: Re: I suppose this is my most frustrating grammar error

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

Sponsored Ads

Sponsored Ads