What nobody tells you about documentation
Points
About the talker:
- Daniele Procida
- Django core developer
- Used to be a high school teacher>
- Twitter @EvilDMP (Private)
Everybody knows "better documentation will make your project more successful", but he introduces in a more advanced way:
"It does NOT matter how good your product is, if you don't have good documentation, nobody will use it."
Most people try to create good documentation. And most people FAIL.
Usually, it's not because they don't try hard enough. Usually, it’s because they are not doing it the right way.
And the right way is the easier way.
This talk will make your project more successful.
There is not ONE thing called "documentation", there are FOUR:
- Tutorial
- How-to Guides
- Discussion / Explanation
- Reference