Give me some help (was: UI module owner)

[Benton, Kevin]

Subject changed due to overly broad description

> timeless wrote:
> > Zero, there's no What's This widget by that link, so I'd never click
it.
> 
> Are you saying that "Give me some help" is not a sufficient indication
> of what the link does, or sufficient encouragement to click it?
> 
> What do you think the link text should say? Or do you think the Help
> trigger should be elsewhere? Or that it should be present even in the
> base page?

I suggest that the "Give me some help" page is not sufficient.  Users
need more help than what field is used for what - they need sample
applications, tutorials, etc.  It's great for those that already have a
basic understanding of how to use the Advanced Search page, but for the
first timer, it's daunting at best.  While the Bugzilla User's Guide is
there, most users aren't given a copy when they hit Bugzilla for the
first time.  I think this is our fault in part as developers.  I think
we ought to provide our users with a form of the User's Guide right from
the initial login page.

> > First, there's no hint as to which things have help, so I don't know
> > what I can hover over, simply using dotted or doubled underlines
would
> > help (alternatively offering whats this hover anchors would also
> > work).
> 
> Well, the top of the newly-reloaded page does say "For help, mouse
over
> the page elements." So you can find out what has help by mousing over
> things. Having said that, all the widgets should have help - do any of
> them not?

I believe all the inputs should have help, even the bug summary.  If the
user puts their mouse over a field, help should be provided either in
the form of tool tips or as a clickable link somewhere.

> It's hard to dotted-underline a widget...
> 
> > Second, here's the actual help text for that box:
> >
> > Specify the start and end dates either in YYYY-MM-DD format
> > (optionally followed by HH:mm, in 24 hour clock), or in relative
> > dates such as 1d, 2w, 3m, 4y, which respectively mean one day,
> > two weeks, three months, or four years ago. 0d is last midnight,
> > and 0w, 0m, 0y is the beginning of this week, month, or year.
> >
> > What part of this says to use -2m or -2w or -*ANYTHING* if you want
to
> > go backwards?!
> 
> The original poster was incorrect in their understanding. There is no
> need for a minus sign, and it is ignored if present. The help text is
> correct (if perhaps a little terse).
> 
> For things changed between 3 weeks and 2 days ago, you put "3w" into
the
> first box, and "2d" into the second box.
> 
> We should probably permit a more verbose version of this syntax.

How about we provide examples next to the description?

> >> If not, why not - because they didn't notice it?
> >> Because they didn't think it would help?
> >
> > Having used it once, I can assure you, I'd never use it again, it's
> > barely more helpful than a Unix document. Even Microsoft help which
> > people love to complain about is considerably better. Especially
given
> > that the number one search anyone ever wants to do is something like
> > -1m.
> 
> What is incorrect about that help text? Suggestions for better wording
> are most welcome.

See above.

> > The problem here is that we don't give people examples or walk
through
> > documents for using our features. If you show anyone how to use
these
> > features it becomes instantly intuitive and they'll remember and use
> > it (ask smaug, I showed him over the weekend), but no one will
guess.
> 
> How do you suggest integrating such help into the interface? Or are
you
> suggesting changes to the Bugzilla Guide?

I think we ought to do both - provide examples through simulating the
user input and describing what it would do at the help level, and
providing the same help in the guide.  I think that the Bugzilla Guide
should be a part of the distribution in such a way that the help system
refers users directly to the proper section in the guide.  That can give
users the context they may be looking for.

---
Kevin Benton
Perl/Bugzilla Developer/Administrator, Perforce SCM Administrator
AMD - ECSD Software Validation and Tools
 
The opinions stated in this communication do not necessarily reflect the
view of Advanced Micro Devices and have not been reviewed by management.
This communication may contain sensitive and/or confidential and/or
proprietary information.  Distribution of such information is strictly
prohibited without prior consent of Advanced Micro Devices.  This
communication is for the intended recipient(s) only.  If you have
received this communication in error, please notify the sender, then
destroy any remaining copies of this communication.