Comparison of Hack for LA Wikis

[ryanfchase]

Overview

We'd like to review the other HfLA teams' Wiki pges to understand how they are being structured (pages, layouts, and sidebar).

Action Items

• Review the following teams' wiki pages
  • website
  • twe-internship
  • tdm-calculator
• For each team, document the following...
  • What categories of resources are available on the HomePage?
  • What is the general structure of the Sidebar?
  • What (if any) series labels are being applied to each Page title?
  • What personas are being enumerated by the wiki?
• Produce a Google Document that provides the answers to the above questions

Resources/Instructions

• Comparison of Hack for LA Wikis Google Document

Links to team wikis

• https://github.com/hackforla/internship/wiki
• https://github.com/hackforla/tdm-calculator/wiki
• https://github.com/hackforla/website/wiki

[ryanfchase]

ETA: providing notes this evening, attempting to close ticket by tmo

[ryanfchase]

Newly created document: https://docs.google.com/document/d/1JJyQrbYVCqKZ88ukpfuSN3BXvSfR_XlvH0zkS8ujf3Q/edit?tab=t.0

[ryanfchase]

Work on document is completed. Lazy posting a copy of the text from the document listed above.

Wiki Review: Website
https://github.com/hackforla/website/wiki

Q: What categories of resources are available on the HomePage?
A: Home page is organized as a directory listing of categorized hyperlinks
Project Definition (text)
Onboarding Links
Quick Links for Developers
Other Links and Resources

Q: What is the general structure of the Sidebar?
A: This appears to be the “Quick Links” for the entire team/repo. Sections are split into section headers, and a dropdown containing hyperlinks
Onboarding Links
Site Architecture
How To (articles)
These mostly describe contributing information (e.g. Github, branching)
File Templates
These are pages that contain YML for the respective templated page
Some templates are for specific chunks on the website. Others contain instructions for more general pages on the website
Roles
These are “Getting Started” / “Quick Links” page for each role
Tools & Resources
Marketing & Analytics

Q: What (if any) series labels are being applied to each Page title?
A: Mostly pages are disjoint, relying on the pages to provide organizational structure, but there are a handful of series labels:
DR - decision records
GHA - github action
How To - articles for contributing, understanding project organization
Research - research plans, labelled by number

Q: What personas are being enumerated by the wiki?
A: This page is only intended for current or prospective team members, these groups are not explicitly enumerated

Wiki Review: TDM Calculator
https://github.com/hackforla/tdm-calculator/wiki

Q: What categories of resources are available on the HomePage?
A: The home page contains a project definition, and links to the following pages
Introduction to the Project
Joining the TDM Calculator Team
Product Documentation
UX Research
UX Design
Software Architecture and Development
Team Meetings
Meeting Agendas

This section differs from other Wikis, it does not attempt to collect and categorize their “Quick Links”, but rather lists the main pages based on where you need to go (e.g. it's more like a Google Drive directory than a web page)

Q: What is the general structure of the Sidebar?
A: Exactly the same as the webpage, it just doesn’t have the project definition

Q: What (if any) series labels are being applied to each Page title?
A:
DR - decision record
RP00X - research plan, by number

Q: What personas are being enumerated by the wiki?
A: Similar to website, it is for prospective members and current members – not explicitly enumerated

Wiki Review: TWE Internship
https://github.com/hackforla/internship/wiki

Q: What categories of resources are available on the HomePage?
A:
Project definition: this one is more detailed than Website or TDM Calculator
Links to pages
Interns: I am a high school or college student who has been invited to Hack for LA’s internship program
Guardians: I am a guardian of a student who is interested in the internship program
Mentors: I am a mentor who wants to be matched with a Hack for LA student intern
HfLA Volunteers: I am a volunteer at Hack for LA working with TWE interns

Q: What is the general structure of the Sidebar?
A:
Interns
Lists resources, overview for different cohorts
Guardians
Overview, research plans
Mentors
Overview, program information, research plans
HfLA Volunteers
Overview, program information, research plans
TWE Team Members
Overview team member information, program information, cohort Quick Links

Q: What (if any) series labels are being applied to each Page title?
A:
Design System - lists out useful resources utilized by their design system, or just links to a particular Figma page
Research Plan X
IS21, IS22 - Internship (Summer) 2021 / 2022

Q: What personas are being enumerated by the wiki?
A:

The personas are enumerated on the Homepage / Sidebar

Interns: I am a high school or college student who has been invited to Hack for LA’s internship program
Guardians: I am a guardian of a student who is interested in the internship program
Mentors: I am a mentor who wants to be matched with a Hack for LA student intern
HfLA Volunteers: I am a volunteer at Hack for LA working with TWE interns