Revised 09/27/04University of Dayton – School of Business Administration MIS Senior Project System Design Specifications for [Client Name] [Project Name] Created by [Team, Members] Version 1.0 mm/dd/yy System Design Specifications Approvals: Client Representatives: Name/Title Date Signature University of Dayton – School of Business Administration MIS Senior Project System Design Specifications (SDS) Revised 09/27/04 Document Revision History: Version Primary Author(s) Description of Version Revision Date Draft TBD Initial draft created for distribution and review comments TBD 21541514.doc Page 2 of 11 University of Dayton – School of Business Administration MIS Senior Project System Design Specifications (SDS) SYSTEM DESIGN SPECIFICATIONS TABLE OF CONTENTS Revised 09/27/04 1.0 General Information (10 Points)............................................................................................. ............5 1.1 Project Executive Summary........................................................................................... ................5 1.2 System Overview......................................................................................................................... ....5 1.3 Design Constraints.................................................................................................. .......................5 1.4 Future Contingencies................................................................................................. ....................6 1.5 Project References.............................................................................................................. ............6 1.6 Terms and Abbreviations............................................................................................................... .6 2.0 System Characteristics (30 Points).............................................................................................. ......6 2.1 System Description................................................................................................................. ........6 2.2 System Partitions and Functions............................................................................... ...................6 2.3 Accuracy and Validity............................................................................................. ........................7 2.4 Timing..................................................................................................................... .........................7 2.5 Adaptability.......................................................................................................................... ............7 2.6 Failure Contingencies.................................................................................................................. ...7 2.6.1 Backup.................................................................................................................... ...................7 2.6.2 Fallback.................................................................................................................................. ....8 2.6.3 Degraded Modes of Operation....................................................................................... ............8 2.7 System Logical Flow..................................................................................................................... ..8 3.0 Environment (30 Points)................................................................................................. ....................8 3.1 Equipment Environment............................................................................................................... ..8 3.1.1 Storage Media.................................................................................................................... ........8 3.1.2 Input/Output Devices....................................................................................... ..........................8 3.2 Communications Environment....................................................................................... ...............8 3.3 Software Environment.................................................................................................... ................8 3.4 Software Interfaces..................................................................................................... ....................9 3.5 Database and File Design.......................................................................................................... .....9 3.5.1 Database Management System Files ................................................................. ......................9 3.5.2 Non-Database Management System Files .............................................................................. ..9 3.6 Human-Machine Interface............................................................................................................ ...9 3.6.1 Inputs............................................................................................................ ...........................10 3.6.2 Outputs/Reports.................................................................................................... ...................10 3.7 Other Environment Considerations.......................................................................................... ...11 4.0 Operational Design (10 Points)................................................................................ ........................11 4.1 Operations.......................................................................................................... ...........................11 4.2 Site preparation and adaptation........................................................................... .......................11 5.0 Appendices (20 Points)............................................................................................... ......................11 5.1 Requirements Traceability Matrix............................................................................... .................11 5.2 Data Dictionary........................................................................................................... ...................11 5.3 Screen Layout, Form, and Report Samples....................................................................... .........11 5.4 Updated ERD for Recommended System.............................................................. .....................11 5.5 Primitive DFDs.................................................................................................................. .............11 5.6 SBA IT Technology Request Workbook (TRW)................................................ ..........................11 5.7 To-be-determined list...................................................................................................... ..............11 Grading notes: 21541514.doc Page 3 of 11 University of Dayton – School of Business Administration MIS Senior Project System Design Specifications (SDS) Revised 09/27/04 Points are deducted from your overall score for improper grammar, sentence structure, word choice; poor spelling and document structure issues such as: incomplete title page, revision history and table of contents. Template references and sources: This template is primarily based on the IEEE Standard for System Design Descriptions, State of Maryland Department of Budget and Management Systems Development Life Cycle Templates, The U.S. Department of Justice Systems Development Life Cycle Guidance Document and Quality Software Project Management by Robert T. Futrell, Donald F. Shafer, Linda I. Shafer. 21541514.doc Page 4 of 11 University of Dayton – School of Business Administration MIS Senior Project System Design Specifications (SDS) Revised 09/27/04 1.0 General Information (10 Points) The System Design Specifications provides a listing of the specifications of the system and its subsystems. It also defines, in detail, the interfaces with other systems and subsystems and the facilities to be used for accomplishing the interfaces. For each subsystem, include such information as timing requirements, equipment needs, communications environment, support software, security, and input and output records. Not all of the sections in this template may apply to your specific project, but you are required to justify why the sections that you are planning to omit do not apply. 1.1 Project Executive Summary This section provides a description of the project from a management perspective and an overview of the framework within which the conceptual system design was prepared. If appropriate, include the information discussed in the subsequent sections in the summary. Remember, since the whole system design statement may be rather long, a real client may only read this executive overview, so give careful thought it its preparation. The System Design Specification (SDS) will act as a template for the proper design of the application. Some of the issues that the Executive Summary should address are the following: 1. A summary of the design specifications, critical milestones, costs & benefits, and risks for the system being developed. 2. A summary highlighting the contents and purpose of the SDS. For example, this document is written to specify the design of the system to be developed and is necessary for successful completion of the project. It can be used as a contract of the work to be performed between the customer commissioning the system and the developers of the system. 3. Your recommendation for the next phase of the project. 1.2 System Overview This section describes the system in narrative form using non-technical terms. It should provide a highlevel system architecture diagram showing a subsystem breakout of the system, if applicable. The highlevel system architecture or subsystem diagrams should, if applicable, show interfaces to external systems. Supply a high-level context diagram for the system and subsystems, if applicable. Include and reference an updated requirements traceability matrix (RTM) that maps to the System Requirements Specifications (SRS), to identify the allocation of the system and functional requirements into this design document. 1.3 Design Constraints This section describes any constraints in the system design (reference any trade-off analyses conducted such, as resource use versus productivity, or conflicts with other systems) and includes any assumptions made by the project team in developing the system design. Describe any global limitations or constraints that have a significant impact on the design of the system's software (and describe the associated impact). Such constraints may be imposed by any of the following (the list is not exhaustive): • Hardware or software environment • End-user environment 21541514.doc Page 5 of 11 University of Dayton – School of Business Administration MIS Senior Project System Design Specifications (SDS) • Availability or volatility of resources • Standards compliance • Interoperability requirements • Interface/protocol requirements • Data repository and distribution requirements • Security requirements (or other such regulations) • Memory and other capacity limitations • Performance requirements • Network communications • Verification and validation requirements (testing) • Other means of addressing quality goals • Other requirements described in the requirements specification 1.4 Future Contingencies Revised 09/27/04 This section describes any contingencies that might arise in the design of the system that may change the development direction. Possibilities include lack of interface agreements with outside resources or unstable architectures at the time this document is produced. Address any possible workarounds or alternative plans. 1.5 Project References Provide a list of the references that were used in preparation of this document. Examples of references are: • Previously developed documents relating to the project (BPP, SRS, etc.) • Documentation concerning related projects 1.6 Terms and Abbreviations Provide a list of the unique terms and abbreviations used in this document and the meaning of each. This section is the similar to the Glossary in the SRS document. 2.0 System Characteristics (30 Points) This section provides an expansion of and update to the information published in the System Requirements Specification (SRS). 2.1 System Description Provide a general description of the system to establish a reference for the remainder of the document. Within this description, you may include graphics representing the relationship of the user organizations to the major components including networking, communications, and distributed processing. 2.2 System Partitions and Functions Although the descriptions of the system functions may be refined and more detailed as a result of the continuing analysis and design effort, they must maintain a direct relationship to the system functions 21541514.doc Page 6 of 11 University of Dayton – School of Business Administration MIS Senior Project System Design Specifications (SDS) Revised 09/27/04 established in the SRS and be described in such a way that the system environment can be related to them. Describe the system partitions and functions, documenting the traceability between the functional and data requirements and the defined subsystem. This section is intended to be a summary and update of the SRS System Functions and Precedence and Criticality sections of the SRS document. 2.3 Accuracy and Validity Describe the features incorporated in the design of the system that meet the accuracy and validity requirements imposed on each system level. Accuracy requirements of mathematical calculations and data must be considered. 2.4 Timing This section should be an expansion of the Performance and Workload Characteristics in the SRS document. Describe the timing requirements imposed on the system, if applicable. For example, the following timing requirements may be considered: • Throughput time • Response time to queries and to updates of the data files • Sequential relationship of system functions – these are related to any dependencies that exist between functions. • Priorities imposed by types of input and changes in modes of operation – may not be applicable unless there are conditions where only portions of the system are available as described in 2.6.3. • Timing requirements for the range of traffic load or transactions under varying operating conditions • Sequencing and interleaving of software units and systems (including the requirement for interrupting the operation of a software unit without loss of data). Examples could include cases where the user loses the session, reboots, or loses their system during the course of a transaction. 2.5 Adaptability Provide a description of the capability to be incorporated for adapting the system to changing requirements, such as anticipated operational changes, interaction with new or improved systems, and planned periodic changes. Components and procedures designed to be subject to change will be identified. 2.6 Failure Contingencies Discuss alternative courses of action that are to be taken to satisfy requirements if the proposed system fails. Include as appropriate: 2.6.1 Backup. Specify what the users / operators should do if the system is temporarily unavailable and what they should do when the system is available again. 21541514.doc Page 7 of 11 University of Dayton – School of Business Administration MIS Senior Project System Design Specifications (SDS) 2.6.2 Fallback. Revised 09/27/04 Fallback techniques for ensuring the continued satisfaction of the specific requirements of the system. Fallback indicates the use of another system to satisfy the system requirements. For example: the fallback techniques for an automated system might be manual manipulation and recording data. 2.6.3 Degraded Modes of Operation. If applicable, state priorities for restoring the essential functional processing steps in the event that full processing capability for all functions is not available. 2.7 System Logical Flow Present the logical flow of the system. Provide flow charts, dialog diagrams, program design language (pseudo code), a narrative description, as appropriate. Graphics should provide an integrated presentation of the system dynamics, entrances and exits, and interfaces with other software units. Represent all modes of operations, priorities, cycles, special handling and general flow of control. Additionally, you must also include a prototype of your system as described in the MIS465 Project Guidelines. 3.0 Environment (30 Points) This section provides detailed information about the environment where the system will operate in. Additionally, you are required to provide an updated TRW if changes were identified in the design phase, and as more detail has become available, that impacted the TRW produced in the analysis phase. 3.1 Equipment Environment Provide a description of the equipment required for the operation of the system. Include descriptions of the equipment presently available, as well as a more detailed discussion of the characteristics and impact of any new equipment necessary for system operation. 3.1.1 Storage Media Include volume of data storage required. 3.1.2 Input/Output Devices Include number and type of each online/offline device. 3.2 Communications Environment Describe the data communications environment of the system. Additionally, provide detailed schematics of the portions of the communications environment that directly relate to the system or subsystem being documented. If a standard communications environment is being used, reference can be made to it. 3.3 Software Environment Describe the software with which the system must interact. Include both support software (trouble shooting, diagnostics software) and test software (automated testing software), if needed. Provide the correct name, description, and documentation references of each such software system, subsystem, and program. Include a reference to the operating system to be used, the database management system (if any), and any other purchased or internally developed software. 21541514.doc Page 8 of 11 University of Dayton – School of Business Administration MIS Senior Project System Design Specifications (SDS) 3.4 Software Interfaces Revised 09/27/04 Provide a description of the interfaces with other application software systems, including those of other operational capabilities. For each interface, specify the file format (input/output) and delivery media. 3.5 Database and File Design Interact with the Database Administrator (DBA) when preparing this section. The section should reveal the final design of all database management system (DBMS) files and the non-DBMS files associated with the system under development. Additional information may add as required for the particular project. Provide a comprehensive data dictionary showing data element name, type, length, source, validation rules, maintenance (create, read, update, delete (CRUD) capability), data stores, outputs, aliases, and description. 3.5.1 Database Management System Files This section reveals the final design of the DBMS files and includes the following information, as appropriate (refer to the data dictionary): • Refined logical model; provide normalized table layouts, entity relationship diagrams (ERD’s), and other logical design information • A physical description of the DBMS schemas, sub-schemas, records, sets, tables, storage page sizes, etc. • Access methods (such as indexed, via set, sequential, random access, sorted pointer array, etc.) • Estimate of the DBMS file size or volume of data within the file • Definition of the update frequency of the database tables, views, files, areas, record sets, and data pages; estimate the number of transactions if the database is an online transaction-based system • Database backup and recovery procedures, including transaction audit trails, redo logs, etc. 3.5.2 Non-Database Management System Files In this section, provide the detailed description of all non-DBMS files and include a narrative description of the usage of each file--including if the file is used for input, output, or both; if this file is a temporary file; an indication of which modules read and write the file, etc.; and file structures (refer to the data dictionary). As appropriate, the file structure information should: • Identify record structures, record keys or indexes, and reference data elements within the records • Define record length (fixed or maximum variable length) and blocking factors • Define file access method--for example, index sequential, virtual sequential, random access, etc. • Estimate the file size or volume of data within the file, including overhead resulting from file access methods • Define the update frequency of the file; if the file is part of an online transaction-based system, provide the estimated number of transactions per unit time, and the statistical mean, mode, and distribution of those transactions 3.6 Human-Machine Interface This section provides the detailed design of the system and subsystem inputs and outputs relative to the user/operator. Any additional information may be added to this section and may be organized according to whatever structure best presents the operator input and output designs. Depending on the particular nature of the project, it may be appropriate to repeat these sections at both the subsystem and design 21541514.doc Page 9 of 11 University of Dayton – School of Business Administration MIS Senior Project System Design Specifications (SDS) Revised 09/27/04 module levels. Additional information may be added to the subsections if the suggested lists are inadequate to describe the project inputs and outputs. 3.6.1 Inputs This section is a description of the input media used by the end user for providing information to the system; show a mapping to the data flow diagrams (DFDs) produced in the analysis phase and documented in the System Requirements Specification. For example, data entry screens, input forms, optical character readers, bar code scanners, etc. If appropriate, the input record types, file structures, and database structures in, File and Database Design, may be referenced. Include data element definitions, or refer to the data dictionary. Provide the layout of all input data screens or graphical user interfaces (GUIs) (for example, windows). Provide a graphic representation of each interface. Define all data elements associated with each screen or GUI, or reference the data dictionary. This section should contain edit criteria for the data elements, including specific values, range of values, mandatory/optional, alphanumeric values, and length. Also address data entry controls to prevent edit bypassing. Identify the inputs and provide information about the characteristics of each input to the system, such as: • file name • format and type of data • validation criteria • error handling • help screens and functions • volume • frequency • means of entry • source documents and their disposition • security and privacy considerations 3.6.2 Outputs/Reports This section describes of the system output design relative to the user/operator; show a mapping to the high-level data flows. System outputs include reports, data display screens and GUIs, query results, etc. Identify the output data and reports, including information about the characteristics of each output from the system, such as: • file names • report formats • selection criteria for displays or outputs • types of output media • disposition of products • report audit and balancing procedures 21541514.doc Page 10 of 11 University of Dayton – School of Business Administration MIS Senior Project System Design Specifications (SDS) 3.7 Other Environment Considerations Revised 09/27/04 4.0 Operational Design (10 Points) This section will supercede any equivalent section in the SDS. 4.1 Operations This could specify the normal and special operation required by the user such as: • The various modes of operation in the user organization • Data processing support functions • System audit procedures • Backup and recovery operations 4.2 Site preparation and adaptation This could define the requirements for any data or initialization sequences that are specific to a given site, mission, or operational mode, for example grid values, safety limits, etc or specify the site of mission-related features that should be modified to adapt the software to a particular installation. 5.0 Appendices (20 Points) 5.1 5.2 5.3 5.4 5.5 5.6 5.7 Requirements Traceability Matrix Data Dictionary Screen Layout, Form, and Report Samples Updated ERD for Recommended System Primitive DFDs SBA IT Technology Request Workbook (TRW) To-be-determined list 21541514.doc Page 11 of 11