-
Notifications
You must be signed in to change notification settings - Fork 10
Decision: Replace Resources page with Subjects page
Thing | Info |
---|---|
Relevant features | Resources page, internal documents, combined search |
Date started | 2024-01-26 |
Date finished | 2024-02-13, although still refining the order of stories |
Decision status | Complete |
Summary of outcome | We'll replace the resources page with the "Find by Subject" page and upgrade our combined search page to use our better search index. Then we'll build the minimum viable filter/sort options on the search page to enable removing the duplicate search feature from "Find by Subject". |
We have a page at /resources/ with the following features for policy research in public resources (supplemental content and Federal Register documents):
- Text that explains what we mean by "resources"
- View all public items
- Keyword search (metadata only)
- Filter by related title, part, subpart, or section
- Filter by category or subcategory
- Download CSV of results (all items or filtered results)
- Sort by newest or oldest (or relevance for keyword searches)
- Apply multiple filters, such as searching by keyword within a category
Summary of user research about the Resources page from June 2023 (requires login).
We want to remove this Resources page and replace it with our "Find Policy Documents" page (aka our subjects page), while providing improved relevance and filters in our site-wide search ("combined search"). What do we need to do before we can remove the Resources page?
According to our analytics, our users rarely search using the resources page. Instead, they use our "combined search" page (available from the top-right search box). This lack of use may be partly because the resources page has a vague name.
We believe that offering a way to navigate by subject ("Find Policy Documents" page) and a better search experience (in the existing "combined search" page) will be more helpful than continuing to offer this page.
We know we need to offer a "Find Policy Documents" page that does not require logging in, and we need to link it from the navigation header.
We may want to offer a context statement on the "Find Policy Documents" page.
This is probably not important. When we did some user research about our homepage, people tended to not find the "recent" sections very helpful (although they didn't mind them).
We will offer much better keyword search via the revised "combined search" page.
This is not as useful as we expected it to be. We'd like to offer a way to filter by title and part in our revised "combined search" page, although lower priority than other filters.
Rebecca said: "Every once in a while I use the part filter because, for example, something like 'application' could span a lot of areas, and I was looking for it specifically for eligibility, so I wanted to narrow it down. I rarely use subpart or section."
The "search these resources" button (on regulation subpart sidebars) relies on this feature (including the subpart and section filters), but we're removing that button.
We are planning to offer filter by category on the revised "combined search" page. We can include filter by subcategory if needed.
Britta uses it (see Export data) but is okay with rebuilding it later.
We are planning to offer this on the revised "combined search" page.
We are planning to offer this on the revised "combined search" page.
We haven't asked our users (for example, using our CMS Slack channel) if any of them use the resources page for a particular reason.
We don't have an analytics report that could easily tell us whether people use the filters without searching, although we might be able to make one.
To remove the resources page, the minimum steps are:
- ✅ Remove "Search These Resources" button - EREGCSC-2506
- ✅ Remove the "View More Changes" buttons on the homepage (under the "Recent Subregulatory Guidance" and "Recent Rules" tabs) - EREGCSC-2519
- ✅ Make the subjects page available while logged out - EREGCSC-2499
- ✅ Update the path for the subjects page - EREGCSC-2536
- ✅ Update the navigation header to link to the subjects page - EREGCSC-2520
- ✅ Remove the resources page code and redirect the resources page path (/resources/) to the new path - EREGCSC-2537
To build a basic "combined search" experience, we need these steps:
- ✅ Index most supplemental content (other than very large PDFs and anything that refuses to be scraped) - EREGCSC-2445
- ✅ Index most Federal Register documents EREGCSC-2552
- ✅ On the current two-column "combined search" page, show full-text results from our Postgres index for supplemental content and FR docs (remove the search.gov results) and include internal results - EREGCSC-2538
- ✅ On the current two-column "combined search" page, enable showing subject tags on items in results - EREGCSC-2557
To prepare for a good "combined search" experience, we need these steps:
- ✅ Decide whether we're sticking with two columns or going to one column on "combined search" - EREGCSC-2446
- ✅ Conduct sessions for search usability EREGCSC-2553
- ✅ [Spike] Improve efficiency in search endpoint EREGCSC-2558
- ✅ Upgrade from Vue 2 to Vue 3 - EREGCSC-1765
- ✅ [Spike] Path to efficient combined search EREGCSC-2584
- ✅ [Spike] Decide on new "v4" API endpoints EREGCSC-2638
- ✅ Refactor the resources app EREGCSC-2639
- ✅ Migrate and delete the file manager app EREGCSC-2641
- ✅ Refactor the content-search app EREGCSC-2642
- ✅ [Spike] Test ranking for combined reg + resources search and adjust weights if needed EREGCSC-2567
To build a good subject page experience, which will also become (in modified format) the combined search page, we need these steps:
- ✅ [Design] Make "find by subject" consistent with combined search EREGCSC-2305
- ✅ Enable pagination for subject pages - EREGCSC-2403
- ✅ Add filter by category to subject pages - EREGCSC-2352
- ✅ Remove type filters from subject page sidebars and add them to centers of subject pages - EREGCSC-2679
- ✅ Remove search box from subject page sidebars and add it to centers of subject pages - EREGCSC-2685
- ✅ Update the sidebar style EREGCSC-2682
- ✅ Update the subject homepage EREGCSC-2881
To build a good "combined search" experience, we need these steps:
- ✅ Convert existing two-column "combined search" page to one column and enable filtering by document type (regs, internal docs, public docs) EREGCSC-2657
- ✅ Add filter by category to combined search - EREGCSC-2659
- ✅ Add filter by subject to combined search page - EREGCSC-2658
Can be delayed, but will be needed for sustainability:
- ✅ Retire search.gov integration code and parameters EREGCSC-2541
- ✅ Auto-index new supplemental content items and FR docs - EREGCSC-2624
- ✅ Auto-index new internal items - EREGCSC-2255
Nice to have:
- Enable sorting search results by newest/oldest EREGCSC-2909
- Re-enable admin and API features for search synonyms EREGCSC-2804
- Re-enable search synonyms on "combined search" page EREGCSC-2732
- Add "sort by" newest/oldest on subject pages - EREGCSC-2681
- Make the category options reflect the documents available from the entire set of results, with counts - EREGCSC-2659
Ideas:
- Plan how we'd incorporate filter by title/part into "combined search" (this could cover regulations, internal resources, and public resources)
- Figure out what a revised "Download CSV" button would do if we built it for the "combined search" page (would it include metadata from regulation and internal resource results?)
- Figure out analytics data we want to track, based on some combination of title change, custom events, and custom dimensions that correspond to URL changes and/or filters
The current resource page allows displaying a list of all items in X category (or all items sorted by newest), without providing a query term. Our new designs don't have this. We don't think we need this. We feel confident we can design and build this if we need it.
We need to do a lot of refactoring to make this happen.
Please note that all pages on this GitHub wiki are draft working documents, not complete or polished.
Our software team puts non-sensitive technical documentation on this wiki to help us maintain a shared understanding of our work, including what we've done and why. As an open source project, this documentation is public in case anything in here is helpful to other teams, including anyone who may be interested in reusing our code for other projects.
For context, see the HHS Open Source Software plan (2016) and CMS Technical Reference Architecture section about Open Source Software, including Business Rule BR-OSS-13: "CMS-Released OSS Code Must Include Documentation Accessible to the Open Source Community".
For CMS staff and contractors: internal documentation on Enterprise Confluence (requires login).
- Federal policy structured data options
- Regulations
- Resources
- Statute
- Citation formats
- Export data
- Site homepage
- Content authoring
- Search
- Timeline
- Not built
- 2021
- Reg content sources
- Default content view
- System last updated behavior
- Paragraph indenting
- Content authoring workflow
- Browser support
- Focus in left nav submenu
- Multiple content views
- Content review workflow
- Wayfinding while reading content
- Display of rules and NPRMs in sidebar
- Empty states for supplemental content
- 2022
- 2023
- 2024
- Medicaid and CHIP regulations user experience
- Initial pilot research outline
- Comparative analysis
- Statute research
- Usability study SOP
- 2021
- 2022
- 2023-2024: 🔒 Dovetail (requires login)
- 🔒 Overview (requires login)
- Authentication and authorization
- Frontend caching
- Validation checklist
- Search
- Security tools
- Tests and linting
- Archive