Chapter |
Description |
Preface |
- Describe expected reader
Version History (empty at this point perhaps)
|
Introduction |
- Describe need for system;
- Function of system in very broad terms (5 sentence
max)
- How system will work with other systems
- How system fits larger organization's business plan
|
Glossary |
- Define any terms a user or programmer may need to know
to read this. (Remember both read this.)
|
User requirements definition |
- Services the system will provide to the user
- NonFunctional requirements description (what the
system will do that is not directly something the user
knows, such as maximum system data size and product and
process standards)
|
System Architecture |
- High level overview of anticipated system
architecture.
- Describe Broadly System modules you will create (maybe
only one)
- Describe Broadly System modules that exist that you
will use.
- List systems you will interface to
- Describe hardware and major tool choices (such as
Java)
- Include one box diagram with all the modules in your
system and all the systems to which your system
interfaces.
- Include the number of computers and who will use each
computer.
- Include at least one standard architectural model
found in your book or documented on the internet that
you will use for this system.
|
System requirements spec |
- Describe the exact tasks the system will do to
implement the user requirements. (note that this must be
above a coding and class definition level. It is still
at a high level, but lower than user requirements.
- All system requirements put together should accomplish
everything written in the user requirements section
|
System Models |
- Include at least one use case
- At least one activity diagram
- At least one sequence diagram
- At least one state diagram
|
System Evolution |
- Describe some future changes you might want a designer
to consider. Come up with at least one.
|
Appendices |
Include documentation of one example of each of the
following methods of elicitation:
- Interview
- Scenario
- Use case
- Ethnography (just describe a part of the user's day)
|