eAPD icon indicating copy to clipboard operation
eAPD copied to clipboard

Content Review of the Example Box Text

Open beparticular opened this issue 2 years ago • 6 comments

A full content review of the example boxes should be conducted to ensure that the use of the example box is consistent across the system. Currently the example box contains examples, instructions, help text, etc.

The example boxes in their current state are documented in Figma: https://www.figma.com/file/6eVvo7JjvXiovGTR4BoVgK/CMS-eAPD-2022?node-id=8480%3A26175

This task is done when...

  • [X] Determine if the content is “help text” or other text that is not an example (Done in #3070)

  • [ ] Determine if an example really needed where one is given or not given

  • [ ] If so, leave the example as is if it's the correct information.

  • [ ] If so, create examples if they don’t exist and are needed

  • [x] Determine if we wanted to use something standard from the design system as the example box, vs the custom box that appears now.

  • [ ] Determine if we'd move the help text elsewhere in the section, or would we reduce or rewrite the help text (rewrites should be given their own ticket if it is determined any are needed)

  • [ ] Should we have components or styles for the following: Help Text, Directives, Policy Information, Examples, etc (If so, this should be broken out into a new ticket)

beparticular avatar May 13 '22 15:05 beparticular

Below is a list of our current example boxes some of example boxes. I am currently making a google sheet with this list with a column does it need to be changed for mmis (yes or no) and is it consistent with our pattern. I feel like that might be a good way to do a content review.

  1. APD Overview : HIE Overview Screen Shot 2022-10-05 at 2.57.13 PM.png
  2. Key State Personnel : Key Personnel & Program Management Screen Shot 2022-10-05 at 2.58.57 PM.png
  3. Activity Overview: Statement of alternative considerations and supporting justification Screen Shot 2022-10-05 at 3.01.37 PM.png
  4. Outcomes and Milestones Screen Shot 2022-10-05 at 3.02.31 PM.png
  5. State Staff and Expenses : State Staff + Other State Expenses Screen Shot 2022-10-05 at 3.04.01 PM.png Screen Shot 2022-10-05 at 3.04.38 PM.png
  6. Private Contractor Costs Screen Shot 2022-10-05 at 3.06.59 PM.png
  7. Cost Allocation: Cost allocation + Description of Cost Allocation Methodology Screen Shot 2022-10-05 at 3.08.29 PM.png Screen Shot 2022-10-05 at 3.08.36 PM.png

akuas avatar Oct 05 '22 18:10 akuas

@jeromeleecms @SGilliamA1M Below is the google sheets I will be working on. It is still in progress, so Ill add more as I review the example boxes https://docs.google.com/spreadsheets/d/1JL52hfdn0cIh1BRkEAYW6-gt3h2vVVCdCFdBTPE1BlY/edit?usp=sharing

akuas avatar Oct 05 '22 19:10 akuas

After reviewing the example boxes, here are my thoughts of what we should do for some of the example boxes. @jeromeleecms @SGilliamA1M Example boxes going away with MMIS:

  1. HIE Overview
  2. Statement of alternative considerations and supporting justification
  3. Estimated Quarterly Expenditure

Proposed example box removal because I feel they are not needed:

  1. Cost Allocation: "Include any participating non-Medicaid FTEs"
  2. Cost Allocation: Description of cost allocation methodology

Examples that could be moved to help text:

  1. Other state expenses : The miscellaneous expenses example can be moved inside the subform as a tooltip or hint text
  2. Private Contractor costs: Could replace existing help text for that section

akuas avatar Oct 14 '22 18:10 akuas

@jeromeleecms Can you please let me know whether you agree about the proposed example box removal and examples that should be help text via zenhub comment? Also, if you have some recommendations on how we could reword some of the examples to appear more like an example than a directive, can you please post a comment on the Figma example box page with your copy changes. You can diregard the examples that fall under the category example boxes going away with MMIS

akuas avatar Oct 14 '22 18:10 akuas

  1. APD Overview: HIE Overview: Yes, OK to remove
  2. Key State Personnel: Key State Personnel & Program Management: Yes, keep and revise example
  3. Activity Overview: Alternative Considerations: Maybe tricky to provide a good example using our format. These can be quite long -- maybe consider how we can incorporate this into the help text
  4. Outcomes and Milestones: Outcomes and Metrics: Yes, keep. Let's use the examples from the outcomes and metrics GitHub page.
  5. State Staff and Expenses: State Staff: Yes. Let's consider how to revise language.
  6. State Staff and Expenses: Other State Expenses: We could potentially expand the dropdown as well to remove the number of examples needed for Misc. Expenses. Will need to consider what we can add, but State Medicaid Director Letter 16-004 can give us some options.
  7. Private contract costs: Yes, keep. Let's revise the copy.
  8. Cost Allocation: We need to keep, but revise the examples.

Will make comments in the Figma page in a moment.

jeromeleecms avatar Oct 19 '22 16:10 jeromeleecms

Comments in the Figma added + some questions. Let me know if you want to talk through them.

jeromeleecms avatar Oct 19 '22 19:10 jeromeleecms

@SGilliamA1M Below are the updated copy for the activities dashboard and outcome and metrics. @jeromeleecms What do you think about providing examples about how an activity can be broken up instead of a list of activities? https://www.figma.com/file/hJpKHKU6fz5J0Z7fisSwa2/eAPD-MMIS-2022?node-id=1714%3A14215 https://www.figma.com/file/hJpKHKU6fz5J0Z7fisSwa2/eAPD-MMIS-2022?node-id=1714%3A14214

akuas avatar Oct 27 '22 16:10 akuas

@SGilliamA1M Below are the updated copy for the activities dashboard and outcome and metrics. @jeromeleecms What do you think about providing examples about how an activity can be broken up instead of a list of activities? https://www.figma.com/file/hJpKHKU6fz5J0Z7fisSwa2/eAPD-MMIS-2022?node-id=1714%3A14215 https://www.figma.com/file/hJpKHKU6fz5J0Z7fisSwa2/eAPD-MMIS-2022?node-id=1714%3A14214

akuas avatar Oct 27 '22 16:10 akuas

I created 4380 to redesign the example boxes and 4381 to update the mmis designs with the example copy rewrites done in this ticket

akuas avatar Oct 27 '22 16:10 akuas

@jeromeleecms @SGilliamA1M Can you please review this ticket? If we are good on the outcome and metrics and activities dashboard, I think we are good to close for this ticket. We might have a greater perspective on what to do with example boxes like other state expenses when we work on that page or on 4381.

akuas avatar Oct 27 '22 16:10 akuas

Itemized example boxes looks good and okay to close @jeromeleecms

SGilliamA1M avatar Oct 31 '22 18:10 SGilliamA1M

@akuas Added some follow-up comments, please take a look at let me know if you have questions. But once we sort through that, I think this is good to go as well.

jeromeleecms avatar Oct 31 '22 19:10 jeromeleecms

@jeromeleecms I made changes to the copy based on your suggestions. So, I think this is good to close.

akuas avatar Nov 02 '22 19:11 akuas

This is done. Refer to the comments in Figma for final closing remarks.

jeromeleecms avatar Nov 03 '22 17:11 jeromeleecms