We were to read Chapter 8 in our online text which was entitled "Explaining the Code". It basically stresses the importance of documentation. My favorite section was 8.5 and it starts like this, and I quote "Documentation has a reputation as being an easy way to begin contributing to a project. This is more true where the new contributor is already experienced or an expert in the material. It is much less likely to be true where the project has not considered how to enable good and easy documentation, or the technical content is very high." VINDICATION! We aren't incompetent- it's just hard! This whole semester Team FOSSils has been trying to contribute documentation fixes to our open source project Django, but to no avail. And lets be honest- it's been depressing, but this quote somehow makes me sit up a little straighter and not feel like a complete failure.
We were also to read Chapter 6 in our text. I'm currently taking CSCI-360 and this chapter goes over all those concepts we are currently learning.
Exercise 8.1.1
We've been looking at a lot of documentation for Django. They have a VERY detailed link explaining/instructing how to write documentation for them. As frustrating as it has been trying to write documentation that is up to their standards- at least they are still allowing us to try and contribute and are always readily available when we have questions.
Exercise 8.4
I do not have enough time for this tonight- this will have to be done at a later date.
No comments:
Post a Comment