TWE: Create Template Issue: Create Timeline for Research Plans

[pandanista]

Overview

We need to create a template issue for TWE: Research: Timeline for Research Plans: Create (named in the format as TWE: Role: Direct Object: Action Verb) so that we have a consistent, transparent, defined, and self-supporting structure for people creating 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 `[Replace NAME OF ISSUE TEMPLATE]`
  ---
  **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

  • TWE: WIKI: UX Research Guides Templates
  • Design
  • Product
  • [Business Analyst / Data Science]
  • [Software Engineer]
  • [Marketing]
  • default document templates, in case you don't have one yet, can be found on the Design Process Overview page

Resources gathered during the completion of this issue

• 2.01 [TWE: [Replace ROLE]: [Replace DIRECT OBJECT]: [Replace ACTION VERB]]([Replace LINK])

[pandanista]

Draft of template issue for Research Plan Timeline Template

name: Research: Create Timeline for Each Research Plan about: We are creating a template for research plans' timelines so we can track research activities under each research plan. title: TWE: IS[Replace YY]: RP[Replace 000]: Research Plan Timeline: Create labels: 'feature: research plan', 'feature: research', 'Participant Type: missing', 'Research 000: missing', 'size: 0.5pt', 'role: UI/UX research', 'milestone: missing', 'complexity: small` 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 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 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]: Timeline Table: Create

    • [ ] Choose "Edit" in the title section
    • [ ] Paste 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

Dependency

• [ ] Research plan for RP[Replace 000] has been drafted

Overview

Create a timeline table for RP[Replace 000] so that we can keep track of all the research activities.

Action Items

Customize Resource Links

• Customize Resource for Wiki Page Link
  • [ ] Go to the wiki page: Research Output Overview (Resources # 1.01)
  • [ ] Open relevant wiki page for RP[Replace 000]
  • [ ] Copy the link for the RP[Replace 000] wiki page
  • [ ] Update Resources # 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
  • [ ] Open the Google Drive's Research by Type Folder (Resources # 1.02)
  • [ ] Open the [Replace TYPE OF PARTICIPANT] Folder
  • [ ] Right-click on the RP[Replace 000] folder
  • [ ] Choose "Get Link"
  • [ ] Choose "Copy link" and "Done"
  • [ ] Update Resources # 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 RP[Replace 000]'s Research Plan Doc
  • [ ] Open RP[Replace 000] folder (the link in Resources # 2.02) if the folder is not open
  • [ ] Right-click on the RP[Replace 000]'s Research Plan doc
  • [ ] Choose "Get Link"
  • [ ] Choose "Copy link" and "Done"
  • [ ] Update Resources # 2.03 with the link you just copied. Paste it inside parentheses at the end of the line.
• Customize Resource for RP[Replace 000]'s Timeline table
  • [ ] Open the template "TWE: Template: Research Plan Timeline Table" (Resources 1.03)
  • [ ] Choose the "Use Template" button to save it to your own drive
  • Rename the file by following the steps:
    • [ ] Copy

      TWE: IS[Replace YY]: RP[Replace 000]: Timeline Table

    • [ ] Choose "File" > "Rename", and paste the texts you copied into the top field
      
  • [ ] 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 Type > [Replace TYPE OF PARTICIPANT]> folder for RP[Replace 000]
    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 Timeline Table, 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 the spreadsheet

• Customize the TWE: Template: IS[Replace YY]: RP[Replace 000]: Timeline Table (linked in Resources # 2.04
  • [ ] Copy

    RP[Replace 000] Timeline

  • [ ] Choose RP[Replace 000] Timeline tab
  • [ ] Choose the green down arrow
  • [ ] Choose "Rename"
  • [ ] Paste the texts you copied into the field
  • [ ] Copy

    TWE: IS[Replace YY]: RP[Replace 000]: Timeline Table

  • [ ] Choose the header row (row 1)
  • [ ] Choose all text in the formula bar (double click), paste the text you copied, replacing the original text
  • [ ] Go to the RP[Replace 000]'s Research Plan doc linked in Resources # 2.03
  • [ ] Identify "Research Activity" in Column A that is needed for RP[Replace 000] based on the research method(s)
  • [ ] Delete the rows where the "Research Activity" does not apply to the study
  • [ ] Fill out "Tentative Start Date", "Duration", and "Who is involved" Column B - D based on the info in RP[Replace 000]'s Research Plan doc
  • [ ] Set up a meeting with RP[Replace 000]'s assignee to review the timeline table (If you are RP[Replace 000]'s assignee, then skip the meeting)
  • [ ] Revise Column A - D based on the conclusions from the meeting
  • [ ] Reach out to UX Lead and ask for a peer review
  • [ ] UX Lead assigns a team member to conduct a peer review
  • [ ] Make revisions based on the peer review

• Update RP[Replace 000]'s Research Plan doc
  • [ ] Open the link in Resources 2.03
  • [ ] Copy (Command+A and Command+C on a Mac; Ctrl+A and Ctrl+C on a PC) the entire Timeline Table linked in Resources 2.04
  • [ ] Paste (Command+V on a Mac; Ctrl+V on a PC) into the Timeline Section in the Research Plan doc
  • [ ] Choose "Link to spreadsheet" and "Paste"
  • [ ] Make sure the table looks readable in the Research Plan Google Doc
• Update the wiki page for this research plan (Resources # 2.01)
  • [ ] Open the link in Resources 2.01
  • [ ] Choose "Edit" to edit the page
  • [ ] Find the "Current Status" 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 "Current Status" section
  • [ ] Choose "Save Page"
• [ ] 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 Type 1.03 TWE: IS[Replace YY]: RP[Replace 000]: Timeline Table

Resources gathered during the completion of this issue

2.01 [Wiki: Research Plan [Replace 000]] 2.02 [Google Drive Folder: RP[Replace 000]] 2.03 [TWE: IS[Replace YY]: RP[Replace 000]: Research Plan] 2.04 [TWE: IS[Replace YY]: RP[Replace 000]: Timeline Table]

[priyatalwar]

@pandanista this issue seems to be in the "new issue approval". Are you currently working on it? If so, please move it to "in progress". Thanks!

[pandanista]

@priyatalwar Thank you. I am moving it to backlog because we were testing the template and it hasn't been completed yet.

[pandanista]

@priyatalwar Turns out it shouldn't be in the backlog column since it is for template making and the UI/UX label will make it confusing to the team. Would it make more sense to move it to the icebox or just leave it in the new issue approval column?

[sunannie27]

• The action items at the top are based on an old issue template, we are currently working on a new issue template in issue #508. When that is done, the action items and dependencies of this issue will need to change.

[pandanista]

This template issue has been updated using the new instructions.