Next iteration for improving UIUX of our help docs

github-education-resources / classroom

GitHub Classroom automates repository creation and access control, making it easy for teachers to distribute starter code and collect assignments on GitHub.

https://classroom.github.com

1.35k stars 567 forks source link

Next iteration for improving UIUX of our help docs #2084

Open shaunakpp opened 5 years ago

shaunakpp commented 5 years ago

Feature request :sparkles:

Currently we have a help section for classroom at https://classroom.github.com/help. It is working great and at v1 and also supports markdown, now courtesy of #1794. But we would like to work on the next iteration by making it more consistent like the GitHub Help design.

CC: @femmebot @sophshep @d12

d12 commented 5 years ago

Making it more consistent with GitHub Help is my suggestion, but I will defer to our design managers as the domain experts :)

femmebot commented 5 years ago

My inclination would be to start with the content and user needs first and let that drive the organization and presentation. That said, one thing I noticed immediately is there doesn't seem to be a Quick Start section. Are there folks on the team who can help with content?

d12 commented 5 years ago

@femmebot We have access to a contractor for professional writing / docs if needed!

sophshep commented 5 years ago

My inclination would be to start with the content and user needs first and let that drive the organization and presentation.

I agree! @shaunakpp you mentioned that it's working great, what is the impetus to change it / make it like the main help site?

shaunakpp commented 5 years ago

Hi @sophshep and @femmebot! Thank you so much for taking a peek at the docs. Well we don't need to change the docs on priority, but there are a few things we'd love to have:

Re-iterating on what @femmebot mentioned, a quick start section, there are video tutorials for that, but they are a bit outdated.
The Help page looks like a large bullet list of links, so maybe a search section like GitHub help has.
Help pages for Education redirect you to GitHub help's page but Classroom has a separate page which doesn't look like GitHub help, or has the same experience.

Would love to hear your thoughts on these 😄

stale[bot] commented 5 years ago

This issue has been automatically marked as stale because it has not had recent activity. Thank you for your contributions.

d12 commented 5 years ago

This is still something we want to do.