Which format for API documentation programmers prefer: PDF or Web?
3rd December 2013
My answer to Which format for API documentation programmers prefer: PDF or Web? on Quora
HTML is a better format for documentation than PDF.
Documentation needs to be easy to access, easy to bookmark, easy to share links to and easy to copy and paste from.
PDFs are lousy for linking to (you can link to the whole document but not to individual sections) and frequently cause weird issues when copy and pasting.
The two advantages of PDF are that you (the author) get more control over how it prints and it’s easier for the end user to download as a single file for offline reading.
If you think these issues are important to your audience you can solve them with HTML by including a good print stylesheet and a zip file for download of all HTML and assets. You could also use a documentation system such as http://sphinx-doc.org/ which can generate both HTML and PDF versions.
More recent articles
- Interesting ideas in Observable Framework - 3rd March 2024
- Weeknotes: Getting ready for NICAR - 27th February 2024
- The killer app of Gemini Pro 1.5 is video - 21st February 2024
- Weeknotes: a Datasette release, an LLM release and a bunch of new plugins - 9th February 2024
- LLM 0.13: The annotated release notes - 26th January 2024
- Weeknotes: datasette-test, datasette-build, PSF board retreat - 21st January 2024
- Talking about Open Source LLMs on Oxide and Friends - 17th January 2024
- Publish Python packages to PyPI with a python-lib cookiecutter template and GitHub Actions - 16th January 2024
- What I should have said about the term Artificial Intelligence - 9th January 2024