Research Issue Template: Research Update

[jianwangcat]

Overview

We need to create a template issue for a Research Update, so that we can create a Research Update, when we are ready and maintain consistency with the org (across projects) and the guides project.

Action Items

• [x] copy the text below this item to a new comment

  ## Orginal draft from Resource 1.0

• [x] Copy the example from Resource 1.0 (title and body) and add under the text you just pasted into the new comment and choose the Comment button
• [x] create a new comment
• [x] Edit the prior comment and copy everything from the prior comment into the new comment
• [x] Replace the text ## Orginal draft from Resource 1.0 with

  ## New draft for guides project

• [x] save the comment
• [ ] edit the last comment to customize to this project.
• [ ] review with product
• [ ] add template to template issue gallery

Resources

1.0 Research: Update Guides you through updating the wiki with the research project info

[the-techgurl]

Orginal draft from Resource 1.0

Update [Replace with RP and the number e.g., RP008]: [name of research]

Overview

We need to review and update the wiki page for [Research Plan number and title] so that future HfLA volunteers can replicate our processes.

Action Items

• [ ] Add milestone: 06.01.02 Research Audit and update wiki page
• [ ] Review/Update Research Date
• [ ] Review/Update Summary of Research
  • [ ] Update Research Question
  • [ ] Update Purpose
  • [ ] Update Methods
• [ ] Review/Update Current Status
• [ ] Search all issues to make sure that there are no mislabeled issues.
• [ ] Make sure that the "All Issues" link correctly identifies all issues related to this RP (both open and closed)
• [ ] Review/Update Outstanding task items
• [ ] Review/Update Assets
  • [ ] Review/Update link to Research Plan
  • [ ] Review/Update link to Scripts Docs
  • [ ] If other relevant subheadings need to be created, create those headings (using RP6 as an example)
  • [ ] Review/update link to Interview Recordings & Transcripts (or relabel if it's quantitative data)
  • [ ] Review/update link to Synthesis (if nothing to report yet, leave blank)
  • [ ] Review/update link to Presentation of Findings (if nothing to report yet, leave blank)
  • [ ] Review/update link to Action Items Spreadsheet (if nothing to report yet, leave blank)
• [ ] Review/Update Links to Related Wiki Pages
• [ ] Research lead reviews wiki page
• [ ] Product reviews wiki page

Resources/Instructions

• [RP__ Wiki Page]
• Example Wiki Research Plan Page: RP6
• Google Drive, Research Folder - you can find research plans by type or by number/name
• Don't link GitHub issues, instead make sure that the wiki page has a link to all the issues using the label (e.g., Research: RP006 label)
• If a particular Research Plan was not conducted during the Internship 2022, note why under "Current Status".
• Tips for identifying mislabeled GitHub issues
  • In the search bar, type keywords that might be related to this research plan
  • Start broad to identify keywords that might indicate the same thing. Quickly scroll through all issues to see if the language to describe this research plan was inconsistent (e.g., "intake" vs. "onboarding"). Make sure that no matter the language that the RP label is correct.
  • Look in both open and closed issues
• Example of Action Items Spreadsheet

[the-techgurl]

New draft for guides project

Update [Replace with RP and the number e.g., RP008]: [name of research]

Overview

We need to review and update the wiki page for [Research Plan number and title] so that future HfLA volunteers can replicate our processes.

Action Items

• [ ] Add milestone: 06.01.02 Research Audit and update wiki page
• [ ] Review/Update Research Date
• [ ] Review/Update Summary of Research
  • [ ] Update Research Question
  • [ ] Update Purpose
  • [ ] Update Methods
• [ ] Review/Update Current Status
• [ ] Search all issues to make sure that there are no mislabeled issues.
• [ ] Make sure that the "All Issues" link correctly identifies all issues related to this RP (both open and closed)
• [ ] Review/Update Outstanding task items
• [ ] Review/Update Assets
  • [ ] Review/Update link to Research Plan
  • [ ] Review/Update link to Scripts Docs
  • [ ] If other relevant subheadings need to be created, create those headings (using RP6 as an example)
  • [ ] Review/update link to Interview Recordings & Transcripts (or relabel if it's quantitative data)
  • [ ] Review/update link to Synthesis (if nothing to report yet, leave blank)
  • [ ] Review/update link to Presentation of Findings (if nothing to report yet, leave blank)
  • [ ] Review/update link to Action Items Spreadsheet (if nothing to report yet, leave blank)
• [ ] Review/Update Links to Related Wiki Pages
• [ ] Research lead reviews wiki page
• [ ] Product reviews wiki page

Resources/Instructions

1.01 [RP__ Wiki Page] 1.02 Example Wiki Research Plan Page: RP6 1.03 Google Drive, Research Folder - you can find research plans by type or by number/name 1.04 Don't link GitHub issues, instead make sure that the wiki page has a link to all the issues using the label (e.g., Research: RP006 label) 1.05 If a particular Research Plan was not conducted during the Internship 2022, note why under "Current Status". 1.06 Tips for identifying mislabeled GitHub issues

• In the search bar, type keywords that might be related to this research plan
• Start broad to identify keywords that might indicate the same thing. Quickly scroll through all issues to see if the language to describe this research plan was inconsistent (e.g., "intake" vs. "onboarding"). Make sure that no matter the language that the RP label is correct.
• Look in both open and closed issues 1.07 Example of Action Items Spreadsheet

[the-techgurl]

• [x] Improve draft by making the Instructions more specific using numbers in resources section
• [ ] add actual path to research folder where referenced