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

Informative vs. Uniformative Link Text #119

Open
1 task
nelsonic opened this issue Oct 19, 2022 · 0 comments
Open
1 task

Informative vs. Uniformative Link Text #119

nelsonic opened this issue Oct 19, 2022 · 0 comments

Comments

@nelsonic
Copy link
Member

nelsonic commented Oct 19, 2022

"this" is a really unhelpful link text. πŸ˜•
It's bad for accessibility and SEO. πŸ‘Ž
Similarly here or link are exceptionally poor link text. πŸ™…
They tell me (and vision impaired people and Google Bot!) nothing about the hyperlink. πŸ€·β€β™‚οΈ

https://www.mtu.edu/accessibility/training/web/link-text/
image

Remember your objective to communicate with the person reading your documentation. πŸ’¬
Not force them to click/follow the link just to know what it is ... ⏳ πŸ€¦β€β™‚οΈ

With that in mind I usually just use the actual URL as the link text e.g: github.com/dwyl/start-here

[github.com/dwyl/start-here](https://github.com/dwyl/start-here)

Or for brevity but not much loss of meaning: dwyl/start-here

[dwyl/**start-here**](https://github.com/dwyl/start-here)

Never here. Ever ...!

Note: I only do one word links for effect ... never for actual work where we want to effectively communicate with people including those who are using a screen reader or the almighty Google Bot πŸ€– praise be the algorithm. πŸ™Œ

Todo

  • Add section to README.md including this advice so we can avoid having PRs with here style links. πŸ™
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant