-
Notifications
You must be signed in to change notification settings - Fork 10
Use cases
Purpose: define what eRegulations is for, so that we know what's in scope or totally out of scope for us in the indefinite future.
I need to find everything relevant to me about the current, past, and/or proposed state of a specific policy thing
- Because I need to build a policy rationale for something
- Because I need to find out my options within policy
- Because I’m drafting changes or clarifications to policy
- Because I’m implementing it in a system or process
- Because I need to teach it to somebody else
I need to get to a specific piece of reg information that I have in mind (such as having a citation for it like 42 CFR Part 433, 433.112, etc, or just knowing approximately where to find it via numbers/titles or keywords)
- Because I need to find out what it says
- Because I need to share it with somebody to help them
- Because I need to check my memory and my understanding of it
I need to find out where something is within CMCS regs
- Because I think this policy thing is in there but I’m not sure where, and I need to do a task related to it
Purpose: Help the team identify how things should work and what's missing.
Search for something:
- At the eRegs homepage, I search for a keyword.
- I view the results and use the context information (like part/subpart/section titles) to find out what they mean.
- I choose one and switch to navigating the Table of Contents and text for that part, so I can skim around.
- I use several methods (ctrl-f, visual scanning for words, and context from the titles of subparts and sections) to find relevant information.
- When I’m at relevant material, I view the contextual materials including subreg guidance to learn more.
- I skim several sections and subparts earlier and later in the reg to make sure I’ve read all the relevant materials.
- I save relevant material for later in various ways (bookmarks, copy-paste, write down citation numbers).
Look up a citation:
- I have a specific citation I want to look up (title, part, subpart), so I go to the eRegs homepage to get to it.
- I scan the page to find the part number I want, and I go to it.
- I see the part table of contents with subpart and section numbers. The subpart and section titles in the table of contents help me check that I’m in the right place.
- I look for the subpart. I prefer to just scroll for it, to use the context clues, in case I have the wrong number in mind somehow.
- I go to the subpart to get to the text of it.
- To make sure I’m in the right place, I read a few sentences and check the citation number.
- I get the link to the subpart to share.
- I copy the link into email.
- I select a couple key sentences and paste them into the email.
- I write some more info and send it.
Learn about a topic and view related information:
- I arrive on an eRegs reg content page out of context, because something linked me to a specific page.
- I can confirm by looking at the eRegs page that I am viewing the piece of reg that I expected to see.
- I read some of the content and view several of the resources and links it offers me, including supplemental content and cross-references.
- I also cross-reference the eRegs content to another resource I’m also looking at, such as a relevant piece of statute.
- I save some of the materials eRegs offers me as tabs, downloads, bookmarks, and copy-and-paste text, as notes and resources to review and use later.
- I need to navigate from one section to another section in the same part, several times.
- I also need to navigate to a section in a different part or title that eRegs does not contain.
- I share what I got from eRegs to others in writing, including links and copy-and-paste text.
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