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.
Actually, what you list as "special factors" should be requirements: the
version of the OS used, hard disk capacity and remaining space, RAM (amount
and type), processor. All of these can be used to spot trends which may not
be obvious otherwise.
> -----Original Message-----
> From: Jon Herrera [mailto:jonherrera -at- yahoo -dot- com]
>
> 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.
