[TEST] TWE: IS24: RP025: Research Roadmap: Update/Create

[jinyan0425]

Research Roadmap Update/Creation Template

---

name: TWE: Template Issue: Research: Create or Update Research Roadmap Details
about: This issue helps you structure your template issue to be consistent with our other template issues in research roadmap creation or updates
title: TWE: Research: RP025: Other Research Roadmap: Create/Update
labels: 'feature: research', 'feature: research roadmap', 'Participant Type: missing', 'Research 000: missing', 'size: 1pt', 'role: UI/UX research', 'milestone: missing', 'complexity: medium'
assignees: ' '

---

Dependencies

• A research setup structure (wiki, GitHub labels, Google Drive, etc.) has been created and approved TWE: Research Structure for Negative Research Experience Survey: Set up #548. Use this URL to search the issue tab for potential results
• TWE: Create Research Roadmap: Other #327 If there is an existing roadmap issue for Other, Use this URL to search the issue tab for potential results

Overview

We need to update the details of the Other Research Roadmap for RP025 so that the high level overview captures why we are doing all the research plans with this user group.

During these tasks you will be asked to add link to the Resources/Instructions section, and that section is at the bottom of this issue (go view it now).

Action Items

Customize Resource Links

• Customize Resource for Wiki Page Links
  • Go to the wiki page: Research Output Overview (Resources # 1.01)
  • Open relevant wiki page for Other
  • Copy the link for the Other wiki page in your browser
  • In Resources # 2.01, place the link you just copied between parentheses at the end of the line with no space in between the right bracket ] and the left parenthesis (, so it turns into a hyperlink
  • Choose "Update comment" in Github and make sure all the checkboxes above have been checked
  • Go to Other Research Overview wiki page (Resources # 2.01)
  • Open relevant wiki page for RP025
  • Copy the link for the RP025 wiki page in your browser
  • In Resources # 2.02, place the link you just copied between parentheses at the end of the line with no space in between the right bracket ] and the left parenthesis (, so it turns into a hyperlink
  • Choose "Update comment" in Github and make sure all the checkboxes above have been checked
• Customize Resource for Google Drive Folder by Participant Type
  • Choose the "Research by Participant Type" folder on the shared Google Drive (Resources # 1.02)
  • Choose Other folder
  • Copy the link of the Other folder
    1. Choose the three vertical dots on the right side of the Other folder
    2. Choose "Share"
    3. Choose "Copy link"
  • In Resources # 2.03, place the link you just copied between parentheses at the end of the line with no space in between the right bracket ] and the left parenthesis (, so it turns into a hyperlink
  • Choose "Update comment" in Github and make sure all the checkboxes above have been checked
• Customize Resource for Other Research Roadmap doc
  • Open the Other folder (linked in Resources # 2.03)
  • Locate TWE: Research Roadmap: Other Google doc in the folder
  • Copy the link of the TWE: Research Roadmap: Other Google doc
    1. Choose the three vertical dots on the top right side of the TWE: Research Roadmap: Other Google doc
    2. Choose "Share"
    3. Choose "Copy link"
  • In Resources # 2.04, place the link you just copied between parentheses at the end of the line with no space in between the right bracket ] and the left parenthesis (, so it turns into a hyperlink
  • Choose "Update comment" in Github and make sure all the checkboxes above have been checked

Check & Fix Research Roadmap Document Formatting

• Review File Name
  • Open the roadmap document (linked in Resources # 2.04)
  • Confirm that the document uses the following naming convention: TWE: Research Roadmap: Other. If it does not follow that format, change the filename to match the project's naming convention.
• Compare Document Headings
  • With the roadmap document open in one tab (linked in Resources # 2.04), open in another tab the TWE: Template: Research Roadmap (linked in Resources # 1.03)
  • Click inside the roadmap document (linked in Resources # 2.04) and scroll through the document to determine whether the document contains the same headings as the research roadmap template (linked in Resources # 1.03).
• Adjust Incorrect Document Headings
  • If the document does not have the correct headings, then adjust the headings according to the template.
    • Check that each major heading is formatted as Header 1.
    • To check formatting, place your cursor inside the heading text and look at the Styles dropdown menu next to the Font dropdown menu. If it needs adjusted, select the entire heading text and choose "Header 1" in the Styles dropdown menu.
  • Check off the items below as you review their formatting (a check mark indicates that you've reviewed the item regardless of whether you fixed it or not).
    • Background
    • Other Research Goals and Objectives
    • Participants
    • Research Framework and Methodologies
    • Individual Research Plans
      • Research Plan Section Titles (see specific instructions in the next section)
    • Resources
    • Notes
• Review Research Plan Names and Formatting
  • Confirm that all the research plans section titles are named in RP000: [TITLE OF RESEARCH] format.
  • Confirm each research plan name in the research roadmap document is correct by checking Other Research Output Overview page (linked in Resources # 2.01). If they need to be adjusted, fix them according to how they are named in the Research Output Overview page (linked in Resources # 2.01) or ask the UXR lead if there is no corresponding wiki page.
  • Confirm that the research plan names are formatted as Header 2 in the document heading options.
    • To check, place your cursor inside the heading text and look at the Styles dropdown menu next to the Font dropdown menu. If it needs adjusted, select the entire heading text and choose "Header 2" in the Styles dropdown menu.
  • Confirm research plan's subsection has the following sections
    • Goals
    • Requirements
    • Timelines
    • Delivery
    • Follow-up Options
    • Research Analysis
  • Confirm research plan's subsection are formatted as Header 3.
    • To check, place your cursor inside the heading text and look at the Styles dropdown menu next to the Font dropdown menu. If it needs adjusted, select the entire heading text and choose "Header 3" in the Styles dropdown menu.

Update and/or create research roadmap details for Other and RP025

• Update Overview Sections
  • If the Other research roadmap overview sections have been drafted, please review and revise the general overview of research roadmap as necessary.
    • Compare the Other Research Roadmap against the Other Research Overview Wiki Page (linked in Resources # 2.01). If you notice any discrepancy, please inform the team about the discrepancy in the Other Research Roadmap by inserting a comment in the Google doc.
    • Read through the following sections to see if they make sense. Check for typos, completeness, and general formatting as you read through each section. If you think the content should be revised, please use "Suggesting Mode" to suggest revisions. If you have questions or concerns, please insert comments in the Other Research Roadmap Google doc for the UX Research Lead to review.
      • Background about the project/product.
      • Research goals and/or objectives of the type of research.
      • Summary of the target participants.
      • Research framework and methodologies.
  • If the Other research roadmap has not been drafted, please fill out the overview sections of the research roadmap by following the steps
    • Open the Research Roadmap for Other if it is not open in your browser (Resources # 2.04)
    • Make sure the structure and format of a research roadmap stays consistent. Check Research Roadmap Template (linked in Resources # 1.03) or Report Template - Roadmap Overview below Resources for the structure of the roadmap overview sections if needed.
    • Go to Other Research Overview wiki page (Resources # 2.01) to gather information
    • Refer to an existing research roadmap as an example for the research roadmap overview you are creating (Resources # 1.04)
    • Fill out the overview sections of Other research roadmap based on the information you gathered
      • Background
      • Other Research Goals and Objectives
      • Participants
      • Research Framework and Methodologies
• Update Research Plan Section
  • If the research roadmap for RP025 has been created, please review and revise each subsection under the RP025's research roadmap as necessary.
    • Compare the RP025's research roadmap subsections against the RP025's wiki page (linked in Resources # 2.02). If you notice any discrepancy, please inform the team about the discrepancy in the RP025's research roadmap by inserting a comment in the Google doc.
    • Read through each section to see if they make sense. Check for typos, completeness, and general formatting as you read through each section. If you think the content should be revised, please use "Suggesting Mode" to suggest revisions. If you have questions or concerns, please insert comments in the RP025 Research Roadmap Google doc for the UX Research Lead to review.
      • Goals
      • Requirements
      • Timelines
      • Delivery
      • Follow-up Options
      • Research Analysis
  • If the research roadmap for RP025 has not been created, please fill out the research roadmap for RP025 by following the steps
    • Open the Research Roadmap for Other if it is not open in your browser (Resources # 2.04)
    • Identify the placement of RP025's research roadmap in the ascending sequence in the Google doc
    • Make sure to copy the structure and format of a research plan's research roadmap to keep the documentation consistent. Copy Report Template - Research Plan below Resources to the research roadmap Google Doc if needed.
      • Rename the research plan title RP???: Research Plan Name with RP025: Negative Research Experiences Survey
      • Apply formatting to RP025: Negative Research Experiences Survey
        • Apply "Header 2" in section title RP025: Negative Research Experiences Survey
        • Apply "Header 3" to all the subsections: Goals, Requirements, Timelines, Delivery, Follow-up Options, and Research Analysis
    • Go to RP025's wiki page (Resources # 2.02) to gather information
    • Refer to an existing research roadmap as an example for the research roadmap overview you are creating (Resources # 1.04)
    • Fill out the research roadmap for RP025 based on the information you gathered
      • Goals
      • Requirements
      • Timelines
      • Delivery
      • Follow-up Options
      • Research Analysis
• Update the Resource Section at the end of research roadmap Google doc
  • Check the final sections (Resources and Notes) to see if they are updated, have functional links, and do not include redundant information.
    • In the Resources section, double check that links to the individual research plans are accurate and complete according to the Overview wiki page (Resources # 2.01).
• Go to the Table of Contents of Other Research Roadmap document once you finish revising or updating the research roadmap draft
• Update the Table of Contents by clicking on the circle icon

Next steps

• Discuss and review the research roadmap document at the next meeting
• Make new issues for research plan(s) under the Other Research Roadmap if the research plan issue hasn't been created yet
  • Include this issue as the dependency in the newly created research plan issue
• Product sign-off
  • Research roadmap Google doc (Resources # 2.04)
  • New issues created for research plan(s) under the Other Research Roadmap
• Release the research plan issue when this issue is closed

Resources/ Instructions

Resources for creating this issue

1.01 Wiki: Research Output Overview
1.02 Google Drive Folder: Research by Participant Type
1.03 TWE: Template: Research Roadmap
1.04 TWE: Research Roadmap: Interns
1.04.01 Individual Research Plan Roadmap Example: RP001
1.04.02 Individual Research Plan Roadmap Example: RP006

Resources gathered during the completion of this issue

2.01 Wiki Other Research Overview Page
2.02 RP025 Wiki Page
2.03 Other Google Drive Folder
2.04 TWE: Research Roadmap: Other

Report Template - Roadmap Overview

- [ ] Background
- [ ] Other Research Goals and Objectives
- [ ] Participants
- [ ] Research Framework and Methodologies
- [ ] Resources
- [ ] Notes

Report Template - Research Plan (each RP in the roadmap should be in the same structure and format)

- [ ] RP025: Negative Research Experiences Survey
   - [ ] Goals
   - [ ] Requirements
   - [ ] Timelines
   - [ ] Delivery
   - [ ] Follow-up Options
   - [ ] Research Analysis 

[jinyan0425]

@pandanista

Hi Ying, I will comment on the Research Roadmap Update/Creation Template in this comment. It is developing.

1. [MINOR] We may change the label feature: research roadmap to feature: roadmap to match the actual label.

2. [MINOR] The action item below is easy for experienced HfLA researchers to follow. But new researchers may feel difficult to locate the specific RP folder on the Research Output Overview page. Shall we add one more step such as Choose 'Research Plans, sorted by number'

• Choose the appropriate research roadmap or research plan folder (ie., RP###) on the wiki page

3. [MAJOR] Does the action below mean to remove [TEST] in the title?

• Update the issue title
  - [ ] Copy
  TWE: IS[Replace YY]: RP[Replace 000]: Research Roadmap: Update/Create

4. [MINOR] Due to migration, Project Management no longer exists in the Repository. Instead, it is TWE: Project Board.

• Under Projects, choose gear , choose Repository, and choose Program Management

5. [MINOR] The action item below: Above "Dependencies" or "Overview"?

• After all the checkboxes above are complete and the issue is ready to be worked on, delete all text below the "Instructions for Creating this Issue" (top heading) and above "Overview" (heading below) -- i.e., the issue assignee will never see this part

6. [MAJOR] For the section Dependencies:

   1. Shall the assignee tick the two action items after replacing the links?
   2. Shall the assignee remove the instruction texts, such as "If there is an existing roadmap issue for Other, Use this URL to search the issue tab for potential results", and
   3. What if the requested issues and links have not been created? There are no instructions for this scenario.

7. [EPIC] I need more information to draft the overview sections for Other research roadmap because Resource # 2.01 Wiki Other Research Overview Page provides little information. Or this instruction means that I should read through all RPs for Other and then summarize?

• Fill out the overview sections of Other research roadmap based on the information you gathered

8. [EPIC] Similar for drafting the details for the RP025's research roadmap. I can draft the research summary based on Resource # 2.02 RP025 Wiki Page but the information for timeline, delivery, and requirements are limited.

• Fill out the research roadmap for RP025 based on the information you gathered

9. [MINOR] Resource # 1.04 TWE: Research Roadmap: Interns lacks the sub-title (level 1 heading): Individual Research Plans

[pandanista]

@pandanista

Hi Ying, I will comment on the Research Roadmap Update/Creation Template in this comment. It is developing.

1. [MINOR] We may change the label feature: research roadmap to feature: roadmap to match the actual label.

• Good catch. We should update using feature: roadmap since we don't have feature: research roadmap, but let's check in with product to make sure the feature: roadmap label is intended for research roadmaps.

2. [MINOR] The action item below is easy for experienced HfLA researchers to follow. But new researchers may feel difficult to locate the specific RP folder on the Research Output Overview page. Shall we add one more step such as Choose 'Research Plans, sorted by number'

• Choose the appropriate research roadmap or research plan folder (ie., RP###) on the wiki page

• Sure, that makes sense. Edited in the template.

3. [MAJOR] Does the action below mean to remove [TEST] in the title?

• Update the issue title
  • Copy
    TWE: IS[Replace YY]: RP[Replace 000]: Research Roadmap: Update/Create

• Not in this case since we are testing the template.
• When the template is deployed, then the [test] won't be needed. That's why it didn't have [test] in the template.

4. [MINOR] Due to migration, Project Management no longer exists in the Repository. Instead, it is TWE: Project Board.

• Under Projects, choose gear , choose Repository, and choose Program Management

• Edited in the template.

5. [MINOR] The action item below: Above "Dependencies" or "Overview"?

• After all the checkboxes above are complete and the issue is ready to be worked on, delete all text below the "Instructions for Creating this Issue" (top heading) and above "Overview" (heading below) -- i.e., the issue assignee will never see this part

• It should be "Dependencies". Edited in the template.

6. [MAJOR] For the section Dependencies:

   1. Shall the assignee tick the two action items after replacing the links?
   2. Shall the assignee remove the instruction texts, such as "If there is an existing roadmap issue for Other, Use this URL to search the issue tab for potential results", and
   3. What if the requested issues and links have not been created? There are no instructions for this scenario.

• 1. Either the assignee or the person who assigns the issue should tick the two action items.
• 2. Ideally yes after the issue links are included in the Dependencies. For example, they can add the issue number where it says [REPLACE WITH RESEARCH ROADMAP ISSUE #], and they can remove the instruction texts. However, if the instruction texts are not removed, that is okay since it doesn't affect the process or the results.
• 3. If the requested issues and links have not been created, then it means at least one action item has not been ticked, which indicates it is the blocker. In that case, a new issue to tackle the dependency needs to be created, and this issue needs to be put into the icebox.
• If there are better ways to phrase the process, please do share.

7. [EPIC] I need more information to draft the overview sections for Other research roadmap because Resource # 2.01 Wiki Other Research Overview Page provides little information. Or this instruction means that I should read through all RPs for Other and then summarize?

• Fill out the overview sections of Other research roadmap based on the information you gathered

• I hear you, and we can discuss it more on the overview section of Other research roadmap. For now, we are just setting up the structure so Sandy could fill out the information on RP025.

8. [EPIC] Similar for drafting the details for the RP025's research roadmap. I can draft the research summary based on Resource # 2.02 RP025 Wiki Page but the information for timeline, delivery, and requirements are limited.

• Fill out the research roadmap for RP025 based on the information you gathered

• That is also for Sandy. :)

9. [MINOR] Resource # 1.04 TWE: Research Roadmap: Interns lacks the sub-title (level 1 heading): Individual Research Plans

• I added 1.04.01 and 1.04.02 as examples to demo the individual research plan roadmap based on your suggestion. Would that be sufficient?
• 1.04.01 Individual Research Plan Roadmap Example: RP001
• 1.04.02 Individual Research Plan Roadmap Example: RP006

[pandanista]

@doctorsandy Hi Sandy, the RP025's research roadmap issue has been created and edited, so it is now ready for you to fill out the research roadmap info.

• The RP025's research roadmap document has been set up, please check Resources 2.04.
• The unchecked action items circled in the screenshot under the "Update Research Plan Section" is the part we need your help with.
• Example for individual research plan's roadmap documents can be found in Resources 1.04 (See 1.04.01 and 1.04.02).

Thank you, and let me know if you have any questions.

[jinyan0425]

Hi All, @pandanista @doctorsandy @bonniewolfe:

I summarized Sandy's inputs for the RP025 roadmap to be more concise and aligned with the other RP roadmaps. **All of my inputs are in green (suggesting mode). Sandy (@doctorsandy), could you please review it and let me know if any updates are needed. Please do not delete what you've written as they will be used in developing the research plan.

I wasn't able to complete the section because roadmaps for other RPs under "Other Research" (e.g., RP003, RP004, RP005, RP021) have not been created yet. The wiki page for "Other Research" also lacks information I can reference. I assume this section is supposed to summarize general information for all "Other Research" plans, not just RP025. @pandanista @bonniewolfe

• Fill out the overview sections of Other research roadmap based on the information you gathered
  • Background
  • Other Research Goals and Objectives
  • Participants
  • Research Framework and Methodologies

Additionally, I have created the new issue for creating the research plan:

• TWE: IS24: RP025: Research Plan: Create #614 ? @pandanista @bonniewolfe

Thank you all!

[pandanista]

@sunannie27 and @KC-skc:

• Please give us a thumbs up if you will be review this issue, Research: Test: Issue Template: Research Roadmap Update/Creation #605, and TWE: Create Template Issue: Create or update research roadmap details  #450.

  • TWE: Create Template Issue: Create or update research roadmap details  #450 is step 1 and 2b, the template draft.
  • Research: Test: Issue Template: Research Roadmap Update/Creation #605 is step 2a, the testing template that set up the template test.
  • [TEST] TWE: IS24: RP025: Research Roadmap: Update/Create #606 is step 3, the template test.

• The research roadmap:update/Create template has finished the testing using RP025.

• RP025's research roadmap document has been reviewed and approved by Bonnie and Tim.

• Let me know what you think. Once approved, we can deploy the template in the repo.