Project Documentation Format

hardcopy | CD

Hardcopy:

The project documentation hardcopy shall be printed on good quality white short bond paper (8.5" x 11") and shall be softbound with a light blue cover. The cover shall have printed on it the title of the project in large black type followed by a list of the project proponents in smaller type. The names of the proponents shall be listed one name per line in alphabetical order of the surnames, with each name being of the form

Firstname MiddleInitial Surname

or

Firstname Surname

Both the title and the list of proponents shall be centered on the cover. The title may span several lines.

[sample cover]

The main body of the documentation shall be preceded by

The title page shall follow the format of this [sample title page].

The abstract page is a single page containing the abstract of the project. [abstract page format]

Lists of tables, figures, code listings, definitions, and other such lists if relevant and/or desired may follow the Table of Contents.

Chapters, sections, and subsections shall be numbered using Hindu-Arabic numerals. Chapters shall be numbered 1, 2, 3, and so on. (not I, II, III, ...). Similarly, sections might be numbered 2.1, 2.2, 2.3, ..., and subsections 2.1.1, 2.1.2, 2.1.3, and so on.

Normal text in the documentation shall be comparable to 12 pt Times New Roman or larger. Line spacing shall be 1.5.

Each chapter shall start on a new page.

The main body of the documentation may be followed by appendices, as needed. Each appendix shall start on a new page.

If there are appendices, the Bibliography shall follow the appendices.

The title page shall be considered page 1, the abstract page shall be page 2, and so on. Page numbers shall not be displayed on the title and abstract pages. Page numbers shall be displayed centered on the footer starting with the Table of Contents.

CD:

The CD containing documentation for the project shall be submitted in an individual transparent CD case. The CD shall have a sticker-label on which are clearly printed the project title, the names of the proponents, and the month and year the project was completed (e.g. October 2003). No date shall be specified, only the month and year. The project title shall be the same title that appears on the cover of the hard copy.

The CD shall contain the following:

  • a copy of the approved proposal

  • copies of the progress reports

  • copies of presentation materials used in presenting the project, if any

  • a soft copy of the formal written report

  • a website for the project

  • other forms of documentation as may be appropriate for the particular project

The copy of the approved proposal shall be placed in a directory named "proposal" in the CD root directory. The copies of the progress reports shall be placed in a directory named "progress-reports" in the CD root directory. The copy of the formal written report shall be placed in a directory named "doc" in the CD root directory.

The CD root directory shall be the home directory for the project website. That is, access to the project website shall be thru a file named "index.html" in the CD root directory. Relative addressing should be used in all links to files within the CD. The links in the project website must work properly when the contents of the whole CD are copied to another location.

Students are expected to use the flexibility of the project website, to present the details of their work in the best way possible.

 

 

 

 

1