Login

Title

Inspection, Correction, and Extension

Course

CS2

Abstract

Inspect a partially completed program that has logic, documentation, and style errors. The inspection is done as a team in-class. Then, as individuals, write a report of the inspection results, fix the errors and complete the program, and then extend the program to add new functionality (basic and extended programs are submitted as separate versions).

This project was originally implementing the SIGCSE Nifty Assignments Scrolling Game. The description has been removed and those interested should refer to the SIGCSE nifty assignments page for details.

This project was used as the first project of the semester to review material taught in CS1 and to give students practice reading code written by others.

See the project overview document for more details.

Author

Janet Burge

Source

Dave Feinburg, Generic Scrolling Game: http://nifty.stanford.edu/2011/feinberg-generic-scrolling-game/

Genre

code review, inspection report

Assignment Duration

Two Weeks

Communication Skill

reading, writing, teaming

Technical Skill

implementation, testing, debugging, comments/documentation

Workplace Scenario

You have just started a new job where you will be designing and writing game software. You are replacing someone who left in the middle of developing a game prototype. Your first assignment is to take over the game project from them by completing the basic game prototype and then to extend the basic game to make one that is more interesting for a user.

Because you are new to the company, and because the person you are replacing left abruptly, the first step in performing your new assignment will be to do a code inspection of the partial prototype to look for defects in both the code (logic errors and style errors) and the documentation. It’s very important to make sure that the code you start with is correct before writing any new code and to make sure that the documentation is correct and complete.

After the inspection you are required to write a report listing the defects found as well as identifying areas of the code that are incomplete (the previous employee left some methods empty and also marked some places with “ToDo” comments to as reminders where new code should be written). This report will be used by your manager to assess the current state of the program and by you to check items off as completed.

Once the inspection is completed, you will then complete the basic game prototype. You will need to test this prototype to ensure that it works. The test cases and test data will need to be submitted to your manager as part of your project status report. You will also write a simple readme.txt file that gives an explanation of how to install and run your game so your manager will be able to try it out.

Finally, once the basic game is done, you will write a new game using the basic game code as a starting point. As with the basic version, you will need to test the game to ensure that it works. The test cases and test data will need to be submitted to your manager as part of your project status report. You will also write a simple readme.txt file that gives an explanation of how to install and run your game so your manager will be able to try it out.

Team Size

N/A

Collection

Citation

Janet Burge, “Inspection, Correction, and Extension,” Incorporating Communication Outcomes into the Computer Science Curriculum, accessed November 19, 2017, http://cs-comm.lib.muohio.edu/items/show/29.

License

Creative Commons License

Comments

Allowed tags: <p>, <a>, <em>, <strong>, <ul>, <ol>, <li>