Closed kelenelee closed 1 year ago
markdown
to increase legibility of things@kelenelee The writing works: clarity is most important. I do not have any pressing changes. It is very clear.
It is very clear.
Thanks @sandraberjan for taking a look. I added some emojis to the headings in the readme to make them more eyecatching. What do you think? If the copy is good, then maybe the visual hierarchy can be played with.
The reason why I'm not 100% with this copy is that generally it's bad UX practice to have hyperlinked text say "click here" or "this page" but I can't think of a clearer way to say it. If I describe the content of the link, which is what the usual practice is for hyperlinks, then people might get more confused. The less info you have to worry about, the better right? I guess I wanted reassurance / gut check that breaking the rule of hyperlinked text is justified in this special case
I also added the project card which is found under our assets and branding drive folder – probably good to be compliant with HfLA practices :)
After receiving feedback from new joiners who completed our team's onboarding issue, the issue template has been updated multiple times.
This study is focused only on DS onboarding, but findings may have implications for HfLA broadly.
Recommendations
These are the simplest fixes:
readme.md
is not the normal place to write these kinds of directions, but the repo homepage is where the user got very lost. If users are visiting the repo homepage, but don't make it beyond to the wiki or the project board, then somewhere on the repo homepage there needs to be something really clear.No description or website provided.
It's at the top of the right sidebar, and could be an opportunity to add onboarding directions. But because it's a sidebar, it may not be as eyecatching as the readme. Neither I nor @allthatyazz have permission to edit this – can the stakeholder do it? What should our description say?More complex proposals:
onboarding
since newcomers just finished onboarding with HfLAMore complex fixes will come as we observe more newcomers.