5 Review: documentation

Question 1

types of developers’ documentation

Answer 1

• data dictionaries + algorithms for design
• system flowcharts + IPO diagrams + DFDs + structure charts for system modeling

Question 2

documentation…

Answer 2

should be ongoing throughout software development cycle

Question 3

each stage…

Answer 3

requires documentation, should be retained + updated when new changes made

Question 4

test data

Answer 4

created to ensure the correct operation of algorithms, reused to test source code’s performance
- will be reused by future maintenance programmers

Question 5

documentation developed in one stage…

Answer 5

used as information for next stage
- e.g. top-down design created for guide on algorithm writing

Question 6

why should documentation be retained

Answer 6

for future maintenance, modifications, features
- retained even after completion of project

Question 7

internal documentation

Answer 7

for the use of developers
- does not affect translation process

Question 8

what counts as internal documentation

Answer 8

use of identifiers which explain their purpose: intrinsic documentation
- intrinsic: belonging to/part of; meaningful identifiers are functional parts of code
comments: used to describe purpose of code + logic of processes
- can also be used to document programmers + date of code written

Question 9

readability of code

Answer 9

• comments help explain the purpose of unusual/difficult processes
• white space/empty lines to provide contrast between logical blocks of code
• indentation

Question 10

function of documentation for users

Answer 10

teaches users about the operation of the product

Question 11

documentation for users could include

Answer 11

installation + reference guides, manuals, tutorials
- can be printed or online(and linked to application’s online help system)

Question 12

online help

Answer 12

provided by most commercial applications
- help files

Question 13

advantage of online help

Answer 13

content extensive