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.
I'm helping our developers during the beta testing of our
first software release. The documentation process is in
pretty good shape for an _ad hoc_ effort, but the beta test
itself is going to be a bit chaotic. (Who knew? <grin>) I'm
currently building a contacts database to let me keep track
of who has the software, but I'd like to incorporate
information that will help the developers hunt down any
bugs. I'm including the following information to begin
with:
- software version number
- operating system version (Win3.1, Win3.11, Win95 plus
revision date, if any)
- cpu (386, 386-clone, 486, 486-clone, Pentium,
Pentium-clone)
- amount of memory (RAM)
- list of all other software that's running at the same
time as our software (i.e., potential conflicts!)
- a description of the behavior that led up to the bug, and
what happened when the bug occurred (e.g., error message
number, GPF, etc.)
We'll be having a brainstorming session to see what other
information they could use, but do you have any other
suggestions for information that could help them find and
squish bugs? Please copy your response to me; I'll
summarize to the list if I get enough responses.
--Geoff Hart @8^{)} geoff-h -at- mtl -dot- feric -dot- ca
Disclaimer: Speaking for myself, not FERIC.
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