3 ms·
The projects that clearly care about good thorough documentation are relatively rare but worth their weight in gold. One of my favourites is Symfony, their doc
by noir_lord 8y ago
The projects that clearly care about good thorough documentation are relatively rare but worth their weight in gold.
One of my favourites is Symfony, their documentation is phenomenal (right up to the ability to generate a beautifully formatted ebook straight from the docs).
https://symfony.com/doc/current/index.html#gsc.tab=0 https://symfony.com/doc/current/index.html#gsc.tab=0
The structure is inviting, nicely thought out, makes it easy to get into from multiple points and well written.
Also I really appreciate they have a good "Best Practices" section, too many frameworks give you a lot of flexibility without any overarching "We suggest you structure it this way" which means that you can pick up two projects based on the 'same' framework and they bare little actual resemblance to each other.
That matters when you inherit someones codebase/decisions.