You are on page 1of 14

Page 1 of 14

Version 1.0

System Requirement Specification


Project Name: xx

Author: Nguyễn Văn A


Page 2 of 14
Version 1.0
Document Revision History
Ve Date Changed by Modifications
r.
0.1 Dd/mm/yy Nguyễn Văn A Update Usecase add new user
0.2
0.3

List of Abbreviations

RS Requirement Specification
OSS Open Source Software
SPOC Single Point of Contact
HLD High Level Design
Page 3 of 14
Version 1.0

Table of Contents

1. INTRODUCTION 6
1.1 Purpose 6
1.2 Scope 6
1.2.1 Scope Overview 6
1.2.2 user 7
1.2.3 7
1.2.4 Monitor 7
1.2.5 Authentication 7
1.3 Out of Scope in UAT 7
1.4 Functional Requirements 7

1. Introduction
1.1 Purpose

1.2 Scope

1.3 Out of Scope

1.4 System perspective

1.4.1 Assumptions

1.4.2 Constraints
Page 4 of 14
Version 1.0
1.4.3 Risks

1.4.4 issues

2. Business Process overview


2.1 Current Business Process

Figure 2: Use case diagram of Bosch Chatbot

2.2 Proposal Business Process


Page 5 of 14
Version 1.0
3. System Diagram
3.1 Use case diagram
Page 6 of 14
Version 1.0
3.2 Entity Ralationship diagram

4. Functional Requirement
The requirements in this document are prioritized as follows:

Value Rating Description


1 Critical This requirement is critical to the success of the project. The project will not be
possible without this requirement.
2 High This requirement is high priority, but the project can be implemented at a bare
minimum without this requirement.
3 Mediu This requirement is somewhat important, as it provides some value but the
m project can proceed without it.
4 Low This is a low priority requirement, or a “nice to have” feature, if time and cost
allow it.
5 Future This requirement is out of scope for this project, and has been included here for a
possible future release.
Page 7 of 14
Version 1.0

4.1 Use case matrix


U Use Case
Prior Acto
C Description Rationale Referenc
ity r
ID e

Module Name: User Management

FR Single repository simplifies HR


A new Master Widget
- management of widget
repository shall be created to Adm
G- 1 development across 30+
house the name records and in
00 global development teams
links to the widget objects.
1

FR ID+Name eliminates duplicate


A widget shall be defined in
- widget name records
the repository via a unique
G- 1
identifier and name
00
combination.
2

Module Name: Product Management

FR Single repository simplifies HR


A new Master Widget
- management of widget
repository shall be created to Adm
G- 1 development across 30+
house the name records and in
00 global development teams
links to the widget objects.
3

FR ID+Name eliminates duplicate


A widget shall be defined in
- widget name records
the repository via a unique
G- 1
identifier and name
00
combination.
4

4.2 Use case detail

4.2.1 Create new user


4.2.1.1 Description

UC ID FR_AD_001 Precondition
User must have account admin
Description Help admin can create new user on Post condition
system New user after creating can log in to system
Main Flow User: Click create button Business rule GUI Reference
System: Show form on the popup G1.1
User: input information to form then G1.2
save G1.3
System: Close popup and loading list
user
Page 8 of 14
Version 1.0
Alternative User: click create button at main screen Business rule GUI Reference
Flow System: Route to user management G1.4

Exception
flow

4.2.1.2 GUI
4.2.1.2.1 Layout

4.2.1.2.2 GUI element

Field Description Control Type Data Defaul Required Rules


Name Type t
(Y/N)
Value

<Caption <Include: <See guidelines Danh Empty - Danh sách được sắp
of the below> sách tăng dần theo alphabe
- Meaning of the
element nhà
field >
on the cung
screensho - Where does the cấp
t> data of this field
come from?
>

4.2.1.2.3 References
Page 9 of 14
Version 1.0
▪ None

4.3 Coordinators
ABC company: Nguyen Van A - project leader
AHN Company: Nguyen Van B - Product Manager

5. Software Requirements
5.1 Architecture System

Figure 3 Architecture HLD


Page 10 of 14
Version 1.0
5.2 Deployment Diagram

5.3 Operational Requirements


5.3.1 Software
No. Name Version Description
1
2
3
4
5

5.3.2 Hardware
No. Server Requirement
1 ▪

2 ▪

3

4

Page 11 of 14
Version 1.0

5.4 API Integration


5.4.1 create new user
▪ Description: this API provide

▪ HTTP Request method: POST

▪ Url:

5.4.1.1.1 Input Request Body: JSON Object


Field name Type Description
UserID String REQUIRED. The unique id of user’s chat session
Createdate String REQUIRED. The user’s message user wants to say to bot
Description String REQUIRED. Time when user chat. The format is millisecond.
Username String REQUIRED. The unique ID of user message

Example:
{from typing import Optional

from fastapi import FastAPI


from pydantic import BaseModel

class Item(BaseModel):

name: str

description: Optional[str] = None

price: float

tax: Optional[float] = None

app = FastAPI()
Page 12 of 14
Version 1.0

@app.post("/items/")
async def create_item(item: Item):
return item

5.4.1.1.2 Response
Field name Type Description
String
String ●

number
String
String
String
Example:
{
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
"meta": {
"totalPages": 13
},
"data": [
{
"type": "articles",
"id": "3",
"attributes": {
"title": "JSON:API paints my bikeshed!",
"body": "The shortest article. Ever.",
"created": "2015-05-22T14:56:29.000Z",
"updated": "2015-05-22T14:56:28.000Z"
}
}
],
"links": {
"self": "http://example.com/articles?page[number]=3&page[size]=1",
"first": "http://example.com/articles?page[number]=1&page[size]=1",
"prev": "http://example.com/articles?page[number]=2&page[size]=1",
"next": "http://example.com/articles?page[number]=4&page[size]=1",
"last": "http://example.com/articles?page[number]=13&page[size]=1"
}
}
}

5.4.2

5.5 Training Requirements


6. Testing Requirements
▪ Testing methodology: manual and automation
Page 13 of 14
Version 1.0

7. Open Source Usage


No. Component Total Status Remark
library

8. Performance Requirements
8.1 API Response Time
Requirement Tag ID PE_REQ_001
Source/Trigger ABC Solution
Description Input API Call from ABC (multi concurrent request per second, and
response time within 2 seconds max)
Process 1. API Call from ABC
2. Return from ACG Solution
Output Based on ABC infrastructure
Validation Method Acceptance Test

9. Information Security, Data Protection requirements


9.1 Data Protection

10. Signatures

Signature 1: Signature 1:
Name: Name:
Designation: Designation
Date: Date:

Signature 2: Signature 2:
Page 14 of 14
Version 1.0
Name: Name:
Designation: Designation
Date: Date:

You might also like