TWE: Research: Review Roadmaps: Make Issues

[bradyse]

Dependencies

Approved Roadmap Documents

• TWE: Create Roadmap for Mentor Research #208
• TWE: Create Roadmap: Intern Research #309
• TWE: Research Roadmap: TWE Volunteers #304
• TWE: Create Research Roadmap Other HfLA Team #328
• TWE: Create Research Roadmap: Other #327

Overview

We need to make an epic issue that tracks all the updated research roadmap Google docs so that we have a way to track which research plan roadmap details need to be updated. Once a roadmap document has been updated and approved, this will also help identify which research plans are ready to be written.

Action Items

• Define what the action items are for the issues that will help finish the roadmaps
• Test issue template for TWE: Research: Review Roadmap & Identify what needs improving: [Replace TYPE OF PARTICIPANT] (in comment below)
• Approve test issue and upload to repo.
• Create new issues for the following roadmap types
  • TWE: Research: Review Roadmap & Identify what needs improving: Mentor
  • TWE: Research: Review Roadmap & Identify what needs improving: Intern
  • TWE: Research: Review Roadmap & Identify what needs improving: TWE team member (volunteer)
  • TWE: Research: Review Roadmap & Identify what needs improving: Other HfLA Teams
  • TWE: Research: Review Roadmap & Identify what needs improving: Other
  • TWE: Create Roadmap: Partners
• Customize the Review Roadmap & Identify what needs improving issues with the wiki page for that type by finding the link on the Research Output Overview wiki page
• UXR lead makes an epic issue for each research type to track the roadmap completion progress (use Create Roadmap Details template issue for missing research plan information).
  • TWE: Research: Update Roadmap: Mentor
  • TWE: Research: Update Roadmap: Intern
  • TWE: Research: Update Roadmap: TWE team member (volunteer)
  • TWE: Research: Update Roadmap: Other HfLA Teams
  • TWE: Research: Update Roadmap: Other
  • TWE: Research: Update Roadmap: Partners

Action Items for issues TWE: Research: Review Roadmap & Identify What Needs Improving

See draft below in a comment

Resources/Instructions

1. Google Drive, Research Folder
2. TWE: Template: Research Roadmap
3. [[replace with TYPE] Research Overview Wiki Page]
4. [TWE: Research Roadmap: [replace with TYPE]]

[ExperimentsInHonesty]

Draft of TWE: Research: Review Roadmap & Identify What Needs Improving: [Replace TYPE OF PARTICIPANT]

labels: Participant Type: missing, feature: research, feature: roadmap, role: UI/UX research, size: 1pt

---

Dependencies

• A roadmap Google document for [Replace TYPE OF PARTICIPANT] has been created.

Overview

We need to locate, review, and identify missing or inaccurate information in the roadmap for [Replace TYPE OF PARTICIPANT] so that we can develop a plan for revising or updating this roadmap.

Action Items

Customize the Issue

