| 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 (if applicable)
|
| Glossary |
- Define any terms a user or programmer may need to know to read this.
(Remember both read this document.)
|
| User requirements definition |
- Services the system will provide to the user
- Include one use case diagram
- NonFunctional requirements description (what the system will do that
is not directly something the user knows, such as maximum system data
size, security and product and process standards)
|
| System Architecture |
- Include one box diagram with all the modules in your system and all
the systems to which your system interfaces. (Be sure to highlight the
modules you are creating separately from the ones to which you will
interface.)
- High level overview of anticipated system architecture (which will
probably be a worded description of the diagram)
- List systems you will interface to
- Describe at a high level the System modules you will create (maybe
only one)
- Describe at a high level the System modules that exist that you will
use.
- Describe hardware and major tool choices (such as Java)
- Include the number of computers and who will use each computer.
|
| System requirements spec |
- Describe the exact tasks the system will do to implement the user
requirements. (note that this should 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
- Include one activity diagram
|
| System Models |
- Include any additional diagrams that will be helpful to understand
your design. (Optional)
|
| System Evolution |
- Describe some future changes you might want a designer to consider.
Come up with at least one.
|
| Survey of existing solultions |
- Describe the solutions that already exist that you either rejected
or will choose to use as a model. For each solution, include a summary
of its purpose and how it relates to your project, the cost to use it
in your system, and how you will use it or why it is not a good solution.
|
| Annotated Bibliography |
- Include at least two credible sources that are also cited somewhere
inside your document with in-line citations.
- The annotation should include a short summary, an evaluation of the
credibility of the source, and an indication of how the source supports
your document.
|