Library Journal Mobile
Log In  |  Register          Free Newsletter Subscription
Subscribe to LJ Magazine
Email
Learn RSS

Tennant: Digital Libraries   



Link This | Email this | Blog This | Comments (3)


Reporting Problems As If You Want Them Fixed

November 9, 2007 In preparing for a talk I titled "Library Software Manifesto" (more to come on that one) that I presented at the 2007 CODI Conference yesterday I realized just how little advice there seems to be for civilians on how to report software bugs.

A Google search tends to pull up advice that's platform-specific, too wordy and condescending, too condescending and wordy, or is for software developers. There seems to be precious little in the way of advice and assistance for the vast majority who actually report software problems -- the actual users of these applications.

The Mozilla Development Center has some of the best (and briefest) advice in its principles section:
  • Be precise
  • Be clear - explain it so others can reproduce the bug
  • One bug per report
  • No bug is too trivial to report - small bugs may hide big bugs
  • Clearly separate fact from speculation
In general, I think the most common error when reporting problems is a lack of specificity. When reporting a bug begin by describing your exact situation (e.g., Firefox 2.0.0.4 on Mac OS 10.4.10 trying to use Software X, version X.X) followed by the exact chain of events (e.g., I went to this page, entered this in the search box, clicked the search button, and I got this exact error message).

The first step to solving any problem is to describe it accurately at sufficient detail that someone who wasn't there with you can understand it and hopefully even replicate it. Reporting bugs thoroughly and accurately will get them fixed faster than just about anything else that is in your control.

Posted by Roy Tennant on November 9, 2007 | Comments (3)


Industries: News & Features
Email
Learn RSS


November 10, 2007
In response to: Reporting Problems As If You Want Them Fixed
Peter Murray commented:

Good call, Roy! This suite of suggestions is definitely a keeper.




November 12, 2007
In response to: Reporting Problems As If You Want Them Fixed
Daniel Kahn Gillmor commented:

Hi Roy-- This is good advice, thanks for putting it out there. However, your "best (and briefest) advice" link seems to point to the same URL as your "too wordy and condescending" link. Can you fix that? i'd like to read the original!

Thanks,
--dkg




November 12, 2007
In response to: Reporting Problems As If You Want Them Fixed
Roy Tennant commented:

Daniel, thanks for reporting this error -- it's fixed now.





POST A COMMENT
Display Name or Registered Users Login Here.
Please restrict submissions to less than 7,000 characters (including any HTML formatting).

Change Image
Before submitting this form, please type the characters displayed above.
Note the letters are NOT case sensitive.

Advertisement

Advertisements





©2009 Reed Business Information, a division of Reed Elsevier Inc. All rights reserved.
Use of this Web site is subject to its Terms of Use | Privacy Policy
Please visit these other Reed Business sites