Re: Documenting software

Subject: Re: Documenting software
From: Cindy Boaen <cboaen -at- CONCORD -dot- COM>
Date: Mon, 6 Jul 1998 17:04:34 -0400

Tony,

Your reply is good, in an ideal world.

There are times, when the GUI is not ideal, that the software technical writer
needs to understand and explain the underlying software.

It's not pretty, but it's the way the real world works.

Cindy

> Kathy Stanzler wrote:
>
> For those of you who document software applications, how much of what
> you do is documenting the GUI and how much of it is documenting the
> underlying structure, the means by which the GUI is implemented? In
> other words, how important is it, do you think, for tech writers to
> understand the inner workings of the software?
>
> Tony Markatos responds:
>
> Software documentors (i.e. creators of end user manuals and training
> manauls) specify procedure. And effective organization of procedure is
> based upon a clear and concise understanding of WHAT the software does
> from an end user perspective. No knowledge of HOW the software is
> implemented is necessary to do such.
>
> Tony Markatos
>
> ______________________________________________________
> Get Your Private, Free Email at http://www.hotmail.com
>
>
>




Previous by Author: Re: "what is chunking" (was Senior Technical Writer..)
Next by Author: Article in Info World
Previous by Thread: Re: Documenting software
Next by Thread: Re: Documenting software


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


Sponsored Ads