this post was submitted on 21 Jun 2023
4 points (83.3% liked)

Django

418 readers
3 users here now

Django Project

Django Community

Django Ecosystem

Jobs
Learning/Docs
Podcasts:
Related Fediverse communities
Feeds

founded 1 year ago
MODERATORS
 

cross-posted from: https://programming.dev/post/133154

Cross-posting this because it's pertinent, but also because Divio is part of the Django community.

The mistake most devs make when trying to document their project is that they only make one (maybe two) types of documentation based on a readme template and/or what their mental model of a newcomer needs.

Devs need to be actively taught that:

  1. Good documentation isn't one thing, it's four. To have good documentation, you need all four distinct types of documentation.
  2. What the four types of documentation are (this is discussed in the link)

If you don't have all four types of documentation, you have bad documentation.

no comments (yet)
sorted by: hot top controversial new old
there doesn't seem to be anything here