TWE: Revise Research: Setup Structure Template

pandanista commented 3 months ago

Overview

We need to update the Setup Structure 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 a Setup Structure Template, so that we can create a Setup Structure 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 Setup Structure Template Issue Template
```
[x] Copy the example from Resource 1.01
- [x] Use the following text for the summary
```
## Revised Setup Structure Template Issue Template from the Guides Team
```
- [x] 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
```
- [x] Make sure each resource is in order of how it appears in the instructions
- [x] Number the resources
  - [x] Add the numbers to the action items
[x] Re-review the whole thing, to make sure
- [x] all the instructions make sense
- [x] all the links resolve
- [x] the work is listed in the most logical order
[x] review with UX lead and get sign-off
[x] ask UX lead or product to update issue template Resource 1.03

Resources/Instructions

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

pandanista commented 3 months ago

Current draft of Setup Structure Template Issue Template

Current draft of Setup Structure Template

### Dependencies ANY ISSUE NUMBERS THAT ARE BLOCKERS OR OTHER REASONS WHY THIS WOULD LIVE IN THE ICEBOX ### Overview We need to create a wiki structure and task list to support the development of a new research plan on [Replace TITLE OF RESEARCH] so that we can stay organized and consistent across all team members and working times. ### Action Items - [ ] Add the milestone: 06.01.01 Research Plan Create Wiki Pages. - [ ] Link the roadmap and its issue for your research into the resources below. - [ ] Create a label for your research plan, using the next number available. Check research plan number in Google drive's research folder and on wiki research output overview page on Github to make sure the number is correct. - [ ] Add label to this issue and to the roadmap issue. - [ ] Create a new wiki page for it. - [ ] Use the template to copy the structure. - [ ] Link new wiki page to [Output overview wiki page](https://github.com/hackforla/internship/wiki/Research-Output-Overview). - [ ] Link it to the appropriate page under `Research Documents by Participant Type`. - [ ] Link it under `Research Plan By Status` based on whether it is current or future research. If the research plan has been created or the data has been collected, then choose `Current Research`. If no research plan nor data has been collected, then choose `Future Research`. - [ ] Link it under `Research by Plan Number`. - [ ] Fill out the wiki page with any information available, and include any links or documents that have already been created. - [ ] Go to the Shared Drives > Internships > Internships > Research > Research by Participant Type - [ ] Open the appropriate participant type folder for this RP - [ ] Check if there is a folder created for this research plan - [ ] If yes, move onto the next section - [ ] If no, please create a new folder called `RP### - [Replace TITLE OF RESEARCH]` in the "Research by Participant Type" folder - [ ] Right click the folder you just created and click "Add shortcut to Drive" - [ ] Go to All Locations > Shared drives > Internships > Internships > Research > Research by Plan # and name - [ ] Click the "Add" button and then "Ok" to the pop-up - [ ] Customize issues that will need to be made by striking through unneeded issues from this list (put ~ before and after text to make it strikethrough). - [ ] Research Plan (internal) - [ ] Timeline - [ ] Forms/Survey/Script - [ ] Emails text to parents if participants are minor (if required) - [ ] Recruitment plan for extra UXRs and participants(if required) - [ ] Identification of recruitment channels for UXRs and participants (if required) - [ ] Messaging for each type of channel (i.e. Slack, social) - [ ] Interest forms for UXRs - [ ] Selection criteria for UXRs and participants - [ ] Consent Plan for participants - [ ] Research Plan (external) - this is a subset of the internal - [ ] Consent Form - [ ] Update Outstanding Task Items on wiki page to reflect the necessary issues from the list above. - [ ] Have review meeting with Research Lead. - [ ] Have alignment meeting with Product for sign-off. - [ ] Create issues using templates from the list of template issues. ### Resources/Instructions - [Label page](https://github.com/hackforla/internship/labels?q=RP) - [Click to create new page on wiki](https://github.com/hackforla/internship/wiki/_new) - [WIKI template](https://github.com/hackforla/internship/wiki/research-wiki-template) - [Internship Google Drive](https://drive.google.com/drive/folders/0ACgRrPVkhnrvUk9PVA) - [Output Overview wiki page](https://github.com/hackforla/internship/wiki/Research-Output-Overview) - [Research list of template issues](https://github.com/hackforla/internship/wiki/UX-Research-Guides-Templates#template-issues)

