-
Notifications
You must be signed in to change notification settings - Fork 10
Categorizing resources
Purpose: Describe how resource categories and subjects work, for reference for developers and designers.
Resources can be assigned to categories and subcategories, which can help users understand what what kind of resource a document is. See the Resources linking page for how this affects content and display of resources.
The top-level categories and subregulatory guidance subcategories should be arranged in order of authoritativeness.
We add and update categories as we work on the content; the following list is an example.
- Statutes
- Federal Register Documents (groups of documents, sorted in date order by the most-recently-published document that each group contains)
- Related Regulations
- Subregulatory Guidance
- State Medicaid Director Letter (SMDL)
- State Health Official Letter (SHO)
- CMCS Informational Bulletin (CIB)
- Frequently Asked Questions (FAQs)
- State Medicaid Manual (SMM)
- Implementation Resources
- State Plan Amendment Resources
- Technical Assistance for States
- Templates
- Toolkits
- Waiver Resources
- Other Resources
Our admin panel enables team members to:
- Create, rename, and delete categories and subcategories
- Associate a subcategory with a parent category
- Add text descriptions for categories, to be displayed under the category name (subcategories don't display descriptions)
- Determine the placement of a category or subcategory in the list, by giving it a numerical value for its order (for example, a category with a weight of "1" would show up first in the list, and a category with a weight of "1000" would show up last)
Resources can also be assigned any number of subjects, which can help users research a topic. See the Resources linking page for how this affects content and display of resources. Subjects do not have a hierarchy. A list of all subjects makes up the sidebar navigation on the Find by Subject page.
Our admin panel enables team members to:
- Create, rename, and delete subjects
- Assign a short name or abbreviation to a subject that people might know by different names
- Add text descriptions for subjects to help editors use them appropriately
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