re: Documentation vs. the interface?

Subject: re: Documentation vs. the interface?
From: "Christensen, Kent" <lkchris -at- sandia -dot- gov>
To: "'TECHWR-L'" <TECHWR-L -at- LISTS -dot- RAYCOMM -dot- COM>
Date: Thu, 27 Jan 2000 08:30:01 -0700

re: you can't fix an incompetent interface by documenting it


re: they (management) should be willing to let you ask the programmers

Back in the dark ages of 1995 or so, when Francine Hyman had her company,
Communitec, I attended her "Writing Documentation Your Customers Will Want
to Use" course, and the radical recommendation there was for the outline of
the user manual to serve as the design document for the programming. That
is, the process of producing the manual occurs before and during software
product development, not just after the programs are completed. Another one
of those "teamwork" ideas. Think Francine works for Oracle now.

Previous by Author: re: Interface vs. Documentation
Next by Author: Re: Good tech writing schools?
Previous by Thread: re:Documentation vs. the interface?
Next by Thread: Forced to read the manual/re: FrameMaker

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

Sponsored Ads

Sponsored Ads