Revised Setup Structure Template Issue Template from the Guides Team

Dependencies

ANY ISSUE NUMBERS THAT ARE BLOCKERS OR OTHER REASONS WHY THIS WOULD LIVE IN THE ICEBOX

Overview

We need to create a wiki structure and task list to support the development of a new research plan on [Replace TITLE OF RESEARCH] so that we can stay organized and consistent across all team members and working times.

Action Items

[ ] Add the milestone: 06.01.01 Research Plan Create Wiki Pages.
[ ] Link the roadmap and its issue for your research into the resources below.
[ ] Create a label for your research plan, using the next number available. Check research plan number in Google drive's research folder and on wiki research output overview page on Github to make sure the number is correct.
- [ ] Add label to this issue and to the roadmap issue.
[ ] Create a new wiki page for it.
[ ] Use the template to copy the structure.
[ ] Link new wiki page to Output overview wiki page.
- [ ] Link it to the appropriate page under Research Documents by Participant Type.
- [ ] Link it under Research Plan By Status based on whether it is current or future research. If the research plan has been created or the data has been collected, then choose Current Research. If no research plan nor data has been collected, then choose Future Research.
- [ ] Link it under Research by Plan Number.
[ ] Fill out the wiki page with any information available, and include any links or documents that have already been created.
[ ] Go to the Shared Drives > Internships > Internships > Research > Research by Participant Type
- [ ] Open the appropriate participant type folder for this RP
- [ ] Check if there is a folder created for this research plan
- [ ] If yes, move onto the next section
- [ ] If no, please create a new folder called RP### - [Replace TITLE OF RESEARCH] in the "Research by Participant Type" folder
  - [ ] Right click the folder you just created and click "Add shortcut to Drive"
  - [ ] Go to All Locations > Shared drives > Internships > Internships > Research > Research by Plan # and name
  - [ ] Click the "Add" button and then "Ok" to the pop-up
[ ] Customize issues that will need to be made by striking through unneeded issues from this list (put ~ before and after text to make it strikethrough).
- [ ] Research Plan (internal)
- [ ] Timeline
- [ ] Forms/Survey/Script
- [ ] Emails text to parents if participants are minor (if required)
- [ ] Recruitment plan for extra UXRs and participants(if required)
- [ ] Identification of recruitment channels for UXRs and participants (if required)
- [ ] Messaging for each type of channel (i.e. Slack, social)
- [ ] Interest forms for UXRs
- [ ] Selection criteria for UXRs and participants
- [ ] Consent Plan for participants
- [ ] Research Plan (external) - this is a subset of the internal
- [ ] Consent Form
[ ] Update Outstanding Task Items on wiki page to reflect the necessary issues from the list above.
[ ] Have review meeting with Research Lead.
[ ] Have alignment meeting with Product for sign-off.
[ ] Create issues using templates from the list of template issues.

Resources/Instructions

Label page
Click to create new page on wiki
WIKI template
Internship Google Drive
Output Overview wiki page
Research list of template issues

Resources for creating this issue

Resources gathered during the completion of this issue

pandanista commented 3 months ago

Template

This is a test.

pandanista commented 2 months ago

Anything related to recruitment should be separated for extra UXR and participants because the needs for those audiences are different. So, it would look like:

Recruitment plan for extra UXRs (if required)
Recruitment plan for participants (if required)

pandanista commented 2 months ago

Current draft of Setup Structure Template Issue Template

Current draft of Setup Structure Template

