How does Django follow diataxis? #137
yaakovLowenstein
started this conversation in
General
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
After reading all about diataxis, I was a little confused about how Django's docs follows diataxis?
They have how-tos and reference documentation, but the majority of their documentation can be found in a section they call 'topics'. My assumption is that 'topics' reflects 'explanation'. However, as a developer who uses Django, I find that 95% of the time when I am using Django and I need practical help I find it in the 'topics' section. My understanding of diataxis is that explanation is more of a deeper "let's think about it" part of the documentation and not one you would be turning to often for practical help, that practical help should be more in the tutorial or how-to section.
Thanks
Beta Was this translation helpful? Give feedback.
All reactions