hackforla / internship

The Internship project provides an opportunity for students to work on open source projects in the fields of software, product development, project management, and UI/UX research and design at LA’s fastest growing Civic Tech non-profit organization during their summer.
GNU General Public License v2.0
16 stars 4 forks source link

TWE: Create Template Issue: Interview Instructions Template #366

Open pandanista opened 1 year ago

pandanista commented 1 year ago

Overview

We need to create a template issue for interview instructions so that we have consistent, transparent, defined and self-supporting structure for people creating them.

Action Items

Resources/Instructions

~Getting started button link for creating new issue using the ["REPLACE with name and link of template"] template on the "New issue" tab~

WIKI Templates

Content to copy for draft

Draft of [replace with name of type] template issue
---
name: TWE: Create Template Issue: [replace with name of template]
about: 
title: TWE: [replace with action verb] [replace with name of template]
labels: 'feature: board / google drive / tools', 'feature: missing', 'size: missing', 'role: missing', 'milestone: 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
- [ ] Find WIKI page for this issue by looking at role pages [Internship Wiki, Join the team page](https://github.com/hackforla/internship/wiki/Joining-the-Team) - then add the appropriate link to the resources section
- [ ] Find document template that should be used [Templates & Product Branding](https://github.com/hackforla/internship/wiki/Design-Process-Overview) - then add that specific template link into the resources section
- [ ] If no dependencies, delete dependency section
- [ ] 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.
- [ ] add appropriate labels and remove the corresponding missing labels
- [ ] 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 DO X FOR Y REASON

### Action Items
A STEP BY STEP LIST OF ALL THE TASK ITEMS THAT YOU CAN THINK OF NOW EXAMPLES INCLUDE: Research, reporting, etc.

### Resources

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) - 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: 'Research: Roadmap' - about: The start of a new roadmap - title: 'TWE: Research Roadmap [name of type]' - labels: 'feature: research, feature: roadmap, milestone: missing, role: UI/UX research, - size: 0.50pt' - assignees: ''
pandanista commented 1 year ago

As a summary, it involves a few steps to make a template.

  1. Identify what the issue template's deliverables are.
    • In this case, the deliverable will be a Google doc that is used to provide UXR interview instructions. Once we know what the deliverables are, we can start on them first in most cases. For this template, since we need an interview instructions doc, we need to consolidate previous interview instructions to create a google doc that can be customized for all research plans in the future.
  1. Start making the issue template.
    • To create this issue template, please refer to [the second comment] (https://github.com/hackforla/internship/issues/343#issuecomment-1371585413) in #343. We will follow the same structure of the roll call and session table template creation, including title, front matter, instructions for creating this issue, and the issue template (Dependencies if needed, Overview, Action items, Resources/Instructions).
  1. Internal testing. It might take multiple rounds. For testing:

    • Set up an issue using the issue template, then follow the instructions to customize the issue so it is ready to be tested. Better to add [TEST] on the title to distinguish from regular issues.
    • Assign someone to do the testing, and ask them to provide feedback in comments.
    • Incorporate the feedback into the issue and issue templates.
  2. Release There might be other changes need to be made after the template release, so we need to make edits to the template in the repository.

Hope this will help you get started in template making. Let me know if you have more questions.

sunannie27 commented 6 months ago

@doctorsandy Please provide update

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures or links* (if necessary): "Add any pictures or links that will help illustrate what you are working on."

Bonnie said you might not have time to work on this, let us know if I can unassign you from this issue.

pandanista commented 4 months ago

https://www.youtube.com/watch?v=Hla1jzhan78 a video can be used for interview training.