3.7 Program Documentation

• There are two main types of program documentation: internal and external
• Match the type of documentation with its primary purpose:

  Internal Documentation ↔️ Explains code logic

  External Documentation ↔️ Provides user instructions
• What is the purpose of collaboration in the context of program documentation?

  To enable teamwork
• Program documentation is essential for making code understandable and usable.

  True
• Program documentation enables developers to understand and modify code easily.
• Match the type of documentation with its purpose:

  Internal Documentation ↔️ Explains code logic and steps

  External Documentation ↔️ Provides user manuals and guides
• Proper use of internal documentation makes code easier to maintain.


  True
• Program documentation is optional for collaborative projects.

  False
• User guidance is an example of external documentation.


  True
• How many main types of program documentation are there?

  Two
• What is the primary purpose of comments in internal documentation?

  Explain code logic
• What are the main types of external documentation?

  User manuals, API references, system design documents
• External documentation provides information not directly embedded within the code.

  True
• What are the two main areas where program documentation provides key benefits?

  Maintainability and collaboration
• Program documentation helps developers understand and modify code, reducing errors
• Arrange the key purposes of program documentation in order of importance:

  1️⃣ Maintainability

  2️⃣ Collaboration

  3️⃣ User Guidance
• Match the type of documentation with its example:

  Internal Documentation ↔️ A docstring describing a function

  External Documentation ↔️ A user manual for software installation
• The three main types of external documentation are user manuals, API references, and system design documents
• The purpose of external documentation is to provide high-level information about the program that is not embedded within the code
• Clarity in documentation involves using plain language, short sentences, and logical structure
• Accuracy in documentation ensures that the information matches the current state of the code
• Match the type of documentation with its purpose:

  Internal Documentation ↔️ Explain code logic within the code

  External Documentation ↔️ Provide overall program information
• What is the purpose of program documentation?

  To explain the program
• Program documentation is crucial for collaboration and maintenance of code.

  True
• Maintainability is one of the key benefits of program documentation.


  True
• Internal documentation explains the logic
• How does maintainability benefit from program documentation?

  Reduces errors and improves efficiency
• What role does user guidance play in program documentation?

  Provides clear instructions for users
• External documentation may include usage instructions or an API reference
• External documentation includes separate documents, manuals, or guides
• Collaboration in programming is enhanced when programmers can grasp each other's code
• A user manual is an example of external documentation
• Match the element of internal documentation with its purpose:

  Comments ↔️ Explain code logic

  Docstrings ↔️ Describe function functionality

  Header Comments ↔️ Provide file overview
• Proper use of internal documentation enhances code readability.


  True
• What does an API reference describe in external documentation?

  Available functions and parameters
• Order the steps to create clear and helpful program documentation:

  1️⃣ Clarity

  2️⃣ Completeness

  3️⃣ Consistency

  4️⃣ Accuracy
• What is the primary purpose of program documentation?

  Make code understandable
• Match the documentation type with its purpose:

  Internal Documentation ↔️ Explain code logic within the code

  External Documentation ↔️ Provide overall program information
• What is the purpose of external documentation?

  Provide overall program information
• Maintainability reduces errors and improves efficiency in code modification.


  True