hackforla / hackforla/VRMS

Create Wiki Glossary Draft: VRMS

Open
#2,002 0 comments 0 reactions 1 assignee Assigned to @pillarijake View on GitHub
complexity: small feature: Documentation feature: Guide role: Product size: 1pt
Dominant language
JavaScript
Stars
61
Forks
101
PR merge metrics
No merged PRs in 30d

Description

### Overview
We need to create a VRMS 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.

### Action Items

- [ ] 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
- continue following this guide to ensure your preexisting glossary matches org requirements
- [ ] Step 3: Copy the Template
- [ ] add the newly created wiki glossary draft and add to Resources
- [ ] Template Instructions
- [ ] 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

### Resources/Instructions

- **Reference Material**: 📝 Google Doc: [How To: Create A Project Glossary](https://docs.google.com/document/d/1EjPdkq_mHHUi6tXk22c7MrLTWwrvbAMw0_Oi5fYRIu0/edit?tab=t.0)
- **Deliverable**: 📊 Google Sheet: [VRMS: Wiki Glossary Draft](https://docs.google.com/spreadsheets/d/1XxGyL1qSYjHTbS2iGJejuJz8tKueNsXGLC8im_PduTs/edit?usp=drive_link)
- 📂 Google Drive Path: [vrms > Project Management > Glossary](https://drive.google.com/drive/folders/1f6FB6Odl2a1Wzio3jR6LOurBQl1EWOMe?usp=drive_link)
- Other VRMS Related Links
- add links that are useful for glossary population here...

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.