Documentation - how to write a bug ticket well

department-of-veterans-affairs / va-mobile-app

"If VA were a company, it would have a flagship mobile app."

https://department-of-veterans-affairs.github.io/va-mobile-app/

17 stars 2 forks source link

Documentation - how to write a bug ticket well #9508

Open TKDickson opened 2 months ago

TKDickson commented 2 months ago

Documentation on how to fill out a bug ticket well, including things like:

Required vs not required fields
Context/why we do certain things
Examples of well-filled out tickets
FYI on the bug scrub process (so if you mess things up at least there's a backstop)
Linking to said documentation from the internal bug ticket template

Will help make expectations around this clearer, for folks onboarding.

Credit to @brea11y for pointing out this was a good idea.

DJUltraTom commented 3 weeks ago

@TKDickson is the intent for this ticket to create a "How to" article, update the bug ticket template or both? If a document/article is the desired output, where should this document live?

TKDickson commented 2 weeks ago

@DJUltraTom mostly a how-to article, but if you find that updating the ticket template along the way also makes sense, go for it. It should live on the QA section of the doc site, probably as a subpage of the Quality Assurance Process section.