Detailed Design

Minimum Requirements for Detailed Design Document

• Introduction (subsystem description)
• High-level architecture (common across a "project")
• Object Model of subsystem
• Classes
• methods for each
• any assumptions/preconditions for the methods
• exceptions/failures (who/what system is responsible for handling them?)
• must be detailed enough for someone else (e.g., a separate implementation team) to understand
• At least 2 sequence diagrams (use your discretion, what actions would be useful to present in detail?) - show interaction within and between modules/systems

* Concentrate on content, clarity, and consistency (with other systems as well as within). Thouroughness and form are also important, but emphasize content.

Requirements for Review Document

• What was reviewed?
• When?
• By whom, including roles
• Short (one phrase up to 2 paragraphs) summary of the evaluation
• Signatures (obviously, don't worry about posting these on the Swiki!)
• List of issues (free form, just list them)

Deliverables

• Detailed Design Document [60%]
      By Friday 10/20, each group needs to:

  • turn in 2 hardcopies
  • put the doc in html and post a link to it on the cs3300 swiki

• Design Review [40%]
      By Friday 10/27, everyone needs to:

  • read and take notes on the document they have been assigned
      In class Friday 10/27:
  • formal design reviews in "review groups" (not the same as design groups). These groups will be assigned later.
      By Monday 10/30, each review group needs to:
  • publish the review document on the cs3300 Swiki

For More Info

See a Design Document Template from a previous Software engineering (cs3302) class project. Of course, make sure you at least follow the guidelines on this page first and foremost.

Review Teams

The liaisons will join a different group and bring their group's document with them. The document to be reviewed is in parenthesis next to the liaison names.

Swiss2 (A2)
Registration	Pairings	Results/Performance	Ratings
Andy Fortier (Pairings)	James Stovall (Res/Perf)	Chris Morris	Rahim Aladin
Steve Bachman	Scott Aday	Chau M Phan	Greg Bosworth
Barry Coleman	Sara Harvey	Joshua Shows	Kathy Gray (Reg)
Zachary Ross		Matt Labbe (Ratings)

SLR
Film	Exposure	Lens	Camera Controls
Shiva Persaud (Lens)	Udit Batra	Shaharyar Aarbi (Exposure)	Pafug Dung Phan
Chris Haire	Mohammad Fakhar	Ansely Post	Cindy Puett
David Jaggie	Irfan Ahmed	Austin Chau	Brian Smith (Film)
	Alex Salazar (Cam Ctrls)		David N Phillips