hackforla / hackforla/knowledgebase-content

Create a Guide/Template: Glossary

Aperta
#54 37 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Complexity: Missing CoP label: checked CoP: Admin CoP: Content CoP: Data Science CoP: Design CoP: Engineering CoP: Marketing CoP: Ops CoP: Product CoP: Revenue CoP: UI/UX Research feature : guide creation good first issue Phase: 2 - Gather Examples Collaborative Ready for Bonnie Triage size: missing status: 2.1 needs communication with teams status: 2.2 needs special issue/check with admin
Lingua principale
Nessun dato sulla lingua
Stelle
2
Fork
1
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

### Overview
We need to create a guide for a UX Researcher's Glossary so that new UX Researchers at Hack for LA can quickly become familiar with the most common terminology

### Action Items
The phases in the guide-making process are listed below. Each phase displayed in blue is linked to a wiki page with instructions on how to complete that phase. Open the wiki page in a new tab, copy the instructions for each part into the section labeled 'Tasks' at the bottom of this issue, and complete each task listed.
- [x] [Gather Examples Solo](https://github.com/hackforla/guides/wiki/How-to-Gather-Examples:-Solo) (open in a new tab)
- [x] [Gather Examples Collaboratively](https://github.com/hackforla/guides/wiki/Phase-2-%E2%80%90-Gather-Examples-Collaboratively)
- [ ] [Create a Guide Draft](https://github.com/hackforla/guides/wiki/How-to-Draft-a-Guide)
- [ ] If needed, create a template
- [ ] [Have your guide peer reviewed](https://github.com/hackforla/guides/wiki/Peer-Reviews-for-Guides)
- [ ] [Present your guide for leadership review](https://github.com/hackforla/guides/wiki/Submitting-Your-Guide-for-Leadership-Review)

### Resources/Instructions
- Google Drive Folder for this Guide’s documents and shortcuts (to documents in other locations) [0054[DRAFT] Glossary](https://drive.google.com/drive/folders/1GJ9hEEmodCixV7AT5QgIAOJtQ7CGfi4K?usp=drive_link)
- DRAFT Guide: [Guide: Create a Glossary](https://docs.google.com/document/d/1EjPdkq_mHHUi6tXk22c7MrLTWwrvbAMw0_Oi5fYRIu0)
- DRAFT Template: [[PROJECT NAME]: Wiki Glossary Draft](https://docs.google.com/spreadsheets/d/10Cg00-OzbwykHXmXxeA6V2DtHG0gAlxNQTZwq4-j4n8) - Tabs:
- [Instructions and Links](https://docs.google.com/spreadsheets/d/10Cg00-OzbwykHXmXxeA6V2DtHG0gAlxNQTZwq4-j4n8/edit?pli=1&gid=1817049699#gid=1817049699)
- [HfLA glossary](https://docs.google.com/spreadsheets/d/10Cg00-OzbwykHXmXxeA6V2DtHG0gAlxNQTZwq4-j4n8/edit?pli=1&gid=210833732#gid=210833732)
- [Project Glossary (input)](https://docs.google.com/spreadsheets/d/10Cg00-OzbwykHXmXxeA6V2DtHG0gAlxNQTZwq4-j4n8/edit?pli=1&gid=107052018#gid=107052018)
- [Glossary-All terms (HfLA & Project)](https://docs.google.com/spreadsheets/d/10Cg00-OzbwykHXmXxeA6V2DtHG0gAlxNQTZwq4-j4n8/edit?pli=1&gid=0#gid=0)
- DRAFT [HfLA: Glossary](https://docs.google.com/spreadsheets/d/1dyzQzBpEK1dRmem068_XGqEuW1brk83cncRgZIDtix4) Tabs:
- [Instructions and Links](https://docs.google.com/spreadsheets/d/1dyzQzBpEK1dRmem068_XGqEuW1brk83cncRgZIDtix4/edit?gid=1340595979#gid=1340595979)
- [Glossary-All terms](https://docs.google.com/spreadsheets/d/1dyzQzBpEK1dRmem068_XGqEuW1brk83cncRgZIDtix4/edit?gid=0#gid=0)
- [Glossary-PM](https://docs.google.com/spreadsheets/d/1dyzQzBpEK1dRmem068_XGqEuW1brk83cncRgZIDtix4/edit?gid=1271763864#gid=1271763864)
- [Glossary-Research](https://docs.google.com/spreadsheets/d/1dyzQzBpEK1dRmem068_XGqEuW1brk83cncRgZIDtix4/edit?gid=1234249208#gid=1234249208)
- [Glossary-Design](https://docs.google.com/spreadsheets/d/1dyzQzBpEK1dRmem068_XGqEuW1brk83cncRgZIDtix4/edit?gid=1874419346#gid=1874419346)
- [Glossary-Data Science](https://docs.google.com/spreadsheets/d/1dyzQzBpEK1dRmem068_XGqEuW1brk83cncRgZIDtix4/edit?gid=109876956#gid=109876956)
- [Glossary-DevOps](https://docs.google.com/spreadsheets/d/1dyzQzBpEK1dRmem068_XGqEuW1brk83cncRgZIDtix4/edit?gid=701855734#gid=701855734)
- [Glossary-Marketing](https://docs.google.com/spreadsheets/d/1dyzQzBpEK1dRmem068_XGqEuW1brk83cncRgZIDtix4/edit?gid=164640937#gid=164640937)
- [Glossary-Engineering](https://docs.google.com/spreadsheets/d/1dyzQzBpEK1dRmem068_XGqEuW1brk83cncRgZIDtix4/edit?gid=49723764#gid=49723764)
- [Bonnie's comment about how glossary making should be done at HfLA](https://github.com/hackforla/knowledgebase-content/issues/54#issuecomment-2612955568) (this will be the starting point for the instructions in the guide

#### External Resources
- [Usability.gov UX Research glossary](https://www.usability.gov/what-and-why/glossary/tag/user-research/index.html)
- [UX Glossary](https://ferpection.com/en/ux-glossary/)
- Common HfLA terminology: [Guides: Glossary draft](https://docs.google.com/spreadsheets/d/175pDnr-izub36J0xya6m9rSfIico6XnsStUz9KHSWIA/edit?gid=0#gid=0)

#### Internal Resources
- [Guide: UX Researcher Toolkit](https://docs.google.com/document/d/1fPBoNEv44ApGwZQHqbdIcoD3B2UI-lvI3L6BpHig2fY/edit)
- has been deleted

Phase 1 findings

### Current glossaries

Name | Format
----------------- | -----------------
Access the Data | GitHub Wiki
Civic Tech Index | GitHub Wiki
Expunge-Assist | Google Doc
Food Oasis | Google Sheet
Guides | GitHub Wiki, Google Sheet
HomeUniteUs | GitHub Wiki, Google Sheet
Tech Work Exp. | Google Sheet
TDM Calculator | Google Sheet
Product | Google Sheet

**GitHub Wiki**

Pros:
- Lives within the project's repository
- Integrates with other knowledge content as a Wiki

Cons:
- Requires knowledge of GitHub and Markdown
- Collaboration requires git, fork, PR, etc.

**Google Sheet/Doc**

Pros:
- Easier to setup, edit, and share
- Simple collaboration tools

Cons:
- Lives outside the project's repository
- Can be misplaced and/or duplicated as members change
- (Doc) Not ideal for large glossaries and table formats

### Projects to Check

- [Access the Data](https://github.com/hackforla/access-the-data)
- [Wiki - Glossary of Terms](https://github.com/hackforla/access-the-data/wiki/UX-Writing-Guide#glossary-of-terms)
- [Civic Tech Index](https://github.com/civictechindex/CTI-website-frontend) - on hold
- [Wiki - Glossary](https://github.com/civictechindex/CTI-website-frontend/wiki/Glossary)
- [Expunge-Assist (formerly known as Record Clearance)](https://github.com/hackforla/expunge-assist)
- https://github.com/hackforla/expunge-assist/issues/409
- [Glossary](https://docs.google.com/document/d/1rVZE1c3G2xfB6Z_-2pAFgiToKm64lK_KHLgIhq7YZYU/edit#heading=h.obaa8a1h4lt2)
- https://github.com/hackforla/expunge-assist/issues/478
- [UXR Glossary](https://docs.google.com/document/d/1D19tbPqQkFzHYF2GemsZDDdMjbUM6jh6E6ArYWS-WIo/edit)
- [Archived content glossary #1](https://docs.google.com/document/d/1wJVO0tgkG3S8CZd8N3KNbFXFbJREo-JZ7NfK_RNwA7Y/edit)
- [Archived content glossary #2](https://docs.google.com/document/d/1tc1RLRfibfAkwKStQFuU0P_Iy5KrA_dkSnQrTvdOPXI/edit)
- [Food Oasis](https://github.com/hackforla/food-oasis)
- https://github.com/hackforla/food-oasis/issues/2271
- [Glossary spreadsheet](https://docs.google.com/spreadsheets/d/10jUOU43P1pCysTDKKR6mlxtvJ62iXq5IrcJWm2N9zGk/edit?gid=0#gid=0)
- [Guides](https://github.com/hackforla/guides)
- https://github.com/hackforla/guides/issues/88
- [Guides: Glossary spreadsheet](https://docs.google.com/spreadsheets/d/175pDnr-izub36J0xya6m9rSfIico6XnsStUz9KHSWIA/edit)
- [Wiki](https://github.com/hackforla/guides/wiki/Glossary)
- [HomeUniteUs](https://github.com/hackforla/homeuniteus)
- [Wiki](https://github.com/hackforla/HomeUniteUs/wiki/Glossary)
- [Slack example](https://github.com/hackforla/knowledgebase-content/issues/54#issuecomment-2542562441)
- ~[Google Sheets glossary](https://docs.google.com/spreadsheets/d/1HBeTCkkbiKRlbjAb2BUkeW4F9G2gnbzBmfWbu1NQ6RI/edit?gid=0#gid=0)~ Has been deleted
- [Tech Work Experience (Internship project)](https://github.com/hackforla/internship)
- https://github.com/hackforla/internship/issues/306
- [TWE: Wiki Glossary Draft](https://docs.google.com/spreadsheets/d/10omnFb1L8lM4n4Rz610UzI1E51ZMRG6tuVnphrYnay0/edit?gid=0#gid=0)
- [TDM Calculator](https://github.com/hackforla/tdm-calculator)
- https://github.com/hackforla/tdm-calculator/issues/19
- [TDM Glossary Draft](https://docs.google.com/spreadsheets/d/1LxACA2eworqV6MG0xll_MFz6DlwEfQqBa1lG03C4Xgo/edit#gid=0)
- [Terms Already Defined in the HfLA Glossary](https://docs.google.com/spreadsheets/d/1LxACA2eworqV6MG0xll_MFz6DlwEfQqBa1lG03C4Xgo/edit#gid=1814646988)
- [Product](https://github.com/hackforla/product-management)
- https://github.com/hackforla/product-management/issues/259
- [Draft Glossary of PM Tools](https://docs.google.com/spreadsheets/d/1Co_QhlpT5b2GXTIdbgzNxoFe0EVTCL0cczs2X5PUWF0/edit?gid=0#gid=0)

Checked the following and found no results

- [100 Automations](https://github.com/100automations/website) - on hold
- [311 Data](https://github.com/hackforla/311-data)
- [BallotNav](https://github.com/hackforla/ballotnav) - on hold
- [Brigade Organizer's Playbook](https://github.com/codeforamerica/brigade-playbook)
- [Civic Tech Jobs](https://github.com/hackforla/CivicTechJobs)
- [Design Systems](https://github.com/hackforla/design-systems)
- [Engage](https://github.com/hackla-engage) - on hold
- [GreenEarthOS](https://github.com/hackforla/climate-project) - on hold
- [Lucky Parking](https://github.com/hackforla/lucky-parking)
- [Open Community Survey](https://github.com/hackforla/open-community-survey) - on hold
- [People Depot](https://github.com/hackforla/peopledepot)
- [Tables team](https://github.com/hackforla/tables/)
- [VRMS](https://github.com/hackforla/vrms)
- [Hack for LA's Website](https://github.com/hackforla/website)
- [Youth Justice Nav](https://github.com/hackforla/YouthJusticeNav/) - on hold
- [Data Science Projects](https://github.com/hackforla/data-science)
- [UI/UX](https://github.com/hackforla/UI-UX)
- [Dev Ops](https://github.com/hackforla/ops)
- [Engineering](https://github.com/hackforla/engineering)

### Tasks
Use this deck Part 3: [Connecting with Other Teams & Moving the Conversation Forward](https://docs.google.com/presentation/d/15WxdSc_YFVLdytCZ-SxZaWPt8y6-OQTxJb8dcppZHVE/)

Remove the following labels from your issue as you complete them:
- [x] status: needs communication with teams

Congrats you have completed Part 2: Gathering Examples with Slack
- [ ] Go to [Making Example Issues + Last Check with Admin](https://github.com/hackforla/guides/wiki/Making-Example-Issues--and-Last-Check-with-Admin) and copy the next steps, into the next comment.

Completed

- [x] **Gathering Examples with GitHub**
Follow the instructions from the slide deck Part 1: [Gathering Examples With GitHub: Wiki, Issues, Project Board, Resources Provided](https://docs.google.com/presentation/d/1XWY-OMiomzpKw_aCL1JkdgAhqpgGDZ2bu_XuReTO1zw/edit#slide=id.g150e30fd48b_0_443)
- Remove the following labels from your issue as you complete them:
- [x] status: needs wiki examples
- [x] status: needs issues examples
- [x] status: needs project board examples
- Congrats you have completed Part 1: Gathering Examples With GitHub: Wiki, Issues, Project Board, Resources Provided
- [x] Go to [Gather Examples, Use GitHub Search](https://github.com/hackforla/guides/wiki/Gathering-Examples-with-Github-Search) and copy the the text block (next steps), below this line

- [x] **Gathering Examples with Github Search**
Follow the instructions from the slide deck Part 1.5: [How to Use Github Search](https://docs.google.com/presentation/d/1M2f2Q9vefNAzQ4lvcw13x-7McPbrb8NZIVFgJUrefzE/edit?usp=sharing)
- [x] Complete the activities inside the deck
- Congrats! You have completed part 1.5: How to Use Github Search.
- [x] Go to [Gather Examples with Slack](https://github.com/hackforla/guides/wiki/Gathering-Examples-with-Slack) and copy it below

- [x] **Gathering Examples with Slack**
Follow the instructions from the slide deck Part 2: [Gathering Examples With Slack](https://docs.google.com/presentation/d/1-Kg7yLRXsdGo4Ln8L-WiunOOO3Uc7TuXvH5afcp3AKQ/)
- Remove the following labels from your issue as you complete them:
- [x] status: needs slack examples
- [x] Phase: 1 - Gather Examples Solo
- Congrats! You have completed Part 2: Gathering Examples with Slack
- [x] Go to [Phase 2 - Gather Examples Collaboratively](https://github.com/hackforla/guides/wiki/Phase-2-%E2%80%90-Gather-Examples-Collaboratively) and copy and copy it below

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Start with the linked DRAFT Guide: Create a Glossary and the DRAFT Template, then review the completed example glossaries and Bonnie's comment. Follow the wiki phases for drafting, peer review, and leadership review. Done means the UX Researcher's Glossary guide and any needed template are completed and have passed the listed reviews.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.