CIS 294 - Visual Basic Programming

Program submission/documentation requirements

Fall Semester 1997

 

 

When you submit a programming assignment, you need to include all of the following:

 

  1. A hard copy (printout) of your source code and documentation*.
  2. A floppy disk with all of the files I will need to run your program on my computer (use Setup Wizard to do this). (Your disk will be returned to you with your graded assignment.)
  3. Depending on the assignment, your instructor may require that you execute the program in the lab. If this is required, it will be stated on the assignment.

 

*NOTE: Remember from your previous classes that "documentation" is much more than just commenting your source code. For each programming assignment, in addition to proper commenting, I expect the following to be included with your program listing (source code):

 

  1. Your name
  2. The date
  3. The assignment number
  4. The type of computer (cpu, speed) and operating system used (Windows 3.1, 95 or NT)
  5. The problem statement (summary of assignment)
  6. Requirements specification (Your understanding of what the user requires this program to do)
  7. Design documentation
  8. Architectural: structure chart (with parameters) or hierarchy classes

    Procedural: modules for new/modified routines

    names, purpose, parameters, pre/post conditions, calls, algorithms

    Data: ADTs, classes, etc.

    User interface: printouts of forms (GUIs)

  9. Test plan (test cases; I am interested to see how you try to make your program "crash")
  10. Program execution (Execute your program and indicate to me which of your test cases correspond to which executions. These DO NOT need to be screen captures. Just describe in words what test cases you used and what the results were.)