Re: Software Development

Subject: Re: Software Development
From: Gretchen Toth <glt -at- ICONOVEX -dot- COM>
Date: Fri, 25 Aug 1995 08:29:25 -0500

Hello everyone! This is a very long-winded post,
hopefully it will explain my concerns more clearly
than one requiring less bandwidth.

I have a huge favor to ask in relation to the Software
Development thread. I can't seem to get beyond just
the abstract idea of it, that is, I would really like
to be able to put all these suggestions, comments,
ideas into place but it's all a little fuzzy.

See I am the first technical writer here and have
had zilch training or education in working with
engineers/developers/etc. or in documentation management.
This is a new company, with very flexible guidelines
for documentation and development set, so I am anxious
to deal with these issues before they become issues.

At this point the system goes like this:

1. Somebody gets a really nifty software idea.
2. Our engineers (or rather an engineer) starts piecing
everything together.
3. Once the program's glue will hold it together enuf
for testing, it comes to me.
4. I test and write, reporting bugs and suggesting
changes/features. (All bugs and features are kept
in a tracking record and prioritized.)
5. Engineer makes changes if my arguments are good and
providing the changes are able to be made (most of
our software works hand-in-hand with another program,
like WordPerfect or Microsoft Word or a Web browser).
6. Continue #4 and #5.
Note: this is as far as I've gotten since I started here!
7. Engineer finishes program.
8. I finish the manual and on-line help.


Peggy Thompson (hi Peggy!) said:

>The only real solutions are

> (1) for the developers to put solid work methodologies in place,
> like those espoused by the Carnegie Mellon Software Engineering
> Institute

> (2) for the documentation team to be *formally and fully
> integrated* into the development picture--with standard means of
> communicating between developers and writers; feature freeze
> dates to keep the manual drafts and developing system in sync
> (we are TERRIBLE at this); and a development methodology for
> writers that parallels the software dev process

(1) Specifically what kinds of methodologies? (OK, so I can
check out what Carnegie Mellon suggests... :-) )

(2) First of all, I know that I should push to be a part
of the development process, when the software is still in the
idea stage... What do you mean by feature freeze dates?

and rselfe -at- mtu -dot- ed said:

>Further: many tech writers are in one-person or very small shops
> and often have no documentation methodologies, standards, or
> project plans to work with.

My brain says 'style guide,' but there HAS TO be more to it than
that!!!

and Mysti Rubert said:

>I highly recommend co-location for small groups. We've got 6 developers,
>one tech writer, one QA dude. We are more or less a team without
>borders now.

How much should I attempt to get involved with the developers
(engineers)? Don't get me wrong! I am not at all afraid to
request getting more involved or to work more closely with them;
I expect I would get quite a warm reception and plenty of
patience and explanation (at least I have from the first
engineer I am working with). I just don't want to suddenly
feel obligated to understand how the software was put
together when it is most important for me to understand how
the user will use the software, what they will attempt to
do with it, what they will expect.


Just looking for some starting blocks from which to dive
into this wonderful pool of technical communication...

You may respond to me personally at glt.iconovex.com.

:-D


<><><><><><><><><><><><><>
Gretchen L. Toth
Technical Writer
The Iconovex Corporation
gretchen -dot- toth -at- iconovex -dot- com
<><><><><><><><><><><><><>


Previous by Author: Re: Portfolios
Next by Author: Re: Automatic Indexing
Previous by Thread: Re. Productivity measures
Next by Thread: DynaText Tables (was: Online help for SGIs?)


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


Sponsored Ads