### Dependencies ANY ISSUE NUMBERS THAT ARE BLOCKERS OR OTHER REASONS WHY THIS WOULD LIVE IN THE ICEBOX ### Overview We need to create a wiki structure and task list to support the development of a new research plan on [Replace TITLE OF RESEARCH] so that we can stay organized and consistent across all team members and working times. ### Action Items - [ ] Add the milestone: 06.01.01 Research Plan Create Wiki Pages. - [ ] Link the roadmap and its issue for your research into the resources below. - [ ] Create a label for your research plan, using the next number available. Check research plan number in Google drive's research folder and on wiki research output overview page on Github to make sure the number is correct. - [ ] Add label to this issue and to the roadmap issue. - [ ] Create a new wiki page for it. - [ ] Use the template to copy the structure. - [ ] Link new wiki page to [Output overview wiki page](https://github.com/hackforla/internship/wiki/Research-Output-Overview). - [ ] Link it to the appropriate page under `Research Documents by Participant Type`. - [ ] Link it under `Research Plan By Status` based on whether it is current or future research. If the research plan has been created or the data has been collected, then choose `Current Research`. If no research plan nor data has been collected, then choose `Future Research`. - [ ] Link it under `Research by Plan Number`. - [ ] Fill out the wiki page with any information available, and include any links or documents that have already been created. - [ ] Go to the Shared Drives > Internships > Internships > Research > Research by Participant Type - [ ] Open the appropriate participant type folder for this RP - [ ] Check if there is a folder created for this research plan - [ ] If yes, move onto the next section - [ ] If no, please create a new folder called `RP### - [Replace TITLE OF RESEARCH]` in the "Research by Participant Type" folder - [ ] Right click the folder you just created and click "Add shortcut to Drive" - [ ] Go to All Locations > Shared drives > Internships > Internships > Research > Research by Plan # and name - [ ] Click the "Add" button and then "Ok" to the pop-up - [ ] Customize issues that will need to be made by striking through unneeded issues from this list (put ~ before and after text to make it strikethrough). - [ ] Research Plan (internal) - [ ] Timeline - [ ] Forms/Survey/Script - [ ] Emails text to parents if participants are minor (if required) - [ ] Recruitment plan for extra UXRs and participants(if required) - [ ] Identification of recruitment channels for UXRs and participants (if required) - [ ] Messaging for each type of channel (i.e. Slack, social) - [ ] Interest forms for UXRs - [ ] Selection criteria for UXRs and participants - [ ] Consent Plan for participants - [ ] Research Plan (external) - this is a subset of the internal - [ ] Consent Form - [ ] Update Outstanding Task Items on wiki page to reflect the necessary issues from the list above. - [ ] Have review meeting with Research Lead. - [ ] Have alignment meeting with Product for sign-off. - [ ] Create issues using templates from the list of template issues. ### Resources/Instructions - [Label page](https://github.com/hackforla/internship/labels?q=RP) - [Click to create new page on wiki](https://github.com/hackforla/internship/wiki/_new) - [WIKI template](https://github.com/hackforla/internship/wiki/research-wiki-template) - [Internship Google Drive](https://drive.google.com/drive/folders/0ACgRrPVkhnrvUk9PVA) - [Output Overview wiki page](https://github.com/hackforla/internship/wiki/Research-Output-Overview) - [Research list of template issues](https://github.com/hackforla/internship/wiki/UX-Research-Guides-Templates#template-issues)

pandanista commented 2 months ago

Example draft of Research Roadmap Issue Template from the Guides Team

