|
|
|
|
|
|
by flowerbreeze
152 days ago
|
|
|
My favourite approach to documentation is the "4 kinds of documentation" - whether it's about an API, a library or anything else. I think it's a very clean way of explaining "good/poor" documentation. In a nutshell, which type of documentation we need depends on the goal we have. Any API missing one of the kinds of documentation will feel like it is missing something. Once I read about it, I've been noticing how the documentation I like tends to have all these aspects covered. https://www.writethedocs.org/videos/eu/2017/the-four-kinds-o... |
|
|