3 ms·
An indirect answer, here are the components of good docs I think about: 1. Reference docs that describe the behavior of the thing and the API 2. Example code
by eatonphil 4y ago
An indirect answer, here are the components of good docs I think about:
1. Reference docs that describe the behavior of the thing and the API
2. Example code and tutorials that show you how to use the thing
3. Architecture docs that describe how the thing works at a high level and how you integrate it into your system
4. Operational docs to tell you how to run the thing in production with backups, monitoring, debugging, and scaling
5. FAQ and anything else
Lots of docs tend to focus on only a few of these. But you've got really great docs when you bring these all together.