1. Which of the following counts as software documentation? (Check all that apply)
All of these are correct answers because these are all items which tell you information about software.
2. For her course project, Camilla puts some comments into her code. This code is for a use case in the project. The comments are a kind of user-facing documentation.
Because these comments are meant for software developers working on the code, the comments are a form of technical documentation.
3. I am downloading the video game Minecraft so that I can play it with my friends. To do so, I look at a gaming website which tells me how to download the software. This website serves as a kind of technical documentation.
The website is not "technical documentation" in the strict sense of the word. This is because technical documentation is designed for software developers who are working on the software project. The website was written for end users of the Minecraft software, so the website can be viewed as a kind of "user manual".
4. What are some reasons that software documentation is important? (Check all that apply)
All of these are valid reasons for why one should take software documentation seriously.
5. What is true about the state of documentation in industry? (Check all that apply)
False! Informal reviews are the most common technique!
True; research tells us that this is true!
False! The ISO standard is ineffective since it fails to capture the particular aspects of good software documentation; after all, a table loom (an object which is completely unrelated to software documentation) would almost pass the ISO standard for good documentation! So, clearly, there is an issue with the ISO standard.
True! Unfortunately, human-led reviews of documentation are slow.