Hacker News new | ask | show | jobs
by rezonant 781 days ago
> Technical writers: documentation by example is good only for newbies skimming through. People familiar with your product need a reference and exhaustive lists, not explanation for different fields spread over 10 tutorial pages.

Well said, this extends far beyond Traefik. Far too much documentation these days is tailored for people who have never used software of it's type. This was a workable strategy during the Great Developer Boom, but that's more or less over now.

As a developer who didn't come from this Boom, I have been constantly frustrated by this trope, and I hope the changes in the industry will tip the scales back toward solid reference documentation, so that I can feel confident in deploying more of these technologies.

Putting that more general note aside, I have been a Traefik user for years and I do recommend it. But a lot of what it does is difficult to cite using solid docs.

1 comments

I've often resorted to just looking through the project on github and finding whatever source file is responsible for parsing the configuration files to figure out what each option does.
This applies nearly universally in open source. If documentation isn’t sufficient, jump into the source code and most things can be figured out. Reading other people’s code is also a great way to learn/experience different approaches