Hacker News new | past | comments | ask | show | jobs | submit login

I don't understand what is going on here - I read this before on https://diataxis.fr - so I guess this is some sort of fork:

2021-04-07: https://github.com/evildmp/diataxis-documentation-framework/... Add license CC-BY-SA 4.0

2021-04-30: https://github.com/divio/diataxis-documentation-framework/co... Copyright change from Danielle Procida to Divio

edit: fixed link




I think Procida initially created this as part of their work with Divio and then forked it to the Diataxis site. The Divio site was definitely around before Diataxis and the Divio site was where these ideas originally gained a lot of popularity.


They’re officially related. Personally, prefer the link I used since it provides a table of contents and link to this YouTube presentation on the system:

https://m.youtube.com/watch?v=t4vKPhjcMZg


This variant seems worse than the dataxis one.

It's already a weakness of this "theory" that it leaves only the reference for documentation that's intended to be complete and correct, while also recommending that the reference be organised as a list of the available operations.

But this divio variant goes so far as to say that, when writing the reference, "don't allow explanations of concepts".

I believe good documentation often needs rigorous definitions of the concepts involved, not just a list of functions or configuration items or whatever.

So either the reference should have space for those, or the explanation should be in a more rigorous style, not a "more relaxed" discussion.




Consider applying for YC's W25 batch! Applications are open till Nov 12.

Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: