Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TEST] TWE: IS22: RP008: Research Roadmap: Update/Create #470

Closed
pandanista opened this issue Oct 2, 2023 · 3 comments
Closed

[TEST] TWE: IS22: RP008: Research Roadmap: Update/Create #470

pandanista opened this issue Oct 2, 2023 · 3 comments
Assignees
Labels
complexity: missing feature: research All issues involving research feature: roadmap feature: template test (step 3) new issue created by assignee of feature: test a template to see if it works without modification Participant Type: Mentor https://github.com/hackforla/internship/wiki/Mentor-Research-Overview PBV: research all issues for the research team Research: RP008 Mentor Intake Interview role: UI/UX research size: 1pt Can be done in 6 hours

Comments

@pandanista
Copy link
Member

pandanista commented Oct 2, 2023

Dependencies

Overview

We need to update the details of the Mentor Research Roadmap for RP008 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 Mentor
    • Copy the link for the Mentor 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 Screenshot 2023-02-21 at 6 47 15 PM
    • Go to Mentor Research Overview wiki page (Resources # 2.01)
    • Open relevant wiki page for RP008
    • Copy the link for the RP008 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 Screenshot 2023-02-21 at 6 47 15 PM
  • 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 Mentor folder
    • Copy the link of the Mentor folder
      1. Choose the three vertical dots on the right side of the Mentor folder Screenshot 2023-10-10 at 5 58 13 PM
      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 Mentor's Research Roadmap doc
    • Open the Mentor folder (linked in Resources # 2.03)
    • Locate TWE: Research Roadmap: Mentor Google doc in the folder
    • Copy the link of the TWE: Research Roadmap: Mentor Google doc
      1. Choose the three vertical dots on the top right side of the TWE: Research Roadmap: Mentor Google doc Screenshot 2023-10-10 at 5 58 13 PM
      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: Mentor. 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
      • Mentor 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 Mentor 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 Mentor and RP008

  • Update Overview Sections
    • If the Mentor research roadmap overview sections have been drafted, please review and revise the general overview of research roadmap as necessary.
      • Compare the Mentor Research Roadmap against the Mentor Research Overview Wiki Page (linked in Resources # 2.01). If you notice any discrepancy, please inform the team about the discrepancy in the Mentor 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. Screenshot 2023-07-20 at 5 17 12 PM If you have questions or concerns, please insert comments in the Mentor 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 Mentor research roadmap has not been drafted, please draft the overview sections of the research roadmap by following the steps
      • Open the Research Roadmap for Mentor 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.
      • If you are unfamiliar with Mentor Research Roadmap, please reach out to UX Research Lead for clarification, and/or bring this issue to the next UXR meeting for further discussion
      • Draft the overview sections of Mentor research roadmap
        • Background
        • Mentor Research Goals and Objectives
        • Participants
        • Research Framework and Methodologies
  • Update Research Plan Section
    • If the research roadmap for RP008 has been created, please review and revise each subsection under the RP008's research roadmap as necessary.
      • Compare the RP008's research roadmap subsections against the RP008's wiki page (linked in Resources # 2.02). If you notice any discrepancy, please inform the team about the discrepancy in the RP008'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. Screenshot 2023-07-20 at 5 17 12 PM If you have questions or concerns, please insert comments in the RP008 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 RP008 has not been created, please draft the research roadmap for RP008 by following the steps
      • Open the Research Roadmap for Mentor if it is not open in your browser (Resources # 2.04)
      • Identify the placement of RP008'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 RP008: Mentor Intake Interviews
        • Apply formatting to RP008: Mentor Intake Interviews
          • Apply "Header 2" in section title RP008: Mentor Intake Interviews
          • Apply "Header 3" to all the subsections: Goals, Requirements, Timelines, Delivery, Follow-up Options, and Research Analysis
      • If you are unfamiliar with RP008, please reach out to UX Research Lead for clarification, and/or bring this issue to the next UXR meeting for further discussion
      • Draft the research roadmap for RP008
        • Goals
        • Requirements
        • Timelines
        • Delivery
        • Follow-up Options
        • Research Analysis
  • Update Resource Section (at the end of research roadmap 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 Mentor Research Roadmap document once you finish revising or updating the draft
  • Update the Table of Contents by clicking on the circle icon Screenshot 2023-07-13 at 4 01 49 PM

Next steps

  • Review with UX Research Lead
    • Lead will direct you to make new issues for each Research Plan that is not properly documented in the Research Roadmap as needed
  • Product Sign-off

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

Resources gathered during the completion of this issue

2.01 Wiki Mentor Research Overview Page
2.02 RP008 Wiki Page
2.03 Mentor Google Drive Folder
2.04 TWE: Research Roadmap: Mentor

Report Template - Roadmap Overview

- [ ] Background
- [ ] Mentor 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)

- [ ] RP008: Mentor Intake Interviews
   - [ ] Goals
   - [ ] Requirements
   - [ ] Timelines
   - [ ] Delivery
   - [ ] Follow-up Options
   - [ ] Research Analysis 
@pandanista pandanista changed the title TWE: IS[Replace YY]: RP[Replace 000]: Research Roadmap: Update/Create TWE: IS22: RP008: Research Roadmap: Update/Create Oct 2, 2023
@pandanista pandanista changed the title TWE: IS22: RP008: Research Roadmap: Update/Create [TEST] TWE: IS22: RP008: Research Roadmap: Update/Create Oct 2, 2023
@pandanista pandanista added Research: RP008 Mentor Intake Interview feature: roadmap feature: research All issues involving research feature: template Participant Type: Mentor https://github.com/hackforla/internship/wiki/Mentor-Research-Overview size: 1pt Can be done in 6 hours role: UI/UX research labels Oct 2, 2023
@sunannie27

This comment was marked as resolved.

@sunannie27
Copy link
Member

For the second bullet point, it's right click, then share then copy link. There's no get link.

@pandanista
Copy link
Member Author

pandanista commented Oct 11, 2023

@sunannie27 Thank you for testing the template. I've incorporated the changes based on the feedback. The template #450 is ready to be reviewed by the project lead.

Closing this issue since we have finished the testing.

@ExperimentsInHonesty ExperimentsInHonesty added feature: template creation (step 1) issue to create a new template (see other labels with test in them) feature: template test (step 3) new issue created by assignee of feature: test a template to see if it works without modification and removed feature: template feature: test feature: template creation (step 1) issue to create a new template (see other labels with test in them) labels Apr 29, 2024
@pandanista pandanista added the PBV: research all issues for the research team label Jun 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
complexity: missing feature: research All issues involving research feature: roadmap feature: template test (step 3) new issue created by assignee of feature: test a template to see if it works without modification Participant Type: Mentor https://github.com/hackforla/internship/wiki/Mentor-Research-Overview PBV: research all issues for the research team Research: RP008 Mentor Intake Interview role: UI/UX research size: 1pt Can be done in 6 hours
Projects
Development

No branches or pull requests

3 participants