Make tutorial video on how to use Bugzilla
Closed, ResolvedPublic

Description

This is kind of a meta bug and not an actual issue in BZ. Couldn't think of a better place to file it...

Filing bugs/enhancements is difficult for some people to figure out. We can lower the barrier pretty easily by making a 1 or 2 minute video showing you how. Upload to commons, link to from BZ main page.

Key components:

  • Sign up
  • Choosing the right product
  • Giving clear description of the problem/request
    • Screenshots are fantastic
    • Providing links is great too
  • Make sure to emphasize to not worry about filling all the fields out properly, the important step is opening the bug!

Major props to User:Biosthmors on enwiki for coming up with the idea.


Version: wmf-deployment
Severity: enhancement
Whiteboard: gci2013 https://www.mediawiki.org/wiki/Google_Code-In#Candidate_tasks
URL: https://commons.wikimedia.org/wiki/File:How_to_file_a_report_in_Bugzilla.webm
See Also:
https://bugzilla.wikimedia.org/show_bug.cgi?id=52696

Details

Reference
bz54606
bzimport set Reference to bz54606.
demon created this task.Sep 25 2013, 5:14 PM

Maybe Victor / some designers / whoever, can produce nice video intro and outro :)

Qgil added a comment.Sep 25 2013, 9:51 PM

A screencast showing the shortest path to file a bug report should do. I haven't done a screencast in ages but I will try tomorrow, with the hope that someone hates what I did and produces something better. :)

In fact this could be start of something. We could have more short screencasts focusing on a specific action (advanced search, comment on a bug...) and extend the idea to other tools (get developer access, comment on Gerrit...). These short videos could be easily embedded in the right wiki pages and...

But let me try with this File Your First Bug screencast first. :)

For the records (and inspiration), the only pretty good (and partially Mozilla-centric) video I am aware of is http://blog.johnath.com/2010/02/04/bugzilla-for-humans/

Qgil added a comment.Oct 10 2013, 10:31 PM

What interface should we use for this screencast? The traditional or this new one Andre is cooking up?

I have started defining a rough script at https://www.mediawiki.org/wiki/Talk:How_to_report_a_bug#Screencast

