RE: Development Procedures - where do you come in?

Subject: RE: Development Procedures - where do you come in?
From: "Keith Soltys" <keith -at- soltys -dot- ca>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Sat, 26 Jan 2002 09:47:37 -0500

At my company, we are setting up a new development process, based on the
Rational Unified Process. Documentation will be involved during the
Elaboration phase of the project, roughly the part when the use cases are
detailed. The doc plan will get done at that point, and documentation will
begin about the same time as the actual coding (hopefully). Since most of
the products in our case are data feed and transaction processing systems
that don't have much of a UI component, the ussability issues aren't as

There are a couple of other issues here: whether there is enough information
to accurately spec out your docs at the really early stages, and whether
there will be enough tech writing resources to participlate in the really
early design stages. We decided that there wasn't much point in preparing a
doc plan until the use case model was defined. And while it would be nice to
b involved earlier to learn more about the product, we don't have the

Your mileage may vary, of course.


Keith Soltys
Host of Internet Resources for Technical Writers since 1994

> -----Original Message-----
> From: bounce-techwr-l-68718 -at- lists -dot- raycomm -dot- com
> [mailto:bounce-techwr-l-68718 -at- lists -dot- raycomm -dot- com]On Behalf Of Jim
> Shaeffer
> Sent: January 25, 2002 7:55 AM
> Subject: RE: Development Procedures - where do you come in?
> Cautionary note: It may be possible to get started too early
> in the process. This is different from being involved. Early
> writing tends to lead to lots of re-working. There seems to
> be a phase in most products between initial design and early
> release when lots of things change rapidly. Of course, the
> nature and length of this fluid phase will vary with variations
> in overall project management and project disciplines.
> Jim Shaeffer (jims -at- spsi -dot- com)
> > -----Original Message-----
> > From: Pegasus Writer [mailto:pegasuswriter -at- hotmail -dot- com]
> >
> Snip
> > Everyone who responded seemed to concur that it isn't
> > possible to get involved too early in the development process.
> > Reflects my feelings exactly.

Attention ForeHelp and Doc-to-Help Users! Upgrade your existing product to
RoboHelp for only $299, through January 31st. RoboHelp can import your
existing Help projects! Learn how else RoboHelp can benefit you.

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.

RE: Development Procedures - where do you come in?: From: Jim Shaeffer

Previous by Author: RE: IMAP method
Next by Author: Lingua Franca Today
Previous by Thread: Re: Development Procedures - where do you come in?
Next by Thread: Development Procedures - where do you come in?

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

Sponsored Ads