Programmers Stack Exchange is a question and answer site for professional programmers interested in conceptual questions about software development. Join them; it only takes a minute:

Sign up
Here's how it works:
  1. Anybody can ask a question
  2. Anybody can answer
  3. The best answers are voted up and rise to the top

We "use" JIRA as our ticketing system, but "use" is a real stretch. We have no standards, no templates, no "best practices" documentation for writing a proper JIRA ticket. So I'm spearheading the movement to create such a doc.

It's bad. Real bad. Sometimes, the reporter just copies-n-pastes a stacktrace and submits the ticket without providing any context, backstory, or directions to reproduce.

I was wondering if anybody had some good input for what format/template we could use and enforce so that I never get a lousily-written ticket assigned to me ever again! Thanks in advance!

share|improve this question

closed as too broad by gnat, GlenH7, MichaelT, Kilian Foth, Yusubov Jul 17 '13 at 18:08

There are either too many possible answers, or good answers would be too long for this format. Please add details to narrow the answer set or to isolate an issue that can be answered in a few paragraphs.If this question can be reworded to fit the rules in the help center, please edit the question.

up vote 3 down vote accepted

The basic information needed in any error report:

  • What exactly did you do?
  • What exactly did you expect to happen?
  • What exactly happened instead?

There's a bunch of other information that can be crucial, but depends on the specifics of the system and your environment - things like what user account was used, what domain objects were being worked on, what server the error occurred on, etc.

But also be careful that your effort to increase ticket quality does not end up discouraging people from submitting tickets at all - that's what happens when you cram everything you can think of into a template and force people to fill out all fields even when most of them don't apply to every ticket.

share|improve this answer

Not the answer you're looking for? Browse other questions tagged or ask your own question.