From cf4adaf459db0c2136dc3c24304a1572e1c9c557 Mon Sep 17 00:00:00 2001 From: Cindy Merrill <69914583+cindymerrill@users.noreply.github.com> Date: Wed, 8 Nov 2023 13:55:36 -0800 Subject: [PATCH] [docs] Research runbook updates (#16069) * demo commit * splitting plan and conversation guide * renaming ticket templates * better renaming * added discovery ticket & updated runbook * added "add link" reminders * added user story * updates * revised all * ready to share w/Dave & Alexis * added: document approval at bottom of file * added "VA" in front of "PO" * reformatted User Story * incorporated Alexis's fdback --------- Co-authored-by: Dave Pickett <51967950+davidmpickett@users.noreply.github.com> --- .../research-conversation-guide.md | 37 +++++++++++++++++++ .github/ISSUE_TEMPLATE/research-discovery.md | 32 ++++++++++++++++ ...conversation-guide.md => research-plan.md} | 10 ++--- ...ent-and-scheduling.md => research-prep.md} | 9 ++--- ...n.md => research-readout-and-post-task.md} | 7 ++-- .github/ISSUE_TEMPLATE/research-sessions.md | 2 +- ....md => research-synthesis-and-repoting.md} | 7 ++-- .../ISSUE_TEMPLATE/runbook---ux-research.md | 21 +++++------ 8 files changed, 94 insertions(+), 31 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/research-conversation-guide.md create mode 100644 .github/ISSUE_TEMPLATE/research-discovery.md rename .github/ISSUE_TEMPLATE/{research-plan-and-conversation-guide.md => research-plan.md} (67%) rename .github/ISSUE_TEMPLATE/{research-recruitment-and-scheduling.md => research-prep.md} (93%) rename .github/ISSUE_TEMPLATE/{research-readout-and-documentation.md => research-readout-and-post-task.md} (91%) rename .github/ISSUE_TEMPLATE/{research-synthesis-and-topline-summary.md => research-synthesis-and-repoting.md} (90%) diff --git a/.github/ISSUE_TEMPLATE/research-conversation-guide.md b/.github/ISSUE_TEMPLATE/research-conversation-guide.md new file mode 100644 index 0000000000..67d734c87d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/research-conversation-guide.md @@ -0,0 +1,37 @@ +--- +name: Research Conversation Guide +about: Use this template when you are drafting a conversation guide +title: Draft [PRODUCT/INITIATIVE] conversation guide +labels: UX, Research +assignees: '' + +--- + +## Description + +### User story +**AS A** Researcher +**I WANT** to document the details for conducting PAW usability sessions +**SO THAT** the research will achieve the stated goals and answer the research questions + +### Templates + +Use the appropriate template for the group you're conducting research with: +- [Editor-facing Conversation Guide Template](https://github.com/department-of-veterans-affairs/va.gov-team/blob/master/platform/cms/research/editor-moderation-guide.md) +- [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/tasks: +- [ ] Brainstorm potential tasks +- [ ] Create initial draft of conversation guide +- [ ] Solicit feedback from UX Lead and/or Product Manager (PM) +- [ ] Solicit feedback from VA Product Owner (PO) async or in a meeting w/PM +- [ ] Test prototype(s) with conversation guide and align +- [ ] Post on github in project research folder for final approval before submitting to Research Review cycle + +## Acceptance Criteria +- [ ] Conversation guide drafted +- [ ] Feedback incorporated from UX Lead and/or PM +- [ ] Feedback incorporated from VA PO +- [ ] Conversation guide aligns with prototype(s) +- [ ] Conversation guide posted on github in project research folder +- [ ] Final approval obtained from VA PO and documented at the bottom of the file in preparation for Research Review cycle diff --git a/.github/ISSUE_TEMPLATE/research-discovery.md b/.github/ISSUE_TEMPLATE/research-discovery.md new file mode 100644 index 0000000000..be5500260b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/research-discovery.md @@ -0,0 +1,32 @@ +--- +name: Research Discovery +about: Use this template when exploring if research is needed/viable +title: Discovery for [PRODUCT/INITIATIVE] research +labels: UX, Research +assignees: '' + +--- + +## Description + +Research Discovery is a time to establish the fundamental approach for a research initiative. Possible tasks may include: + +**What do we want to know?** +- [ ] Align with Product Manager & Product Owner on the high-level purpose and scope of the research +- [ ] Review Product outline to understand background context +- [ ] Draft big picture research questions + +**Has anyone else researched this before?** +- [ ] Review previous research on this Product (if available) +- [ ] Review Research Repo for previous relevant research from other teams +- [ ] Summarize findings from research review + +**How might we learn more?** +- [ ] Consider methodologies - do we have the right tools to build a useful prototype? +- [ ] Consider participants - do we have access to the right users? +- [ ] Consider timeline - how long will this take? how much time do we have? + +## Acceptance Criteria +- [ ] High-level scope of research is drafted and agreed upon +- [ ] Subsequent tickets are created + diff --git a/.github/ISSUE_TEMPLATE/research-plan-and-conversation-guide.md b/.github/ISSUE_TEMPLATE/research-plan.md similarity index 67% rename from .github/ISSUE_TEMPLATE/research-plan-and-conversation-guide.md rename to .github/ISSUE_TEMPLATE/research-plan.md index ae7075b2ed..d37c1ee0e0 100644 --- a/.github/ISSUE_TEMPLATE/research-plan-and-conversation-guide.md +++ b/.github/ISSUE_TEMPLATE/research-plan.md @@ -1,7 +1,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 +name: Research Plan +about: Use this template when you are drafting a research plan +title: Draft [PRODUCT/INITIATIVE] research plan labels: UX, Research assignees: '' @@ -9,11 +9,9 @@ assignees: '' ## Description -Use the appropriate templates for the type of research you are conducting: +DEMO Use the appropriate templates for the type of research you are conducting: - [Editor-facing Research Plan Template](https://github.com/department-of-veterans-affairs/va.gov-team/blob/master/platform/cms/research/sitewide-cms-editor-research-plan-template.md) -- [Editor-facing Conversation Guide Template](https://github.com/department-of-veterans-affairs/va.gov-team/blob/master/platform/cms/research/editor-moderation-guide.md) - [Veteran-facing Research Plan Template](https://github.com/department-of-veterans-affairs/va.gov-team/blob/master/platform/research/research-plan-template.md) -- [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 Sharepoint for collaborative editing diff --git a/.github/ISSUE_TEMPLATE/research-recruitment-and-scheduling.md b/.github/ISSUE_TEMPLATE/research-prep.md similarity index 93% rename from .github/ISSUE_TEMPLATE/research-recruitment-and-scheduling.md rename to .github/ISSUE_TEMPLATE/research-prep.md index 819d3c07d7..b38086963e 100644 --- a/.github/ISSUE_TEMPLATE/research-recruitment-and-scheduling.md +++ b/.github/ISSUE_TEMPLATE/research-prep.md @@ -1,9 +1,8 @@ --- -name: Research Recruitment and Scheduling -about: Use this template when recruting and scheduling participants for a research - study -title: Recruit and schedule participants for [PRODUCT/INITIATIVE] research -labels: Design, Research +name: Research Prep Tasks +about: Use this template when prepping for a research study +title: Prep for [PRODUCT/INITIATIVE] research +labels: UX, Research assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/research-readout-and-documentation.md b/.github/ISSUE_TEMPLATE/research-readout-and-post-task.md similarity index 91% rename from .github/ISSUE_TEMPLATE/research-readout-and-documentation.md rename to .github/ISSUE_TEMPLATE/research-readout-and-post-task.md index f00b711202..446025cc56 100644 --- a/.github/ISSUE_TEMPLATE/research-readout-and-documentation.md +++ b/.github/ISSUE_TEMPLATE/research-readout-and-post-task.md @@ -1,8 +1,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 +name: Research Readout and Post-Research tasks +about: Use this template when sharing your research via readouts and doing final clean-up tasks. +title: Conduct [PRODUCT/INITIATIVE] research readout and complete post-research tasks labels: Research, UX assignees: '' diff --git a/.github/ISSUE_TEMPLATE/research-sessions.md b/.github/ISSUE_TEMPLATE/research-sessions.md index 528c1fcfd1..1a7124788d 100644 --- a/.github/ISSUE_TEMPLATE/research-sessions.md +++ b/.github/ISSUE_TEMPLATE/research-sessions.md @@ -1,7 +1,7 @@ --- name: Research Sessions about: Use this template when you are conducting research session -title: Conduct [PRODUCT/INITIATIVE] Research Sessions +title: Conduct [PRODUCT/INITIATIVE] research sessions labels: UX, Research assignees: '' diff --git a/.github/ISSUE_TEMPLATE/research-synthesis-and-topline-summary.md b/.github/ISSUE_TEMPLATE/research-synthesis-and-repoting.md similarity index 90% rename from .github/ISSUE_TEMPLATE/research-synthesis-and-topline-summary.md rename to .github/ISSUE_TEMPLATE/research-synthesis-and-repoting.md index 4b0f24fba0..4892c5b593 100644 --- a/.github/ISSUE_TEMPLATE/research-synthesis-and-topline-summary.md +++ b/.github/ISSUE_TEMPLATE/research-synthesis-and-repoting.md @@ -1,8 +1,7 @@ --- -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 Summary +name: Research Synthesis and Reporting +about: Use this template when synthesizing your research and reporting the topline findings. +title: Synthesize [PRODUCT/INITIATIVE] research & create Topline Summary labels: Research, UX assignees: '' diff --git a/.github/ISSUE_TEMPLATE/runbook---ux-research.md b/.github/ISSUE_TEMPLATE/runbook---ux-research.md index ce407a8444..a8313db6bc 100644 --- a/.github/ISSUE_TEMPLATE/runbook---ux-research.md +++ b/.github/ISSUE_TEMPLATE/runbook---ux-research.md @@ -10,21 +10,20 @@ assignees: '' ## Description -Here are the steps to follow when setting up a new UX research process: -**Pre-work** -- [ ] Align with Product Manager & Product Owner on the high-level purpose and scope of the research -- [ ] Review Research Repo for previous relevant research -- [ ] Read and understand [Platform's Research Guidleines](https://depo-platform-documentation.scrollhelp.site/research-design/). This runbook is meant help reduce time creating tickets, not to replace or overrule those guidelines. +Here are the steps to follow when setting up a new UX research epic: **Setting up your Research Epic** +- [ ] Read and understand [Platform's Research Guidleines](https://depo-platform-documentation.scrollhelp.site/research-design/). This runbook is meant help reduce time creating tickets, not to replace or overrule those guidelines. - [ ] 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=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 +- [ ] Create a [Research Discovery](ADD LINK AS LAST STEP) issue +- [ ] Create a [Research Plan](ADD LINK AS LAST STEP) issue +- [ ] Create a [Research Conversation Guide](ADD LINK AS LAST STEP) issue +- [ ] Create a [Research Review Cycle](ADD LINK AS LAST STEP) issue +- [ ] Create a [Research Prep](ADD LINK AS LAST STEP) issue +- [ ] Create a [Research Sessions](ADD LINK AS LAST STEP) issue +- [ ] Create a [Research Synthesis & Reporting](ADD LINK AS LAST STEP) issue +- [ ] Create a [Research Readout & Post-tasks](ADD LINK AS LAST STEP) issue - [ ] Add all the above issues to the Research Epic and add dependencies ## Acceptance Criteria