CMPT140 Programming Lab Marking Scheme

Lab Write-Up

See the template lab write-up for additional details. The write-up must include (in this order):

• Planning documents (prepared before writing any code):
  • A brief restatement of the problem in your own words
  • A statement on the suitability of solving this problem with a computer
  • A first refinement of the solution (A statement of the steps required to solve the problem):
    • what is given (input)
    • what needs to be calculated, including any formulas used (process)
    • the output required
  • Second refinement / first level of pseudocode:
    • can be sketchy
    • may not exactly match the final product, but illustrates first level of thinking
    • may be handwritten and on a separate sheet
    • don't go back and change this after coding
  • Third refinement to final pseudocode:
    • Separate pseudocode for each procedure/function, clearly showing any algorithms
    • should match the final product (or explain why not)
    • one line of pseudocode per statement or per block as appropriate
    • Examples of pseudocode:

      	print out informative headings and greeting to the user
      	compute _____ using (insert formula from first refinement)
      	obtain the density of the material from the user
      	assign the initial value 3 to the rate of decomposition
      	for each element of the array, do the following:
      		statement
      		statement
      	while the value of the month is more than June do
      		statement
      		statement
      	repeat the following steps:
      		statement
      		statement
      	until (some condition is met)

    • DO NOT INCLUDE keywords or key symbols such as '\n' or raw_input, although you may need to use for, while, etc.
  • If the steps in the third refinement cannot easily be implemented or need further breakdown, you may need to include a fourth refinement with more sub-steps shown. The rule of thumb is that if the implementation of a line of pseudocode is obvious to you, you need not refine it any more; otherwise refine to smaller steps until each one is obvious.
  • A data table, listing all constants, types, and variables and noting all imports:
    • should be by block, including the main block and every procedure
    • say what each variable is for
  • Sample I/O to illustrate how it is supposed to work
    • NOTE: this is a statement of how it is supposed to work, not how it did work. That is, you do this before you write the code, not after you run it!
  • Documentation for a user to operate the program (a user manual):
    • Explanations of error handling and messages (if applicable)
    • for every error that may happen, tell how you handle it or why it isn't a problem
• Screenshots of several actual runs with real input:
  • Your program should print a welcome message that includes your name or other identifying information, so that we know that the screenshot is of your program.
  • Every feature has to be tested!
  • Tests should demonstrate every single error / error message in your code.
  • Run it several times with a variety of data; think hard about how a user might use your program in an unexpected way.
  • If there are discrepancies between the predicted I/O and the actual, you must explain.

Marking Rubric