In my experience, software documentation is pretty hit-or-miss. It can be very technical and difficult to read but more informative. Other times its user friendly and readable and almost like an online tutorial. Sometimes there is not useful documentation at all. All three of these are possibilities when working with open source software. Jupyter notebooks is a large project and has some great documentation that can be seen below:
There are six major sections of the documentation with installation and UI Components being the ones we used the most. We found the documentation to be user friendly and readable with plenty of diagrams and screenshots. We never felt bogged down by technical language and we could usually quickly find the answer to what we were looking for.
No comments:
Post a Comment