Architecture and Design Template - Software Methodology

Your architecture and design document should have the following sections:

Title page
Change log (using the same format as previous phases)
Table of contents
Overview. Text providing a roadmap to the sections and diagrams in your document.
Major design decisions. Text describing significant design choices, and modularization criteria.
Architecture. Your modified architecture diagram, including any supporting explanatory text.
Structure diagrams. UML structure diagrams, along with text explaining the relationship between these diagrams and components in the software architecture. Each object should be fully described (name, attributes with types, operations with signatures, visibility) in at least one place (though to reduce clutter, other diagrams may contain just a subset of this information).
Sequence diagrams. For each of the 10 scenarios, cut and paste the scenario text into this document. Then, provide one or more UML sequence diagrams for each scenario.
Open issues. If you were unable to resolve all known design issues in this document, note the open issues, and steps you're taking to resolve them.

You also need to turn in your meeting notes and time cards.

Grading Guidelines

This assignment is worth 70 points (out of 500 total on the project). The 70 points will be divided up as follows:

Category	Points	What kinds of things will I be looking for?
Class and Structure Diagrams	12	Are they syntactically correct? Are they semantically correct: Are methods and attributes in the correct class? Are the class relationships correct?
Sequence Diagrams	16	Are they syntactically correct? Are objects and messages labelled correctly? Do messages flow in the correct direction? Does each diagram have a name that identifies its scenario? Are they semantically correct: Do they agree with your scenarios and requirements? Are the object lifelines correct? Do the messages and parameters make sense?
Consistency	16	Do your sequence and class diagrams agree? Does the class diagram include all messages shown in the sequence diagrams, and are they in the correct class? Does the class diagram include attributes referenced in the sequence diagram, and vice versa? Are the data types consistent between the various drawings? Is a common naming convention used? For example, points will be subtracted if some names use mixed-case (getValue) while others use underbars (get_string).
Title Sheet, Table of Contents, Overview, Design Decisions	7	Do they exist? Does the overview provide appropriate detail? Does it help the reader understand the remainder of the document? Do you provide justification for your design decisions? Have you described your modularization criteria?
Architecture Diagram	5	Does it seem correct? Can I understand what the architecture is from the diagram?
Neatness and Legibility	7	Can I read the various diagrams and tables? Is the layout reasonable? For example, in sequence charts are the objects laid out from left to right?
Time Sheets, Meeting Notes and Agendas	7	Do they exist? Can I read them? Do they appear to be complete?

Last updated: 10/17/2002