Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TWE: Create Template Issue: Rapid Qualitative Analysis (RQA): Conduct Transcript Summaries #624

Open
18 of 34 tasks
jinyan0425 opened this issue Sep 18, 2024 · 5 comments
Open
18 of 34 tasks

Comments

@jinyan0425
Copy link
Contributor

jinyan0425 commented Sep 18, 2024

Dependency

Overview

We need to create a template issue for TWE: Research: Rapid Qualitative Analysis (RQA): Transcript Summaries so that we have a consistent, transparent, defined, and self-supporting structure for people conducting them.

Action Items

Customize this issue

  • Customize this issue by adding the Name of Issue Template.
    • Note: An issue template's name is different from the issue title created from the template.
    • Search for [Replace NAME OF ISSUE TEMPLATE] by using the browser search (Mac: ⌘+F; PC: Ctrl+F)
    • Replace the keyword string (including text and the brackets) below with the name of your issue template according to the template naming convention: TWE: Role: Direct object: Action verb
      • The role is the primary owner of the issue template (e.g., Research, Design, Product)
      • Direct object should be the item that we're updating or working on (e.g., Wiki, Interviews, Roadmap)
      • Action verb should be the main descriptor of the action items (e.g., Update, Create, Transcribe)

Customize the issue settings (located in right sidebar)

Change the issue settings to ensure the issue is properly categorized and easy to manage.

  • Under Assignees, assign yourself.
  • Under Projects, choose gear, choose Repository, and choose TWE: Project Board.
  • Add the milestone: Project Management
  • Add a feature label specific to what the template is related to, if available. If not clear what you should use, ask product.

Customize template draft

Create a draft of new template, which will be known as our "draft".

  • Copy resource 1.01 Content to copy for draft to a new comment on this issue.
  • In your draft, fill out the top part (called front matter) with the following information. See resource 1.02 Front Matter Resources section below for definitions and examples.
    • Name
    • About
    • Title
    • Labels
  • Define any Dependencies (or remove the dependency section if there is no dependency)
  • Customize the Overview section
  • Fill out the Action Items section (in your draft) by defining the steps that are required to be done, keeping the following in mind:
    • The person working on this issue might be new to the org, so the issue should be able to be worked on without any prior knowledge
    • If the person needs to add links, or put documents in specific locations, the place where they can do that action must be linked in the resources section
      • The links in the resources section provided by the issue creator should be in the same order as the Action Items
      • Refer to resource 1.03 Example Action Items for Finding Wiki Page and Template for an example of how to write clear instructions that avoid compound steps (steps within a step).
    • Number each resource in the order each resource appears in the Action Items
      • Group resources into numbers and decimals (e.g., Resource 1.01, Resource 2.01)
      • Group the resources based on whether they are available when making the issues or they need to be created from this issue
        • If the resource is available, then group it under the Resources for creating this issue section (e.g., Resource 1.01, Resource 1.02, Resource 1.03)
        • If the resource will be delivered or created from this issue, then group it under the Resource links gathered during the making of this issue section (e.g., Resource 2.01, Resource 2.02, Resource 2.03)
  • If documents or folders (sheets, docs, presentations, dashboard, etc.) will be created, find the document template that should be used by checking resource 1.04 WIKI Templates by role pages.
    • If there is a template
      • Add a link to the template into the #### Resources for creating this issue section of your draft
    • If there is no template yet
      • Put a placeholder into the #### Resources for creating this issue section of the draft [TWE: Template Issue: [Role]: [Replace ACTION VERB][Replace DIRECT OBJECT]
  • Get sign-off by Product on the draft

If this is for a template draft that needs testing at a later stage, please use the following handoff steps:

  • Add feature: template creation (step 1) to this issue
  • Once the template draft is finished, assign a team member or yourself to create testing issues
  • Once the testings issues are completed, get sign-off by Product on the template draft
  • Create or update the template issue on the repo
  • Add the link to the new issue template once created to resource 2.01. Find by clicking on the Get started button to the right of the new template listed on new issue page
  • Update the appropriate place in the wiki for your template (see resources section)

Resources/Instructions

Resources for creating this issue

  • 1.01 Content to copy for draft
