Individual Reports, 2B03
2003 February 18

When designing, reviewing and testing individual routines for your player modules for the card game Sevens and writing the corresponding reports, please note the following guidelines and the expected contents of your reports. See also the slides for the corresponding lectures.

Design Report: Your task of designing a particular routine starts with the specification of your routine (the relevant parts of the MIS and MID, especially the routine semantics in terms of the concrete state variables) and ends with

It is the designer's responsibility to ensure that the Oberon-2 source code satisfies the specification (see section 7 of the Semiformal Specification of the Interface between the Main Control Program and the Student Teams' Player Modules at MCPInterface2B03.html.)

Your Design Report should include

In your report explain why you wrote the source code you wrote and not some other code. Indicate what techniques, criteria, etc. you used for transforming the specification into your source code. Address the issues raised by the following questions: Review Report: Your task of inspecting and reviewing a particular routine starts with the Design Report (and relevant parts of other documents such as the MIS and MID) and ends with your conclusions regarding the presence or absence of errors in the routine's source code or in its specification.

Your Review Report should

In your report explain why you inspected and reviewed the routine the way you did and not some other way. Indicate what techniques, criteria, etc. you used in your inspection. Address the issues raised by the following questions: Testing Report:  Your task of testing a particular routine starts with the Design Report and possibly the Review Report and relevant parts of other documents such as the MIS and MID and ends with your list and analysis of errors in the routine and in its specification and, in particular and most importantly, test cases not handled correctly by the routine being tested.

Throughout your testing you should take the attitude that there are errors in the routine and that you will find all of them. Be very critical and suspicious.

Your Testing Report should

Your Testing Report must give at least the following information for every test case: Your Testing Report must include a table showing which or how many test cases exercised which path segments. Use this table to ensure that your test cases covered all path segments.

Voluminous detail (e.g. a list of many test cases) should be included in an appendix and summarized in the body of your report.

In your report explain why you tested the routine the way you did and not some other way. Indicate what techniques, criteria, etc. you used in your testing. Address the issues raised by the following questions: