-
Notifications
You must be signed in to change notification settings - Fork 10
Decision: Wayfinding while reading content
[DRAFT]
Thing | Info |
---|---|
Relevant features | Content view |
Date started | 2021-09-22 |
Date finished | |
Decision status | |
Summary of outcome |
When a regulation reader clicks on a reg section from the search results or uses the "jump to" for a specific reg section (or any other specific link, like clicking a reg part ToC link), it can be hard to tell which subpart you are in without scrolling a lot (either up to top in the middle or down in the left sidebar).
When a regulation reader is reading through reg content, it can be easy to lose track of what subpart you are in.
What would be the best ways to help a reader better understand where they are? This may include:
-
When you click a link or use “jump to” to go somewhere new, what should the left sidebar of the new page do?
-
When you scroll up and down the page, how should the left sidebar behave?
-
Should we have some kind of persistent auto-updating wayfinding line like ATF eRegulations does? Example
We already highlight where you are within the left sidebar (subparts and sections already have an active state).
When we redesign our navigation to accommodate multi-view (section, subpart, and part view) and add parts of Title 45, that complexity will mean we'll need even more communication to the reader about where they are. Ideally, whatever we decide should be compatible with those concepts as well.
Multiple scrolls and transitions on page may be interrupting each other (e.g. scrolling in middle reader column affecting scrolling in left sidebar on page load).
Options:
- The left sidebar remains in its default neutral position (with "jump to regulation section" displayed and then the first sections in that subpart) - current status.
- The left sidebar should be scrolled to that reg section or subpart (matching what is in the middle).
- Example: I'm on the part 455 homepage and click "Subpart E - Provider Screening and Enrollment" in the center ToC. The left sidebar should show me Subpart E at the top.
Options:
- It stays in the same place, and your URL fragment stays the same as well - current status.
- The left sidebar scrolls in sync with the content, and the URL fragment updates with scrolling as well.
- Could this be frustrating that it's moving without your direct input, for example if you scroll to a specific point in the center column but you wanted to keep the left column in a specific place so you could refer back to something else?
Should we have some kind of persistent auto-updating wayfinding line like ATF eRegulations does?
Based on this, we'll need to update or replace https://jiraent.cms.gov/browse/EREGCSC-631
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