-
Notifications
You must be signed in to change notification settings - Fork 10
Content editor user flows
Purpose: Help the team imagine how people could use the content editing system. Not all of these things may be feasible or may need to be supported.
Adding metadata takes time and energy. The promised benefit would be that you (and your coworkers) can find what you're looking for because:
- You don't have to pick just one subject for an item - it can have multiple subjects
- Filter items by date, document type, etc. to reduce the number of items you have to look through
- For finding more specific things that may not be tagged with a subject, we can have full-text keyword search that doesn't take forever
These stories may apply to both eRegs team members and CMCS staff members who would be helping build the repository.
- I want to add internal documents and add metadata to them (subjects, regulation sections, date, title, etc.). Possibilities:
- I want to upload one document.
- I want to upload 10 documents that have different subjects.
- I want to upload 10 documents that all have the same subjects.
- I want to upload a zip file that contains multiple documents. [Ideally we would not need to allow this, just noting that a person may want to do it.]
- I have a URL for an internal content item (on Sharepoint or similar).
- I want to add internal documents with just a file name, and I'll leave it to somebody else to add the metadata.
- I want to edit metadata for an existing internal document (regulation sections, date, title, etc.).
- I want to make sure an internal document is findable, but I don't know whether it's already in eRegs, so I'm not sure whether I should upload it.
- I want to edit the subject matter list.
- I want to edit the document type list.
- I want to edit the states and territories list.
- I want to add or update subjects for an existing public document (a piece of supplemental content or Federal Register document with a URL).
- I want to add a public document and add subjects and other metadata to it (regulation sections, date, title, etc.). Possibilities:
- I have a URL for a supplemental content item.
- I have a URL for a Federal Register item.
- I have a file and I'm not sure whether it's an internal document or public document. I don't know where to find the URL for it.
- I want to update non-subject metadata for a public document (regulation sections, date, title, etc.).
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