• Copy and paste entire template in this issue into text editor (ie., "TextEdit" on Mac, "Wordpad" on PC)
• Use Search/Replace (Mac: ⌘+F or PC: Ctrl+F) to search for [Replace in order to replace the keyword strings (including text and brackets) below with the appropriate values.
  • Type of Participant
    • Replace the participant type (e.g., "Intern") with Replace TYPE OF PARTICIPANT]
  • If you see [Replace text inside other areas of the template, this is because these are inside template ``` marks that will be replaced later.
• Copy and paste the edited template from text editor back into this Github Issue, replacing all original text
• Re-check all the checkboxes above after copying and pasting the edited template
• Close the text editor

Customize Resource Links

• Customize Resource for Wiki Page Link
  • Go to the wiki page: Research Output Overview (# 1.01 link in Resources)
  • Find relevant overview page for [Replace TYPE OF PARTICIPANT] under the heading Research Documents by overview type
  • Copy the link for the wiki overview page.
  • Update Resource # 2.01 with the link you just copied. Place it into parentheses at the end of the line.
• Customize Resource for Google Drive Folder by Type
  • Open the Google Drive's Research folder (# 1.02 link in Resources)
  • Open the folder 1. Research by Type
  • Right click on the [Replace TYPE OF PARTICIPANT] folder and copy the link
  • Update Resource # 2.02 with the link you just copied. Place it into parentheses at the end of the link.
• Customize Resource for Roadmap Google Doc
  • Open the Google Drive folder by Type (# 2.02 link in Resources that you just copied and pasted)
  • Right-click on the roadmap document and copy the link
  • Update Resource # 2.03 with the link you just copied. Place it into parentheses at the end of the link.

Check & Fix Document Formatting

• Review File Name
  • Open the roadmap document (link # 2.03 that you just copied and pasted)
  • Confirm that the document uses the following naming convention: TWE: Research Roadmap: [TYPE]. 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 (link # 2.03), open in another tab the TWE: Template: Research Roadmap (link # 1.03)
  • Click inside the roadmap document (link # 2.03) and scroll through the document to determine whether the document contains the same headings as the template (link # 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
    • [Type] Research Goals and Objectives
    • Participants
    • Research Framework and Methodologies
    • Individual Research Plans
      • Research Plan Section Titles (see specific instructions below)
    • Resources
    • Notes
• Review Research Plan Names
  • Confirm that all the research plans section titles are named RP000: [NAME OF RESEARCH]. If they need adjusted, fix them according to how they are named in the Research Output Overview page (link # 1.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.

Recording Sections that Need Improvement

• Review Overview Sections
  • Review the overview items for boilerplate language or information that does not make sense.
  • If any of the overview items had boilerplate or did not make sense, record which items need updating using the following steps.
    • Copy the Report Template - Roadmap Overview (below Resources) and paste into a comment.
    • As you review the document, check off the areas of the document in the overview that needs fixed.
• Resource Section (at end of doc)
  • Check the final sections (Resources and Notes) to see if they are updated, have functional links, and do not include redundant information.
    • Record the areas that needs fixed in the Report Template - Roadmap Overview that you copied and pasted into a comment.
    • In the Resources section, double check that links to the individual research plans are accurate and complete according to the Overview wiki page (link # 2.01).
• Research Plan Section
  • Compare document individual research plan sections against the Overview by Type wiki page (link # 2.01) and note discrepancies in your issue.
  • Each individual research plan section has the following sections, with Header 3 formatting. Identify and record which sections of the roadmap document have boilerplate text that needs to be replaced by copying the Report Template - Research Plan and creating a comment on this issue (below Resources):
    • Goals
    • Requirements
    • Timelines
    • Delivery
    • Follow-up Options
    • Research Analysis
  • Read through any sections that are finished to see if they make sense. Check for typos, completeness, and general formatting and make a note in your report comment. Remember to avoid fixing each and every problem, as that is not part of this issues' action items. The goal is to document what needs fixed.

Next steps

• Bring to UXR Team meeting for UXR lead to review.
  • Lead will direct you to make new issues for each Research Plan that is not properly documented in the Roadmap
• Create issues using the issue template titled "Research: Create Roadmap Details" (link # 1.04 in Resources)

Resources for creating this issue

1.01 Wiki: Research Output Overview
1.02 Google Drive, Research Folder
1.03 TWE: Template: Research Roadmap
1.04 Issue Template: Research: Create Roadmap Details

Resources gathered during the completion of this issue

2.01 [Wiki: [Replace TYPE OF PARTICIPANT] Research Overview]
2.02 [Google Drive Folder: [Replace TYPE OF PARTICIPANT]]
2.03. [TWE: Research Roadmap: [Replace TYPE OF PARTICIPANT]]

Report Template - Roadmap Overview

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

Report Template - Research Plan (copy as many times as needed for each RP in the roadmap

- [ ] RP[Replace 000] is missing the following info (has boilerplate)
   - [ ] Goals
   - [ ] Requirements
   - [ ] Timelines
   - [ ] Delivery
   - [ ] Follow-up Options
   - [ ] Research Analysis 
     - Add notes about other problems (typos, completeness, and general formatting) or missing info.
     - Avoid spending time fixing the issues. The goal is to document what needs fixed.

[ExperimentsInHonesty]

@bradyse I removed the dependency since all the other issues got closed. And I removed the ready for milestone because you are going to finish the draft and then I will look at it again.

[ExperimentsInHonesty]

Since Sara is only doing planning, this is ready for us to test and see if it needs revision before making a template

[bradyse]

@pandanista @cbutcher318
This draft template (in comment here) should be ready for testing.

Once the draft template is approved, then we can move forward with the rest of the action steps in this issue.

[cbutcher318]

Ready to be tested