Audit GitHub developer wiki pages.

[seanlip]

Platform
GitHub

Describe the request
We have several developer-facing GitHub projects, all of which have READMEs:

• https://github.com/oppia/
• https://github.com/oppia/oppia?tab=readme-ov-file#oppia-
• https://github.com/oppia/oppia-android?tab=readme-ov-file#oppia-android

These READMEs have the function of both introducing contributors to the project's mission and aims, and helping them get started.

The READMEs, so far, have been put together piecemeal. The aim of this issue is to apply a UX Writing approach to them so that the introductions to the repositories are compelling and clearly help prospective developers understand the project and get started easily.

UXR success criteria

• Developers understand and are inspired by the Oppia project's mission, vision and impact. (We might want to highlight some pictures of areas we work in or organizations we partner with -- it might be worth getting some information from the Programs team about anything we can say that is going to be true over the long term.)
• Developers can easily find where to get started (https://github.com/oppia/oppia/wiki for Oppia Web, https://github.com/oppia/oppia-android/wiki for Oppia Android). Note: Those two pages have not been edited in a long time, and we might want to include them in the UX Writing pass so that the "new contributor" experience flows smoothly. Developers should get routed to the developer "getting started" instructions, and other volunteers should get routed to the Volunteer page or Volunteer form (whichever is appropriate).
• The README doesn't end up being a roadblock for developers (e.g. too much to read).

DESIGN APPROVAL CHECKLIST -- DO NOT EDIT.

• UX Design approved (Android mocks should include dark mode)
• UX Writing approved
• Product approved

For a design project to be completed, it needs approval from UXD, UXW and PM. Please tag the following reviewers when your project is ready (at least one reviewer for each of the bullet points below):

• UXD: @rflore / @S4v8n (for Web projects), @seanlip (for Android projects)
• UXW: @tamiorendain
• PM: @seanlip

[tamiorendain]

UXW Assignment as discussed with Sean: review both copy and structure - what would volunteers need to know? Do we need images, metrics, etc?

[aileenyesand]

Hi, off the bat in reviewing these pages, I have a couple of suggestions/questions @seanlip:

1. Some pages could benefit from a clear visual hierarchy of information so the pages are easily scannable and the reader's eyes are drawn to the most important pieces of information, in the right order.

2. I noticed there are some links that lead to no information or the same information, e.g., missing vision statement; same page is shown for Classrooms and Math Lessons.

3. Would you like me to continue adding my suggested revisions here, or in a separate document perhaps? I should NOT edit the Github pages directly, correct?

[seanlip]

Hi @aileenyesand,

Thanks! Feel free to add suggested revisions either here or in a separate doc, but don't edit the GitHub pages directly.

Also, where possible, could you please link to or provide images to help clarify what the suggestions are? E.g. for (2) I'm not sure which specific links you are referring to.

Thanks!