Research: Test: Issue Template: Consent Document Creation

[pandanista]

Overview

We need to test the Consent Documents for Participants over 18 Issue Template so that researchers can start making Consent Documents for Participants over 18 issues on/for the various research plans/tasks

Details

We expect that the template you are testing will need some improvement and the fact that you don't know much about the project is a benefit here, because it's likely that the person making the template can overlook something that they already know how to do, but should be fully explained in the template so that people can do the work independently.

Action Items

• [x] Open the research template issue in Resource 1.01
• [x] Copy the draft into a new blank issue
• [x] Replace the title with the following text

  `[TEST]` 

• [x] Add the title from Resource 1.02 after the text: [TEST]. This part is the title that would have been provided if the issue was made from a template instead of this testing process.
• [x] Submit the issue
• [x] Assign yourself to the issue
• [x] Move the issue to the In Progress Column
• [x] Follow the instructions in the new issue.
• [x] If you have any questions about the instructions in this issue, leave a comment below and move this issue to the Questions column add ready for research lead label
• [x] When you have question or suggestions about the instructions in the template issue you are testing, please:
  • [x] leave comments in that issue, @ messaging the person who made the template in your comment
  • [x] move it to the Questions column
  • [x] add ready for research lead label
  • [x] @ message the person who made the template in Slack with a link to your comment.
• [ ] Review changes to the template made by author and repeat your review process until you are satisfied that it's ready for deployment
  • [ ] Leave a comment on the template issue and the issue you created with your sign-off (@ messaging both the template author and the Research Lead)
  • [ ] Add the issues to the next Research team agenda (Resource 1.03) and @ messaging both the template author and the Research Lead via the team Slack channel with a link to the issue comments)

Research lead action items

• [ ] review the template again
  • [ ] if changes are needed, send back to author with notes
  • [ ] if no changes are needed, deploy template, close issues.
    • [ ] Add link to the finished template to Resource 2.01

Resources

Resources for creating this issue

• 1.01 https://github.com/hackforla/internship/issues/368
• 1.02 [Replace with DEFAULT TITLE, ISSUE TEMPLATE WILL HAVE]
• 1.03 https://github.com/hackforla/internship/issues/62

Resources gathered during the completion of this issue

• 2.01 [TWE: Template Issue: Research: Create Consent Documents for Study Participants over the age of 18]

[pandanista]

Instructions for creating this issue

Resources/Instructions: This section is at the bottom of this issue (scroll to the bottom to view it now). The person who creates this issue should use links in the section "Resources for creating this issue" (i.e., 1.01, 1.02, etc.) to customize this 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.

