Package-Documentation


Table of Contents

Intent
Patterns used
Diagramms
Detailed Description
Dependencies on other packages
Hints for extending and maintaining this package
Todo

Intent

Why was this package created? Which concepts does it encapsulate?

Patterns used

Which patterns have been applied?

Diagramms

All kinds of important diagramms go here. Especially overview diagramms should be placed here. (This does not mean you should place all diagramms in this section, only those which are of importance to the whole documentation.)

Detailed Description

Describe the roles of the package classes and interfaces without going into to much detail. Discuss design decisions e.g. tradeoffs between different kinds of implementations, advantages and disadvantages of the chosen solution.

Dependencies on other packages

On which packages does this package depend? Why?

Hints for extending and maintaining this package

Are there any standard ways this package can be extended?

Which dependencies should be kept and which should be avoided?

Todo

List things to do and/or suggestions for improvement of this package. Add references to bug reports, change requests, design documents and so on if available.