News for hackers. Stuff that matters.

A comment on Take a look at traefik, even if you don't use containers. Parent comment

Re:Take a look at traefik, even if you don't use containers by johanbcn on Sunday May 05, 2024 @12:40PM (#40266148)
> 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

[ Parent | on HN ]
Re:Take a look at traefik, even if you don't use containers by yoyojojofosho on Sunday May 05, 2024 @04:18PM (#40267886)
Discussed on HN: https://news.ycombinator.com/item?id=33721314
[ Parent | on HN ]
Re:Take a look at traefik, even if you don't use containers by adolph on Sunday May 05, 2024 @01:45PM (#40266677)
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.

[ Parent | on HN ]
Re:Take a look at traefik, even if you don't use containers by siamese_puff on Sunday May 05, 2024 @08:38PM (#40269989)
Also https://docs.divio.com/documentation-system/
[ Parent | on HN ]
Re:Take a look at traefik, even if you don't use containers by FelipeCortez on Monday May 06, 2024 @10:23AM (#40275048)
These are "the same". Diátaxis is the fork the author made after (I presume) they left Divio.
[ Parent | on HN ]
Re:Take a look at traefik, even if you don't use containers by siamese_puff on Wednesday May 08, 2024 @12:19PM (#40299835)
Ah TIL
[ Parent | on HN ]
Re:Take a look at traefik, even if you don't use containers by yread on Monday May 06, 2024 @04:47AM (#40272561)
MSDN also follows these principles
[ Parent | on HN ]
Re:Take a look at traefik, even if you don't use containers by molszanski on Monday May 06, 2024 @08:57AM (#40274098)
Thank you for the link <3
[ Parent | on HN ]