Title
Game Manual Rewrite
Course
CS1
Abstract
This project can be used for introductory students. The specific code attached here is applicable to students who are learning Java and have learned how to use 2D arrays and write their own classes. But, one can write their own "poorly styled" code for this assignment as well.
Students are given a piece of code that works, but is poorly written with no documentation. They must first experiment with the program to figure out what it does. Once they do, they have to redesign the code, use good style and comment the code so that it solves the same problem, but is easier to read. In addition, the students must produce a user's manual for the finished product, so that someone can easily use the program.
Students are given a piece of code that works, but is poorly written with no documentation. They must first experiment with the program to figure out what it does. Once they do, they have to redesign the code, use good style and comment the code so that it solves the same problem, but is easier to read. In addition, the students must produce a user's manual for the finished product, so that someone can easily use the program.
Author
Arup Guha
Genre
User Manual
Assignment Duration
One Week
Communication Skill
Writing
Technical Skill
Programming Language Basics, Object Oriented Language Features
Workplace Scenario
Practice in cleaning up and documenting someone else's code.
Collection
Citation
Arup Guha, “Game Manual Rewrite,” Incorporating Communication Outcomes into the Computer Science Curriculum, accessed May 18, 2020, http://cs-comm.lib.muohio.edu/items/show/31.
Comments