PRD - Create Wiki Glossary Draft

[ryanfchase]

Overview

We need to create a 311 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.

Details

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

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
    • Step 3: Copy the Template
    • Step 4: Create the wiki glossary draft and add to Resources
  • Template Instructions: 311 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)
        • https://hackforla.slack.com/archives/C01Q24YF56J/p1757116772011799
• 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
  • 311 Dependency Post-Work
    • release the dependency on this issue: DEV - Darken parts of the map that you can't interact with #1585
• Create new ongoing ticket to track new glossary terms (similar to FAQ ticket)

Resources/Instructions

• Reference Material: 📝 Google Doc: How To: Create A Project Glossary
• Deliverable: 📊 Google Sheet: 311 Data: Wiki Glossary Draft
  • 📂 Google Drive Path: 311-data.org > 3 - Project Management > Glossary
• Other 311-Data Related Links
  • UXD - Clarify regions that are not part of LA city on Map #1305 (comment)
    • Design seeking guidance from PM team for authoritative source of info on non-NC regions
  • UXD - Clarify regions that are not part of LA city on Map #1305 (comment)
    • Design completed, but wanting source^ to finalize ticket
  • DATA - Obtain geojson boundaries for areas outside City of Los Angeles #1948 (comment)
    • we collected a large number of desired non-NC geojson boundaries for us to render it onto the map
• https://neighborhoodempowerment.lacity.gov/councils/
• Alternative Boundary Sources
  • Bonnie requested Federally defined boundaries be backed up by local government sources. Local governments do not (seem to!) use the same boundary definitions, but SCAG (Southern California Association of Governments) has some good alternatives:
    • Urbanized Areas (definition, map, dataset)
    • Counties (definition, map, dataset)
    • Federal vs. Local Term Comparison Worksheet

Click to see: Breakdown of Project Glossary (input) columns

• Term - The new term
• Alternative terms - Other terms if applicable
• Description - Define the term
• Official Link - Web link to the description
• Links to where term appears - Web links to where the term appears in your project
• Proposed Description - Updated description if necessary
• CoP - Community of Practice that the term belongs to
• Peer Reviewer Questions and Feedback - Leave blank for your project lead
• Final - Leave blank for your project lead
• Sign Off by Org - Leave blank for your project lead