Documentation and when it is produced

Overview

Four things technical documentation contains, four things user documentation contains and risk that thin documentation creates.

What you need to know

Answer each one before you reveal it.

Questions from this subtopic

Each one with the model answer underneath.

1. 1

   What documentation is produced during the feasibility study?

   Model answer

   The feasibility report, stating the problem, the options considered and the recommendation with its costs and benefits.

2. 2

   What documentation is produced during analysis?

   Model answer

   The requirements specification, together with the models of the current and proposed systems such as data flow diagrams and entity relationship diagrams.

3. 3

   What documentation is produced during design?

   Model answer

   The design specification — file and data structures, screen and report layouts, algorithms, module structure and the test plan.

4. 4

   Why is the test plan written at the design stage rather than after coding?

   Model answer

   Tests derived from the design test what the system was supposed to do; tests written afterwards tend only to confirm what it does.

5. 5

   What documentation is produced during implementation?

   Model answer

   The annotated program listings and the technical description of how each module works.

6. 6

   What documentation is produced during testing?

   Model answer

   The completed test log, giving each test's data, expected result, actual result and any action taken.

Other ways to work this

The same content, four other ways.

What is inside Levo

Six ways to work the same material.