Add: lesson on the different ways to document code

[lwasser]

https://www.pyopensci.org/python-package-guide/documentation/write-user-documentation/document-your-code-api-docstrings.html

We have the above page in our guidebook but a more robust page on the different types of documentation and how to add it would be useful. This would include

• reference and links to how expressive naming contributes to documentation

• How and when to add docstrings

• How to add docstring examples

• How to call help / see how the docstrings appear to a user

Notes on how docstrings become critical when adding API docs (as a small section at the end).

[sneakers-the-rat]

There are a few of these floating around from CSCW/STS people that are better than this, but a typology of documentation i find helpful:

• API docs - how does the code work
• Narrative docs - why does the code work that way
• Tutorial docs - how do i use the code
• Examples/notebooks - how the code is supposed to be used

would be nice to have an overview like this somewhere, I think it's in a few places and in the structure of that section of the guide, but seems like "overview" material :)

(sorry if this isn't waht you meant in this issue)