TWE: Create Template Issue: Update Wiki Page #593

pandanista · 2024-05-29T02:25:38Z

Overview

We need to create a template issue for [TWE: Research: Wiki Page: Update (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 [TWE: Research: Wiki Page: Update] 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 Management.
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".

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: Wiki Page: Update`
---
**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 Management.
    - [ ] 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])

The text was updated successfully, but these errors were encountered:

pandanista · 2024-05-29T02:37:37Z

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', 'feature: research audits', 'p-feature: wiki', 'Participant Type: missing', 'Research 000: missing', 'size: 1pt', 'role: UI/UX research', 'milestone: missing'
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 Output 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 roadmaps or research plans to customize this issue
- Copy and paste entire template text in this issue into text editor (i.e., "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")
  - 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]: Research: Update Wiki Page
```
  - 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 , 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 TWE: Project Board
- Add the milestone: choose gear , and choose Research Audit and Update Wiki Page
- 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

We need to review and update the wiki page for [Replace TITLE of RESEARCH] so that we can stay organized, consistent, and up-to-date on the wiki.

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.

Action Items

Customize Resource Links

Customize Resource for Wiki Page Link
- Go to the wiki page: Research Output Overview (Resources # 1.01)
- Scroll down to the section Research by Plan Number
- Open the hyperlink Research Plans, sorted by number (Resources # 1.02)
- 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]
- Return to the issue you are working on
- Choose three dots and Edit in this comment
- In Resource # 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
Customize Resource for the Research Plan's folder on Google Drive
- Go to the Shared Drives > Internship > Internships > Research > Research by Plan # and Name (Resources # 1.03)
- Go to the research plan folder of RP[Replace 000]
- Right-click on the RP[Replace 000] folder
- Choose "Get Link"
- Choose "Copy link" and "Done"
- In Resource # 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

Review files in RP[Replace 000] folder on Google Drive

Go to the Shared Drives > Internship > Internships > Research > Research by Plan # and Name > RP[Replace 000] folder (Resources # 2.02)
Review all files in the folder of RP[Replace 000] to get familiar with this research plan
Gather information regarding RP[Replace 000] that will be reflected in the wiki page update

Update Wiki Page (Resources # 2.01)

Resources/Instructions

Resources for creating this issue

1.01 Research Output Overview
1.02 Research: Plans: by Number
1.03 Google Drive, Research Folder
1.04 Internship issues direct link
1.05 Research Home Page

Resources gathered during the completion of this issue

2.01 [RP[Replace 000]: Wiki Page]
2.02 [RP[Replace 000]: Research Folder on Google Drive]

pandanista · 2024-05-29T02:47:16Z

Need to update the template above further by adding customize the issue and customize the settings sections, then we will update the order of the resources if needed.

See this comment for more info.

pandanista · 2024-06-13T02:39:38Z

@jinyan0425 Would you mind finish updating this wiki page update template? Thank you.

The customize the issue and customize the settings can be found in this comment you drafted in TWE: Revise Research: Research Plan Template #533.

jinyan0425 · 2024-06-20T02:24:44Z

@jinyan0425 Would you mind finish updating this wiki page update template? Thank you.

The customize the issue and customize the settings can be found in this comment you drafted in TWE: Revise Research: Research Plan Template #533.

@pandanista I have added the customization sections and reordered the sources as needed.

pandanista · 2024-06-27T00:01:32Z

For the update wiki page template, there is an action item that asks the assignee to link the issues related to the RP### label. I'd like to get some clarification on the scope of the action item.

Does it only ask the assignee to use the Feature: RP008 to check and see if they are all labelled correctly using the RP###?
Does the assignee check all open and closed issues using Internship issues direct link to check all the issues?

ExperimentsInHonesty · 2024-08-08T17:20:38Z

@jinyan0425 Next step is to test this issue using this testing template Once you have created the testing issue, add the link to a new comment here and the label status: template testing (step 2b) to this issue.

pandanista · 2024-08-09T01:13:04Z

I updated thetesting template, and some of the changes include:

Correcting feature: test a template (step 2a) to feature: template test (step 3) since the step 3 label needs to be added to any new testing issues assignees create instead of step 2a;
Adding status: template testing (step 2b) to the create template draft issue in the instructions.

@jinyan0425 Let me know if we need to make more changes to the testing template while you set it up. Thank you.

jinyan0425 · 2024-09-27T02:53:34Z

Shall we move this to the ICEBOX? @pandanista Could you please check this with Bonnie next week? If so, please move it to the ICEBOX. Thank you!

ExperimentsInHonesty · 2024-11-21T18:40:41Z

This issue is waiting on #TWE: IS24: RP025: Research Plan: Create #614 to be completed

pandanista added role: missing feature: missing size: missing feature: board / google drive / tools clean or setup issues milestone: missing labels May 29, 2024

pandanista changed the title ~~TWE: Create Template Issue: [name of template]~~ TWE: Create Template Issue: Update Wiki Page May 29, 2024

pandanista added this to the 03 - Project Management milestone May 29, 2024

pandanista added role: UI/UX research p-feature: wiki feature: template creation (step 1) issue to create a new template (see other labels with test in them) feature: research All issues involving research and removed feature: board / google drive / tools clean or setup issues labels May 29, 2024

pandanista added size: 1pt Can be done in 6 hours and removed role: missing feature: missing milestone: missing size: missing labels May 29, 2024

pandanista mentioned this issue May 29, 2024

TWE: Revise Research: Update WIKI Template #534

Closed

21 tasks

ExperimentsInHonesty added this to P: TWE: Project Board Jun 10, 2024

ExperimentsInHonesty moved this to Prioritized Backlog in P: TWE: Project Board Jun 10, 2024

ExperimentsInHonesty added the PBV: research all issues for the research team label Jun 10, 2024

pandanista moved this from Prioritized Backlog to In progress (actively working) in P: TWE: Project Board Jun 13, 2024

pandanista assigned jinyan0425 Jun 13, 2024

ExperimentsInHonesty added Participant Type: missing complexity: missing Participant Type: TWE Team Member and removed Participant Type: missing labels Jun 17, 2024

jinyan0425 added the ready for research lead label Jun 20, 2024

jinyan0425 moved this from In progress (actively working) to Questions/Review in P: TWE: Project Board Jun 20, 2024

pandanista added complexity: medium and removed complexity: missing labels Jun 20, 2024

pandanista added Ready for product When the issue is ready for product team to review and removed ready for research lead labels Jun 27, 2024

This comment was marked as resolved.

Sign in to view

ExperimentsInHonesty mentioned this issue Aug 8, 2024

TWE: All Team meeting Agenda #101

Open

2 tasks

This was referenced Aug 8, 2024

TWE: UX Lead and PM Agenda #315

Open

TWE: Agenda for PM meetings #49

Open

ExperimentsInHonesty removed the Ready for product When the issue is ready for product team to review label Aug 8, 2024

ExperimentsInHonesty moved this from Questions/Review to In progress (actively working) in P: TWE: Project Board Aug 8, 2024

jinyan0425 mentioned this issue Aug 12, 2024

Research: Test: Issue Template: Update Wiki Page #611

Open

31 tasks

jinyan0425 added the status: template testing (step 2b) added to issue in the questions column after a test issue has been made/linked label Aug 13, 2024

jinyan0425 moved this from Questions/Review to In progress (actively working) in P: TWE: Project Board Sep 25, 2024

ExperimentsInHonesty added the Ready for product When the issue is ready for product team to review label Nov 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TWE: Create Template Issue: Update Wiki Page #593

TWE: Create Template Issue: Update Wiki Page #593

pandanista commented May 29, 2024 •

edited

Loading

pandanista commented May 29, 2024 •

edited

Loading

pandanista commented May 29, 2024 •

edited

Loading

pandanista commented Jun 13, 2024

jinyan0425 commented Jun 20, 2024 •

edited

Loading

pandanista commented Jun 27, 2024

This comment was marked as resolved.

ExperimentsInHonesty commented Aug 8, 2024

pandanista commented Aug 9, 2024

jinyan0425 commented Sep 27, 2024 •

edited

Loading

ExperimentsInHonesty commented Nov 21, 2024

TWE: Create Template Issue: Update Wiki Page #593

TWE: Create Template Issue: Update Wiki Page #593

Comments

pandanista commented May 29, 2024 • edited Loading

Overview

Action Items

Customize this issue

Customize the issue settings (located in right sidebar)

Customize template draft

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

Resources/Instructions

Resources for creating this issue

Resources gathered during the completion of this issue

pandanista commented May 29, 2024 • edited Loading

Revised Update Wiki Page Template

Instructions for creating this issue

Overview

Action Items

Customize Resource Links

Review files in RP[Replace 000] folder on Google Drive

Update Wiki Page (Resources # 2.01)

Resources/Instructions

Resources for creating this issue

Resources gathered during the completion of this issue

pandanista commented May 29, 2024 • edited Loading

pandanista commented Jun 13, 2024

jinyan0425 commented Jun 20, 2024 • edited Loading

pandanista commented Jun 27, 2024

This comment was marked as resolved.

ExperimentsInHonesty commented Aug 8, 2024

pandanista commented Aug 9, 2024

jinyan0425 commented Sep 27, 2024 • edited Loading

ExperimentsInHonesty commented Nov 21, 2024

pandanista commented May 29, 2024 •

edited

Loading

pandanista commented May 29, 2024 •

edited

Loading

pandanista commented May 29, 2024 •

edited

Loading

jinyan0425 commented Jun 20, 2024 •

edited

Loading

jinyan0425 commented Sep 27, 2024 •

edited

Loading