1.1.8 Importance of user documentation

Question 1

What happens when programs and systems become more complex as they expand?

Answer 1

it may be difficult for users to use the program and the product functions may not be clear to users

Question 2

What can unclear usage of a program or system lead to?

Answer 2

serious problems during implementations or operational stages of the Software Life Cycle (SLC). User may not know hot to use the product to its whole capacity and even technician may not be able to set up the new system properly

Question 3

What can counter the misusage of a program or system (product)?

Answer 3

user documentation. since there is a user manual explaining every component of product

Question 4

what are the two types of documentation?

Answer 4

internal documentation and external documentation

Question 5

What is internal documentation?

Answer 5

code comprehension features and details provided as part of the source code itself

Question 6

what does proper internal documentation include?

Answer 6

appropriate module headers, appropriate comments, useful and meaningful variable names, appropriate code indentation, code structuring.

Question 7

what is external documentation?

Answer 7

written as a separate document from the program itself. Provided through various types of user-supporting documents such as a user’s guide, software requirements, specification document, detailed description of the design

Question 8

can the internal documentation be easily read bye the final user?

Answer 8

no it is very difficult for the source code to be read by the final user