• Customize the issue
  • [ ] Open the "Research Overview" wiki page (Resource 1.01)
  • [ ] Choose "Research Documents by Participant Type" or "Research by Plan Number" to locate the appropriate research roadmap or research plan folder (ie., RP###) on the wiki page
  • Use the information on the wiki page and in research roadmap or research plan to customize this issue
  • [ ] Copy and paste entire template text in this issue into text editor (ie., "TextEdit" on Mac, "Wordpad" on PC)
  • Use Find/Replace (Mac: ⌘+F or PC: Ctrl+F) to search for and replace the keyword strings (including text and the brackets) below with the appropriate values
    • Year
      • [ ] Find/Replace [Replace YY] with research year (Two digit format, ex: "22" for year "2022")
    • Research Plan Number
      • [ ] Find/Replace [Replace 000] with the research plan number (Three digit format, ex: "001" for research plan "RP001")
    • Type of Participant
      • [ ] Find/Replace [Replace TYPE OF PARTICIPANT] with the participant type (ex: "Intern" or "Mentor")
  • [ ] 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
  • Update the issue title
    • [ ] Copy

      TWE: IS[Replace YY]: RP[Replace 000]: [Replace TYPE OF PARTICIPANT] Informed Consent Documents (18 yrs +): 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 a Researcher if it has been determined. Otherwise, leave it blank.
  • [ ] Under Labels, choose gear , and apply the label Research: RP[Replace 000]
  • [ ] Under Labels, choose gear , and apply the label Participant Type: [Replace TYPE OF PARTICIPANT]
  • [ ] Remove the Research 000: missing and Participant Type: missing labels
  • [ ] Under Projects, choose gear , choose Repository, and choose Program Management
  • [ ] Add the milestone: choose gear , and choose Research Plan Execution
  • [ ] Remove the label milestone: missing
• Remove this section
  • [ ] After all the checkboxes above are complete and the issue is ready to be worked on, delete all text below the "Instructions for Creating this Issue" (top heading) and above "Overview" (heading below) -- i.e., the issue assignee will never see this part

[pandanista]

This issue and #551 serve as a demo for template testing workflow.

The first comment is the template draft copied from #551. To set up the test, we followed the "Instructions for creating this issue" to customize this issue so it is ready to be tested.

When UXRs and PM finish the testing issues, we update the template (#551 in this case), and then we bring #551 for final review.

[pandanista]

Draft of template issue for Consent Documents Template for Participants over 18

name: TWE: Template Issue: Research: Create Consent Documents for Study Participants over the age of 18 about: This issue helps you structure your template issue to be consistent with our other template issues in consent documents title: TWE: IS22: RP008: Mentor Informed Consent Documents (18 yrs +): Create labels: 'feature: research', 'Participant Type: missing', 'Research 000: missing', 'size: 1pt', 'role: UI/UX research', 'milestone: missing' assignees:

---

Instructions for creating this issue

Resources/Instructions: This section is at the bottom of this issue (scroll to the bottom to view it now). The person who creates this issue should use links in the section "Resources for creating this issue" (i.e., 1.01, 1.02, etc.) to customize this 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.

• Customize the issue
  • [x] Open the "Research Overview" wiki page (Resource 1.01)
  • [x] Choose "Research Documents by Participant Type" or "Research by Plan Number" to locate the appropriate research roadmap or research plan folder (ie., RP###) on the wiki page
  • Use the information on the wiki page and in research roadmap or research plan to customize this issue
  • [x] Copy and paste entire template text in this issue into text editor (ie., "TextEdit" on Mac, "Wordpad" on PC)
  • Use Find/Replace (Mac: ⌘+F or PC: Ctrl+F) to search for and replace the keyword strings (including text and the brackets) below with the appropriate values
    • Year
      • [x] Find/Replace 22 with research year (Two digit format, ex: "22" for year "2022")
    • Research Plan Number
      • [x] Find/Replace 008 with the research plan number (Three digit format, ex: "001" for research plan "RP001")
    • Type of Participant
      • [x] Find/Replace Mentor with the participant type (ex: "Intern" or "Mentor")
  • [x] Copy and paste the edited template from text editor back into this Github Issue, replacing all original text
  • [x] Re-check all the checkboxes above after copying and pasting the edited template
  • [x] Close the text editor
  • Update the issue title
    • [ ] Copy

      TWE: IS22: RP008: Mentor Informed Consent Documents (18 yrs +): 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 a Researcher if it has been determined. Otherwise, leave it blank.
  • [ ] Under Labels, choose gear , and apply the label Research: RP008]
  • [ ] Under Labels, choose gear , and apply the label Participant Type: Mentor]
  • [ ] Remove the Research 000: missing and Participant Type: missing labels
  • [ ] Under Projects, choose gear , choose Repository, and choose Program Management
  • [ ] Add the milestone: choose gear , and choose Research Plan Execution
  • [ ] Remove the label milestone: missing
• Remove this section
  • [ ] After all the checkboxes above are complete and the issue is ready to be worked on, delete all text below the "Instructions for Creating this Issue" (top heading) and above "Overview" (heading below) -- i.e., the issue assignee will never see this part

Overview

Create informed consent documents for RP008 so that we can keep track of the participants who agree to participant in the study. This process only applies to participants over 18 years old.

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.

Dependency:

• [ ] Mentor Research Plans and Goals Chart has been created

Action Items

Customize Resource Links

• Customize Resource for Wiki Page Link
  • [ ] Go to the wiki page: Research Output Overview (Resources # 1.01)
  • [ ] Choose the link in the "Research by Plan Number" section
  • [ ] Open relevant wiki page for RP008
  • [ ] Copy the link for the RP008 wiki page.
  • [ ] 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
  • Customize Resource for this Research Plan's Google Drive Folder
  • [ ] Choose the "Research by Plan # and name" folder on the shared Google Drive (Resources # 1.02)
  • [ ] Right-click on the RP008 folder
  • [ ] Choose "Get Link"
  • [ ] Choose "Copy link" and "Done"
  • [ ] Update Resource # 2.02 with the link you just copied. Paste it inside parentheses at the end of the line.
  • [ ] Choose "Update comment" in Github and make sure all the checkboxes above have been checked
• Customize Resource for Mentor's Research Plans and Goals Chart
  • [ ] Go to Research Output Overview Wiki page (Resources # 1.01)
  • [ ] Choose Mentor in the "Research Documents by User Type" section
  • [ ] Choose the Research Plans and Goals Chart in the "Mentor Research Plans and Goals (public page)" section
  • [ ] Copy the URL of Mentor Research Plans and Goals wiki page in the browser window
  • [ ] Update Resource # 2.03 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
• Customize Resource for RP008's Research Informed Consent Overview Google Doc
  • [ ] Open the template "TWE: Template: Research Informed Consent Overview" (Resources 1.03)
  • [ ] Choose the "USE TEMPLATE" button to save it to your own drive
  • Update the file name by following the steps:
    • [ ] Copy the text below

      TWE: IS22: RP008: Mentor Research Informed Consent Overview

    • [ ] Choose "File" > "Rename", and paste the text you copied into the top field of the Google Doc to rename the file
    • [ ] Highlight the texts of the title on the first page of the Google Doc cover page
    • [ ] Paste the texts you copied to replace the original title of the Google Doc
    • [ ] Keep the "Research Informed Consent Overview" Google doc open in a tab for future editing
  • [ ] Move the file into the Internship's shared drive in this Research Plan's Google Drive folder
    1. Choose File > Move (or Move icon)
    2. Choose the back arrow to access all your drives
    3. Choose Shared drives > Internships > Internships > Research > Research by Plan # and name > folder for RP008
    4. Choose "Move here"
    5. Choose "Move" when it asks if you want to change ownership to a shared drive
    6. Dismiss the notification that says the file is now in the shared drive
  • [ ] Update Resource # 2.04 link
    1. In the "Research Informed Consent Overview" Google Doc you just created, choose "Share" (upper right corner)
    2. Choose "copy link" and "Done"
    3. Update Resource # 2.04 with the link you just copied. Place it into parentheses at the end of the line.
    4. Choose "Update comment" in Github and make sure all the checkboxes above have been checked
  • Customize Resource for RP008's Informed Consent Form
  • [ ] Open the Informed Consent Form in Resources # 1.04
  • [ ] Choose the 3 vertical dots at the top of the Google Form on the left of your profile
  • [ ] Choose "Make a copy"
  • [ ] Copy the text below

    TWE: IS22: RP008: Mentor Research Informed Consent Form for Surveys/Interviews

  • [ ] Paste the texts you copied into the "Name" field
  • [ ] In the "Folder" field, choose "Consent Form", then choose back arrow to "Templates", back arrow to "Research" folder
  • [ ] Choose Research > Research by Plan # and name > folder for RP008
  • [ ] Choose "Select"
  • [ ] Choose "Make a copy"
  • [ ] Update Resource # 2.05 link by completing the following steps
    1. Choose "Send" in the TWE: IS22: RP008: Mentor Research Informed Consent Form for Surveys/Interviews you just created
    2. Choose the link icon
    3. Check the box for "Shorten URL"
    4. Choose "Copy"
    5. Update Resource # 2.05 with the link you just copied. Place it into parentheses at the end of the line.
    6. Choose "Update comment" in Github and make sure all the checkboxes above have been checked
• Customize Resource for RP008's Research Consent Email
• [ ] Open the link in Resources # 1.05
  • [ ] Choose the "USE TEMPLATE" button to save it to your own drive
    • Update the file name by following the steps:
      • [ ] Copy the text below

        TWE: IS22: RP008: Mentor Research Consent Email

      • [ ] Choose "File" > "Rename", and paste the text you copied into the top field of the Google Doc
  • [ ] Move the file into the Internship's shared drive in this Research Plan's Google Drive folder
    1. Choose File > Move (or Move icon)
    2. Choose the back arrow to access all your drives
    3. Choose Shared drives > Internships > Internships > Research > Research by Plan # and name > folder for RP008
    4. Choose "Move here"
    5. Choose "Move" when it asks if you want to change ownership to a shared drive
    6. Dismiss the notification that says the file is now in the shared drive
  • [ ] Update Resource # 2.06 link
    1. In the Google Doc, choose "Share" (upper right corner)
    2. Choose "copy link" and "Done"
    3. In Resource # 2.06, place the link you just copied into 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
    4. Choose "Update comment" in Github and make sure all the checkboxes above have been checked

       Customize documents needed for RP008's Consent Overview, Form, and Email

• Customize RP008's Research Informed Consent Overview Google Doc
  • [ ] Open RP008's Research Informed Consent Overview Google Doc (Resources # 2.04) if it is not open
  • [ ] Copy the text below

    You are invited to take part in Tech Work Experience’s 2022 Mentor Research

  • [ ] Highlight the first sentence of the Google Doc (see screenshot)
  • [ ] Paste the texts you copied into the highlighted section to replace the original first sentence of the Google Doc
  • [ ] Copy the hyperlink from Resources # 2.03
  • [ ] Paste into the highlighted section so the document says Mentor Research Plans and Goals with a Wiki page link attached
  • Update the footer of the Google Doc on page 2
    • [ ] Update the date with the date this Google Doc is created
    • [ ] Update participant type with Mentor
  • [ ] Update the LINK TO SIGN INFORMED CONSENT at the end of the doc with the link labeled 2.05 in Resources
    1. Copy the link in 2.05
    2. Highlight the LINK TO SIGN INFORMED CONSENT
    3. Choose "Insert link" icon
    4. Paste the link you copied into the box and choose Apply
• Customize RP008's Research Informed Consent Form
  • [ ] Open RP008's Research Informed Consent Form (Resources # 2.05) if it is not open
  • [ ] Copy the text below

    TWE: IS22: RP008: Mentor Research Informed Consent Form for Surveys/Interviews

  • [ ] Under "Questions" tab, highlight the title section
  • [ ] Choose the pencil shaped icon in the lower right of the Google Form
  • [ ] Paste the texts you copied into the title section of the Google Form to replace the original texts
  • [ ] Copy the hyperlink from Resources # 2.04
  • [ ] Paste the hyperlink you copied to replace the highlighted section (in the screenshot below) so the form says TWE: IS22: RP008: Mentor Research Informed Consent Overview with the Google Doc link attached
  • [ ] Edit the TWE: IS22: RP008: Mentor Research Informed Consent Overview URL you just pasted
  • [ ] Choose "Edit link"
  • [ ] Choose the "Link to" field
  • [ ] Make sure to delete edit?usp=sharing and add preview at the end of the link so people outside the TWE Team can view the Google Doc
  • [ ] Choose "OK"
  • [ ] Copy the text below

    Mentor #

  • [ ] Paste into the highlighted area in the participant # question
  • [ ] Add or delete participant numbers based on the Research Plan doc in RP008's folder (Resources # 2.02)
  • [ ] Copy the text below

    Mentor

  • [ ] Paste into the highlighted area in the signature section
  • [ ] Choose the pencil shaped icon in the lower right of the Google Form to make sure you are in the editing mode
  • [ ] Scroll up to the top of the Google Form to select the "Responses" tab
  • [ ] Under "Responses", choose "Link to Sheets"
  • [ ] Choose "Create a new spreadsheet"
  • [ ] Choose "Create"
  • [ ] Go to RP008 folder (Resources # 2.02)
  • [ ] Locate the TWE: IS22: RP008: Mentor Research Informed Consent Form for Surveys/Interviews (Responses) spreadsheet
  • [ ] Choose "Get Link"
  • [ ] Choose "Copy link" and "Done"
  • [ ] Update Resource # 2.07 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
  • [ ] Under "Settings", make sure the "Collect email addresses" and "Allow responses editing" are toggled on.
• Customize TWE: IS22: RP008: Mentor Research Consent Email script
  • Subject line:
    • [ ] Copy the text below

      Mentor

    • [ ] Paste the texts you copied to replace the highlighted area of the subject line
  • Email body:
    • [ ] Copy the text below

      Mentor in our Summer 2022

    • [ ] Paste the texts you copied to replace the highlighted area of the email body
    • [ ] Copy the text below

      Mentor

    • [ ] Paste the texts you copied to replace the following highlighted area of the email body
    • [ ] Copy the hyperlink from Resources # 2.03
    • [ ] Paste into the highlighted section so the document says Mentor] Research Plans and Goals with a Wiki page link attached
    • [ ] Copy the URL in Resources # 2.05
    • [ ] Choose "this link"
    • [ ] Choose "Edit link"
    • [ ] Paste the link you copied into the box
    • [ ] Choose "Apply"

• Update the wiki page for this research plan (Resources # 2.01)
  • [ ] Open the link in Resource 2.01
  • [ ] Choose "Edit" to edit the page
  • [ ] Find the "Script" section
  • [ ] Make a new line at the end of the list and add a new bullet by inserting - at the beginning of the line
  • [ ] Copy and paste Resource 2.04 (both the text and URL) from this issue to the right of this new bullet (-) in the "Script" section
  • [ ] Copy and paste Resource 2.05 (both the text and URL) from this issue to the right of this new bullet (-) in the "Script" section
  • [ ] Choose "Save Page"
• Update [Mentor Research Plans and Goals] on Wiki (Resource 2.03)
  • [ ] Open the link in Resource 2.03
  • [ ] Choose "Edit" to edit the page
  • [ ] Find the "Consent" Section,
  • [ ] Make a new line at the end of the list and add a new bullet by inserting - at the beginning of the line
  • [ ] Copy and paste Resource 2.04 (both the text and URL) from this issue to the right of this new bullet (-) in the "Consent" section
  • [ ] Copy and paste Resource 2.05 (both the text and URL) from this issue to the right of this new bullet (-) in the "Consent" section
• [ ] Update the research plan doc in [Google Drive Folder: RP008] (Resource 2.02)
  • [ ] Include consent overview (Resources 2.04), form (Resources 2.05), and email (Resources 2.06) in the research plan Google Doc's Appendix
• [ ] Review with UX Lead
• [ ] Product sign-off

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 TWE: Template: Research Informed Consent Overview 1.04 TWE: Template: Research Informed Consent Form for Surveys/Interviews This consent form is for participants over 18 1.05 TWE: Template: Research Consent Email

Resources gathered during the completion of this issue

2.01 [Wiki: Research Plan 008] 2.02 [Google Drive Folder: RP008] 2.03 [Mentor] Research Plans and Goals] 2.04 [TWE: IS22: RP008: Mentor Research Informed Consent Overview] 2.05 [TWE: IS22: RP008: Mentor Research Informed Consent Form for Surveys/Interviews] This consent form is for participants over 18 2.06 [TWE: IS22: RP008: Mentor Research Consent Email] 2.07 [TWE: IS22: RP008: Mentor Research Informed Consent Form for Surveys/Interviews (Responses)] This consent form is for participants over 18

[pandanista]

• Title:

  • [x] We should be more specific about which template issue we are testing. Otherwise all the research template testing issue will look the same, and see the current title below:

• Labels:

  • [x] Since it is for testing research templates, we should include feature: research in the labels.
  • [ ] I thought we created the label status:template testing for research template testing purpose because feature:testing was created for a different purpose, not for research template testing. Is it still the case? If yes, we need to take off the feature:testing label.

• Search/Replace section:

  • Search for [Replace with LINK TO RESEARCH TEMPLATE ISSUE]
    • Instead of the link to the research template issue, it should be #[Replace TEMPLATE DRAFT ISSUE NUMBER]
  • Search for [Replace with DEFAULT TITLE ISSUE TEMPLATE WILL HAVE]
    • In Resources 1.02, it has a comma: [Replace with DEFAULT TITLE, ISSUE TEMPLATE WILL HAVE]
      • Which one do we use? Need to be consistent.
    • What does DEFAULT TITLE ISSUE TEMPLATE WILL HAVE mean?
  • Need to add two more search/replace because it shows up in the action items and resources sections
    • [ ] Search for [Replace DIRECT OBJECT]
    • [ ] Search for [Replace with NAME OF TEMPLATE]

• Under the section of Search/Replace (see screenshot below), we need to add some more action items:

  • [ ] 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

• Need to add an action item before the following section:

  • [ ] Assign a team member to this issue

[sunannie27]

Feedback

• When it says copy draft of template issue it is referring to the 2nd comment, not first comment. That one is to create issue template, so we should direct people to the comment instead
• Give step by step instructions for copy and paste such as clicking on three dots, edit and then control/command a, control c
• We have to tell people to assign project board, have to refresh to see arrow down and then click in progress
• It keeps saying the or this issue, clarify whether it is the old or new issue because it gets confusing
• Can the instruction for creating the issue be merged with the testing template? -Ying
• It will be confusing if people are assigned to the issue but won’t actually be working on it -Ying
• I think complexity is a new label so it is not on there