DOCUMENTATION Flashcards

1
Q

Documentation

A

Collects information about the system usually in written format.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
2
Q

System Documentation

A

Describe system itself.

Written so that software can be maintained and modified by people other than the original developer.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
3
Q

User Documentation

A

As user guide/manual.

Step by step instructions on how to use system.

Can contain tutorials and screenshot.

Powerful marketing tool.

Written for both novice and expert users.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
4
Q

Technical Documentation

A

Helps clients’ processes regarding installation and gets unstruck.

Understand inner,outer dependencies of software.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
5
Q

Why Documentation important?

A

More knowledge about the system.

Describe how users should operate and administer system.

Future references & use.

Traceability purposes.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
6
Q

Describe a range of documentation that should be given to you by the Project Manager
prior to development

A

Functional Requirements Document

Technical Requirements Document

Architecture Document

Design Document

Testing Plan

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
7
Q

List the documentation that each programmer should produce on completion of their
programming task

A

Code documentation

User manual

Test documentation

Maintenance documentation

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
8
Q

Documentations to know

A

Code documentation

User manual

Maintenance documents

Functional Requirements documents

Architecture documents

Design documents

Testing planning

Technical documents

Testing requirements documents

How well did you know this?
1
Not at all
2
3
4
5
Perfectly