contributing icon indicating copy to clipboard operation
contributing copied to clipboard

Informative vs. Uniformative Link Text

Open nelsonic opened this issue 3 years ago • 0 comments

"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. 🙏

nelsonic avatar Oct 19 '22 10:10 nelsonic