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

Updating Research Runbook templates #15046

Merged
merged 11 commits into from
Sep 22, 2023
92 changes: 46 additions & 46 deletions .github/ISSUE_TEMPLATE/ap-defect.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,46 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI i suspect this file is showing up due to whitespace changes but I can't figure out how to confirm. FYI @timcosgrove in case you care.

name: (AP) Defect
about: Work to fix a problem with existing functionality
title: "<Short description of the functional problem>"
labels: Accelerated Publishing, Defect

---

### What is the problem?
<!-- Describe the problem in a few sentences or less, focusing on the functional issue rather than the technical failure. -->

### Who is affected?
<!-- What is the user prevented from doing? About how many users are affected? -->

### How urgent is the issue?
Critical / Major / Minor

```[tasklist]
###
- [ ] The problem as described is fixed
- [ ] The repro steps result in 'expected result'
- [ ] An automated test is written to catch the problem, if appropriate
```

### How can we see the problem? (repro steps)
<!-- Please include environment, browser, operating system information if it is relevant. -->
1. Please include a set of steps that allows an independent tester to see the problem.
2. Write them so that after the defect is fixed, the steps will result in the expected result.
3. It is helpful to write the steps methodically so they can be the foundation of an automated test.

**Expected result:** What should be the outcome?<br />
**Actual result:** What currently happens?

### Is there any additional information?
Screenshots:

Log messages (please specify from where or what commands(s))
```
Log messages here
```

### Why is the problem happening and how do we fix it?
<!-- Provide any information about why the bug is happening. Links to tickets where the work was originally done are helpful. -->
<!-- This is the place for info about the technical failure. -->
<!-- This probably will not be filled out when the ticket is initially created. -->

---
name: (AP) Defect
about: Work to fix a problem with existing functionality
title: "<Short description of the functional problem>"
labels: Accelerated Publishing, Defect
---
### What is the problem?
<!-- Describe the problem in a few sentences or less, focusing on the functional issue rather than the technical failure. -->
### Who is affected?
<!-- What is the user prevented from doing? About how many users are affected? -->
### How urgent is the issue?
Critical / Major / Minor
```[tasklist]
###
- [ ] The problem as described is fixed
- [ ] The repro steps result in 'expected result'
- [ ] An automated test is written to catch the problem, if appropriate
```
### How can we see the problem? (repro steps)
<!-- Please include environment, browser, operating system information if it is relevant. -->
1. Please include a set of steps that allows an independent tester to see the problem.
2. Write them so that after the defect is fixed, the steps will result in the expected result.
3. It is helpful to write the steps methodically so they can be the foundation of an automated test.
**Expected result:** What should be the outcome?<br />
**Actual result:** What currently happens?
### Is there any additional information?
Screenshots:
Log messages (please specify from where or what commands(s))
```
Log messages here
```
### Why is the problem happening and how do we fix it?
<!-- Provide any information about why the bug is happening. Links to tickets where the work was originally done are helpful. -->
<!-- This is the place for info about the technical failure. -->
<!-- This probably will not be filled out when the ticket is initially created. -->
14 changes: 3 additions & 11 deletions .github/ISSUE_TEMPLATE/research-plan-and-conversation-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Research Plan and Conversation Guide
about: Use this template when you are drafting a research plan & conversation guide
title: Draft [PRODUCT/INITIATIVE] Research Plan & Conversation Guide
labels: Design, Research
labels: UX, Research
assignees: ''

---
Expand All @@ -16,10 +16,10 @@ Use the appropriate templates for the type of research you are conducting:
- [Veteran-facing Conversation Guide Template](https://github.com/department-of-veterans-affairs/va.gov-team/blob/master/platform/research/planning/conversation-guide-template.md)

Suggested workflow:
- [ ] Create your initial drafts in Google Docs for collaborative editing
- [ ] Create your initial drafts in Sharepoint for collaborative editing
- [ ] Solicit feedback on artifacts from Design Team and Product Manager
- [ ] Schedule a 1-hour meeting with the Product Owner to review artifacts (also invite Product Manager)
- [ ] Convert artifacts to MS Word for PO review and send at least 24 hours in advance of the review meeting
- [ ] Send artifacts to PO for review at least 24 hours in advance of the review meeting
- [ ] Convert into markdown files for final approval and sending to Research Review cycle

## Acceptance Criteria
Expand All @@ -28,11 +28,3 @@ Suggested workflow:
- [ ] Update artifacts with PO feedback from review meeting
- [ ] Convert artifacts to markdown format and store in github Research Folder
- [ ] Get final approval from PO before sending to Research Review cycle

### Team
Please check the team(s) that will do this work.

- [ ] `CMS Team`
- [ ] `Public Websites`
- [ ] `Facilities`
- [ ] `User support`
14 changes: 3 additions & 11 deletions .github/ISSUE_TEMPLATE/research-readout-and-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Research Readout and Documentation
about: Use this template when reporting your research via readouts and documentation.
title: Conduct [PRODUCT/INITIATIVE] Research Readout and Document Findings in Research
Repository
labels: Design, Research
labels: Research, UX
assignees: ''

---
Expand All @@ -12,7 +12,7 @@ assignees: ''

**Crafting Recommendations**

Recommendations are key outputs of the research process. They connect your findings back to the product roadmap(s) and shape the experience of future users. Depending on the type of research conducted, recommendations might be narrowly focused on improving a specific interface component of your team's product, or they might have broad implications for multiple parts of the VA.gov ecosystem. Work with your Design team, Product Manager, & Product Owner to generate, refine, and categorize recommendations. PMs and POs also play a key role in socializing recommendations to other teams.
Recommendations are key outputs of the research process. They connect your findings back to the product roadmap(s) and shape the experience of future users. Depending on the type of research conducted, recommendations might be narrowly focused on improving a specific interface component of your team's product, or they might have broad implications for multiple parts of the VA.gov ecosystem. Work with your UX team, Product Manager, & Product Owner to generate, refine, and categorize recommendations. PMs and POs also play a key role in socializing recommendations to other teams.

**Research Readout(s)**
- Work with PM & PO to determine audience(s) and meeting length(s)
Expand All @@ -24,7 +24,7 @@ Recommendations are key outputs of the research process. They connect your findi
- Message Naomi Marcussen on Slack to sign up

**Documenting Findings**
- Building off the Topline Report, fill out the [Research Findings Template](https://github.com/department-of-veterans-affairs/va.gov-team/blob/master/platform/research/sharing-research/research-findings-template.md) and add it to your Research Folder
- Building off the Topline Summary, fill out the [Research Findings Template](https://github.com/department-of-veterans-affairs/va.gov-team/blob/master/platform/research/sharing-research/research-findings-template.md) and add it to your Research Folder
- Once your findings are fully written up, make sure they are linked to from the relevant research repository
- Veteran-facing research:[How to add reserach to Platform Repo](https://github.com/department-of-veterans-affairs/va.gov-research-repository/issues/70)
- Editor-facing research: [CMS Research Repository](https://github.com/department-of-veterans-affairs/va.gov-team/tree/master/platform/cms/research)
Expand All @@ -38,11 +38,3 @@ Recommendations are key outputs of the research process. They connect your findi
- [ ] Conduct readout(s)
- [ ] Document findings in Research Repo
- [ ] Destroy or archive research materials

### Team
Please check the team(s) that will do this work.

- [ ] `CMS Team`
- [ ] `Public Websites`
- [ ] `Facilities`
- [ ] `User support`
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,3 @@ assignees: ''
- [ ] Schedule Pilot session
- [ ] Schedule Daily Research Debriefs and invite relevant team members

### Team
Please check the team(s) that will do this work.

- [ ] `CMS Team`
- [ ] `Public Websites`
- [ ] `Facilities`
- [ ] `User support`
11 changes: 2 additions & 9 deletions .github/ISSUE_TEMPLATE/research-review-cycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Research Review Cycle
about: Use this template when you have a research plan & conversation guide ready
for review by other teams
title: Conduct [PRODUCT/INITIATIVE] Research Review Cycle
labels: Design, Research
labels: UX, Research
assignees: ''

---
Expand All @@ -13,18 +13,11 @@ assignees: ''
- Veteran-facing research must go through Platform's [Research Review Cycle](https://depo-platform-documentation.scrollhelp.site/research-design/research-checklist#ResearchChecklist-2.Researchreview)
- Editor-facing research must go through the [CMS Collaboration Cycle](https://va-gov.atlassian.net/wiki/spaces/VAGOV/pages/1791459333/CMS+Collaboration+Cycle)

Note: This step is a hard blocker for Veteran Recruitment, but less so for Editor Recruitment.
Note: This step is a hard blocker for Veteran Recruitment, but may be less so for Editor Recruitment.

## Acceptance Criteria
- [ ] Create the necessary tickets for the Review Cycle
- [ ] Incorporate any feedback from the Review Cycle into the Research Plan and Conversation Guide
- [ ] If there are significant alterations, consult your Product Manager or Product Owner
- [ ] Once approved, move on to Participant Recruitment & Scheduling

### Team
Please check the team(s) that will do this work.

- [ ] `CMS Team`
- [ ] `Public Websites`
- [ ] `Facilities`
- [ ] `User support`
11 changes: 2 additions & 9 deletions .github/ISSUE_TEMPLATE/research-sessions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Research Sessions
about: Use this template when you are conducting research session
title: Conduct [PRODUCT/INITIATIVE] Research Sessions
labels: Design, Research
labels: UX, Research
assignees: ''

---
Expand All @@ -14,7 +14,7 @@ assignees: ''
- [Research Safety guidelines](https://depo-platform-documentation.scrollhelp.site/research-design/research-safety-and-emergency-exit-strategies)
- [Notetaker guidelines](https://depo-platform-documentation.scrollhelp.site/research-design/observer-guidelines#Observerguidelines-Howtobeagoodnotetaker)
- For Veteran-facing research, Perigean can provide a notetaker
- For Editor-facing research, the Product Manager or a member of the Design Team should take notes
- For Editor-facing research, the Product Manager or a member of the UX Team should take notes
- [Observer guidelines](https://depo-platform-documentation.scrollhelp.site/research-design/observer-guidelines)

**Recruitment Trackers**
Expand Down Expand Up @@ -46,10 +46,3 @@ assignees: ''
- [ ] You have conducted enough sessions to satisfy our intended demographics from research plan
- [ ] OR Product Owner has signed off that you've done enough to move forward

### Team
Please check the team(s) that will do this work.

- [ ] `CMS Team`
- [ ] `Public Websites`
- [ ] `Facilities`
- [ ] `User support`
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
name: Research Synthesis and Topline Report
name: Research Synthesis and Topline Summary
about: Use this template when synthesizing your research and reporting the topline
findings.
title: Synthesize [PRODUCT/INITIATIVE] Research & Create Topline Report
labels: Design, Research
title: Synthesize [PRODUCT/INITIATIVE] Research & Create Topline Summary
labels: Research, UX
assignees: ''

---
Expand All @@ -17,24 +17,16 @@ assignees: ''
- Conduct statistical analysis
- Revisit the hypotheses from the Research Plan to see which can be confirmed

Topline Report:
Topline Summary:
- Use the [Topline Summary Template](https://github.com/department-of-veterans-affairs/va.gov-team/blob/master/platform/research/sharing-research/topline-summary-template.md) to summarize major findings
- Consult your Product Manager and Product Owner to see if a meeting should be scheduled to discuss the Topline Report
- Your PM and PO may have additional questions based on Topline Report that require additional synthesis
- Your PM and PO may have additional questions based on Topline Summary that require additional synthesis
- This is just a summary of findings, no recommendations

Next Steps:
- The Research Lead should work with the Design Team & PM to create recommendations
- The Research Lead should work with the UX Team & PM to create recommendations
- The PM & PO should decide if a full research readout is required and who needs to be invited

## Acceptance Criteria
- [ ] Create Topline Report, share with PO, and update if needed
- [ ] Create Topline Summary, share with PO, and update if needed
- [ ] Schedule a full research readout (if PM & PO request)

### Team
Please check the team(s) that will do this work.

- [ ] `CMS Team`
- [ ] `Public Websites`
- [ ] `Facilities`
- [ ] `User support`
22 changes: 7 additions & 15 deletions .github/ISSUE_TEMPLATE/runbook---ux-research.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Runbook - UX Research
about: Use this template when starting a new UX research process. This will create
a high-level checklist to guide you through building tickets for upcoming sprints.
title: "[PRODUCT/INITIATIVE] Research Runbook"
labels: Design, Research
labels: UX, Research
assignees: ''

---
Expand All @@ -19,21 +19,13 @@ Here are the steps to follow when setting up a new UX research process:
**Setting up your Research Epic**
- [ ] Create a Research [Epic](https://github.com/department-of-veterans-affairs/va.gov-cms/issues/new?assignees=&labels=Epic%2C+Needs+refining&template=cms-epic.md&title=%3CInsert+summary+of+epic%3E) for your product/initiative
- [ ] Create a Research Folder following [Platform's Research guidance](https://depo-platform-documentation.scrollhelp.site/research-design/research-checklist#ResearchChecklist-1.Planningforresearch)
- [ ] Create a [Research Plan & Conversation Guide](https://github.com/department-of-veterans-affairs/va.gov-cms/issues/new?assignees=&labels=Design%2C+Research&template=research-plan-and-conversation-guide.md&title=Draft+%5BPRODUCT%2FINITIATIVE%5D+Research+Plan+%26+Conversation+Guide) issue
- [ ] Create a [Research Review Cycle](https://github.com/department-of-veterans-affairs/va.gov-cms/issues/new?assignees=&labels=Design%2C+Research&template=research-review-cycle.md&title=Conduct+%5BPRODUCT%2FINITIATIVE%5D+Research+Review+Cycle) issue
- [ ] Create a [Research Recruitment & Scheduling](https://github.com/department-of-veterans-affairs/va.gov-cms/issues/new?assignees=&labels=Design%2C+Research&template=research-recruitment-and-scheduling.md&title=Recruit+and+schedule+participants+for+%5BPRODUCT%2FINITIATIVE%5D+research) issue
- [ ] Create a [Research Sessions](https://github.com/department-of-veterans-affairs/va.gov-cms/issues/new?assignees=&labels=Design%2C+Research&template=research-sessions.md&title=Conduct+%5BPRODUCT%2FINITIATIVE%5D+Research+Sessions) issue
- [ ] Create a [Research Synthesis & Topline Report](https://github.com/department-of-veterans-affairs/va.gov-cms/issues/new?assignees=&labels=Design%2C+Research&template=research-synthesis-and-topline-report.md&title=Synthesize+%5BPRODUCT%2FINITIATIVE%5D+Research+%26+Create+Topline+Report) issue
- [ ] Create a [Research Readout & Documentation](https://github.com/department-of-veterans-affairs/va.gov-cms/issues/new?assignees=&labels=Design%2C+Research&template=research-readout-and-documentation.md&title=Conduct+%5BPRODUCT%2FINITIATIVE%5D+Research+Readout+and+Document+Findings+in+Research+Repository) issue
- [ ] Create a [Research Plan & Conversation Guide](https://github.com/department-of-veterans-affairs/va.gov-cms/issues/new?assignees=&labels=UX%2C+Research&template=research-plan-and-conversation-guide.md&title=Draft+%5BPRODUCT%2FINITIATIVE%5D+Research+Plan+%26+Conversation+Guide) issue
- [ ] Create a [Research Review Cycle](https://github.com/department-of-veterans-affairs/va.gov-cms/issues/new?assignees=&labels=UX%2C+Research&template=research-review-cycle.md&title=Conduct+%5BPRODUCT%2FINITIATIVE%5D+Research+Review+Cycle) issue
- [ ] Create a [Research Recruitment & Scheduling](https://github.com/department-of-veterans-affairs/va.gov-cms/issues/new?assignees=&labels=UX%2C+Research&template=research-recruitment-and-scheduling.md&title=Recruit+and+schedule+participants+for+%5BPRODUCT%2FINITIATIVE%5D+research) issue
- [ ] Create a [Research Sessions](https://github.com/department-of-veterans-affairs/va.gov-cms/issues/new?assignees=&labels=UX%2C+Research&template=research-sessions.md&title=Conduct+%5BPRODUCT%2FINITIATIVE%5D+Research+Sessions) issue
- [ ] Create a [Research Synthesis & Topline Summary](https://github.com/department-of-veterans-affairs/va.gov-cms/issues/new?assignees=&labels=UX%2C+Research&template=research-synthesis-and-topline-report.md&title=Synthesize+%5BPRODUCT%2FINITIATIVE%5D+Research+%26+Create+Topline+Summary) issue
- [ ] Create a [Research Readout & Documentation](https://github.com/department-of-veterans-affairs/va.gov-cms/issues/new?assignees=&labels=UX%2C+Research&template=research-readout-and-documentation.md&title=Conduct+%5BPRODUCT%2FINITIATIVE%5D+Research+Readout+and+Document+Findings+in+Research+Repository) issue
- [ ] Add all the above issues to the Research Epic and add dependencies

## Acceptance Criteria
- [ ] All tickets have been created and assigned

### Team
Please check the team(s) that will do this work.

- [ ] `CMS Team`
- [ ] `Public Websites`
- [ ] `Facilities`
- [ ] `User support`