Title: Guides: Research Roadmap [name of type] ### Dependencies ANY ISSUE NUMBERS THAT ARE BLOCKERS OR OTHER REASONS WHY THIS WOULD LIVE IN THE ICEBOX ### Overview We need to create a research roadmap to [describe what and why] ### Action Items - Add to Project Board and set up milestone - [ ] Under "Projects," add to the Project Management Board - [ ] Add milestone: 04.01 Prep for User Research of Gather examples guides - [ ] Create a new page on the wiki for the roadmap - [ ] Copy the template for Research Roadmap (Resource # 1.01) - [ ] Click on the link for creating a new wiki page (Resource # 1.02) - [ ] Paste in the copied template - [ ] Name it `[type name] Research Overview` - [ ] update the link in the resources below (Resource # 2.01) - [ ] link it to the Research Output Overview wiki page (Resource # 1.03) - 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) (Resource # 1.03) - [ ] update the link in the resources below (Resource # 2.02) - [ ] Make a new document using the report template - [ ] Copy the research roadmap template (Resource # 1.05) - [ ] Move the document from "My Drive" to the shared drive guides folder that you just created. - [ ] Name the document to be called Guides: Research Roadmap: [name of type] - [ ] update the link in the resources below (Resource # 2.03) - Create the research roadmap content - [ ] Fill out the research roadmap - [ ] Update the Table of contents (page 2) when you are finished with the document - Get Approvals/Make Edits - [ ] UX Research Lead sign-off - [ ] Product-sign off ### Resources/Instructions #### Resources for creating this issue 1.01 [WIKI template for Research Roadmap](https://github.com/hackforla/guides/wiki/research-roadmap-wiki-template) 1.02 [Click to create new page on wiki](https://github.com/hackforla/guides/wiki/_new) 1.03 [Research Output Overview](https://github.com/hackforla/guides/wiki/Research-Output-Overview) 1.04 [Google Drive, Research, 1. Research by Participant Type Folder](https://drive.google.com/drive/folders/1rFyhdgGs7wzGSujEzXXDDo02govPtyKV) 1.05 [Guides: Template: Research Roadmap] #### Resources gathered during the completion of this issue 2.01 [RP000: Wiki Page] 2.02 [Google Drive, Research, 1. Research by Type, [Number. Name of Type]] 2.03 [Guides: Template: Research Roadmap: [TYPE]]

pandanista commented 2 months ago

Revised Setup Structure Template Issue Template

name: TWE: Template Issue: Research: Create Research Structure about: This issue helps you structure your template issue to be consistent with our other template issues in research structure title: TWE: Research: [Replace TITLE OF RESEARCH]: Research Structure: Create labels: 'feature: research', 'p-feature: wiki', 'epic', 'Participant Type: missing', 'Research 000: missing', 'size: 1pt', 'role: UI/UX research', 'milestone: missing' assignees:

Dependencies

ANY ISSUE NUMBERS THAT ARE BLOCKERS OR OTHER REASONS WHY THIS WOULD LIVE IN THE ICEBOX

Overview

We need to create a wiki structure and task list to support the development of a new research plan on [Replace TITLE OF RESEARCH] so that we can stay organized and consistent across all team members and working times.

Resources/Instructions: This section is at the bottom of this issue (scroll to the bottom to view it now). You will be asked to add links to this section while completing the issue.

Tip: Use two windows side by side. One with the issue open and the other one with resource links displayed to avoid back and forth. To prevent loss of work, refresh both windows after each edit.

Action Items

Customize the issue

Use Find/Replace (Mac: ⌘+F or PC: Ctrl+F) to search for and replace the keyword strings (including text and the brackets) in this issue with the appropriate values
- Research Plan Name
  - [ ] Find/Replace [Replace TITLE OF RESEARCH] with the research plan name
