TWE: Revise Research: Update WIKI Template

[pandanista]

Overview

We need to update the Update WIKI 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

• Copy the example from Resource 1.01
  • Paste into a comment below using details to make it collapsible
  • Use the following text for the summary

## Current draft of Update Issue Template

• Copy the example from Resource 1.01
  • 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)

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

@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 TWE: Revise Research: Setup Structure Template #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]

Current draft of Update Issue Template

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

[jinyan0425]

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

[jinyan0425]

Revised Update Wiki Page Template

---

name: TWE: Template Issue: Research: Update Wiki Page
about: This issue helps you structure your template issue to be consistent with our other template issues in research wiki page updates
title: TWE: Research: [Replace TITLE of RESEARCH]: Update Wiki Page
labels: 'feature: research audits', 'p-feature: wiki', '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 we can stay organized and consistent across all team members and working times, and future TWE volunteers can replicate our processes.

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

Update Issue Labels (located in the right sidebar)

• Under Assignees, assign yourself
• Under Labels, click the gear-shaped setting icon (), then apply the label Participant Type: [Replace TYPE of PARTICIPANT]
• Remove the Participant Type: missing label
• Under Projects, click the setting icon, then choose Repository, and choose Program Management
• Add the milestone: click the setting icon, then choose 06.01.02 Research Audit and Update Wiki Page
• Remove the label milestone: missing

Review Google Drive

• Go to the Shared Drives > Internship > Internships > Research > Research by Plan # and Name (Resources # 1.01)
• Go to the research plan folder of RP[Replace 000]
• Review all files in the folder of RP[Replace 000]
• Find all updated files that will be reflected in the wiki page update, see the action items below

Find Wiki Page

