alphagov / alphagov/tech-docs-gem
[Enhancement]: Investigate improved search bar functionality
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 16
- Forks
- 47
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 14
Description
What should change?
Recent user research has highlighted some ares that could be improved when using the search bar in the tech docs. This ticket is to define a spike to look at the detailed user research, analyse the search functionality and define a plan to improve it.
headlines from the user research are:
- most participants used the search function to find content, rather than the side navigation bar.
- participants always used short and simple search terms such as “VPN” or “AWS account”.
- participants did not usually find the search results and snippets very useful when deciding if the pages contained the info they needed.
- there appeared to be a bug in the search where it occasionally returned no results, but if the same search was repeated it would return results.
User need
The user research outlined above, there is a full report which is being shared when available
Proposed solution
To create a group of tickets that will resolve some or all of the issues, or alternatively suggest a new/improved way to implement a search function
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by obtaining and reading the full user research report, then review the current search behavior against the reported results and snippets issues. Done means producing a clear plan that addresses the findings, including the intermittent no-results behavior, and breaking the work into follow-up tickets.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation, search
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100