hackforla / hackforla/HomeUniteUs

Product - Create Wiki Glossary Draft

Open
#927 0 comments 0 reactions 1 assignee Claimed by @lola3736 View on GitHub
Complexity: Small documentation Feature: Missing Milestone: missing Role: PM size: 1pt
Dominant language
Python
Stars
45
Forks
22
Avg merge
15d 1h
Merged PRs (30d)
1

Description

**UPDATE LABELS: Add the following labels to each new issue, and remove default labels. Then remove this section:**
* Complexity
* Feature
* Role
* Milestone
* Size
* Project
#### Select Project Board (located in the right sidebar)- Then remove this section:
- Under Type,![image](https://github.com/user-attachments/assets/aaf85aa9-ac24-41c7-aac5-e0fd10a3f5de)
- P: HUU: Project Board
#### Select the applicable type (located in the right sidebar). Then remove this section:
- Under Type,![image](https://github.com/user-attachments/assets/aaf85aa9-ac24-41c7-aac5-e0fd10a3f5de) select the applicable label:
- Bug - select if the issue is to fix a bug
- Feature - select if the issue is product feature
- Task - select if the issue is administrative, not a feature
#### Select issue "Planned Start and End date". Then remove this section:
- Under selected Project Board: P: HUU: Project Board Under Type,![image](https://github.com/user-attachments/assets/aaf85aa9-ac24-41c7-aac5-e0fd10a3f5de) located in the right sidebar, click on the 2nd drop down button and select the appropriate "Planned Start and End Date"
---

## 🧩 Overview
- We need to create a HUU Glossary and sync it with the Hack for LA Glossary so that we can make it accessible to team members and website visitors without duplicating terms.

- Our glossary will need to include definitions of places to provide a definitive guide for referencing other boundaries and locations within the HUU -Data application.
---

## 🎯 Objective

> Example:
> Identify best practices and innovative UX patterns used in competitor onboarding flows.

---

## 🔍 Background / Context
> Any relevant links, research, documentation, team discussions, or past tickets that provide context.

- Slack thread: [link]
- Related team/stakeholder discussions or decisions: [link]

---

## 📝 Scope of Work
Clearly list what is expected for this task to be complete, such as:

- [ ] Gather all previous glossary-style documentation (e.g. spreadsheets, docs, wikis, issue comments) and add to Resources below
- [ ] Open the guide and follow instructions...
- [ ] Review pre-work material
- [ ] Read "What is in the Create a Project Glossary Guide"
- [ ] Read "Alternatives or Things to Know?"
- [ ] Confirm you have "Prerequisites For Using This Guide
- [ ] Access to the HfLA: Glossary
- [ ] Access to the [PROJECT NAME]: Wiki Glossary Draft Template
- [ ] A Google Drive for your project and a place to put the template
- [ ] Read "What is Google Sheets?"
- [ ] Read "How to Use This Guide"
- [ ] follow instructions if you do not have edit access to prerequisites
- [ ] Set up the glossary draft for your project...
- [ ] Step 1: Check For a Preexisting Project Glossary
- [ ] Step 2: Review The Preexisting Project Glossary
- [ ] Step 3: Copy the Template
- [ ] Step 4: Create the wiki glossary draft and add to Resources
- [ ] Template Instructions: HUU Data: Wiki Glossary
- [ ] Step 1: Update Your Project Information
- [ ] switch to sheet: "Project Glossary (input)"
- [ ] replace [TEAM LOGO] with an image of your team's logo
- pls grab logo from Figma or Google Drive... no screenshots...

- [ ] replace [Project Name] with your team's name

- [ ] Step 2: Input Terms

- [ ] Review any/all previous glossary-style documentation for your project
e.g. issues, google docs/sheets/slides, Figma

- [ ] switch to sheet: "Project Glossary (input)"

- [ ] Add any missing terms into sheet

- [ ] Step 3: Review

- [ ] switch to sheet: "Glossary-All terms (HfLA & Project)

- [ ] review all terms

- [ ] delete any duplicate terms (highlighted in red)

- [ ] Step 4: Submit for Approval

- [ ] switch to sheet: "Project Glossary (input)

- [ ] get sign off by project lead

- [ ] project lead to use "Peer Reviewer Questions and Feedback" and "Final" column for approval

- [ ] Step 5: Update Guides Team:

- [ ] Post in admin channel (see instructions in guide for message contents)

- [ ] Wrap up and next steps

- [ ] Decide where links to the HfLA + Project Glossary should live (e.g. Wiki, Website, onboarding items)

- [ ] Brainstorm an approach for adding new terms to the Project Glossary
- [ ] add all draft glossary terms in a new comment

- [ ] HUU Dependency Post-Work

release the dependency on this issue:
- [ ] Synthesize findings into a presentation or doc
- [ ] Share with stakeholders
- [ ] Include recommendations or next steps

---

## 📎 Deliverables
What are the final outputs?

- Slide deck? Documentation? Spreadsheet? Jira epics? Summary in Notion?

> Example:
> 3-page slide deck with screenshots and written insights to support redesign.

---

## 🧭 Success Criteria
How will we know this task was completed effectively? Such as:

- [ ] All required sources were reviewed
- [ ] Insights were actionable and relevant
- [ ] Stakeholders reviewed and approved the findings

---

## 🛑 Risks / Dependencies
> Are there blockers, timing challenges, or dependencies on other teams? Such as:

- May require coordination with Design or Research
- External access to data might be delayed

---
## Action Items
- [ ] Assignee: Assign yourself to this issue.
- [ ] Assignee: Move the issue from Prioritized Backlog to In Progress.
- [ ] Product Manager (Assignee): Conduct the necessary research (if applicable), clarify any questions
- [ ] Product Manager (Assignee): Work with PM team/lead to clarify any questions about the Task/Initiative
- [ ] Product Manager (Assignee): Work with Product Team Lead to assign the appropriate size & complexity
- [ ] Product Manager (Assignee) and Lead: determine if work should be split into multiple issues, if so, create issue(s) and link them in this issue (if applicable) or create as standalone.
- Draft and Review:
- [ ] Product Manager (Assignee): Change Issue Status to "In Progress"
- [ ] Product Manager (Assignee): Draft the issue. Once complete provide for review
- [ ] Product Manager (Assignee): Change Issue Status to "For Review/Feedback Needed"
- [ ] Product Manager (Assignee): Add Label "Ready for: Design Peer Review"
- [ ] Product 1st Level/Peer Review: Review to ensure the issue captures the objective/goal outlined above provides adequate information to Design and Dev, if applicable. Provide comment(s) in the comment section of the issue and tag assignee.
- [ ] Product 1st Level/Peer Reviewer: Change Issue Status to "Questions/Clarification" and add label "Ready for Product.....Persona"
- [ ] Product Manager (Assignee): Change Issue Status to "In Progress"
- [ ] Product Manager (Assignee): Review issue comment(s) and resolve accordingly
- [ ] Repeat above steps until all comments are resolved
- [ ] Product 1st Level/Peer Reviewer: Change Issue Status to "For Review/Feedback Needed" and add label "Ready for: Product Lead"
- [ ] 2nd final/Product Lead: Review and provide feedback (if any) in comment section below, add label "Ready for Product...Persona"
- [ ] Repeat above steps until all comments are resolved

---

## 🔗 Related Tickets / Resources
- Epic: [link]
- Design: [link]
- Engineering: [link]

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.