Documentation module #140
Documentation module #140
Conversation
| - Tutorial(s) | ||
| - In-code documentation | ||
| - API reference | ||
| - Overview of components | ||
| - User documentation |
There was a problem hiding this comment.
@DaniBodor these three types of documentation that were mentioned here, are more or less three high level categories of documentation divided by the audience. The things you added seem to me to be a collection of 1) different formats/implementations of documentation [README, in-code docs, API ref/docstrings (could also add a web page to this list and a printed paper/book] and 2) a shape/narrative type [tutorial, overview of components, story/narrative]. I think it might be confusing to put them all in one list, but I do like the idea of looking at these different aspects of audience/implementation/shape. For example, you could have a tutorial that describes how to deploy the software written down in a README file, or you could have an overview of components and descriptions on how to use them written down in comments in the code (not the best user documentation, I agree). What do you think about this?
There was a problem hiding this comment.
I had put different "levels" of documentation into this list on purpose. Apart from the three high level ones, all the others are also part of the previous exercise as well as part of the "types of documentation" tab, so there should be plenty of info around.
I see how it could be confusing, but in my mind not so much so that it is preventative. I'm happy to change it though, if you disagree.
No description provided.