Programming HW
ENGR 1120 - 030/031 Spring 2016
Individual Programming Assignments - Formal Reports
Overview :
For each individual programming assignment, you will submit a report describing your work. This report must be generated with a word processor and/or other software. No handwritten work will be accepted. The required components in this report are detailed below, however some assignments may require special instructions.
Required in Report :
1. Problem Statement - Explain the problem you are going to solve. This is a broad overview of what your program does and why. This could be just a couple sentences or a short paragraph. Any additinoal background information may be added here.
2. Inputs and Outputs - Describe what data your program uses (the inputs) and what results your program generates (the outputs). If the data is not too large (multiple pages is too large) then show it here. If it is too large consider showing a portion or summary of the data here.
3. Math Verification - For some (not all) of your data solve the correct answer by hand. Show these sample calculations. This step will look different dependsing on the nature of the programs inputs and outputs. The purpose of this step is to verify that the math in your program is correct. I recommend using MS Word to type this step.
4. Flowchart (not required on program 1) - Create a flowchart for your program. Every small detail is not required. The flowchart should show the overall program structure. Also, the text in the flowchart does not need to be exact MATLAB code. I recommend using MS Word, MS Powerpoint, or Visio (all avilable in Clement 4th floor labs).
5. Implementation - Present your entire script in your report. If there is more that one script include them all. Make sure to put a proper header on your code. Also, it is helpful tol clearly comment your code for readability.
6. Results - Does your program work? Does it behave like you expected? If not not can you guess why? Inlcude any important findings in this step. If the output data is not too large (multiple pages is too large) then show it here. If it is too large consider showing a portion or summary of the data here.
1