Navigation Area The latest news about Team Synergy Information about Projects undertaken by Team Synergy Team Synergy Member Profiles Team Synergy Member Management Team Synergy Project-related Documentation Team Synergy Meetings Archive Downloads relating to Team Synergy Projects Funny Stuff Team Synergy Logo
Icon Navigation Home Help / Frequently Asked Questions Products Site Site Map Email the Webmaster

Documentation
Documentation Home
BKernel Javadoc Documentation (No Frames)
Cohesion - Client User Guide
Cohesion - Administration Manual
Configuration Management
CVS Documentation
Debug Package Documentation
Demerit Point Scheme
Management Procedures
Package Description
Project Plans and Procedures
Samba
Software Design Spec.
Software Requirements Spec.
Syndicate User Manual
Technical Style Standards
Web Document Style Standards
Work Log & Weekly Plan Proc.
WWW Document Template
 
Table of Contents
Executive Summary

1.   Introduction

1.1  Document Purpose
1.2  Project Scope
1.3  Definitions, Acronyms, and Abbreviations
1.4  Document Overview
1.5  Applicable Documents
2.   Development Process Perspective 2.1  Methodology
2.2  Software Process
2.3  Core Functionality
3.   Product Characteristics 3.1 Functions
3.2 Performance
3.3 Interfaces 3.3.1 Mouse
3.3.2 Keyboard
3.3.3 Screen
3.3.4 Printer
4. User Characteristics 4.1 The General User
4.2 The Software Designer
4.3 The Quality Engineer
4.4 The Administrator
4.5 The Client
5. Functional Requirements 5.1  CRUD Project
5.2  CRUD Workspace
5.3  CRUD Model
5.4  CRUD Meta-Model
5.5  CRUD Package
5.6  File IO
5.7  Communications
5.8  Administration
5.9  Online Help
6. Interface Requirements 6.1 Supported Display Modes
6.2 Supported Devices
7. System Diagnostics 7.1 Level of Diagnostics
7.2 General Reporting Formats
7.3 Diagnostic Utility Software
8. Verification Requirements

9. General Constraints

9.1 Assumptions and Dependencies 10. System Requirements 10.1 Client Computer
10.2 Server Computer
Appendix A : External Context Diagram

Appendix B : Internal Context Diagram

Appendix C : Use Cases

Appendix D : Hierarchical User Interface Decomposition

 
Pages 1 - 2 - 3 - 4

6. Interface Requirements

The requirements of the user interface can be described in terms of the types of displays that it must be able to perform on and the user devices that it must be able to support.
 

6.1 Supported Display Modes

The system will be using the Java Look and Feel (JLF) formally known as Metal for the interface.
 

Allow users of  the vast majority of systems to be able to use Java applications.
 

It would be safe to assume that users of this system will have a VGA 640 by 480 or better screen although the JLF will support lesser screen capabilities than this.
 

6.2 Supported Devices

The system will have to support numerous devices.  The keyboard will be used as the primary input device.  Keyboards have been proven to be the best device for text input, the use of non-standard keyboards such as the Dvorak or Chord Keyboard will have to be supported by the underlying operating system.

In addition to the keyboard, devices for manipulation and selection of objects will be supported.  The mouse, trackball and accupoint(on laptops)  will all be supported to fulfill this need.
 
 
 

7. System Diagnostics
 

7.1 Level of Diagnostics

Errors will be detected by the system and delivered to the user through the use of message dialogs.
 

7.2 General Reporting Formats

Any error encountered by the system will generally be reported in a Message Dialog.  There are different message dialogs displayed depending of the severity of the error.  For the less severe error a warning message will be displayed and for the more critical errors an error message.
 

7.3 Diagnostic Utility Software

The only diagnostic utility software that accompanies the system is an application that allows the user to view the file in it’s raw form.  This gives the user who has knowledge of how the information is stored the opportunity to fix a corrupted file.
 
 
 

8. Verification Requirements

In order to verify that the system meets the requirements specified in this document, a variety of tools, techniques and methods will be used.  These methods implemented by both the Quality Assurance and Application Engineering teams will play a crucial role in assuring that the system meets the specified requirements.

Peer reviews will be held within all Team Synergy sub-groups. This means that new code is submitted by an Application Engineer to be reviewed by another Application Engineer, who will then check it for any defects. Once this code has been reviewed it can then be submitted for review by the Quality Assurance team.

Once the code is submitted to the Quality Assurance team, it is subjected to the testing procedure defined in the Project Plan (Section 5). Before any submissions to the Quality Assurance team are tested, a test script is to be written by each Quality Engineer involved (See Project Plan Section 6). These scripts are written according to the Test Script template written by the Quality Assurance team (This is available on request to the Quality Assurance Team Leader). These scripts consist of a list of proposed tests, expected results, and whether or not the submitted software passed or failed each test.

The following list presents the type of test used with respect to the code type:

* Code fragments (such as single classes, a cluster of classes or non-self executing synchronised classes) - white-box testing.
* For self executing code (such as partial system builds or specific dialogs) - black-box testing.

After each test is run any problems identified are listed in a test summary document. This summary document is then reviewed by the Quality Assurance Team Leader, and if accepted, passed on to the Application Engineering Team Leader. They then use this document as a reference to fix the problems listed in the Team Synergy Bug Tracking Tool.

The software, once corrected, is filtered through the same process until accepted as complete by the Quality Assurance team.

Tools that will be used by the Quality Assurance team when assessing software will vary. However there are some tools that have been developed explicitly for the purpose of testing code developed by Team Synergy. These tools are the strip, assert, log and debug java class files. They are used to strip code not to be tested, assert certain values to ensure that invalid values or situations do not occur, and to redirect debug information (such as exceptions) to tester-specified locations along with custom generated analytical data.  These debug utilities will be available for download on the Team Synergy Web Site (http://cohesion.it.swin.edu.au/teamb) under "Downloads".

Refer to the Team Synergy Project Plan Document (Section 4-6) for any further information.

9. General Constraints
 

General design/implementation constraints include:

  • The software system will run under Windows NT 4.0.
  • All code shall be written in Java 2.
  • Text files shall be used for all data storage and reporting.
  • The system shall be developed using the methodology specified in Section 2.
  • The documentation and code shall be in accordance with the Web Style Standards and Technical Style Standards.

  •  
9.1 Assumptions and Dependencies

Although the system should run on any Java 2 compatible platform, it will only be supported on Win32 platforms.

     
10. System Requirements

The client and server components of the system will be integrated and therefore using the system as a server will still include, but not use, the client software. Both the server and the client will need the same storage capacity as outlined below. The following physical objects have been identified to be within the scope of the deliverable system:

  • Client Computer.
  • Server Computer
10.1 Computer Configuration

Both the Client/Server Computers will be expected to have the following minimum configuration:

  • Pentium II 333MHz or above (Pentium II recommended).
  • 64MB RAM or higher
  • Win32 operating system.
  • 10MB free hard disk space.
  • 10Mb/s Network card (Optional - for remote access).