Draft of template issue for `TWE: Research: Rapid Qualitative Analysis (RQA): Conduct Transcript Summaries`
---
**name:** TWE: Template Issue: [Replace ROLE]: [Replace ACTION VERB][Replace DIRECT OBJECT]
**about:** This issue helps you structure your template issue to be consistent with our other template issues in [Replace DIRECT OBJECT]
** title:** TWE: [Replace ROLE]: [Replace DIRECT OBJECT]: [Replace ACTION VERB]
**labels:** 'feature: board / google drive / tools, feature: missing, milestone: missing, role: missing, size: missing', 'Participant Type: missing', 'complexity: missing'
**assignees:**

---
#### Instructions for creating this issue
The person who creates this issue should use these links to add links to the resources section and customize this issue
- Customize the 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 
    - [ ] Search for `[Replace`
    - [ ] Replace with whatever the keyword or information is asking for.
- Customize the issue settings (located in right sidebar)
    - [ ] Under Labels, add labels for any labels identified as missing
    - [ ] Remove the corresponding missing labels
    - [ ] Under Projects, choose gear, choose "Repository," and choose TWE: Project Board.
    - [ ] Add the milestone: [Replace MILESTONE]
    - [ ] Add a feature label specific to what the template is related to, if available. If not clear what you should use, ask product.
- Customize dependencies 
    - [ ] If no dependencies, delete dependency section
    - [ ] If dependencies, add the dependencies (any issue or reason that would prevent the action items from being completed)
- Remove this section.
    - [ ] Delete this section when all the checkboxes above are complete (i.e., the issue assignee will never see this part)

### Dependencies

### Overview
We need to [Replace ACTION VERB] [Replace DIRECT OBJECT] for [Replace REASON].

### Action Items
A STEP BY STEP LIST OF ALL THE TASK ITEMS THAT YOU CAN THINK OF NOW EXAMPLES INCLUDE: Research, reporting, coding, etc.

### Resources
#### Resources for creating this issue
- 1.01
- 1.02

