From Princípy tvorby software

Contents 1 Introduction 1.1 Purpose 1.2 Document Conventions 1.3 Intended Audience and Reading Suggestions 1.3.1 Developers 1.3.2 Project managers 1.3.3 Documentation writers 1.3.4 Users 1.4 Product Scope 2 Overall Description 2.1 Product Perspective 2.2 Product Functions 2.3 User Classes and Characteristics 2.3.1 Manager 2.3.2 Customer care 2.3.3 Warehouse operator 2.3.4 Application 2.4 Operating Environment 2.5 User Documentation 2.6 Design and Implementation Constraints 3 External Interface Requirements 3.1 User Interfaces 3.2 Hardware Interfaces 3.2.1 Database server 3.2.2 Client stations 3.3 Software Interfaces 3.3.1 Database server 3.3.2 Client stations 3.4 Communications Interfaces 4 System Features 5 Other Nonfunctional Requirements 5.1 Performance Requirements 5.2 Security Requirements 5.3 Software Quality Attributes 6 Attachments 6.1 Use Case Diagram 6.2 Use Case description

Introduction

Purpose

This document describes requirements for Warehouse management software. Main ambition of this software is to organize basic storage facilities. The software is offering following functionality:

• Stock item management
• Stock orders management
• Stock receipt operations
• Code-book data management
• Customer orders management
• Seasonal stock stats reports views
• Reclamations management
• Tax documents management
• Automatic email communication
• Data export for stock economics software
• Simple task management

Document Conventions

Convention Name	Convention Description
operations	Data insertion, editing, view
ES	Entire section as a whole
Software	Warehouse management software
code-book	List of suppliers

Intended Audience and Reading Suggestions

Document is intended for several types of readers:

Developers

Most important parts for this group of readers are (ordered by recommended sequence of reading)

• Document conventions
• References
• Product perspective
• Product functions
• User Classes and characteristics
• Operating environment
• Design and implementation constraints
• Assumption and dependencies
• User Interfaces
• Software Interfaces
• Communication interface
• System features (ES)
• Other nonfunctional requirements (ES)
• Other requirements (ES)

Project managers

This group is responsible for whole project, so it’s very important to read entire document.

Documentation writers

This group should read the same topic range as developers except Design and implementation software and Other nonfunctional requirements (ES)

Users

Most important parts for this group of readers are (ordered by recommended sequence of reading)

• Purpose
• Product Scope
• References
• User documentation

Product Scope

Software should cover all the native needs of warehouse management, such as order management, basic tax document management, stock items management. Software is not meant to be economics software or workflow system.

Overall Description

Product Perspective

Software will replace all separated tools currently using and link up their functionality. Main goal is to increase productivity and support management activities.

Product Functions

• Stock item information view
• Stock item insertion and editing
• Insertion, editing of warehouse orders
• Stock receipt and stock out view
• Stock receipt and stock out insertion
• Stock receipt and stock out editing
• Code-book data insertion(customers,suppliers,forwarders)
• Customer orders insertion and editing
• Customers orders state revision
• Seasonal stock stats reports views
• Reclamations view
• Reclamations insertion and editing
• Credit notes, invoices generating
• Tax documents reports
• Sending email order notifications and posters
• Data export for stock economics software
• Management ability to assign personal tasks
• Checking personal tasks status

User Classes and Characteristics

Manager

(User with highest privileges):

• Ability to add, edit or delete suppliers customers or forwarders(Code-book management)
• Overall access to orders and reports.
• Ability to setting up new item lists
• Responsibility for data export for economics software

Customer care

• Taking care of full order processing
• Credit notes and invoices overview (Tax documents)
• Responsibility for reclamation process

Warehouse operator

• Responsibility for stock receipt and stock out

Application

• Handle standing facilities (automatic email notifications, special offers)

Operating Environment

Software will be implemented using JAVA technology. Unfortunately, many platforms (such as FreeBSD, GEOS, Linux, and even Sun's own SunOS) are not targeted for a Java port by any commercial license. Recommended operating systems: Microsoft Windows, Apple MacOS with Java runtime environment.

User Documentation

Userguide will be delivered along with the software. It will contain tutorial (in text form) for each of user groups. Software homepage will also contain online help.

Design and Implementation Constraints

Software uses MySql relational database and has to offer Multilanguage GUI (English, German and Slovak language are planned to be released).

External Interface Requirements

User Interfaces

Software design will be realized by standard User Interface guidelines for applications built using Java Swing.

• All the code-book management and item management forms will use SpringLayout [1]
• All the search forms will use GroupLayout [2]
• All the detail views will use SpringLayout [3]
• All the report views will use GridBagLayout

Hardware Interfaces

Recommended parameters should be understood as rather minimal parameters.

Database server

• Processor: Intel Dual-Core or Quad-Core Xeon
• RAM: 8GB (or more)
• Memory: 250GB (or more)
• Network: 100/1000 Mbit / s

Client stations

• Processor: 1.2Ghz (or more)
• RAM: 1GB (or more)
• Memory: 40GB (or more)
• Network: 100/1000 Mbit / s
• I/O Devices

Software Interfaces

Database server

• Operating system: FreeBSD
• MySQL relational database

Client stations

• Operating system : Windows XP (or later) or MacOS
• JRE (Java Runtime Environment) 1.5 (or later)

Communications Interfaces

Client-server communication will be provided by SSH network protocol.

System Features

A detailed description of all the use cases is defined in document attachment.

Other Nonfunctional Requirements

Performance Requirements

System is extensively operating with database. It's very immportant to make all the simplest INSERT and DELETE queries under 0.05 seconds, and All the SELECT queries under 0.02 seconds. Advanced queries can vary from 1 second to half a minute, but they should always take minimum time to make the Software responsive and productive.

System has to ensure almost immediate response to user actions.

Security Requirements

Each user group will obtain autogenerated password (12 alphanumerical characters). Software will be a desktop application, so only employees sharing a group password, who connect directly from the internal network will have full access to Application.

Software Quality Attributes

One of the main software priorities is modularity due to easy extensibility. Software will be fully tested before submitting. It will include all the functionality mentioned in this document.

Attachments

Use Case Diagram

Use Case diagram

Use Case description

Use Case description