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:The user guide prescribes the program From:joe rapp <joe-rapp -at- JUNO -dot- COM> Date:Mon, 6 Jan 1997 15:03:18 EST
Can someone provide a reference that supports the following
view?
An experienced engineer/manager at NYNEX told me that
he believes that "The documentation IS the program." This
means that, for example, on a $60 million software project, they
FIRST wrote the user guide and designed the screens. Then
the users tested the guide for usefulness, clarity, etc. This
first phase took a year and a half. AFTER this was done, the
programmers were told to write the code -- which they did in
two weeks.
This engineer told me it is standard thinking that the
computer program IS the user guide, while the code is just
the code. If the program "doesn't work" properly, then
changes are made to the code -- not vice versa.
Since this view of documentation makes the tech writer's job
more central, more important, and more valuable, I would like
to see where this view is supported in the literature of
computer program development and/or user guide
development.
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html