• Go to the wiki page: Research Output Overview (Resources # 1.02)
• Scroll down to the section Research by Plan Number
• Open the hyperlink Research Plans, sorted by number (Resources # 1.03)
• Locate the Research Plan you attempt to update the wiki page, often titled as Research Plan [Replace 000]: [Replace TITLE of RESEARCH]
• Open the wiki page of Research Plan [Replace 000]
• Copy the URL of the wiki page of Research Plan [Replace 000]
• Paste the URL at the end of Resources # 2.01 in () so it becomes a hyperlink

Update Wiki Page (Resources # 2.01)

• Open the link in Resources # 2.01 if it is not open
• Initiate an update on wiki page
  • Choose "Edit" in the title section
• Update research plan agenda on wiki page
  • Update Proposed Research Agenda
    • Update date information for Start, Data Collected and End
• Update research plan details and status on wiki page
  • Update Summary of Research
    • Update Question
    • Update Purpose
    • Update Methods
  • Update Current Status
• Check all issues related to the research plan
  • Check issue labels
    • Go to the repository hackforla/intership
    • Click "Issues" OR Use this direct link
    • Go over all issues, either open or closed, related to RP[Replace 000]
    • Check the consistency in the language describing the research plan (e.g., "intake" vs. "onboarding")
      • Correct any inconsistency in description language
    • Check if all issues related toRP[Replace 000] have the correct label Research: RP[Replace 000]
      • Add the correct label if the research label is missing
      • Correct any incorrect research label
  • Check All Issues
    • Go back to the wiki page
    • Open the hyperlink of All Issues
    • Check if every issue listed, either open or closed, is associated with a label RP[Replace 000], which indicates the wiki page correctly identifies all issues related to this research plan
• Update research outstanding tasks and assets on wiki page
  • Update Outstanding Task Items
  • Update Assets
    • Update the second link under Google Drive Folders
      • Go to the Shared Drives > Internship > Internships > Research > Research by Plan # and Name (Resources # 1.01)
      • Find the research folder of RP[Replace 000]
      • Copy the sharable link of RP[Replace 000] folder
      • Update the link for RP folder
    • Update the links under Research Plan
      • Go to the Shared Drives > Internship > Internships > Research > Research by Plan # and Name (Resources # 1.01) > RP[Replace 000]
      • Find the updated research plan document, often titled as TWE: IS[Replace 00]:RP[Replace 000]:[Replace the TITLE of Reserach] Research Plan
      • Copy the sharable link of the updated research plan document
      • Update the link for Research Plan
    • Update the links under Scripts Docs
      • Go to the Shared Drives > Internship > Internships > Research > Research by Plan # and Name (Resources # 1.01) > RP[Replace 000]
      • Find all updated script documents, often titled as TWE:IS[Replace 00]:RP[Replace 000]:[Replace TITLE of RESEARCH] Script/Form
      • Copy the sharable link(s) of the updated script documents
      • Update the link(s) for Scripts Docs
      • Leave it blank if there is no update in the Google Drive
    • Update the links under Interview Recordings & Transcripts (for qualitative data) or Survey (for quantitative data)
      • Go to the Shared Drives > Internship > Internships > Research > Research by Plan # and Name (Resources # 1.01) > RP[Replace 000]
      • Find all updated interview recordings & transcripts OR survey documents
      • Copy the sharable link(s) of all updated interview recordings & transcript OR survey documents
      • Update the link(s) for Interview Recordings & Transcripts OR Survey
      • Leave it blank if there is no update in the Google Drive
    • Update the links under Synthesis
      • Go to the Shared Drives > Internship > Internships > Research > Research by Plan # and Name (Resources # 1.01) > RP[Replace 000]
      • Find the updated synthesis documents, often titled as TWE:IS[Replace 00]:RP[Replace 000]:[Replace TITLE of RESEARCH] Synthesis
      • Copy the sharable link of the updated synthesis document
      • Update the link for Synthesis
      • Leave it blank if there is no update in the Google Drive
    • Update the links under Presentation of Findings
      • Go to the Shared Drives > Internship > Internships > Research > Research by Plan # and Name (Resources # 1.01) > RP[Replace 000]
      • Find the updated presentation documents, often titled as TWE:IS[Replace 00]:RP[Replace 000]:[Replace TITLE of RESEARCH] Presentation
      • Copy the sharable link of the updated presentation document
      • Update the link for Presentation of Findings
      • Leave it blank if there is no update in the Google Drive
    • Update the links under Action Items Spreadsheet
      • Go to the Shared Drives > Internship > Internships > Research > Research by Plan # and Name (Resources # 1.01) > RP[Replace 000]
      • Find the updated action item spreadsheet, often titled as TWE:IS[Replace 00]:RP[Replace 000]Action Steps:[Replace TITLE of RESEARCH]
      • Copy the sharable link of the updated action item spreadsheet
      • Leave it blank if there is no update in the Google Drive
• Update related wiki pages
  • Update Related Wiki Pages
    • Copy the URL of Research Home Page (Resources # 1.04)
    • Paste behind the Research Home Page in () so it becomes a hyperlink
    • Copy the URL of Research Output Overview (Resources # 1.02)
    • Paste behind the Research Output Overview in () so it becomes a hyperlink
• Ask Research Lead to Review the Updated Wiki Page
• Ask Product Team to Review the Updated Wiki Page

Resources/Instructions

Resources for creating this issue

1.01 Google Drive, Research Folder
1.02 Research Output Overview
1.03 Research: Plans: by Number
1.04 Research Home Page

Resources gathered during the completion of this issue

2.01 [RP[Replace 000]: Wiki Page]

[jinyan0425]

This is ready to review @pandanista. I will make any revisions and edits as needed.

A few comments:

1. According to our discussion, I titled the template "Update Wiki Page Template" instead of "Revised Update Issue Template from the Guides Team" in the first comment. Shall we further change it to "Research Audit and Update Wiki Template" to be consistent with the name of the milestone?

2. I am not sure about the last two action items? I assume they mean to ask the research lead and product team to review the wiki page.

   • Research Lead Reviews Wiki Page
   • Product Reviews Wiki Page

3. I did not find a good example of action item spreadsheet. The example provided in the old template is hackforla.org: RP009: Action Steps- Wins Page Research. Not sure how good it is. So, I did not add details as I did for other actions.

4. As for the order of the actions, is it possible to update all the labels including milestones at the end? The label information (e.g., participant type) may be clearer after researchers have reviewed and updated the wiki page.

5. I added more details, compared to the original template.

6. Two minor changes: I renamed "06.01.02 Research Audit and update wiki page" to "06.01.02 Research Audit and Update Wiki Page", and "Research Plan # and name" to "Research Plan # and Name" in Google Drive. I am a bit obsessive-compulsive about capitalization for consistency.

[pandanista]

• Did you accidentally delete a comment?
  • I remember there were three comments: old template, new template from the guide team, and updated template for TWE.
  • Looks like the new template from the guide team is missing?
  • We usually hide comments as they are outdated or not relevant anymore, but not delete them.

-is this comment the updated template? If so, let's not collapse it so it is easier for review.

[pandanista]

@jinyan0425: To answer some comments you had earlier,

1. According to our discussion, I titled the template "Update Wiki Page Template" instead of "Revised Update Issue Template from the Guides Team" in the first comment. Shall we further change it to "Research Audit and Update Wiki Template" to be consistent with the name of the milestone?

   • We could do that. Let's confirm with the Product team before making that change.
   • The alternative would be to add research audit to the overview section so anyone assigned would be clear about the goal and process of the issue.

2. I am not sure about the last two action items? I assume they mean to ask the research lead and product team to review the wiki page.

• Research Lead Reviews Wiki Page
• Product Reviews Wiki Page

• Yes, it is for the review process before any issue gets closed.

1. I did not find a good example of action item spreadsheet. The example provided in the old template is hackforla.org: RP009: Action Steps- Wins Page Research. Not sure how good it is. So, I did not add details as I did for other actions.

   • We have a template, and let me grab it for you.
   • the template for action item

2. As for the order of the actions, is it possible to update all the labels including milestones at the end? The label information (e.g., participant type) may be clearer after researchers have reviewed and updated the wiki page.

   • We want to keep it consistent across all issues since all the issues have the customizations for labels and milestone at the top.

3. I added more details, compared to the original template.

   • Great.

4. Two minor changes: I renamed "06.01.02 Research Audit and update wiki page" to "06.01.02 Research Audit and Update Wiki Page", and "Research Plan # and name" to "Research Plan # and Name" in Google Drive. I am a bit obsessive-compulsive about capitalization for consistency.

   • Thank you for being detail-oriented.

[jinyan0425]

• Did you accidentally delete a comment?

  • I remember there were three comments: old template, new template from the guide team, and updated template for TWE.
  • Looks like the new template from the guide team is missing?
  • We usually hide comments as they are outdated or not relevant anymore, but not delete them.

-is this comment the updated template? If so, let's not collapse it so it is easier for review.

Sorry that I misunderstood it. Yes, I deleted an earlier comment which was the older version of the revised template. I assumed I should finish the revised template based on the demo. I did not realize that we should keep the "Revised Update Issue Template from the Guides Team". I could redo the two comments in the correct order, but this requires deleting the comment on the current revised template--might not be ideal.

And just un-collapsed.

[ExperimentsInHonesty]

Product needs to review the template in comment above for the ordering of resources

[jinyan0425]

@jinyan0425: To answer some comments you had earlier,

1. According to our discussion, I titled the template "Update Wiki Page Template" instead of "Revised Update Issue Template from the Guides Team" in the first comment. Shall we further change it to "Research Audit and Update Wiki Template" to be consistent with the name of the milestone?

   • We could do that. Let's confirm with the Product team before making that change.
   • The alternative would be to add research audit to the overview section so anyone assigned would be clear about the goal and process of the issue.

2. I am not sure about the last two action items? I assume they mean to ask the research lead and product team to review the wiki page.

• Research Lead Reviews Wiki Page
• Product Reviews Wiki Page

• Yes, it is for the review process before any issue gets closed.

1. I did not find a good example of action item spreadsheet. The example provided in the old template is hackforla.org: RP009: Action Steps- Wins Page Research. Not sure how good it is. So, I did not add details as I did for other actions.

   • We have a template, and let me grab it for you.
   • the template for action item

2. As for the order of the actions, is it possible to update all the labels including milestones at the end? The label information (e.g., participant type) may be clearer after researchers have reviewed and updated the wiki page.

   • We want to keep it consistent across all issues since all the issues have the customizations for labels and milestone at the top.

3. I added more details, compared to the original template.

   • Great.

4. Two minor changes: I renamed "06.01.02 Research Audit and update wiki page" to "06.01.02 Research Audit and Update Wiki Page", and "Research Plan # and name" to "Research Plan # and Name" in Google Drive. I am a bit obsessive-compulsive about capitalization for consistency.

   • Thank you for being detail-oriented.

Thanks! I just updated the details about the action item spreadsheet. @pandanista

[pandanista]

@jinyan0425 Thank you so much for all the work you have put into revising the template! I edited a few minor things, but it looks great overall.

[jinyan0425]

@jinyan0425 Thank you so much for all the work you have put into revising the template! I edited a few minor things, but it looks great overall.

Thanks for your edits :)

[ExperimentsInHonesty]

This issue is complete the resources have been organized.

It looks like this template will need to have another issue to revise it, so that it has a Customize Issue section that will guide the person through the replacing process. the resources will then need to be redone because the finding the folder part will be completed when customizing, and a link to the folder added to the issue

This issue can be closed when Research makes a new issue to do the above.