[johanbcn]

> 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. Focus on those that use the product day in and day out, not solely on the "onboarding" procedure.

I agree. We all would benefit by giving more exposure to documentation frameworks such as https://diataxis.fr

[adolph]

I'm glad to have clicked through for curiosity's sake. Diátaxis is tremendously interesting.

For folks who might recognize the author's name:

Daniele Procida: Director of Engineering at Canonical. Creator of Diátaxis and BrachioGraph. Django core developer. Fellow of the Python Software Foundation.

[siamese_puff]

Also https://docs.divio.com/documentation-system/

[FelipeCortez]

These are "the same". Diátaxis is the fork the author made after (I presume) they left Divio.

[siamese_puff]

Ah TIL

[yoyojojofosho]

Discussed on HN: https://news.ycombinator.com/item?id=33721314

[yread]

MSDN also follows these principles

[molszanski]

Thank you for the link <3