3 ms·
I like well written documentation. Well written documentation will show me all the capabilities of a thing, the inner workings, all the possible variables and
by LinuxBender 6y ago
I like well written documentation. Well written documentation will show me all the capabilities of a thing, the inner workings, all the possible variables and options, along with real world examples of configuring, debugging, tuning. If that is missing from the documentation, I go looking for real world implementations, example configurations, learned caveats this will rarely be in documentation, tips and tricks for things you can do that are outside the intended purpose. An example of well written documentation is the Apache HTTPD project [1]. They have all possible configuration directives, even include documentation for modules they did not create and provide defaults along with example configurations for most directives.
[1] - https://httpd.apache.org/docs/2.4/ https://httpd.apache.org/docs/2.4/