General Requirements
for projects in CM16

• Floppy: Submit all work on a floppy diskette (3.5" 1.44MB MS-DOS "FAT" format), with your name on a paper label. Floppys will be returned within one week.

• Directory: Each project should be in a separate directory ("folder"). If work from other classes is on the diskette, put all CM16 work & subdirectories in a directory named "cm16".

• C/C++ files: Include the source file(s) AND the executable compiled from it. Make sure program can be read & executed from floppy, before handing in.

• Comments: At the top of the program, place comment lines givng you name, date, class (CM16), and a project description. (You may use comments elsewhere in the program to explain the purpose of parts of the code, what it does, or how it works; do not explain what a C/C++ statement means.)

• Symbolic names: Use meaningful symbolic names, and briefly describe each variable in a comment on the declaration statement line. Each function should be described in comment line(s) where the function is defined.

• External documentation: Each project should be accompanied by a "brief writeup" covering the following:
  • Identification: author, project name, course #
  • What the program does. How to use it.
  • Descriptions of the input data (including restrictions, if any).
  • Descriptions of the output data (and how to interpret it).
  • Other references that would be helpful to someone using your program.
  The writeup may be on a separate ASCII file or in a block comment.

• Internal Documentation: Larger projects should also include maintenance documentation to support future modification or debugging. Typically, this might include:
  • Design materials, such as pseudocode or flowcharts.
  • If you made any assumptions about the requirements or the data, document them here.
  • Describe any new or unusual algorithms or techniques used.
  • Other information or references that may be useful to someone modifying your program in the future.