-
Notifications
You must be signed in to change notification settings - Fork 10
Decision: How to display reserved locations
Thing | Info |
---|---|
Relevant features | Content |
Date started | 2022-07-14 |
Date finished | |
Decision status | Tentative |
Summary of outcome |
Several of our regulation parts in scope have "reserved" subparts and sections. They say "reserved" in the name/title and are otherwise blank, without any regulation text.
In tables of contents, how should we treat reserved subparts and sections? Should they be normal clickable links? Or should they be greyed out and inactive?
On content pages, how should we treat reserved subparts and sections? Should we display text informing readers about what "reserved" means?
The Government Publishing Office has an official explanation for what "Reserved" means:
"[Reserved]" is a term used as a place holder within the Code of Federal Regulations. An agency uses "[Reserved]" to simply indicate that it may insert regulatory information into this location some time in the future. Occasionally "[Reserved]" is used to indicate that a portion of the CFR was intentionally left empty and not accidentally dropped due to a printing or computer error.
Any portion of regulation (part, subpart, section, paragraph, etc.) can be marked reserved, but it's most common to see a reserved subpart or section.
CMS sometimes removes a subpart or section (via a Final Rule) because it is obsolete. CMS usually renames the deleted subpart or section to "Reserved" and blanks out the text, instead of completely removing the location, to indicate that it wasn't accidentally dropped.
A reserved subpart or section may have associated resources. For example:
- A proposed or final rule that updated the content that used to be in that location
- A proposed or final rule that removed the content (and marked it as "reserved")
- A piece of guidance related to the content that used to be in that location
Potential user stories:
- People may find it helpful to look up a subpart or section mentioned in some older document, find out that it's reserved, and see the related resources for the previous content.
- Learners may not understand what "reserved" means.
- Researchers usually know what "reserved" means.
- Knowledge Keepers definitely understand what "reserved" means.
(See Audiences for background.)
This what we are currently doing on production, and it seems fine, so we're sticking with it for now:
- In a regulation part homepage Table of Contents, reserved subparts are normal clickable links, but reserved sections are greyed-out
- On a regulation content page, reserved subparts and sections are treated normally; they can have associated resources
- We are not displaying any special informative text about what "reserved" means, but we can revisit that later
We'll keep the prototype site (for usability testing) as approximately matching the production behavior.
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