bcgov / orgbook-bc-client

Vue.js rewrite of OrgBook BC
Apache License 2.0
6 stars 8 forks source link

Help text for main search and search results #140

Closed swcurran closed 2 years ago

swcurran commented 2 years ago

We've had feedback that searchers have had trouble with some searches, especially when punctuation is involved. We want to provide some guidance for those searching on the home page near the "Find an organization" autocomplete widget and on the search results page near the "XXX result(s)" indicator. Basically, we need two buttons/icons/links and for each a popup with text that I can provide.

The issues I'm trying to address are these, from the "dislike" comments we've received:

I'd like @alexgmetcalf to weigh in on the UI element -- the buttons/icons/links to be used. Alex -- please mock up some images for what to use in the two places.

Here is a first cut of the text to use in both places. Alex/others -- feel free to improve on this. Worst case, we start with this and we can evolve it as needed:

Help Text

The OrgBook searching by legal name returns all of the organizations that have any of the words that you search on, and floats the most likely matches to the top of the list. In most cases, that means that putting the fully legal name of the entity will float that result to the top. However, in some cases you may find that you get both many (many!) search results, and the entity you are looking for is not at the top. This most often happens when the legal name has punctuation marks -- for example a period "." at the end of the name, e.g. "Co." or "Inc.". It's a problem with the search tool we are using -- we're working on a fix!

When you get too many results and the name you are looking for is not at the top, we recommend that you put only the least common word (or two) from the name. For example, when searching for "BKV SOCIAL ENTERPRISE CO.", about 1300 results are returned, with the top ones having "Social" in them. That darn trailing period! In this case "BKV" is the least common word, so let's only search for that by typing "BKV" into the search bar and hitting ENTER (e.g. don't pick anything from the drop down list). The result is now just a couple of entries, one of which is the one we want.

Remember as well that with OrgBook, you don't have to search on the legal name. You can also search on the BC Registries ID (has two characters and 7 digits, like FM1234567) and by the CRA Business Number (9-digits) for the entity. If you know one or both of those values, using those for an existing entity will always find an exact match.

If you still can't find the entity you are looking for (and you are pretty sure it exists), please use the "Contact" link at the top of the page to let us know what you are looking for and that you can't find it, and we'll see if we can help.

WadeBarnes commented 2 years ago

In the case of "BKV Social Enterprise Co.":

When using any of the above search terms BKV Social Enterprise Co. is the first in the list for auto-complete. But when you click on it either nothing happens (no search is initiated) or you end up with the same result set as if you used the term, BKV Social Enterprise Co., where the company name you just picked out of auto-complete is not even on the first page. image

What's changed with search? This is not a very intuitive experience.

Yes in the case of this company they could have just searched for "BKV", but what about the many cases where there isn't a distinct word in the name. You should be able to perform a full string search using "" to narrow the results.

swcurran commented 2 years ago

Thanks, Wade -- that's great. I'll adjust the help to try to highlight that.

I don't think anything has changed on the search. When you click on a drop down entry it uses the entry you clicked, with no quotes, so no difference from your 3rd item in your list. Pretty sure that's always been the behaviour.

Another weird one:

So this tells me the hint should include "not enough" and "too many" results.

And we need to adjust the guidance to mention the use of quotes.

Search is hard...

wadeking98 commented 2 years ago

closed after help text merged