Dec 03, 2024 | 601 words | 6 min read
16.3. Report - 25 points#
For your final project report, you will document your work in a clear, organized format that demonstrates both the development process and functionality of your program. This report should serve as a comprehensive guide, allowing someone unfamiliar with your project to understand its purpose, design, and how to use it effectively. Each section should be concise yet informative, focusing on your project’s key components, such as the inputs and outputs, user-defined functions, and any unique features you’ve implemented. Use the provided prompts to structure your report, ensuring that each area of your project is explained in detail.
16.3.1. Task Instructions#
Please download the template
ip_ind_report_username.docx
and save it as ip_ind_report_username.pdf. Be sure to replaceusername
with your Purdue username.Refer to the rubric in Table 16.4 to guide you in crafting a strong report that meets the grading criteria.
Submit as ip_ind_report_username.pdf on Gradescope.
Task(s) |
Deliverables |
---|---|
report |
ip_ind_report_username.pdf |
code files |
Upload all code files to Gradescope |
16.3.2. Rubric#
Criteria |
Fully Achieved |
Mostly Achieved |
Partially Achieved |
No Attempt |
---|---|---|---|---|
Title Page |
Title page includes name of author, section-team number, and title of program. |
Includes name but missing name of program or section-team number or both. |
Missing name. |
|
Introduction to the Program |
Introduction is clear, includes motivation for the project, and explains how it is connected to your dream project idea. It is free of spelling and/or grammar errors. |
Introduction is mostly clear, but does not include connection to dream project idea, or contains more than two spelling and/or grammar errors. |
Introduction is not clear or contains more than 3 spelling and/or grammar errors. |
No program introduction is included. |
Description of Inputs and Outputs |
Clear overview describing what the program does, along with its inputs and outputs. It is free of spelling and/or grammar errors. |
Incomplete overview missing overall description, inputs, or outputs, or contains more than two spelling and/or grammar errors. |
Minimal description that does not provide enough detail to understand the inputs and outputs, or contains more than 3 spelling and/or grammar errors. (1 pt) |
Overview is not included. |
Description of User-defined Functions |
Clearly describes all user-defined functions. |
Clearly describes some user-defined functions but does not include all functions, or description is not clear for some functions, or contains more than one spelling and/or grammar error. |
Mentions that there are user-defined functions but does not describe them or contains more than 3 spelling and/or grammar errors. |
Does not mention user-defined functions. |
User Manual |
Clear and easy-to-understand user manual with concise descriptions and screenshots of the user interaction. |
Incomplete or hard-to-understand manual that either lacks clear instructions and/or does not include screenshots, or contains more than 3 spelling and/or grammar errors. |
Started a user manual but is missing many required aspects. |
No user manual is included. |
Flowchart |
Flowchart is included and is clear, easy to read, and accurately represents the program. |
Flowchart is included but is difficult to read or does not accurately represent the program. |
No flowchart is included. |
|
Code Files |
Complete code is included in the appendix AND all code files are uploaded to Gradescope. |
Partial code or no code is included in appendix but all files are uploaded to Gradescope OR full code in appendix but all code files are not uploaded to Gradescope. |
Code is not included in appendix AND no code files are submitted on Gradescope. |
|
Submission |
Submitted in pdf format to Gradescope. |
Not submitted to Gradescope as a pdf. |