search

nodeshift / nodejs-reference-architecture

The Red Hat and IBM Node.js Reference architecture. The teams 'opinion' on what components our customers and internal teams should use when building Node.js applications and guidance for how to be successful in production with those components.
https://nodeshift.dev/nodejs-reference-architecture/
Apache License 2.0
1.71k stars 122 forks source link

doc: first cut at accessiblity section #118

Closed mhdawson closed 2 years ago

mhdawson commented 2 years ago

Signed-off-by: Michael Dawson mdawson@devrus.com

bennypowers commented 2 years ago

There's room to talk about making software libraries more accessible to their consumers as well, considering that neurodiversity issues are also included in a11y concerns.

For example, JavaScript library authors should include TypeScript declaration files with good inline documentation (JSDoc blocks). These are very helpful at reducing cognitive load: it's way easier to just read the API docs in your editor than go code spelunking on github.com, and for users with ADHD to pick one example of many, opening another browser tab may come with a significant cognitive load cost.

mhdawson commented 2 years ago

Discussed in Ref arch meeting today, everybody was ok with it landing in current form. Michael will leave PR open until end of week in people want to take some more time to review and comment.