Deliverable: #3 - Software architecture and design
Documentation: 8:00am Saturday 8th July 2017
Oral Walkthrough: Week of 10th - 17th July 2017

Description:

Describe your software architecture and design.

Requirements:

  1. Title page, including project name, team number, team name, and each team members name and Quest IDs.
  2. Architecture and design documentation (Pages unspecified).
  3. Must be compiled in a single PDF document.

Only one team member should submit document to learn.uwaterloo.ca by 08:00am on Saturday 8th July 2017. File naming scheme: cs446-d3_<team-number>.pdf * (use - instead of space in file names)

Required documentation:

You must describe the high level architecture and design used by the software you are currently developing. This involves providing:

Oral walk through:

At least two individuals will meet collectively with each team, all of whose members mush be present, at a time to be mutually determined, to review the software being developed, its architecture, construction, design, the management of this project, and the contribution of individuals within the team to it. Each meeting will take 30 minutes, and will be scheduled via an online poll.

This is a strictly oral interview in which some questions may be directed to the entire team, while others may only be answered by the indicated individual. No aids beyond access to a white board are permitted presenters.

This is not an exam, but only an exploration and review of the work you claim to be undertaken as part of your course project, which you consequently should already be intimately familiar with. However, you will need to be familiar with methods of describing your software architecture which make sense to those initially unfamiliar with it. Your goal should be to convey as clearly and as concisely as possible in your initial 15-20 minute oral presentation your high level software architecture and your justification for employing this architecture within your project.

To the extent that this is possible all present are encouraged to review, explore and comment on the strengths and weaknesses of the system as presented. Those reviewing your work will have access to all prior documentation submitted by you and may make reference to that earlier documentation, ask questions about it, and relate that earlier documentation to your material as presented in this walk through.

You will also be expected to explain (without help or prompting from others) your own individual contribution to the project, and why that contribution was of value to the team as a whole. If there are concerns about this contribution, the history of activity relating to this software development, as reflected in the commit history associated with the source control system being used, and all prior written documentation may be reviewed. It is important that no matter how you contributed, you identify those major contributions, least they otherwise be overlooked.

If it is deemed necessary, additional time may be requested by the TA's to review and discuss individual projects with team members, to ensure that in the marking of them, they are themselves sufficiently familiar with them. The time and length of such meetings are to be arranged between the team and the TA's wishing to further review a deliverable.

Assessment:

The documentation as provided is worth 5% of your final grade.

The TA and instructor will individually grade the final deliverable in terms of the technical complexity of the completed system, the polish that has been applied to the system, and the functional and non-functional properties of the deliverable, employing as background all submitted documentation. This final grading of each project will be worth an additional 30% of your final grade.

Confidentiality:

The development of your project is a confidential corporate exercise. Distinct teams may not collaborate on the production of any deliverable. Information contained within a team's final deliverable should not be shared with other teams, prior to its presentation to all teams. Any matter may be discussed during the oral presentation.