I like it, but it needs some work. I'll be moving the page to a better name soon.
I actually thought about this quite a lot (as you will see from the small essay below), and it was a while before I chose "Reporting_Bugs". While I respect your right to change it to whatever you consider a better name, would you at least please invite comments? At least for me. :)
Just to let you know my train of thought: I wanted the name of the article to be descriptive, accurate, easy to remember, and relevant.
(I was anticipating using the URL in replies to bug reports where it would be useful for the author to improve them in some way, possibly quite often. I imagined my replies as being simply the URL, although maybe with some of the article copied + pasted if it was specifically relevant or particularly helpful - so I tried to pick a title that would immediately show what it was about; I wanted it to be accurate, because if someone clicked the link and saw something that didn't fit the title, they wouldn't even get to the content of the article before becoming confused about it. I also hoped that it might be something that people found useful enough to recommend so it had to be simple enough to remember easily, or at least simple enough that it was easy to find again. And, relevant, because again as I wanted to use the article URL as a post in itself, I tried to think of something that would make sense as a response to different types of posts - or at least, not not make sense as a reply.)
First I thought of things like "How to write good bug reports" or "Tips on writing good bug reports". I chose "Writing bug reports" because it was shorter, basically. However it's a bit formal and would be more appropriate to more in-depth look at writing bug reports than the short helper list I was hoping would actually be read by the people writing the reports. It's also probably not as likely to be found again as something including the phrase "bug reports", as "Reporting bugs" is slightly different - not as commonly used so not as likely to be the first thing the comes into someone's mind when they've forgotten the actual title.
(I actually had the same problem again when thinking of the subject of this post (which has different criteria, slightly).)
So! I would say that if the title were to be changed, I would use "Writing Good Bug Reports" (possibly substituting "Good" with something that might seem more applicable - maybe Quality or Useful. I dunno). It's fairly short, easy to search for, descriptive, hopefully accurate, and more likely to imply a list of tips rather than an in-depth tutorial.
Choo choo! The train has arrived and thank fuck for that.
What I think needs done:
* Less "Wall of text"... divide it out into short, concise, logical sections.
Yeah, very true - the formatting needs work for sure. (If it'd been a plain text file I would've done a much better job! If it'd been a plain HTML file I would've too! Bloody wiki markup though, I don't write enough to remember all the little bits off the top of my head.)
One thing is perhaps to make the main points at the top, with the more detailed and possibly less relevant or important advice below.
* Put a MAJOR emphasis on getting bug reports to the right place. Many users don't realize that posting to a forum thread is not enough for me. I read it, I might even think it's a great idea, and then the next time I sit down and work on the addon I forget all about it cause it's not on my tracker. Providing good reports don't do shit if it's not in the right place.
That's very true, yes. However I did want to make it specific to WoWAce in particular, and I would have to say that the forum thread is the place to report bugs for most of the addons I know of. Don't read that to mean that I don't agree with you about emphasising the importance of where the bug is reported - I mean, I just did agree with you in my previous sentence :) - but I'm not sure that such a MAJOR emphasis is a good idea; just emphasis, maybe. :) I'm not sure it's a good idea to attempt to make something that covered all WoW addons in general (even though it may largely be useful in general) because it would make it necessary to include more information about the different possible ways of reporting bugs and what is expected from whom, while also limiting the detail of the advice given
Perhaps putting something like:
- MAKE SURE you are reporting your bug in the right place. For example, if you are reporting your bug in a forum thread, this may not be checked by the addon author in the near future - or at all - as some developers use alternative methods for tracking bugs. See below for some places to check if you're not certain that the developer will be checking wherever you are posting your report.
* Provide LINKS!
* Help people read the debug stack a tad... embed reports often go to the wrong place... would be good ta make the user aware that the issue may not be with the mod reporting it
Thanks Tekkub, these are all great suggestions.