Information Technology Reference
In-Depth Information
Chapter 8
Documentation
8.1 Types of Documents
One has to differentiate between documents being created and required before,
during and after a project. These include so-called reference documents. They are
necessary before and during an acceptance process to establish an unequivocal
understanding of acceptance between customer and supplier. They are a mixture of
technical and commercial documents which are referenced in part by the contract
as the basis for implementation. Table
8.1
shows some example entries (see
explanations of the field items).
Meaning of the field items:
• No.: sequential number
• File name: incl. path
• Author: responsible editor (not the user having saved the latest version)
• Document title: title in long text, for example:
- Acceptance guideline
- Technical specification
...
.
- Test script for
.
- Functional specification
...
.
...
- Test schedule
. etc.
...
• Version: no. of released version (versioning according to ISO standard)
• Date: date of document release.
Besides these there are documents which are created during the acceptance
process containing results. Here are some examples:
• Protocol of provisioning
• Problem repository
• Acceptance protocol
.
...
