|1||Title Page||Here you typically find such things as:
Title, Author(s), Institutional Affiliation, and Funding Statements|
|2||Table of Contents||This part is pretty much what you
would expect. However, larger technical reports may have added tables of contents
for such things as figures and tables. If the technical report is sufficiently short,
the table of contents may be merged with the title page or eliminated all together. |
|3||Introduction||Here you state the objectives of the
project and give a summary of the entire technical report. Although not typically
part of a technical report, you should itemize the contributions of each contributor
to the project in this section. |
|4||Theory of Operation||Here you discuss how and why
your system works or is supposed to work. Here you will find such things as system
block diagrams, algorithm descriptions, and similar material. |
|5||User's Manual||Instructs the user on how to set up, initiate, control, and otherwise use the system. |
|6||System Architecture||This section describes the major components of the system, specifies communication between the components, identifies any external dependencies, and describes performance factors. |
|7||Detailed Design||For software, the
detailed design needs to specify at a minimum:
The Java development system provides a mechanism for producing standardized
detailed manual page entries for each class and its objects. The
Java documentation standard mandates grouping methods descriptions with
- The precondidtions for each method.
- The postconditions for each method.
- The side-effects of each method.
- Any critical timing considerations.
Describes how the system is to be tested. The tests to be performed must thoroughly
exercise the system and allow the person performing the test to isolate the problem.
In its simplest form, a test report is simply a table indicating the
test performed, the expected result, and the result actually obtained. |