- Type of Participant
  - [ ] Find/Replace [Replace TYPE OF PARTICIPANT] with the participant type (ex: "Intern" or "Mentor")
  - [ ] The participant types can be found in the "Research Documents by Participant Type" section of Research Output Overview wiki page (see Resources # 1.01)
Update the issue title
- [ ] Copy
```
TWE: Research: [Replace TITLE OF RESEARCH]: Research Structure: Create
```
- [ ] Choose "Edit" in the title section
- [ ] Paste the texts you copied into the issue title
- [ ] Choose "Save"

Customize the issue settings (located in right sidebar)

[ ] Under Assignees, assign yourself or another team member
[ ] Under Labels, choose gear , and apply the label Participant Type: [Replace TYPE OF PARTICIPANT]
[ ] Remove the Participant Type: missing label
[ ] Under Projects, choose gear , choose Repository, and choose Program Management
[ ] Add the milestone: choose gear , and choose Research Plan Create Wiki Pages
[ ] Remove the label milestone: missing

Customize Resource Links

Customize Resources for Roadmap Document and Issue
- [ ] Go to the wiki page: Research Output Overview (Resources # 1.01)
- [ ] Choose [Replace TYPE OF PARTICIPANT] in the "Research Documents by Participant Type" section
- [ ] Open Research Roadmap document from the wiki page
- [ ] Choose Share > Copy link > Done
- [ ] Copy the link for the Research Roadmap on [Replace TYPE OF PARTICIPANT]
- [ ] Update Resource # 2.01 with the link you just copied. Place it into parentheses at the end of the line.
- [ ] Choose "Update comment" in Github and make sure all the checkboxes above have been checked
- [ ] Go to the top of the Github page, and open the Issues tab in a new tab
- [ ] Use "roadmap" as a filter to search for any existing research roadmap issues on [Replace TYPE OF PARTICIPANT] on Github. Check both open and closed issues.
- [ ] Once identified the roadmap issue, add the issue number to Resources 2.02
- [ ] Choose "Update comment" in Github and make sure all the checkboxes above have been checked

Create a New Label with the New Research Plan Number

Create a label dedicated to the new research plan number, using the next number available.
- Before creating a new label associated with the new research plan number, check Wiki, Google Drive and label page to make sure the next number available is consistent across all sources
  - [ ] Go to the wiki page: Research Output Overview (Resources # 1.01)
  - [ ] Choose the link in the "Research by Plan Number" section
  - [ ] Check the existing research plan numbers on wiki
  - [ ] Go to the Google Drive Folder: Research by Plan # and name (Resources 1.02)
  - [ ] Check the existing research plan numbers in Google Drive's research folder
  - [ ] Go to the label page (Resources 1.03)
  - [ ] Make sure the next available number is consistent
- [ ] Open the label page (Resources 1.03) if it is not open
- [ ] Choose New Label
- [ ] Apply the same naming structure and color used in other research plan labels
- [ ] Choose Create label
Update the new research plan number in this issue
- [ ] Use Find/Replace (Mac: ⌘+F or PC: Ctrl+F) to search for and replace the [Replace 000] (including text and the brackets) in this issue with the new research plan number (three digit format, ex: "001" for research plan "RP001")
Apply the new label to relevant issues
- [ ] Under Labels, choose gear , and apply the label Research: RP[Replace 000] in this issue
- [ ] Remove the Research 000: missing label from this issue
- [ ] Open the roadmap issue in Resources 2.02, and apply the label Research: RP[Replace 000]

Set Up A Wiki Page and Google Drive Folders

Create a new wiki page for the new research plan
- [ ] Open the template in Resources 1.04 in a new tab to copy the wiki page structure
- [ ] Open the link in Resources 1.05 in another new tab to paste what you copied into the big text box
- [ ] Create a title for this research plan by following the naming structure of other research plans
  - Go to the link in Resources 1.01
  - Choose the link in the Research by Plan Number section
  - Observe the naming structure of other existing research plans
  - Use the same structure to name this new research plan
- [ ] Choose Save Page
- [ ] Copy the URL of the new wiki page of the research plan
- [ ] Update Resource 2.03 with the link you just copied. Place it into parentheses at the end of the line.
Link the new wiki page to the following locations of Research Output Overview wiki page (link in Resources 1.01)
- [ ] Link it to the appropriate page under Research Documents by Participant Type
- [ ] Link it under Research Plan By Status based on whether it is current or future research. If the research plan has been created or the data has been collected, then choose Current Research. If no research plan nor data has been collected, then choose Future Research.
- [ ] Link it under Research by Plan Number
Create a research plan folder and a shortcut to the folder on the shared Google Drive
- [ ] Go to the Shared Drives > Internship > Internships > Research > Research by Participant Type
- [ ] Open the appropriate participant type folder for this RP
- [ ] Check if there is a folder created for this research plan
  - [ ] If yes, move onto the next section
  - [ ] If no, please create a new folder called RP[Replace 000] - [Replace TITLE OF RESEARCH] in the "Research by Participant Type" folder.
- [ ] Right click the folder you just created and choose Organize > Add shortcut
- [ ] Go to All Locations > Shared drives > Internship > Internships > Research > Research by Plan # and name
- [ ] Click the "Add" button and then "Ok" to the pop-up
- [ ] Right click the folder you just created and choose Share > Get link
- [ ] Choose Copy link and Done
- [ ] Update Resource 2.04 with the link you just copied. Place it into parentheses at the end of the line.

Customize Wiki Page

[ ] Review all issues (open and closed) associated with the new research plan by checking on the label page (Resources 1.03)
[ ] Fill out each section of the wiki page with any information available. If there is no information available, please leave it blank.
[ ] Include any links or documents that have already been created
- Research Roadmap section
  - [ ] Add link to [Replace TYPE OF PARTICIPANT]'s wiki page from Research Output Overview Page(Resources 1.01)
  - [ ] Add link to the research roadmap document (Resources 2.01)
- All Issues section
  - [ ] Choose the label page (Resources 1.03)
  - [ ] Choose the RP[Replace 000] label
  - [ ] Copy the URL of the issues associated with RP[Replace 000]
  - [ ] Paste in the parenthesis at the end of the label line
- Assets section
  - [ ] Add the link to [Replace TYPE OF PARTICIPANT] folder on shared Google Drive
    - [ ] Choose Research Output Overview wiki page (Resources 1.01)
    - [ ] Locate the appropriate participant type in the Research Documents by Participant Type section
    - [ ] Copy the text and link from the Research Documents by Participant Type section of the wiki page
    - [ ] Remove [TYPE]() in the Assets section on the RP[Replace 000]'s wiki page and paste what you just copied to the right of the "Type folder: "
  - [ ] Add the link to the new research plan folder (Resources 2.04)
[ ] Customize issues that will need to be made by striking through unneeded issues from this list (put ~ before and after text to make it strikethrough).
- [ ] Research Roadmap
- [ ] Research Plan (internal)
- [ ] Timeline
- [ ] Forms/Survey/Script
- [ ] Emails text to parents if participants are minor (if required)
- [ ] Recruitment plan for extra UXRs (if required)
- [ ] Selection criteria for UXRs (if required)
- [ ] Identification of recruitment channels for UXRs (if required)
- [ ] UXRs recruitment message draft for each type of channel (i.e. Slack, social) (if required)
- [ ] Interest forms for UXRs (if required)
- [ ] Recruitment plan for participants(if required)
- [ ] Selection criteria participants (if required)
- [ ] Identification of recruitment channels for participants (if required)
- [ ] Participants recruitment message draft for each type of channel (i.e. Slack, social) (if required)
- [ ] Consent Plan for participants
- [ ] Research Plan (external) - this is a subset of the internal
- [ ] Consent Form
[ ] Update Outstanding Task Items on wiki page to reflect the necessary issues from the list above
[ ] Have review meeting with Research Lead
[ ] Have alignment meeting with Product for sign-off
[ ] Create issues using templates from the list of template issues (Resources 1.06)

Resources/Instructions

Resources for creating this issue

1.01 Wiki: Research Output Overview 1.02 Google Drive Folder: Research by Plan # and name 1.03 Label page 1.04 WIKI template 1.05 Click to create new page on wiki 1.06 Research template issues

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]

pandanista commented 1 month ago

Refer to this comment as feedback. #548 was used as a testing for revising this template.

pandanista commented 3 weeks ago

Updated the template in the repository.

hackforla / internship