If you have documentation for your library/SW/service, please, please ensure there is an option to show the whole documentation in a form I can print. That could be:
- Showing it all in one HTML page (and styled so it prints well)
- Export to a document format like PDF
For many of us, it is far easier to read docs on paper than on any screen. It is easier on the eyes. One can easily mark things on paper. It is easier to read on the go (e.g. when waiting at a doctor’s office or on an airplane). When there are new libraries/tools I want to learn, I often print out the docs and just have them in my car, so I can grab them anywhere I have downtime (e.g. while eating alone at a restaurant).
It’s just more ergonomic.
And certain people have health issues that make it harder for them to stare at screens over long periods (eye strain, etc).
So when you choose what system to write your docs in, please use one that supports easy printing.
Comments
You can view and respond to this post in the Fediverse (e.g. Mastodon), by clicking here. Your comment will then show up here. To reply to a particular comment, click its date.