First Draft Specification for Your System
You are to produce a first draft of a complete requirements
specification of the identified scope of the system that your group is
prototyping in SE 490; The identified scope is that embodied by
the final and mutually consistent
-
domain model with superimposed world diagram;
-
use case diagram; and
-
list of assumptions, exceptions, and variations
from your group's Deliverables 1, 2, and 3. This complete
requirements specification can be in any of a number of formats,
including, but not limited to:
-
a complete Software Requirements Specification (SRS),
-
a complete user's manual (UM),
-
a complete set of complete UML descriptions (at least a
domain model, an object model, a use case model, and a complete,
covering set of use cases),
-
a complete online help system,
-
a complete set of complete user stories and for each user
story, and associated complete, covering set of test cases, or
-
a set of artifacts accepted by the course prof as providing sufficient
completeness.
The key criterion for completeness is that the group, in writing
the specification, is forced to flesh out all the requirements that
are already present in the chosen scope of the system that you are
prototyping in SE 490.
To start producing this specification from the final mutually consistent
versions of the three artifacts that you handed in as Deliverables 1,
2, and 3, you will have to produce an updated version of each of these
three artifacts in which:
-
all defects noticed by anyone, including your TA, have been fixed, and
-
all the artifacts are consistent with each other.
The main additional information, beyond that coming from the three
artifacts, needed in the complete requirements specification is
-
a complete set of scenarios for each use case, including the typical and
all exception and alternative scenarios, and
-
a complete user interface that is used in these scenarios,
or the equivalent, as agreed to by your TA and the prof, appropriate for
your group's format. All other format-specific variations in the
specification fall out of this information.
To try to be more precise, regardless of format, your specification will
include at least
-
cover page + table of contents + page numbers,
-
notational conventions, if anything you do in the document might be
unclear,
-
a glossary of terms,
-
the final domain model with superimposed world diagram,
-
the final use case diagram,
-
the final list of assumptions, exceptions, and variations,
-
a typical scenario for each use case,
-
all needed exceptional scenarios for each use case, especially to deal
with assumptions that do not hold; if for any assumption, you have decided
that the system can do nothing about it, then a statement to that effect,
-
all needed alternative scenarios for each use case, and
-
a user-interface description, including diagrams, that is associated with
these scenarios or the accepted equivalent, e.g., as suggested in
Slide 8 of the User Interface Specifications slides
and in Lihua Ou's WD-Pic User's
Manual.
Each scenario is expressed in natural langauge in one of several possible
formats, including:
-
the format of Lihua Ou's WD-Pic
User's Manual,
-
the format of Adobe Acrobat's online help pages, and
-
an approved equivalent.
You must follow any relevant advice given in the
"User's Manual Advice" slides.