-
Notifications
You must be signed in to change notification settings - Fork 10
Design standards and conventions
Generally, while we do want to be succinct, lean toward being more descriptive and adding helper text for clarity.
Icons: Default to adding text labels
Text Alignment: Default to left align
External Links: In general, these should be noted with an external link icon
Links: Default to underlining when reasonable, because our users sometimes miss links that don't have underlines
Placeholder Text: Be more descriptive - "Search Title 42" vs. "Search"
Headings: Include both part/section numbers and text where appropriate - "42 CFR Part 433 – State Fiscal Administration" vs. "42 CFR Part 433"
Dates: Default to three-letter month with no period - "Jan 3, 2011"
Current/Present: Default to saying "latest." Avoid "current" and "present" since there's likely to be a delay between the release of a new version of the reg and what eRegs is displaying
Case: Default to title case to match Medicaid.gov
Reg Numbers and Titles: Use a dash between title/part numbers and titles - "Part 431 – State Organization and General Administration" (specifically, an en dash with spaces on both sides)
Section symbols: Include a space after the section symbol and before the number - "§ 433.107" (this should be implemented as a non-breaking space)
eCFR is always capitalized like that
eRegulations is our product name. eRegs is an internal project nickname. We use a plain title describing the site (Medicaid & CHIP eRegulations) because it's part of the Medicaid.gov family of tools.
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