TWE: Revise Research: Update Template

pandanista commented 3 months ago

Overview

We need to update the Update Template issue template so it has the same formatting as the most recent templates we have made.

Action Items

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

Action Items

[x] Copy the example from Resource 1.01
- [x] Paste into a comment below using details to make it collapsible
- [x] Use the following text for the summary
```
## Current draft of Update Issue Template
```
[x] Copy the example from Resource 1.01
- [x] Use the following text for the summary
```
## Revised Update Issue Template from the Guides Team
```
- [ ] Add bullet headers and divide work into sections
  - example:
  - If the current template has
    - [ ] Go to the Google Drive, Research, 1. Research by Type, Folder
      
      [ ] Create a new folder in the drive called [number. name of type]
  - The revised template should have this text and formatting
    - Create new Google Drive Folder
      
      [ ] Go to the Google Drive, Research, 1. Research by Type, Folder (Resource # 1.04)
      
      [ ] Create a new folder in the drive called [number. name of type] (e.g., 1. Mentor, 2. Intern)
      
      [ ] update the link in the resources below (Resource # 2.02)
- [x] Separate the resources into two sections
  - ```
  #### Resources for creating this issue
```
- ```
#### Resources gathered during the completion of this issue
```
- [ ] Make sure each resource is in order of how it appears in the instructions
- [ ] Number the resources
  - [ ] Add the numbers to the action items
[ ] re-review the whole thing, to make sure
- [ ] all the instructions make sense
- [ ] all the links resolve
- [ ] the work is listed in the most logical order
[ ] review with UX lead and get sign-off
[ ] ask UX lead or product to update issue template Resource 1.03

Resources/Instructions

1.01 TWE Research: Update Issue Template, new issue 1.02 Issue templates in the code 1.03 TWE Research: Update Issue Template, file

pandanista commented 1 week ago

Current draft of Update Issue Template

Current draft of Setup Structure Template

### 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](https://github.com/hackforla/internship/wiki/Research-Plan-6:-Intern-Intake-Interviews) - [Google Drive, Research Folder](https://drive.google.com/drive/folders/1LLHYcQCRmpC3DX_ZMj4BXNCmb_XliUXd?usp=sharing) - 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](https://docs.google.com/spreadsheets/d/1WGim70shHIt-6BbweDvbn-J0IdOR8JmQLYg9Rovf7bA/edit#gid=1693908723)

pandanista commented 1 week ago

@jinyan0425 Hi Jinyan, please follow the instructions in the first comment and mark the checkboxes in the Action Items as you complete them.

Please refer to #531 as an example on how it is done because it is the same instructions and structure.
To add formatting to any comments on GitHub, please look up Markdown language to learn some basic knowledge.
To make revisions or copy and paste content with the same format from another comment, select the three dot on the right hand side of the comment, and then select edit. See screenshot below.

Please let me know if you have any questions.

jinyan0425 commented 4 days ago

Current draft of Update Issue Template

### 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](https://github.com/hackforla/internship/wiki/Research-Plan-6:-Intern-Intake-Interviews) - [Google Drive, Research Folder](https://drive.google.com/drive/folders/1LLHYcQCRmpC3DX_ZMj4BXNCmb_XliUXd?usp=sharing) - 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](https://docs.google.com/spreadsheets/d/1WGim70shHIt-6BbweDvbn-J0IdOR8JmQLYg9Rovf7bA/edit#gid=1693908723)

jinyan0425 commented 4 days ago

Revised Update Issue Template from the Guides Team

--- **name:** TWE: Template Issue: Research: Update **about:** This issue guides you through updating the wiki with the research project info **title:** TWE: Research: [Replace TITLE OF RESEARCH]: Research: Update **labels:** 'feature: research audits', 'Participant Type: missing', 'Research 000: missing', 'size: 1pt', 'role: UI/UX research', 'milestone: missing' **assignees:** --- ### Overview We need to review and update the wiki page for [Replace TITLE OF RESEARCH] 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 #### Resources for creating this issue 1.01 [Wiki: Research Output Overview](https://github.com/hackforla/internship/wiki/Research-Output-Overview) 1.02 [Example Wiki Research Plan Page: RP6](https://github.com/hackforla/internship/wiki/Research-Plan-6:-Intern-Intake-Interviews) 1.03 [Google Drive Folder: Research by Plan # and name](https://drive.google.com/drive/folders/1ZQnTEFbIQjxSDBmPTO0zuLroZVqd-nuZ?usp=share_link) 1.04 [Example of Action Items Spreadsheet](https://docs.google.com/spreadsheets/d/1WGim70shHIt-6BbweDvbn-J0IdOR8JmQLYg9Rovf7bA/edit#gid=1693908723) [original__needs updates] - [RP__ Wiki Page] _ [Example Wiki Research Plan Page: RP6](https://github.com/hackforla/internship/wiki/Research-Plan-6:-Intern-Intake-Interviews) - [Google Drive, Research Folder](https://drive.google.com/drive/folders/1LLHYcQCRmpC3DX_ZMj4BXNCmb_XliUXd?usp=sharing) - 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](https://docs.google.com/spreadsheets/d/1WGim70shHIt-6BbweDvbn-J0IdOR8JmQLYg9Rovf7bA/edit#gid=1693908723) #### Resources gathered during the completion of this issue 2.01 [TWE: Research Roadmap: [Replace TYPE OF PARTICIPANT]] 2.02 # 2.03 [RP[Replace 000]: Wiki Page] 2.04 [RP[Replace 000]: Google Drive Folder

jinyan0425 commented 2 days ago

@pandanista I need to go over the content of the revised template with you before working on the unchecked action items.

hackforla / internship