Requirement Analysis detailed design summary part of the Design Manual Samples

XX System Overview Design Manual

Directory

1. Document Introduction 1
1.1 Purpose 1
1.2 document range 1
1.3 target audience 1
1.4 References 1
1.5 terms and abbreviations 1
2. System Overview 2
3. Design constraints 2
3.1 requirement constraint 2
3.2 implicit constraint 2
4. Design Strategy 3
4.1 scaling policy 3
4.2 Reuse Policy 3
4.3 compromise strategy 3
5. Overall system structure 3
5.1 overall system structure 3
5.2 subsystem functions and interfaces 4
6. subsystem structure and function 5
6.1. termserv 5
7. Functional requirements traceability 5
8. Environment configuration 5
9. Other 6
Appendix 6
A. interface with host 6
B. Terminal interface 6

1. Document Introduction
1.1 Purpose of the document
The purpose of this document is to clarify the functions and processing modes of the XXXX system from the perspective of the overall design, clarify the interfaces with UnionPay, and enable system developers and product management personnel to clarify the product functions, system development, testing, and acceptance can be carried out in a targeted manner.

1.2 Scope of documents

1.3 target readers
This document is intended for user representatives, software analysts, developers, and testers.

1.4 references
XXXX system requirement Manual
　　
1.5 Glossary
None
2. System Overview
The XX system uses the touch screen as the main interactive tool to help users perform business queries on their own. The main functions of the system include: telephone bill query, new business introduction, outlet distribution query, self-service terminal distribution query, telecom news, transaction monitoring, equipment maintenance and monitoring. The design goal of this system is
Ensure that the system can run safely and efficiently without faults. Business personnel can easily monitor and manage equipment and transactions. The report type is complete and can meet various accounting requirements of business personnel.

3. Design Constraints
3.1 requirement Constraints
* Standards that the system should follow
The data naming rules follow the relevant provisions in the C Programming specification;
* Software and Hardware Environments
The system consists of two modules: online processing and system monitoring.
The online module is based on the C/S structure and adopts the AIX operating system and Informix database. It is developed using esql/C language, and the server uses PC
Server;
The monitoring module is based on the B/S structure and is developed using the Win9x/2000/XP operating system and ASP. NET.
* Interface/protocol
The TCP/IP protocol is used for communication between the system and the self-service terminal and the telecom host;
For the interface with the self-service terminal, see Appendix A and the interface with the self-service terminal.
For interfaces with telecom hosts, see Appendix B and interfaces with telecom hosts.

* User Interface
The monitoring part uses the Windows graphical interface to ensure that personnel with a secondary school or higher education level can perform operations without barriers.
* Software Quality
Correctness: transactions must be processed correctly;
Robustness: The system should be able to run without fault within 7x24 hours;
Efficiency: the system supports 100 terminals to initiate transactions at the same time. The transaction processing time cannot exceed 10 seconds;
Ease of use: Graphical operations should be adopted on the monitoring interface to facilitate operations by business personnel;
Security: key data domains in packets are transmitted in ciphertext mode;
Scalability: the future transaction modification or increase should be fully taken into account to avoid large-scale modification of the program when the demand changes;

3.2 implicit Constraint
The people who use the monitoring management function are banking business personnel who have strong business skills and basic computer knowledge, the operation interfaces provided by them should ensure that they are accessible after simple training;
Reports should be browsed and printed on multiple operating systems;
The system should provide the review tracking function;
The parameters that may be changed should be stored in the configuration file or database to ensure the flexibility of parameter modification.

4. Design Strategy
4.1 scaling policy
This system is a transaction processing system. In the future, function expansion mainly refers to the addition of new transactions. In order to facilitate the future expansion of the system, the following policies should be taken during system design:
To minimize the scale of program changes when new functions or interfaces are added, the packet format configuration file should be used to parse and organize packets;
To ensure system flexibility, variable parameters should be saved to the configuration file;
XX system detailed design instruction

