TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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
and
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.
