Project Technical Report Format
The appearance and overall organization of the report as well as its content will influence the grading.
The technical report should be "professional quality" because in a real setting they will be the first description of your project that management encounters – the thing upon which they base their first impression. A slick technical report help to "sell" a project. It's hard to overcome a bad first impression in your actual (in the real world) report.
Be sure to include each of the components listed on the project page. The technical report should be submitted as a pdf file. Word allows you to save as a PDF file.
An html version (web site) of the technical report is also required. The html version must be submitted via a zip file. You can use classweb to develop and host a live version, but the zip file is required as well.
- High-quality PDF version of report
- Web site version of report with image maps allowing easy traversal of DFD
- Zip file containing files for the two items above (redundancy for safety)
- Peer evaluations submitted individually by and for each team member
You must include each of the following sections, in the order in which they appear below.
(Click on any item in the table below to see a description.)
|Required Sections in Technical Report|
Your report requires a cover page. It’s all about first impressions. There are a lot of
things that go into a professional proposal, but we are talking about first impressions
here. So, let’s see what should be included on the first thing the reviewers' eyes fall on –
the cover page.
The why and wherefore is communicated through
You can dress it up with a slick graphic or related image. See this link for more ideas.
The following templates may help provide some design ideas.
|Table of Contents|
|The table of contents page sets out the sections and subsections of the report and their corresponding page numbers. It should clearly show the structural relationship between the sections and subsections. A reader looking for specific information should be able to locate the appropriate section easily from the table of contents.|
Be sure to include each of the following, and label each clearly.
The executive summary is a critical part of a proposal, and should always be the first text the reader sees.
Be sure to include both of the following, and label each clearly.
Functional decomposition of current system (be sure to include grouping of processes)
Current Logical DFD
Partial Physical DFD
Partial Data Dictionary
Partial System Structure Charts
Functional decomposition of future system (be sure to include grouping of processes)
Future logical DFD
|Partial OO Representation of Future Logical System|
Use Case Diagram
Use Case Descriptions
UML Class Diagram
|This is your final chance to "sell" your project. Make it memorable!|
Here is an Example Technical Report.