Jump to content

Topic on Talk:Quality Assurance/Writing feature descriptions

improving the volunteers' experience - bz queries

Sharihareswara (WMF) (talkcontribs)

Today I ran through this myself.

In the future, for events like this, for any feature we aim to test, we should include a BZ query at the top of the backlog section, so people can look at bugs to turn into scenarios. Some basis for ideation is better than none.

Also, we should improve the sample scenario at How to contribute. Chris said:

Given I am searching enwiki (or whatever wiki that is)/And <file exists>..." We have a number of targets for these tests, so good practice is to specify target in Given statement
I think I should add another Plain English example that e.g. is searching contents of a file uploaded to a particular wiki.
the audience for G/W/T output is humans not machines. real is good
Qgil-WMF (talkcontribs)

I also learned a lot with my first exercise of writing scenarios, not only about the exercise itself but also about how to improve our documentation.

The two main lessons for newbies I got, that are not explained:

  • Focus on explaining the bed-time story. Don't get obsessed with the right syntax. More experienced writers can and will polish your syntax quickly (and you will learn from their fixes) but they will have a hard time if thew story is not clear.
  • When in doubt between writing a scenario too generic or too detailed, go for too detailed. If needed, someone can and will come after you and abstract the details into regular expressions. The the way around doesn't work, and a too generic scenario might have to be investigated from scratch.

About listing bugs: YES! In the past weeks, and during the event, I asked for real pointers to real tasks. I don't believe in newcomers "finding a feature they like" or "looking at the backlog for the kind of things to do". And even for more advanced scenario writers: we can't expect them to check what scenarios exist and therefore what are welcome. A Bugzilla keyword for reports welcoming an automated test?

This post was posted by Qgil-WMF, but signed as Qgil.

ZFilipin (WMF) (talkcontribs)
A Bugzilla keyword for reports welcoming an automated test?

I remember we already talked about that, but I am not sure if it is done or not. How do I check if Chris and Andre are following this thread? :)


This post was posted by ZFilipin (WMF), but signed as Zeljko.filipin(WMF).

Qgil-WMF (talkcontribs)

The only way to know is by asking them.  :(

This post was posted by Qgil-WMF, but signed as Qgil.