Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Audit GitHub developer wiki pages. #171

Open
3 tasks
seanlip opened this issue Jan 7, 2025 · 1 comment
Open
3 tasks

Audit GitHub developer wiki pages. #171

seanlip opened this issue Jan 7, 2025 · 1 comment

Comments

@seanlip
Copy link
Member

seanlip commented Jan 7, 2025

Platform
GitHub

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

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):

@tamiorendain
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Not Started
Development

No branches or pull requests

2 participants