CEN4020: Software Engineering I up↑

Class & Attribute Descriptions

Instructions for Class Description

Name
Name of the class exactly as it appears on the class diagram. Remember the name should be a noun or noun phrase with the first letter of the name capitalized.
Description
Brief description of the general purpose of this class.
Attributes
In the name column, list each attribute exactly as it appears on the class diagram. For each attribute, define the data type and give a brief description.
Methods
In the name column, list each method exactly as it appears on the class diagram. For each method, provide a brief description of the method. Note: This section will be done during the design workflow; do not fill this portion out yet for the SRS.
Relationships
For each relationship shown on the class diagram for this class, list the name of the connecting classes and the type of relationship. The comments column is for any additional information that aid in the understanding of this relationship.

Instructions for Attribute Description

Name
Name of the attribute exactly as it appears on the class diagram. Remember the name should be a noun or noun phrase.
Class Name
Name of the class, exactly as it appears on the class diagram, that contains this attribute.
Type
Data type of this attribute (e.g., int, float, String).
Length
Length of this attribute (for every data type).
Output Format
If the attribute will appear in a display or report (i.e., it is output) and it requires special formatting, that formatting needs to be described here. For example, a password shown with over strike asterisks or a date displayed as 10/20/07 instead October 20, 2007.
Default Value
If the attribute has a standard initial value, it is defined here.
Acceptable Values
If the attribute has defined range or list of values or specific syntax that it is limited to, those values are defined here. For example, a Social Security number may be defined in this section as NNN-NN-NNNN where N represents an integer.
Source
The originator of the this attribute. Examples are actors or the system. For example, dueDate on a library book would have the system as its source.
Derivation Formula
If this attribute is a derived attribute, the formula for deriving its value is defined here. For example, the age of a person is a derived attribute which has a derivation formula of currentYear - birthYear.
Comments
Any additional information that aid in the understanding of this attribute.

Grading Criteria

  1. Correctness
    1. Class Description
      1. Name does not match class diagram
      2. Description missing or incorrect
      3. Attributes missing or incorrect
      4. Relationships missing or incorrect
    2. Attribute Description
      1. Name does not match class diagram
      2. Class name does not match class diagram
      3. Alternative name incorrect
      4. Type missing or incorrect
      5. Length missing or incorrect
      6. Output format missing or incorrect
      7. Default values missing or incorrect
      8. Acceptable values missing or incorrect
      9. Source missing or incorrect
      10. Derivation formula missing or incorrect
      11. Description missing or incorrect
  2. Format
    1. Not written in required table format as provided
    2. Misspelled words
$Id: ClassDescriptionInstructions.html,v 1.2 2010/09/11 23:20:30 baker Exp baker $