#### Resources gathered during the completion of this issue
- 2.01
- 2.02
  • 1.02 Front Matter Resources

    Front Matter Fields and Meaning
    • name: (name that appear on the new issue tab)
    • about: (is the description that appears next to the issue template on the new issue tab)
    • title: (the title that appears when the issue is created. User then customizes this title for their issue)
      • Use the naming convention: TWE: Role: Direct object: Action verb
      • If more than one word should go into the direct object spot, use multiple square brackets with the keyword (see example below)
    • labels: (choose the labels that will be the same each time, and choose missing labels for the ones that depend on content)
    • assignees:
    Front Matter Field Example
    • name: 'TWE: Template Issue: Research: Create Roadmap'
    • about: This issue helps you structure your template issue to be consistent with our other template issues in roadmap
    • title: 'TWE: Research: IS[Replace YY]: RP[Replace 000]: [Replace TYPE OF PARTICIPANT] [Replace TYPE OF RESEARCH METHOD]: Roadmap : Create'
    • labels: 'feature: research', 'feature: roadmap', 'milestone: missing', 'role: UI/UX research', 'Participant Type: missing', 'Research 000: missing', 'complexity: missing'
    • 'size: 0.50pt'
    • assignees: ''
  • 1.03 Example Action Items for Finding Wiki Page and Template

    Example Action Items
    ### Action Items
    - Customize wiki page
         - [ ] Go to link 1.01 Internship Wiki, Join the team page
         - [ ] Find wiki page for this issue by looking at role pages.
         - [ ] Copy the link for the wiki page.
         - [ ] Add the link to Resource 2.01
            - [ ] Add the name of the link in square brackets
            - [ ] Add the URL in parenthesis without a space between the square bracket and parenthesis
    - Customize document template.
        - [ ] Go to link 1.02 Design Process Overview
        - [ ] Find document template that should be used in this issue.
        - [ ] Copy the link for the template.
        - [ ] Add the link to Resource 2.02
            - [ ] Add the name of the link in square brackets
            - [ ] Add the URL in parenthesis without a space between the square bracket and parenthesis
    
    Example Resource Lists
    ### Resources for creating this issue
    - 1.01. [Internship Wiki, Join the team page](https://github.com/hackforla/internship/wiki/Joining-the-Team)
    - 1.02. [Design Process Overview](https://github.com/hackforla/internship/wiki/Design-Process-Overview)
    
    ### Resource links gathered during the making of this issue
    - 2.01. [Wiki page for [Replace TYPE OF ROLE]]
    - 2.02. [TWE: Template: [Replace NAME OF TEMPLATE]]
    
  • 1.04 WIKI Templates by role pages

Resources gathered during the completion of this issue

  • 2.01 [TWE: [Replace ROLE]: [Replace DIRECT OBJECT]: [Replace ACTION VERB]]([Replace LINK])
@jinyan0425
Copy link
Contributor Author

jinyan0425 commented Sep 18, 2024

Draft of template issue for TWE: Research: Rapid Qualitative Analysis (RQA): Conduct Transcript Summaries

name: TWE: Template Issue: Research: Rapid Qualitative Analysis (RQA): Conduct Transcript Summaries
about: This issue helps you structure your template issue to be consistent with our other template issues in Rapid Qualitative Analysis
title: TWE: Research: Rapid Qualitative Analysis (RQA): Conduct Transcript Summaries
labels: feature: research, feature: research analysis, Participant Type: missing, Research 000: missing, size: 1pt, role: UI/UX research, milestone: missing, complexity: medium
assignees:


Instructions for creating this issue

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.

  • Customize the issue
    • Open the "Research Overview" wiki page (Resource 1.01)
    • Choose 'Research Plans, sorted by number' hyperlink
    • Choose the appropriate research roadmap or research plan folder (ie., RP###) on the wiki page
    • Use the information on the wiki page and in research roadmaps or research plans 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"; if the research hasn't been conducted, use the next cohort's enrollment year)
      • 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")
      • Research Plan Name
        • Find/Replace [Replace TITLE OF RESEARCH] with the research plan name on the wiki page or the research plan folder (ex: “Intern Intake Interview” or “Mentor Exit Interview”)
    • Copy and paste the edited template from text editor back into this Github Issue, replacing the 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]: Rapid Qualitative Analysis (RQA): Conduct Transcript Summaries
      
      • Choose "Edit" in the title section
      • Paste what 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 Screenshot 2023-01-11 at 10 50 11 AM, and apply the label Research: RP[Replace 000]
    • Under Labels, choose gear Screenshot 2023-01-11 at 10 50 11 AM, 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 TWE: Project Board
    • Add the milestone: choose gear Screenshot 2023-01-11 at 10 50 11 AM, and choose Research Analysis
    • 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 "Dependencies" (heading below) -- i.e., the issue assignee will never see this part F or PC: Ctrl+F) to search for and replace the keyword strings (including text and the brackets) below with the appropriate values

Dependencies

  • RP[Replace 000]'s Rapid Qualitative Analysis (RQA): Pre-process needs to be done. [Replace with Rapid Qualitative Analysis (RQA): Pre-process issue number]
  • RP[Replace 000]'s transcript has been transcribed, de-identified and cleaned up. [Replace with de-identification and clean-up issue numbers]

Overview

We need to re-analyze the data collected for RP001 to generate research findings, synthesize insights, and provide product recommendations. This template aims to help researchers conduct transcript summaries for Rapid Qualitative Analysis (RQA).

Action Items [IN PROGRESS]

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
    • Locate relevant wiki page for RP[Replace 000]
    • Copy the link for the wiki page
    • In Resources # 2.01, place the link you just copied between 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
    • Choose "Update comment" in Github and make sure all the checkboxes above have been checked Screenshot 2023-02-21 at 6 47 15 PM
  • Customize Resource for this Research Plan's Google Drive Folder

    • Open the Google Drive's Research by Type Folder (Resources # 1.02)
    • Choose the [Replace TYPE OF PARTICIPANT] folder
    • Choose the RP[Replace 000] folder
    • Copy the link of the RP[Replace 000] folder
      1. Choose the three vertical dots on the right side of the RP[Replace 000] folder Screenshot 2023-10-10 at 5 58 13 PM
      2. Choose "Share"
      3. Choose "Get link"
      4. Choose "Copy Link" and "Done"
    • In Resources # 2.02, place the link you just copied between 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
    • Choose "Update comment" in Github and make sure all the checkboxes above have been checked
    • Open the RP[Replace 000] folder in Google Drive (Resources # 2.02)
    • Locate the research plan in RP[Replace 000] folder
      • Choose RP[Replace 000]'s research plan in Google Doc
      • Copy the link of the RP[Replace 000] research plan
        1. Choose the three vertical dots on the right side of the RP[Replace 000] research plan Screenshot 2023-10-10 at 5 58 13 PM
        2. Choose "Share"
        3. Choose "Copy Link"
        4. The "Link copied" notification pops up
    • In Resources # 2.03, place the link you just copied between 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
    • Choose "Update comment" in Github and make sure all the checkboxes above have been checked
    • Locate the RP[Replace 000]'s de-identified transcript(s) in RP[Replace 000] folder (Resources # 2.02)
      • Choose RP[Replace 000]'s de-identified transcript(s)
      • Copy the link of the RP[Replace 000] de-identified transcript(s)
        1. Choose the three vertical dots on the right side of the RP[Replace 000] de-identified transcript(s) Screenshot 2023-10-10 at 5 58 13 PM
        2. Choose "Share"
        3. Choose "Copy Link"
        4. The "Link copied" notification pops up
    • In Resources # 2.04, place the link you just copied between 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
    • Choose "Update comment" in Github and make sure all the checkboxes above have been checked

Review Resources to Get Familiar with the Hamilton's Process of Rapid Qualitative Analysis (RQA)

  • If you are new to RQA, review the list of resources to get familiar with the RQA process and techniques (Resources 1.03 - 1.05)
  • If you are experienced with RQA, you may skip reviewing the documents or review them for a refresher

A STEP BY STEP LIST OF ALL THE TASK ITEMS THAT YOU CAN THINK OF NOW EXAMPLES INCLUDE: Research, reporting, coding, etc.

Resources [IN PROGRESS]

Resources for creating this issue

1.01 Wiki Intern Research Overview Page
1.02 Research by Participant Type Folder on Google Drive
1.03 Qualitative Methods in Rapid Turn-Around Health Services Research MUST READ
1.04 Linda's Presentation to UXR Team on How to Conduct Rapid Qualitative Analysis
1.05 A step-by-step Checklist for Conducting Rapid Qualitative Analysis - This issue comment provides more context on the checklist this issue is following

Resources gathered during the completion of this issue

2.01 [RP[Replace 000] Wiki Page]
2.02 [Google Drive RP[Replace 000] Folder]
2.03 [RP[Replace 000] Research Plan]
2.04 [RP[Replace 000] De-identified Transcript Folder]

@jinyan0425
Copy link
Contributor Author

I am working on it and hopefully, it will be finished by next week's all-team meeting (09/26).

@jinyan0425 jinyan0425 changed the title TWE: Create Template Issue: Rapid Qualitative Analysis (RQA): Transcript Summary Creation TWE: Create Template Issue: Rapid Qualitative Analysis (RQA): Transcript Summary Protocol Creation Sep 18, 2024
@jinyan0425 jinyan0425 changed the title TWE: Create Template Issue: Rapid Qualitative Analysis (RQA): Transcript Summary Protocol Creation TWE: Create Template Issue: Rapid Qualitative Analysis (RQA): Transcript Summary Sep 20, 2024
@jinyan0425 jinyan0425 changed the title TWE: Create Template Issue: Rapid Qualitative Analysis (RQA): Transcript Summary TWE: Create Template Issue: Rapid Qualitative Analysis (RQA): Conduct Transcript Summaries Sep 20, 2024
@jinyan0425
Copy link
Contributor Author

@pandanista Change of plan per our discussion. The issue has been updated to Conduct Transcript Summaries -- Phase 2 or RQA, and I'm moving it to the icebox for now, as it's blocked by the following issue that we still need to work on

@jinyan0425
Copy link
Contributor Author

@bonniewolfe @KC-skc @sunannie27

I will be leaving the country to visit my family from September 30 to October 21 and will miss all the Thursday meetings during this period. However, I will try to crunch some time to work on it and check in with Ying @pandanista for updates!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In progress (actively working)
Development

No branches or pull requests

2 participants