Directory
Chapter 1 Introduction 1
1.1 Overview 1
1.2 Background 1
1.3 Definition 1
1.4 References 1
1.5 terms and abbreviations 1
2. program structure 2
2.1 Module summary table 2
3. Program Design 2
3.1 terminal communication subsystem 2
3.1.1 subsystem function 2
3.1.2 subsystem flowchart 3
3.1.3 subsystem module design 5
4. Data Structure Design 5
4.1 terminal archives table termfile 5
5. Interface Design 5
5.1 interface with self-service Device 5
5.2 host interface 6
5.3 Internal interface 6

Chapter 1 Introduction
1.1 Overview
Write
The purpose of the XX product Detailed Design Manual is to clarify the business variety and function scope of the XX project from the perspective of detailed design, and to clarify the interface with the business host/Terminal System and the business processing mode, enable system developers and product management personnel to define product functions and conduct system development and testing in a targeted manner.
Test, acceptance, and other aspects of the work.
1.2 Background
System name: XX System
Task initiated by: XXX
Developer: XX Department
User: XX Telecom
1.3 Definition
1.4 references
Project development plan
Product Requirement analysis manual
General System Design Manual
1.5 Glossary
　　
2. Program Structure
2.1 Module summary table
Terminal communication subsystem Module name function description readdata Receiving Terminal request message writelog write the packet into the log setsockscoket set parsing/organizing the packet and packet distribution module name function description unpack_c parse terminal request message PR
Intstruct_c outputs the decoded packet checkpackage packet validity check pack_c organizes the response packet ::::
3. Program Design Description
3.1 terminal communication subsystem
3.1.1 sub-system functions
Establish a TCP/IP server to listen for connection requests from self-help devices.
Creates a process for a listening connection, receives and sends the received and sent raw data on the connection, and writes the received and sent raw data to the log file.
Send the received data to queue 1 and fetch the data from queue 2 for sending.
List of sub-system function programs:
Termserv. c
Subsystem Interface Description:
Input: terminal request message, resolution/organization message, and response message generated by the packet distribution module
Output: the terminal request message is output to the parsing/organizing message and the packet delivery module, the Response Message is output to the terminal, and the received data is output to the log file.
3.1.2 subsystem Flowchart

Chapter 1 Introduction... 1

1.1 writing purpose... 1

1.2 project background... 1

1.3 basic definition... 1

Chapter 2 Product Overview... 2

2.1 system functions... 2

2.2 runtime environment... 2

2.3 user features... 2

2.3 conditions and restrictions... 2

Chapter 3 functional requirements... 3

3.1 functional division... 3

3.2 Function Description... 3

4.3 software interface... 4

4.4 troubleshooting... 4

Chapter 4 other requirements... 5

4.1 application environment... 5

4.2 other requirements... 5

Chapter 1 Introduction
1.1 Writing Purpose
The purpose of this document is to clarify the user requirements of the XX system, so that software developers and users have a unified and unambiguous understanding of the requirements for developing software. The content described in this document can be used as a basis for software validation testing. This document is intended for user representatives, software analysts, and developers.
Managers and testers.

1.2 Project Background
See XX project kickoff meeting notes

1.3 basic definition

Chapter 2 Product Overview
2.1 system functions
Serial number
Function Name
Priority
Brief Description

1
Online Functions
High
Solving real-time transaction problems

2
Management and monitoring functions
High
Solve routine terminal maintenance problems

2.2 Runtime Environment
Software Platform: the server is the aix unix 4.3.3 operating system and Informix database;

The monitoring end is the Windows 98/2000/XP operating system.

Hardware Platform: the server is an IBM rs6000 series host;

The monitoring end is a PC.

2.3 user features
Since the people who use the self-service terminal are general citizens, the operation interface of the self-service terminal should be accessible to junior high school students or above;

The personnel who use the monitoring and management functions are business personnel who have strong business skills and basic computer knowledge. The operation interfaces provided to them should ensure that they are accessible after training.

2.3 conditions and restrictions
The development period starts from 2002-2-5 and ends from 2002-3-5;

Discuss the adoption of socket communication protocol;

The host interface is provided by the host and cannot be changed;

The company negotiates with the terminal manufacturer for the terminal interface.

# Software Engineering