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:Writing good bug descriptions From:Jon Herrera <jonherrera -at- yahoo -dot- com> To:techwr-l -at- lists -dot- raycomm -dot- com Date:Tue, 2 May 2000 13:11:11 -0700 (PDT)
I've been assigned to write some guidelines/tips for
software engineers so that they can write good bug
descriptions. Right now, the descriptions are very
difficult to understand and have to be rewritten
before they are given to the support department or
released to customers. Does anyone have any ideas or
suggestions?
So far, I tell them to make sure the following
information is included:
* the product name and version number
* any special factors (for example, limited RAM or
disk space)
* any actions performed that lead to the bug
appearing
* any other products affected
* solutions
I appreciate your suggestions.
Thanks,
Jon
P.S. I posted this question on the TechComm mailing
list but didn't get many responses, so I'm posting to techwr-l.
__________________________________________________
Do You Yahoo!?
Send instant messages & get email alerts with Yahoo! Messenger. http://im.yahoo.com/
