Draft: Internal Research Plan Template
Rabia2219 opened this issue · comments
Note: template in #111
Overview
We need to create a draft template for an internal research plan, review, finalize and then create an issue template.
Action Items
- Create a draft template below
- Get review and approval
- Create the issue template
Use this information while creating the template issue:- name of template: YJN: Research Plan
- about: this will serve as a template for creating internal research plan issues for each research type
- Issue default title: [YJN: RP00_: Internal Research Plan]
- Assignees:
- Labels:
Resources/Instructions
- Issue Template
- Research Guide and Template linked above
- Find WIKI page for your role YJN Wiki, Join the team page
Reminder for @Rabia2219 and @ExperimentsInHonesty
Once this draft is approved and the template has been created, update this page:
https://github.com/hackforla/YouthJusticeNav/wiki/UX-Research-Guides-and-Templates
name of template: YJN: Research Plan
about: this will serve as a template for creating internal research plan issues for each research type
Issue default title: [YJN: RP00_: Internal Research Plan]
Assignees:
Labels: Research: RP00_
Overview
We need to create a research plan for [Name of Research] in order to have a comprehensive overview that guides the research work.
Action Items
- Add the label to this issue that matches the Research Plan
- Find the roadmap document (look in the Google Drive>Research>Research by Type folder (Resource 2.)
- add a link to the document into the Resources section below with number
- Add its issue for your research into the Resources section below with number
- Add a link to the research plan wiki page to the Resources section below (e.g.
RP001: Stakeholder Alignment Interviews) with number - Make a copy of the Research Plan Template (Resource 3.)
- Name the document using the naming convention [YJN: RP00_: Internal Research Plan]
- Move your document from "My Drive" to the relevant research folder
- Click on the File menu in your document, choose Move, Go to the main research folder on the YJN shared drive
- Choose the folder for the Research Type
- Find the relevant folder for this research number. If it does not exist, confirm you are in correct type, and if yes, make the folder
- highlight the folder and Select
- Click on the File menu in your document, choose Move, Go to the main research folder on the YJN shared drive
- Add link to new research plan in resources (below)
- Link it to WIKI research page for your research plan (e.g.
RP001: Stakeholder Alignment Interviews) - Use the guide to customize the draft for this plan
- Review
- Finalize
Resources/Instructions
@Rabia2219 @ExperimentsInHonesty
Once this template is finalized, we need to update
Research Plan Template preview | copy
on the following page
https://github.com/hackforla/YouthJusticeNav/wiki/UX-Research-Guides-and-Templates
Question:
Does HackforLA have a document template for a research roadmap?
@Rabia2219 I reviewed the Internal Research Plan template google doc - it looks good to me!
- number the resources. See (hackforla/internship#321) for example
name of template: YJN: Research Plan
about: this will serve as a template for creating internal research plan issues for each research type
Issue default title: [YJN: RP00_: Internal Research Plan]
Assignees:
Labels: Research: RP00_
Overview
We need to create a research plan for [Name of Research] in order to have a comprehensive overview that guides the research work.
Action Items
- Update this issue to make sure it's properly categorized and easy to manage
- Add to the Project Board (helps with Project Management overview)
- Add a milestone (helps with prioritization)
- Add label of the correct research plan number associated with this research plan (e.g., Research: RP001) (helps you find related issues in the same workflow)
- Edit title of issue with the correct research plan number (same as prior)
- Edit placeholders in Overview of this issue with the relevant information in square brackets. (personalizes the issue to make it easier to read). Any place you see [replace...] replace both the text and the brackets with what it is asking for (including in the front matter above but not where it says name, but not where it says title.
- Update this issue with the relevant Resources:
- Go to the Research Output Overview Page (link in Resources) and find the relevant overview type wiki page. Then, change
[Wiki [TYPE] Research Overview Page]in the Resources below with the correct wiki page of the research overview by type. - Go to the Research Output Overview Page again and find the relevant wiki page for this specific research plan. Then, change the
[RP__ Wiki Page]in the Resources below with this RP's specific wiki page. - Find and link the folder you are going to put your research plan in (e.g., Research by Type>2. Intern>RP6 - Week out post-event survey)
- Go to the Google Drive's Research by Type Folder (link in Resources)
- Go into the relevant Type Folder (e.g., 1. Stakeholder, 2. Collabathon, etc.)
- once inside, right-click on the relevant destination folder and copy the link. (e.g., RP6 - Week out post-event survey)
- Add the Google Drive link in the Resources below with the link you just copied and revise the display text to include the Research Plan number (e.g.,
Google Drive RP__ FoldertoGoogle Drive RP008 Folder)
- Go to the Research Output Overview Page (link in Resources) and find the relevant overview type wiki page. Then, change
- Create the Research Plan Document.
- Make a new document using the TWE Research Plan template (link in Resources). Follow the instructions in the How To Write a Research Plan guide (link in Resources) and mark your progress in this issue.
- Move your document from "My Drive" to the shared drive internship folder of this specific RP.
- Name your document to be called "TWE: RP___ : [TITLE OF RESEARCH] Research Plan".
- Update the document with the relevant information in accordance with the research roadmap document (found on the Research Overview Page).
- Update the Table of contents (page 2) when you are finished with the document.
- Meet and sign-off research plan document with UX Research lead (by adding it to the research team meeting agenda).
- Update RP Wiki Page with any changes or corrections.
- Once research lead has signed off, add it to the PM/Research lead agenda
- sign-off by PM
- Does this issue have any dependency checkboxes in the action items here?
- if yes, remove dependencies that are listed below (issues that are waiting on this issue to be completed. Sometimes they have already been made and sometimes they yet to be made).
- close this issue
- if no, check to see if the follow-up issues have already been made (see related structure issue). If new issues have not been made, then apply label
ready for research leadand define what needs to be done in a comment below- close the issue
- move to
Question/ReviewColumn
- if yes, remove dependencies that are listed below (issues that are waiting on this issue to be completed. Sometimes they have already been made and sometimes they yet to be made).