Computer Studies Department
School of Advanced Technology
Submission Standard
The assignment submission standards have been combined and consolidated from a number of sources, including the previous Standard. The purpose of this standard is to clarify the assignment requirements, simplify the grading process, and reduce student uncertainty.
- No assignment can include hand-written material, including changes written onto printed output. [except for hand-written identification of test cases on the output keyed to the Test Plan]
- All printed material must be printed on white 8½ by 11 inch paper in black by either an ink-jet or a laser printer in good condition.
- If a submission cannot be read, it cannot be marked.
Submission package and contents
- Optional: unsealed 9 by 12 envelope; [use if required only]
- Diskette or equivalent, if required; [not required]
- Cover Pages
- Program Analysis and Design Document
- Program Listings
- Test Plan Results
Packaging
If the lab is submitted in an envelope, it MUST be submitted in an UNSEALED page size envelope
(9 by 12 inches) that is labeled with the following information:
| |
|
Student name and number | Course name and number |
| Assignment number (and name, if assigned) | Lab Section |
| Professor's Name | Submission Date |
|
Diskette or equivalent, if required [not required]
- A submitted diskette must have a printed and legible external label with at least the student name and id, the assignment number, and the filename of the file index.
- A submitted diskette must be empty except for the assignment.
- Note that the same information must accompany any electronic form of submission as well (e.g. email, ftp, web-based).
COVER PAGE
All assignment submissions MUST begin with a cover page section with the following information:
| |
|
Student name and number | Professor's name |
| Assignment number and name if any | Due date of assignment |
| Course name and number | Submission date of assignment |
| Lab section number | Table of contents (list of files / printouts in order)
|
|
Program Analysis and Design Document
This is a separate document (and a separate file) from any program listing. It may be required to be submitted before the program itself is written so that it can be approved before coding begins.
- Problem statement; Requirements of the problem to be solved
- The Problem Description Language (PDL, or Pseudocode) description of the problem solution (the HOW of the solution)
- Data Dictionary (key variables and their purpose)
- Detailed Test Plan including both test input and expected result
- Samples of program output (design of program output)
- Structure charts or other required diagrams (like HIPO) that assist in understanding the problem (optional; at instructor's discretion)
PROGRAM HEADER (one per program or script)
| Item
| Required
| Comments
|
|---|
| Big Separator | Yes | To page width |
| Filename: | Yes | But not the path unless it's essential |
| Version: | Yes | Program version number |
| Author Name: | Yes | |
| Student Number: | Yes | |
| Course Name | Yes | |
| Course Number: | Yes | |
| Lab Section: | Yes | Normally implies "Course Section" |
| Course Section: | No | Required only for unusual situations |
| Assignment Num: | Yes | As provided by the instructor |
| Assignment Name: | Yes | If the instructor has given it a name |
| Due Date: | Yes | |
| Submission Date: | Yes | |
| Professor's Name | Yes | |
| Purpose: | Yes | A brief prose description, a few lines. |
| Big Separator | Yes | To page width |
FUNCTION HEADERS (one per function, including the main() function)
By necessity a Function Header must be created for each function, including the main() function, that the student writes as part of the overall assignment.
| Item
| Required
| Comments
|
|---|
| Big Separator | Yes | To page width |
| Function name | Yes | |
| Purpose | Yes | A brief description |
| Function Inputs | Yes | Arguments and parameters |
| Function Outputs | Yes | Returned value(s) |
| Version | Yes | Function version (change history) |
| Author Name: | Yes | Or reference to the function's source |
| Big Separator | Yes | To page width |
Updated August 23, 2002