(In reply to comment #4)

What interface should we use for this screencast? The traditional or this new
one Andre is cooking up?

I'd assumed you'd create a video in .ogv format.

A paginated PDF is also an option.

Qgil added a comment.Oct 11 2013, 5:08 AM

Well, yes, a video screencast.

What I'm asking is whether we should do it using the plain Bugzilla interface or the guided form.

Guided form (bug 36762) is still under development and not deployed - this week was too busy with reallife but will try to get it into shape next week.

Currently I'd use the normal form with "Hide Advanced Fields" enabled, and either MediaWiki or Wikimedia product, plus component "General/Unknown".

Note that there are also bugzilla.mozilla.org thoughts on having video tutorials for specific Bugzilla topics: https://bmo.etherpad.mozilla.org/bugzilla-tips-videos
I don't know how much upstream this would be though.

Elitre added a comment.Nov 4 2013, 1:01 PM

The guided form is now ready (i.e. https://bugzilla.wikimedia.org/enter_bug.cgi?product=VisualEditor&format=guided ), and I'd really love to have a screencast about it!

hashar added a comment.Nov 4 2013, 2:18 PM

(In reply to comment #10)

https://bugzilla.wikimedia.org/enter_bug.cgi?product=VisualEditor&format=guided

That is REALLY nice!! You should post that guided form to wikitech-l, I am sure other components could make use of a similar form.

(In reply to comment #11)

You should post that guided form to wikitech-l

http://lists.wikimedia.org/pipermail/wikitech-l/2013-October/072786.html

lettrich42 wrote:

I am a student from Google Code in this task was assighned to, and I will start today, begining in a couple of hours. (Regular updates were required)

Awww! Thanks a lot!

lettrich42 wrote:

OK, Im thinking about doing the script with part Slideshow and mostly a Guided screen recording. What do you guys think about that?

lettrich42 wrote:

(In reply to comment #15)
*or girls

:) I wouldn't like to see slides in the video, but hey, that's just me. Let's see what Andre thinks, since he rules over Bugzilla here!

lettrich42 wrote:

I'm not sure how to transition from logging in to using the new formatted bug submission form, as there seems to be no link from the site homepage.

Hear, hear! Bug 57254.

richiell wrote:

Ive made a little bit of progress on the script, here's the link if anyone wants to follow it: https://www.mediawiki.org/wiki/User:Richardusername/BugzillaScriptProject

Qgil added a comment.Nov 26 2013, 12:28 AM

Hi Richiell!

Slides vs screencast, this video was well received here. Just in case it serves as source of inspiration:

http://blog.johnath.com/2010/02/04/bugzilla-for-humans/

There is another GCI task about title cards for videos, but they are not ready yet. Still, this task is about agreeing on the script, so never mind.

Same for the link to the guided form. You are right, currently there is no way to reach it from Bugzilla itself. However, for your script we can assume that it will be in the home.

About your script, feel free of reusing the very little I could do at https://www.mediawiki.org/wiki/Talk:How_to_report_a_bug#Screencast

I also started thinking of the registration process. Then again, Bugzilla's registration is quite standard, so perhaps it is better to save that time to the viewers of the video and yourself. Mention in the script that users must be registered in order to file bugs, feel free spending 3 seconds to point to the Register link in the home and get directly to the stuff.

This means that the beef of your script is "Examples". :)

Sorry for not reaching to this conclusion before! Your draft helped reaching to this conclusion. This is how iterations work...

lettrich42 wrote:

Thanks for the video! It was exactly what I was thinking of, except doing this one more to the point. Also this is my main account, was accidentally logged in to wrong one when posting the last one. (I was going through the steps again) As for the brief sign-up , we can easily remove it if needed, so ill just leave it until final revisions.

lettrich42 wrote:

The draft is finished if you're interested. Just going to clean it up and maybe add more details. Link again for CC:https://www.mediawiki.org/wiki/User:Richardusername/BugzillaScriptProject

Qgil added a comment.Nov 26 2013, 5:50 AM

It's a good first draft, but still needs more work. I have left my feedback. Andre and other readers of this report are encouraged to comment there as well.

(In reply to comment #18)

I'm not sure how to transition from logging in to using the new formatted bug
submission form, as there seems to be no link from the site homepage.

Uhm. I don't have an easy answer to that either right now. :(

So far I've expected users to follow links on wikipages which point to the ?format=guided form in the URL.
But as Elitre already wrote: Discussed in bug 57254.

Qgil added a comment.Nov 26 2013, 10:17 PM

Ok Richard, you don't need to get stuck in this discussion about the origin of the link. Whenever someone (you?) creates the screencast we will use an existing entry point in a wiki page (VisualEditor would work, as specified in your script).

Qgil added a comment.Nov 28 2013, 2:04 AM

I have given Richard my last round of comments. The script already looks very good. If you have additional feedback don't comment: edit the script directly ("Be bold").

As soon as this task is completed I will create a new one about creating the screencast.

lettrich42 wrote:

Ok, i think its just about there, Did i seem to mention anything
Link for convenience: https://www.mediawiki.org/wiki/User:Richardusername/BugzillaScriptProject

Qgil added a comment.Nov 29 2013, 4:10 PM

Thank you Richard!

The task about writing a script has been completed. I just created the task to produce the screencast:

http://www.google-melange.com/gci/task/view/google/gci2013/5787018130882560

Hello, I'm a student from GCI, and I've been assigned this task.
So, about the screencast, I have an idea: how about once the user account has been created successfully, I go to http://www.mediawiki.org/wiki/MediaWiki, then search for How to report a bug. From there I move to the new guided form.

Well, in the video, the windows taskbar or chrome logo is not there but tabs are visible, that okay?

The script tells to go to your e-mail client, and I went to my gmail account to get the mail, is that okay?

(In reply to comment #31)

Well, in the video, the windows taskbar or chrome logo is not there but tabs
are visible, that okay?

That's totally fine. Is the address bar (where the URL is shown) still visible? I'd say that's preferable to have.

(In reply to comment #32)

The script tells to go to your e-mail client, and I went to my gmail account
to get the mail, is that okay?

Yes, but if you prefer to not show your real private email address and inbox at that time to the world, you might want to create another email account just for testing and making this video.

Qgil added a comment.Dec 23 2013, 3:06 PM

(In reply to comment #30)

Hello, I'm a student from GCI, and I've been assigned this task.
So, about the screencast, I have an idea: how about once the user account has
been created successfully, I go to http://www.mediawiki.org/wiki/MediaWiki,
then search for How to report a bug. From there I move to the new guided
form.

OK

(In reply to comment #32)

The script tells to go to your e-mail client, and I went to my gmail account
to get the mail, is that okay?

Let's see how it looks like. The idea about not showing browser/email/OS chrome is to make the video as generic and as brand-free as possible. Don't worry, we can always cut.

(In reply to comment #33)

That's totally fine. Is the address bar (where the URL is shown) still
visible?
I'd say that's preferable to have.

Well, I got that fixed by now, so its not a problem anymore, only the address bar is visible.
But the g-mail will would be appearing, can't fix that.

  • Bug 58965 has been marked as a duplicate of this bug. ***
Qgil added a comment.Jan 13 2014, 10:53 PM

Shujat completed the tutorial, which is available at https://commons.wikimedia.org/wiki/File:How_to_file_a_report_in_Bugzilla.webm

Your help featuring it in mediawiki.org and other projects is welcome!

Thank you very much, Shujat.

Excellent work Shujat! Thank you very much :-)

Add Comment