Skip to content

Pilot stage

Britta edited this page May 14, 2021 · 32 revisions

In scope

What are the core services we want the eRegs pilot to offer to fulfill stakeholder needs?

What do we need to provide to deliver that?

Web application fundamentals

  • Site meets CMS accessibility requirements
  • Site works or gracefully degrades on browsers CMS staff use
  • Site is responsive for various sizes of screen CMS staff use
  • There's a way for people using this to give us feedback, suggestions, report bugs, etc
  • There is basic print styling for reg content
  • Mobile view works for reading reg text (not full features)

Reg content that people read and trust

  • Use content versions directly from eCFR (not homebrewed by interpreting rules)
  • Display complete reg content (including Federal Register citations, "Authority", "Scope", and "Editorial Note" info from the CFR, etc.)
  • Footnotes, formulas, and tables are readable
  • Nested paragraphs are indented
  • Always tells you when the reg content was last updated
  • Always displays appropriate disclaimer

Usable navigation of parts, subparts, and sections

  • Default view of reg content is by subpart, with full part view as a fallback when needed (such as sections that aren't within a subpart)
  • Within a part, you can jump to another section or another part
  • For any specific reg content you're looking at (more specific than a part), you can use "next" and "previous" buttons to navigate
  • In any content view, you can find out where you are by seeing location information (including both the part number and the part name)
  • You can get more room to read reg text by collapsing other info
  • Each paragraph can be independently referenced by an anchor link in the URL
  • The reg part homepage center column has a table of contents for the latest version, marked with the version/date of the content
  • Each reg part homepage can have custom content in the center and right columns
  • While reading reg content, there's a way to see an expanded Table of Contents for that part, for skimming
  • There's a way to copy the URL (that's not just copying the URL bar)
  • When you receive a link to a specific piece of reg on eRegs, the text you were linked to is highlighted (in an unobtrusive way)
  • Each reg part homepage can display an automated list of recent changes (recent rules) and proposed changes affecting the part
  • Print button for the reg content you're looking at

Integration of key supplemental content in context with regs

  • Ability to display supplemental content that has a link, a title, a category, one or many section + date pairs
  • A policy SME can write content in a structured way that the system can incorporate (reflecting the content model)
  • Categories of supplemental content have names, weight, and descriptions (captions)
  • Automated list of related rules

Usable keyword search across and within parts

  • Global search is available from every page
  • In search results, there's an option to search for your keyword in other tools with a wider scope of information (such as beta eCFR and Medicaid.gov)
  • There's a way to filter search results by part, no matter how you started the search
  • You can search within current part
  • Search includes search for simple plurals
  • Literal keywords in search results are highlighted

Usable navigation of past reg versions and comparisons between versions (timeline / history)

  • Ability to view a past version of a regulation
  • Ability to compare a reg part from one past date to another (including comparing to the present version)
  • For any past or current version you're looking at, you can access a link to the Final Rule (including preamble) that gives context for that version in the Federal Register
  • You can see the number of differences counted up for you
  • You can go to the next difference
  • The left nav table of contents includes indicators for subparts and sections that have changed
  • You're able to view a reg part as it was effective on a past date, using the annual editions (the official data from the GPO) plus data from eCFR (monthly)

Maybe:

  • We tell the user when there is a final rule that has content that will become effective in the future for the part they're looking at

Helpful and accurate cross-reference links (basic)

  • When reg text says a reference to a piece of reg that eRegs contains, it links you to it within eRegs (part, section number, and paragraph or subparagraph, like (a)(1)) - not considering ranges
  • In reg end-of-section citations, Federal Register notice citations links you to the Federal Register website
  • When reg text says a reference to a piece of reg that eRegs does not contain, it links you to that piece of reg in eCFR (just part and section number)
  • Basic tooltips for links

Helpful site homepage

  • The homepage has customizable content areas (separate from the list of parts)
  • The homepage displays a list of parts that are within eRegs
  • The homepage displays an automated list of recent changes (recent rules) and proposed changes affecting the in-scope parts

Out of scope

Full cross-referencing

Sophisticated search

  • Display search results as a hierarchy according to part and section number
  • Search is able to search for simple synonyms for your keyword (such as the full version of an abbreviation), drawing from an existing source of data
  • Search is able to search for fuzzy synonyms for your keyword (such as multiple alternate phrases), drawing from an existing source of data [thesaurus]
  • Search results display hand-written additional material (such as "related searches"), in addition to keyword results [thesaurus]
  • Search box has type-ahead search suggestions, drawing from an existing source of data [thesaurus]
  • Search results display semi-automated additional material (such as "related searches") from a different source, in addition to keyword results
  • When you click a search result, your search term remains highlighted on the content page (and the highlights can be dismissed)
  • When you're in search, there's a "Back to Regulation Text" button that tracks where they were coming from
  • If search tracks where you come from, the search results page includes the context AND the left sidebar is collapsed by default

Extended reg range

  • Regulations outside Title 42 relevant to Medicaid and CHIP (such as Title 45 Part 95)

Findability

  • Site is optimized to show up at the top of Google results for reg citation searches

Keep track of things (lightweight)

  • eRegs tracks and keeps a list of where you've been and helps you get back to what you've seen (local history, no auth)
  • People can add lightweight "bookmarks" for reg pieces (saved locally)

Reg timeline includes full granular detail

  • You're able to view a reg part as it was effective on a past date, on a rule-by-rule granular level, using the annual editions plus parsing changes in Federal Register rules

Reg timeline includes proposed and future-effective rules

  • We tell the user when there is a proposed change that affects the part they are viewing (including a link to the NPRM)
  • Ability to view final but future-effective versions and compare them within eRegs
  • Ability to view proposed versions and compare them within eRegs

Sharing

  • There's a way to copy the text of a piece of reg with one click. When you paste that text from eRegs to Outlook desktop email on Windows, it looks reasonable (to the degree we're able to control this).
  • There's a way to copy a link to a range of paragraphs
  • When people share a link to eRegs on a tool like Slack, there's a meaningful snippet of content
  • When you're looking at a piece of reg content, you see labels telling you the citation style info for what you're looking at in a way you can copy-and-paste (subpart, part, section)

Easy-to-use authoring for all custom content

  • Including custom content on reg part homepages

Definitions

  • Each part can have a set of definitions data (terms that should be defined and the paragraphs they should link to)
  • There is a way to author the definitions data (to select the terms that should be defined and the paragraphs they should link to)
  • A definition inline links to its source location in the reg content (a specific paragraph from the definitions list within the reg)
  • A definition inline presents a preview of its text

Thesaurus

  • We display a list of the custom content we use to power our thesaurus in search (groups of terms + regs they are associated with), as a reference and to support oversight

Teaching people to use CMCS regs

  • The homepage provides a plain language description for each part
  • There is unobtrusive inline/embedded content throughout eRegs that provides tips to help new reg readers learn how to use regs, such as explaining NPRMs, Reserved, etc
  • We offer recorded video demos of how to do various tasks with eRegs

Authenticated personal experience

  • Add annotations to pieces of reg text
  • Label pieces of reg text with personal keywords and view by label
  • Tracked history and bookmarked regs are persistent, not dependent on local storage

Overview

Data

Features

Decisions

User research

Usability studies

Design

Development

Clone this wiki locally