3 ms·
I always assumed docs were either written by the devs writing the software, or technical writers. My mental model of good documentation has two types: old-schoo
by sgarland 2y ago
I always assumed docs were either written by the devs writing the software, or technical writers. My mental model of good documentation has two types: old-school, heavily technical (e.g. Postgres [0]), and friendlier-but-still-detailed (e.g. Django [1]).
The former definitely does not attempt to hold your hand in the slightest, whereas the latter has a Quick Start, Tutorials, and detailed information about specific components.
[0]: https://www.postgresql.org/docs/current/index.html https://www.postgresql.org/docs/current/index.html
[1]: https://docs.djangoproject.com/en/5.0/ https://docs.djangoproject.com/en/5.0/