Requirements Scope and Signoff Checklist

advertisement
Requirements Scope and Signoff Checklist
NOTES:
a. Some of the model elements may be listed below multiple times. Numerous instances of different model element types may exist with
numerous views, but only one instance of nouns or verb phrases for major model elements may exist. A single instance’s sub-elements may be
define during a mixture of modeling activities, but must be complete for final signoff
b. *=Optional in this sub-model
c. $=SoDA generated
Enterprise Model
General Requirements
Basic Requirements
No Polish notation present in model, i.e. “theFirstUseCase” should be “The First Use Case”
No extraneous wordage attached to packages, diagrams or model elements, i.e. XXXX controller, XXXX sequence diagram, XXXX UseCase.
No extraneous elements
Spelling checked
Packages
Every major model element contained with its own package
Business Actors
Business Use-Cases
Actors
Use-Cases
Objects
Classes
Model prefixes attached to appropriate major model element package names
Business Use-Case Model: BUC
Business Object Model: BOM
Use-Case Model: UC
Analysis Model: AM
Design Model: DM
Diagrams
Title Note
Elements
Diagram Type: Name, same as enclosing diagram
Created: MM-DD-YY by UserName, UserID
Modified: MM-DD-YY by UserName, UserID
Internal Review: MM-DD-YY by UserName, UserID
Package Diagram(s)
One per package
Immediate sub-packages displayed with associations displayed
Immediate two super-ordinate packages with associations displayed
Discipline View
Project
Business Modeling
Documents and Reports
Business Glossary*$
Business Rules*$
Supplementary Business Specifications* $
Requirements
Documents and Reports
Glossary
Requirements Attributes*
Software Requirements Specification
Supplementary Specifications
Vision
Analysis & Design
Documents and Reports
Software Architecture Document$
Project Management
Documents and Reports
Stakeholders
Product Acceptance Plan
Issues List
Risk List
Review Records
Use-Case View
Business Use-Case Model
NA (If to be use for any documentation, follow requirements for Use-Case Model)
Use-Case Model
General Requirements
Package named “Actors” per sub-ordinate level of analysis model per project
One Package per Actor in super-ordinate package
Package named “Use-Cases” per sub-ordinate level of analysis model per project
One Package per Use-Case in super-ordinate package
Actor(s)
Attributes
Named as noun
Stereotype assigned and displayed
Documentation supplied as needed
External documentation attached as needed
Documents and Reports
Actor Report$
Use-Case(s)
Attributes
Named as verb phrase
Stereotype assigned and displayed
Abstractness defined
Documentation supplied as needed
External documentation attached as needed
Diagrams
Use-Case Diagram(s)
General Requirements
Sufficient number of diagrams to decompose business processes into distinct units of activity but clearly
demonstrate complexity when needed
Named after Use-Case with perspective appended as necessary
Supplemental diagrams to illustrate includes, extends, and generalizations per Use-Case in packages
attached to Use-Case package
Attached to Use-Case and not package
Appropriate Actor(s), Use-Case(s) and association(s) displayed
Association(s)
General Attributes
Documentation supplied as needed
Stereotype assigned and displayed
Roles assigned
Details
Link Element(s) defined as needed
Name direction defined as needed
Constraint(s) defined as needed
Role Attributes
Export Control Defined
Documentation supplied as needed
Constraint(s) defined as needed
Multiplicity defined
Navigability defined
Aggregation defined
Static value(s) defined
Friendship relationship defined
Containment defined
Key(s)/Qualifier(s) defined
Note(s)
Sufficient notes attached to appropriate model elements for diagram to be self explanatory
Activity Diagram(s)
General Requirements
Provide a sufficient number of diagrams to decompose the Use-Case into distinct units of activity but
clearly demonstrate complexity when needed. Several degrees of abstraction are expected in the UseCase model to provide the overviews necessary with the actual details expected in the analysis model
Attached to Use-Case and not package
Start Event
General Attributes
Named
Documentation supplied as needed
History Requirements specified
Action(s) Specifications
When
Event defined
Argument(s) defined
Condition
Type
Name
Argument(s) defined
Target defined
State(s)
General Attributes
Name as verb phrase
Stereotype assigned and displayed
Documentation supplied as needed
History requirements specified as needed
Action(s) Specifications
When
Event defined
Argument(s) defined
Condition
Type
Name
Argument(s) defined
Target defined
Activity(s)
General Attributes
Name as verb phrase
Stereotype assigned and displayed
Documentation supplied as needed
History requirements specified as needed
Action(s) Specifications
When
Event defined
Argument(s) defined
Condition
Type
Name
Argument(s) defined
Target defined
State Transition(s)
General Attributes
Event defined
Argument(s) defined
Stereotype assigned and displayed
Documentation supplied as needed
Detail
Guard Condition(s) defined as needed
Action defined as needed
Event trigger(s) defined as needed
Send event defined
Send argument(s) defined
Send target defined
Substate transitions defined as needed
Decision(s)
General Attributes
Named as question with a “?” mark at the end
Stereotype assigned and displayed
Documentation supplied as needed
Swimlane(s)
General Attributes
Named as object as noun
Class specified as needed
Documentation supplied as needed
Exit Event
General Attributes
Named
Documentation supplied as needed
History Requirements specified
Action(s) Specifications
When
Event defined
Argument(s) defined
Condition
Type
Name
Argument(s) defined
Target defined
Note(s)
Sufficient notes attached to appropriate model elements for diagram to be self explanatory
Documents and Reports
Use-Case Report$
Documents and Reports
Use-Case Storyboard*$
Use-Case Survey$
Use-Case Model Report$
Package Report$
Documents and Reports
Use-Case View Report$
Logical View
Business Object Model
(If to be use for any documentation, follow requirements for Analysis Model)
Analysis Model
General Requirements
Package Diagram(s)
One per package
Title Note
Immediate sub-packages displayed with associations displayed
Immediate two super-ordinate packages with associations displayed
Package named “Actor Realizations” per sub-ordinate level of analysis model per project
One Package per Actor to be realized from Use-Case Model in super-ordinate package
Package named “Use-Case Realizations” per sub-ordinate level of analysis model per project
One Package per Use-Case to be realized from Use-Case Model in super-ordinate package
Package named “Analysis Classes” per sub-ordinate level of analysis model per project
One Package per Analysis Package to be realized from Use-Case Model in super-ordinate package
Sub-packaging may be done to organize classes by type
Actor Realization(s)
Realized Actor(s)
General Attributes
Named as noun
Stereotype assigned and displayed
Export Control Defined as needed
Documentation supplied as needed
External documentation attached as needed
Diagrams
Realization Diagram(s)
General Requirements
Single Class Diagram per Actor named “Realization”
Attached to realized Actor package
Elements
Actor from Use-Case Model to be realized
Analysis Class with same name as Actor
Association
Realization between Actor and Analysis Class
Note(s)
Sufficient notes attached to appropriate model elements for diagram to be self explanatory
Documents and Reports
Actor Realization Report$
Use-Case Realization(s)
Realized Use-Case(s)
General Attributes
Named after Use-Case being realized
Stereotype assigned and displayed
Abstractness defined
Documentation supplied as needed
External documentation attached as needed
Diagrams
Realization Diagram(s)
General Requirements
Single Class Diagram per Use-Case named “Realization”
Attached to realized Use-Case and not package
Elements
Use-Case from Use-Case Model to be realized
Realized Use-Case
Analysis Class with same name as Use-Case
Associations
Use-Case Realization between Use-Cases
Instantiation/dependency between realized Use-Case and analysis class
Notes
Sufficient notes attached to appropriate model elements for diagram to be self explanatory
Activity Diagram(s)
General Requirements
Provide a sufficient number of diagrams to decompose the Use-Case into distinct units of activity but
clearly demonstrate complexity when needed. Several degrees of abstraction are expected in the UseCase model to provide the overviews necessary with the actual details expected in the analysis model
Attached to Use-Case and not package
Start Event
General Attributes
Named
Documentation supplied as needed
History Requirements specified
Action(s) Specifications
When
Event defined
Argument(s) defined
Condition
Type
Name
Argument(s) defined
Target defined
State(s)
General Attributes
Name as verb phrase
Stereotype assigned and displayed
Documentation supplied as needed
History requirements specified as needed
Action(s) Specifications
When
Event defined
Argument(s) defined
Condition
Type
Name
Argument(s) defined
Target defined
Activity(s)
General Attributes
Name as verb phrase
Stereotype assigned and displayed
Documentation supplied as needed
History requirements specified as needed
Action(s) Specifications
When
Event defined
Argument(s) defined
Condition
Type
Name
Argument(s) defined
Target defined
State Transition(s)
General Attributes
Event defined
Argument(s) defined
Stereotype assigned and displayed
Documentation supplied as needed
Detail
Guard Condition(s) defined as needed
Action defined as needed
Event trigger(s) defined as needed
Send event defined
Send argument(s) defined
Send target defined
Substate transitions defined as needed
Decision(s)
General Attributes
Named as question with a “?” mark at the end
Stereotype assigned and displayed
Documentation supplied as needed
Swimlane(s)
General Attributes
Named as object as noun
Class specified as needed
Documentation supplied as needed
Exit Event
General Attributes
Named
Documentation supplied as needed
History Requirements specified
Action(s) Specifications
When
Event defined
Argument(s) defined
Condition
Type
Name
Argument(s) defined
Target defined
Note(s)
Sufficient notes attached to appropriate model elements for diagram to be self explanatory
Sequence Diagrams
General Requirements
Sufficient number of diagrams to decompose the activity diagram by primary flow and alternative flows
with the exception of simple failure alternative flows.
Named to identify associated flow
Attached to realized Use-Case and not package
Elements
Object(s)
General Attributes
Named as noun
Type defined
Stereotype assigned and displayed
Export Control defined
Documentation supplied as needed
Detail
Multiplicity defined as needed
Persistence defined as needed
Concurrency defined as needed
Abstractness defined as needed
Attribute(s)
General Attributes
Named as noun
Type defined
Stereotype assigned and displayed
Initial Value defined as needed
Export Control defined
Documentation supplied as needed
Detail
Containment defined
Static defined as needed
Derived defined as needed
Operation(s)
General Attributes
Named (should be same as corresponding message)
Return Type defined
Stereotype assigned and displayed
Export Control Defined
Documentation supplied as needed
Arguments
General Attributes
Name
Data type
Default Value
Time as needed
Concurrency as needed
Pre-conditions as needed
Sub-Interaction diagrams as needed
Post-conditions as needed
Sub-Interaction diagrams as needed
Semantics supplied as needed
Sub-Interaction diagrams as needed
Related Classes defined as needed
Nested Classes defined as needed
Participation in Components defined
External documentation attached as needed
Link(s)
General Attributes
Named
Role Association defined as needed
Supplier visibility defined as needed
Shared state as needed
Client visibility defined as needed
Shared state as needed
Message(s)
General Attributes
Named
Documentation supplied as needed
Synchronization defined
Frequency defined
Lifelines
Focuses of Control as needed
Destruction Marker(s) as needed
Notes
Sufficient notes attached to appropriate model elements for diagram to be self explanatory
Collaboration Diagram(s)
General Requirements
Sufficient number of diagrams to decompose the activity diagram by primary flow and alternative flows
with the exception of simple failure alternative flows.
Named to identify associated flow
Attached to realized Use-Case and not package
Elements
Object(s)
General Attributes
Named as noun
Type defined
Stereotype assigned and displayed
Export Control defined
Documentation supplied as needed
Detail
Multiplicity defined as needed
Persistence defined as needed
Concurrency defined as needed
Abstractness defined as needed
Attribute(s)
General Attributes
Named as noun
Type defined
Stereotype assigned and displayed
Initial Value defined as needed
Export Control defined
Documentation supplied as needed
Detail
Containment defined
Static defined as needed
Derived defined as needed
Operation(s)
General Attributes
Named (should be same as corresponding message)
Return Type defined
Stereotype assigned and displayed
Export Control Defined
Documentation supplied as needed
Arguments
General Attributes
Name
Data type
Default Value
Time as needed
Concurrency as needed
Pre-conditions as needed
Sub-Interaction diagrams as needed
Post-conditions as needed
Sub-Interaction diagrams as needed
Semantics supplied as needed
Sub-Interaction diagrams as needed
Related Classes defined as needed
Nested Classes defined as needed
Participation in Components defined
External documentation attached as needed
Link(s)
General Attributes
Named
Role Association defined as needed
Supplier visibility defined as needed
Shared state as needed
Client visibility defined as needed
Shared state as needed
Message(s)
General Attributes
Named
Documentation supplied as needed
Synchronization defined
Frequency defined
Focus of Control applied as needed
Destruction Markers as needed
Notes
Sufficient notes attached to appropriate model elements for diagram to be self explanatory
Documents and Reports
Use-Case Realization Report$
Analysis Classes
General Requirements
At least one analysis class per Actor and Use-Case
Additional classes may be defined as needed
Analysis Class(s)
General Attributes
Named after Actor being realized
Stereotype assigned and displayed
Export Control Defined as needed
Documentation supplied as needed
External documentation attached as needed
Diagrams
Statechart Diagram(s)
General Requirements
Generally one diagram per Analysis Class, however if complexity of possible object states
additional statechart diagrams may be needed to decompose complexity
Named to match associated class with state name if sub-statechart diagram
Attached to analysis class and not package
Elements
Start Event
Named
Documentation supplied as needed
History Requirements specified
Action(s) Specifications
Action(s) Specifications
When
Event defined
Argument(s) defined
Condition
Type
Name
Argument(s) defined
Target defined
State(s)
Name as verb phrase
Stereotype assigned and displayed
Documentation supplied as needed
History requirements specified as needed
Action(s) Specifications
When
Event defined
Argument(s) defined
Condition
Type
Name
Argument(s) defined
Target defined
State Transition(s)
Event defined
Arguments defined
Stereotype assigned and displayed
Documentation supplied as needed
Guard Condition defined as needed
Action(s) Specifications
When
Event defined
Argument(s) defined
Condition
Type
Name
Argument(s) defined
Target defined
Substate transitions defined as needed
Exit Event
Named
Documentation supplied as needed
History Requirements specified
Action(s) Specifications
When
Event defined
Argument(s) defined
Condition
Type
Name
Argument(s) defined
Target defined
Notes
Sufficient notes attached to appropriate model elements for diagram to be self
explanatory
Object Diagrams
General Requirements
Generally one diagram per Analysis Class
Attributes and Operations Visible
Named to match associated class
Attached to analysis class and not package
View of Participating Classes Diagram per Analysis Classes package
All Classes in Package Visible
Attributes and Operations Visible
Elements
Object(s)
General Attributes
Named as noun
Type defined
Stereotype assigned and displayed
Export Control defined
Documentation supplied as needed
Detail
Multiplicity defined as needed
Persistence defined as needed
Concurrency defined as needed
Abstractness defined as needed
Attribute(s)
General Attributes
Named as noun
Type defined
Stereotype assigned and displayed
Initial Value defined as needed
Export Control defined
Documentation supplied as needed
Detail
Containment defined
Static defined as needed
Derived defined as needed
Operation(s)
General Attributes
Named (should be same as corresponding message)
Return Type defined
Stereotype assigned and displayed
Export Control Defined
Documentation supplied as needed
Arguments
General Attributes
Name
Data type
Default Value
Time as needed
Concurrency as needed
Pre-conditions as needed
Sub-Interaction diagrams as needed
Post-conditions as needed
Sub-Interaction diagrams as needed
Semantics supplied as needed
Sub-Interaction diagrams as needed
Related Classes defined as needed
Nested Classes defined as needed
Participation in Components defined
External documentation attached as needed
Link(s)
General Attributes
Named
Role Association defined as needed
Supplier visibility defined as needed
Shared state as needed
Client visibility defined as needed
Shared state as needed
Message(s)
General Attributes
Named
Documentation supplied as needed
Synchronization defined
Frequency defined
Focus of Control applied as needed
Destruction Markers as needed
Notes
Sufficient notes attached to appropriate model elements for diagram to be self
explanatory
Documents and Reports
Class Report
Documents and Reports
Analysis Classes Report$
Analysis Classes, Attributes and Operations Report$
Analysis Model Report$
Package Report $
Documents and Reports
Logical View Simple Report$
Logical View Public Report$
Logical View Full Report$
Download