RE: Structuring Documentation

Subject: RE: Structuring Documentation
From: "Dan Goldstein" <DGoldstein -at- riverainmedical -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 13 Dec 2005 15:33:56 -0500

Hi Tony,

I doubt I could improve on the clear steps to structured writing that
Sharon Burton and Dick Margulis have already posted.

I would add only that all tech writing requires the ability to ask your
SME an intelligent question and listen carefully to the answer. If the
answer leaves you in the dark, rephrase your question for clarification.
If you repeat the same question, you're liable to leave the unfortunate
misapprehension that you didn't hear the answer.

I've met many SMEs who needed help articulating their answers. Haven't
met many tech writers who needed help rephrasing the question, so I
guess that's a skill that's common in the field.

-- Dan Goldstein
(Won't rise to the bait again)
(Maybe)

> -----Original Message-----
> From: Tony Markos
> Sent: Tuesday, December 13, 2005 3:05 PM
> To: Dan Goldstein; TECHWR-L
> Subject: RE: Structuring Documentation
>
> What are the basic steps to structured writing
> (formatting aside)?
>
> Tony
>
> --- Dan Goldstein <DGoldstein -at- riverainmedical -dot- com>
> wrote:
>
> > Tony, many of us work every day with intelligent
> > people who are
> > perfectly capable of performing an analysis, but are
> > completely
> > incapable of expressing their analysis in writing.
> > Not the same, not
> > even nearly the same.
> >
> > -- Dan Goldstein
> >
> > > -----Original Message-----
> > > From: Tony Markos
> > > Sent: Tuesday, December 13, 2005 2:53 PM
> > > To: Dick Margulis
> > > Cc: TECHWR-L
> > > Subject: Re: Structuring Documentation
> > >
> > > If structured writing (formatting considerations
> > > aside) is the same or nearly the same as analysis,
> > > then the term serves no purpose other than to
> > create
> > > confusion...
> > >
>

This message contains confidential information intended only for the use of the addressee(s). If you are not the addressee, or the person responsible for delivering it to the addressee, you are hereby notified that reading, disseminating, distributing, copying, electronic storing or the taking of any action in reliance on the contents of this message is strictly prohibited. If you have received this message by mistake, please notify us, by replying to the sender, and delete the original message immediately thereafter. Thank you.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


Previous by Author: RE: Structuring Documentation
Next by Author: Smart answers and useful answers
Previous by Thread: RE: Structuring Documentation
Next by Thread: RE: Structuring Documentation


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

Sponsored Ads


Sponsored Ads