Documente Academic
Documente Profesional
Documente Cultură
VIETNAMESE
SOFTWARE REQUIREMENT
SPECIFICATION
- Hanoi, 06/2014 -
UJD_VN | Software requirement specification
RECORD OF CHANGE
Signature page
Team member
Team member
Supervisor
Table of Contents
1.1 Introduction .................................................................................................. 4
1.1.1 Purposes ................................................................................................ 4
1.1.2 Definition and Acronyms ........................................................................ 5
1.2 System Purpose ............................................................................................. 5
1.3 Scope ........................................................................................................... 5
UJD 2
UJD_VN | Software requirement specification
UJD 3
UJD_VN | Software requirement specification
1.1 Introduction
1.1.1 Purposes
This document is created as the introduction for project Useful Japanese Dictionary for
Vietnamese – our Capstone Project at FPT University. In this document, we will descript the
overview of function list, use case of our software, a brief description about function's screen.
This document help user understand more about our system
UJD 4
UJD_VN | Software requirement specification
This section describes the definitions, terms, and acronyms that are used in software
requirements specification.
Items Description
UJD_VN Useful Japanese dictionary for Vietnamese
1.3 Scope
The scope of this project contains Requirement Analysis, Design, Coding and Testing (Unit
Test, Integration Test, and System Test).
UJD 5
UJD_VN | Software requirement specification
UJD 6
UJD_VN | Software requirement specification
Common Module
UJD 7
UJD_VN | Software requirement specification
Practice Management
UJD 8
UJD_VN | Software requirement specification
UC0033 Reading Add reading document Thêm mới các bài đọc
Document Edit reading document Chỉnh sửa thông tin các bài
UC0034 Management đọc
UC0049 Doing test Add test Thêm mới bài kiểm tra
management Edit test Chỉnh sửa bài kiếm tra
UC0050
UC0052 content
Approve content Chấp nhận ý kiến đóng góp
management
Reply user Trả lời người dùng
UJD 9
UJD_VN | Software requirement specification
Name Description
User Manual Provide detailed explanation about the system, screens and
guide users how to use all features of UJD_VN website.
1.4.5 Assumption
- Receive the guidance and good support of teacher.
UJD 10
UJD_VN | Software requirement specification
1.5.2.1 Vocabulary
No Field Name Type Mandatory Description
id
1 Number Y Vocabulary’s id
Hiragana
2 String Y Vocabulary’s hiragana
Romaji
3 String Y Vocabulary’s romaji
Meaning
4 String Y Vocabulary’s meaning
Category
5 String Y Vocabulary’s category
Kanji
6 String Vocabulary’s kanji
Specialized
7 String Vocabulary’s specialized
Status
8 Number Y Vocabulary’s status
UJD 11
UJD_VN | Software requirement specification
1.5.2.2 Sentence
ID
1 Number Y Sentence’s id
Hiragana
2 String Y Sentence’s hiragana
Romaji
3 String Y Sentence’s romaji
Meaning
4 String Y Sentence’s meaning
Kanji
5 String Y Sentence’s kanji
1.5.2.3 Grammar
ID
1 Number Y Grammar’s id
Hiragana
2 String Y Grammar’s hiragana
Romaji
3 String Y Grammar’s romaji
Level
4 String Y Grammar’s level
Meaning
5 String Y Grammar’s meaning
Use
6 String Y Grammar’s use
Lesson
7 String Grammar’s lesson
Status
8 Number Y Grammar’s status
1.5.2.4 Video
No Field Name Type Mandatory Description
ID
1 Number Y Video’s id
Title
2 String Y Video’s title
Link
3 String Y Video’s link
UJD 12
UJD_VN | Software requirement specification
1.5.2.5 Kanji
ID
1 Number Y Kanji’s id
Kanji
2 String Y Kanji in Japanese
Hanviet
3 String Y Kanji’s Vietnamese-Han
Onyomi
4 String Y Kanji’s onyomi
Kunyomi
5 String Kanji’s kunyomi
Meaning
6 String Y Kanji’s meaning
Level
7 String Y Kanji’s level
Lesson
8 String Kanji’s lesson
Status
9 Number Y Kanji’s status
1.5.2.6 Conversation
No Field Name Type Mandatory Description
ID
1 Number Y Conversation’s id
Titel
2 String Y Conversation’s level
Level
3 String Y Conversation’s title
Content
4 String Y Conversation’s content
Audio
5 String Y Conversation’s audio
Image
6 String Conversation’s image
UJD 13
UJD_VN | Software requirement specification
1.5.2.7 User
No Field Name Type Mandatory Description
ID
1 Number Y User’s id
Username Username login
2 String Y
Password Store password login of user.
3 String Y
Using md5 algorithm.
Role
4 Number Y Admin can assign permission for
user
Full name
5 String User’s name display
Email
6 String Y User’s email
Register date
7 Date Y Date register
Status
8 Number Y Active or deactive
1.5.2.8 Test
No Field Name Type Default Description
ID Test’s id
1 Number Y
Title
2 String Y Test’s category
Level
3 String Y Test’s level
Category
4 String Y Test’s category
Content
5 String Test’s content
Question
6 String Y Test’s question
Answer
7 String Y Question’s answer
UJD 14
UJD_VN | Software requirement specification
1.5.2.9 Contact
No Field Type Mandatory Description
Name
ID
1 Number Y Contact’s id
Email
2 String Y Contact’s email
Content
3 String Y Contact’s content
Type
4 String Y Contact’s type
Reply
5 String Contact’s reply
Status
6 Number Y Contact’s status
ID
1 Number Y Listening’s id
Title Listening’s title
2 String Y
Level
3 String Y Listening’s level
File
4 String Y Listening’s file
Question
5 String Y Listening’s question
Script
6 String Y Listening’s script
Meaning
7 String Y Listening’s meaning
Answer
8 String Y Listening’s answer
UJD 15
UJD_VN | Software requirement specification
ID Reading’s id
1 Number Y
Title
2 String Y Reading’s title
Level
3 String Y Reading’s level
Vocabulary
4 String Y Reading’s vocabulary
Grammar
5 String Y Reading’s grammar
Kanji
6 String Y Reading’s kanji
Article
7 String Y Reading’s article
UJD 16
UJD_VN | Software requirement specification
Figure 1: Search
UJD 17
UJD_VN | Software requirement specification
Author Tuan NN
Actor:
Summary:
Triggers
Click on search area , input sentences in the text area, choose type of search and
then click “Search” button
Preconditions:
- Website is available
Post Conditions:
- Serial number
- Name of sentences by hiragana
- Name of sentences by romaji
- Meaning of sentences
Alternative Scenario:
UJD 18
UJD_VN | Software requirement specification
Exceptions:
2 Fill data that they want to find Return Error message to in orm that
(that do not exist in database) sentences cannot be found
into these fields then click
“Search” button
Author Tuan NN
UJD 19
UJD_VN | Software requirement specification
Actor:
Summary:
Triggers
Click on search area , input conversation in the text area, choose type of search and
then click “Search” button
Preconditions:
- Website is available
Post Conditions:
- Serial number
- Name of conversation by hiragana
- Name of conversation by romaji
- Meaning of conversation
Alternative Scenario:
UJD 20
UJD_VN | Software requirement specification
Exceptions:
2 Fill data that they want to find Return Error message to inform that
(that do not exist in database) conversation cannot be found
into these fields then click
“Search” button
Author Tuan NN
UJD 21
UJD_VN | Software requirement specification
Actor:
Summary:
Triggers
Click on search area , input grammar in the text area, choose type of search and
then click “Search” button
Preconditions:
- Website is available
Post Conditions:
- Serial number
- Name of grammar by hiragana
- Name of grammar by romaji
- Meaning of grammar
Alternative Scenario:
UJD 22
UJD_VN | Software requirement specification
Exceptions:
2 Fill data that they want to find Return Error message to inform that
(that do not exist in database) grammar cannot be found
into these fields then click
“Search” button
Author Tuan NN
Actor:
Summary:
Triggers
Click on search area , input video in the text area, choose type of search and then
click “Search” button
Preconditions:
- Website is available
UJD 23
UJD_VN | Software requirement specification
Post Conditions:
2 Input data in search area and Display “video information” screen that
choose “Video” type then click contains the information of chosen video
button Search with these elements:
- Serial number
- Name of video by hiragana
- Name of video by romaji
- Meaning of video
Alternative Scenario:
Exceptions:
2 Fill data that they want to find Return Error message to inform that video
(that do not exist in database) cannot be found
into these fields then click
“Search” button
UJD 24
UJD_VN | Software requirement specification
Author Tuan NN
Actor:
Summary:
Triggers
Click on search area , input specialized Japanese in the text area, choose type of
search and then click “Search” button
Preconditions:
- Website is available
Post Conditions:
UJD 25
UJD_VN | Software requirement specification
- Serial number
- Name of specialized Japanese by
hiragana
- Name of specialized Japanese by
romaji
- Meaning of specialized Japanese
Alternative Scenario:
Exceptions:
2 Fill data that they want to find Return Error message to inform that
(that do not exist in database) specialized Japanese cannot be found
into these fields then c ick
“Search” button
UJD 26
UJD_VN | Software requirement specification
UJD 27
UJD_VN | Software requirement specification
UC006 – Login
Author Tuan NN
Actor:
Member, Administrator
Summary:
Triggers
User choose the login method, input data and click on login button
Preconditions:
- Website is available
Post Conditions:
2 Choose login method ( login by Validate information and log user into
Facebook/register account), input system.
account and password and then
UJD 28
UJD_VN | Software requirement specification
Alternative Scenario:
Exceptions:
UC007 – Logout
UJD 29
UJD_VN | Software requirement specification
Author Tuan NN
Actor:
Member, Admin
Summary:
Triggers
Preconditions:
- Website is available
Post Conditions:
UJD 30
UJD_VN | Software requirement specification
UJD 31
UJD_VN | Software requirement specification
characters
Author Tuan NN
Actor:
Guest
UJD 32
UJD_VN | Software requirement specification
Summary:
Visitor can create new account to use more function as a register user
Triggers
Preconditions:
- Website is available
Post Conditions:
Alternative Scenario:
Exceptions:
3 Missing “Tên đăng nhập” field Display error message beside “Tên đăng
and click “Đăng kí” button nhập” field.
UJD 33
UJD_VN | Software requirement specification
3 Missing “Họ và tên” field and Display error message beside “Họ và tên”
click “Đăng kí” button field.
UJD 34
UJD_VN | Software requirement specification
Author Tuan NN
UJD 35
UJD_VN | Software requirement specification
Actor:
Member
Summary:
Triggers
Preconditions:
- Website is available
Post Conditions:
2 Enter necessary and mandatory Redirect to previous page and logged user
information and click "Login” into system.
Alternative Scenario:
Exceptions:
UJD 36
UJD_VN | Software requirement specification
UJD 37
UJD_VN | Software requirement specification
Author Tuan NN
Actor:
Member, Admin
Summary:
When Member, Admin forgot their password to login the system, this function
will receiving their password to email
Triggers
Preconditions:
- Website is available
Post Conditions:
2 Click on “Quên mật khẩu link. Display “Quên mật khẩu” page
3 Enter necessary and mandatory System will send the password into your
information in the “Quên mật email .
khẩu” form and click "Gửi yêu
cầu" button.
Alternative Scenario:
UJD 38
UJD_VN | Software requirement specification
Exceptions:
3 Enter email incorrect with Display error message and request to re-
email that use to register enter email
account
UJD 39
UJD_VN | Software requirement specification
UJD 40
UJD_VN | Software requirement specification
Author Tuan NN
Actor:
Member
Summary:
Triggers
User enter website link and click on “Liên hệ” link on the website
Preconditions:
- Website is available
Post Conditions:
2 Enter necessary and mandatory Redirect to previous page and logged user
information and click "Login” into system.
UJD 41
UJD_VN | Software requirement specification
Alternative Scenario:
Exceptions:
4 Missing “Nhập từ” field and Display error message beside “Nhập từ”
click “Đóng góp” button field.
4 Missing “Loại từ” field and Display error message beside “Loại từ”
click “Đóng góp” button field.
UJD 42
UJD_VN | Software requirement specification
UJD 43
UJD_VN | Software requirement specification
Author Tuan NN
Actor:
Member
Summary:
Triggers
User enter website link and click on “Liên hệ” link on the website
Preconditions:
- Website is available
Post Conditions:
2 Enter necessary and mandatory Redirect to previous page and logged user
information and click "Login” into system.
UJD 44
UJD_VN | Software requirement specification
Alternative Scenario:
Exceptions:
4 Missing “Nhập nội dung:” Display error message beside “Nhập nội
field and click “Đóng góp” dung:” field.
button
UJD 45
UJD_VN | Software requirement specification
UJD 46
UJD_VN | Software requirement specification
Author Tuan NN
Actor:
Member
Summary:
Triggers
Preconditions:
- Website is available
Post Conditions:
2 Enter necessary and mandatory Redirect to previous page and logged user
information and click "Login” into system.
UJD 47
UJD_VN | Software requirement specification
Alternative Scenario:
Exceptions:
UJD 48
UJD_VN | Software requirement specification
Author Tuan NN
Actor:
Member
Summary:
This function will help users do the online quiz and check the answers, grading and
evaluation capabilities
Triggers
User going to website, login and then click on “Kiểm tra” link on the website
UJD 49
UJD_VN | Software requirement specification
Preconditions:
- Website is available
Post Conditions:
2 Enter necessary and mandatory Redirect to previous page and logged user
information and click "Login” into system.
Alternative Scenario:
UJD 50
UJD_VN | Software requirement specification
UJD 51
UJD_VN | Software requirement specification
Author Tuan NN
Actor:
Guest, Member
Summary:
This function provide users some the listening of level N2, N3, N4 to help users
training listening skill
Triggers
User going to website and click on “Luyện nghe” link on the website
Preconditions:
- Website is available
Post Conditions:
UJD 52
UJD_VN | Software requirement specification
Alternative Scenario:
At St p User System
UJD 53
UJD_VN | Software requirement specification
Author Tuan NN
UJD 54
UJD_VN | Software requirement specification
Actor:
Guest, Member
Summary:
This function provide users some the conversation in everyday life and common
situations (eg: restaurants, shopping, in hospital ..)
Triggers
Preconditions:
- Website is available
Post Conditions:
Alternative Scenario:
UJD 55
UJD_VN | Software requirement specification
Author Tuan NN
UJD 56
UJD_VN | Software requirement specification
Actor:
Guest, Member
Summary:
This function provides users some document: elementary, intermediate and review.
Triggers
Preconditions:
- Website is available
Post Conditions:
Alternative Scenario:
UJD 57
UJD_VN | Software requirement specification
UJD 58
UJD_VN | Software requirement specification
Author Tuan NN
Actor:
Admin
Summary:
Triggers
Admin login the website and click on add new admin link on the website
Preconditions:
UJD 59
UJD_VN | Software requirement specification
- Website is available
Post Conditions:
3 Click on add new admin button Display “Add New Admin” screen that
contains these elements:
- Username
- Password
- Roll
- Email
4 Fill test information into all The system validates the input data and
necessary or mandatory fields and then save new test data into database
click “Add” button
Alternative Scenario:
Exceptions:
UJD 60
UJD_VN | Software requirement specification
UJD 61
UJD_VN | Software requirement specification
Author Tuan NN
Actor:
Administrator
Summary:
Triggers
Administrator login the website and click on the edit profile link
Preconditions:
- Website is available
Post Conditions:
UJD 62
UJD_VN | Software requirement specification
3 Click on edit profile tab Display “Edit profile” screen that contains
these elements:
- Username
- Password
- New-Password
- Renew-Password
- Full name
- Email
4 Fill test information into all The system validates the input data and
necessary or mandatory fields and then save new test data into database
click “Add” button
Alternative Scenario:
Exceptions:
UJD 63
UJD_VN | Software requirement specification
Author Tuan NN
Actor:
Administrator
Summary:
Triggers
Preconditions:
- Website is available
Post Conditions:
UJD 64
UJD_VN | Software requirement specification
4 Enter the account that you want to Remove administrator rights of account
remove administrator rights and display message to remove
successfully
Alternative Scenario:
Exceptions:
UJD 65
UJD_VN | Software requirement specification
UJD 66
UJD_VN | Software requirement specification
member
Author Tuan NN
UJD 67
UJD_VN | Software requirement specification
Actor:
Admin
Summary:
Triggers
Admin login the website and click on search member , input member’s account in
the right text box then click “Search” button
Preconditions:
- Website is available
Post Conditions:
- User Name
- Roll
- Ban/Unban
UJD 68
UJD_VN | Software requirement specification
- Status
- Delete
Alternative Scenario:
Exceptions:
Author Tuan NN
UJD 69
UJD_VN | Software requirement specification
Actor:
Admin
Summary:
When admin can ban user who violated rule of website and unban member
Triggers
Admin login the website and click on member’s account and then click
“Ban/Unban” button
Preconditions:
- Website is available
Post Conditions:
Alternative Scenario:
UJD 70
UJD_VN | Software requirement specification
Exceptions:
3 Fill information of the member that Return Error message to inform that
they want to find (that do not exist member cannot be found
in database) into these fields then
click “Search” button
Author Tuan NN
Actor:
Admin
Summary:
Triggers
Admin login the website and click on the delete member link
Preconditions:
- Website is available
UJD 71
UJD_VN | Software requirement specification
Post Conditions:
Alternative Scenario:
Exceptions:
UJD 72
UJD_VN | Software requirement specification
“Search” button
UJD 73
UJD_VN | Software requirement specification
UJD 74
UJD_VN | Software requirement specification
reference of
vocabulary if
reference exist
UC0024 – Specification
Author TuanNN
UJD 75
UJD_VN | Software requirement specification
Actor:
Admin
Summary:
Goal:
Triggers
Admin login the website and click on “Vocabulary management” tab, input
vocabulary in the right text box then click “Search” button
Preconditions:
- Website is available
Post Conditions:
UJD 76
UJD_VN | Software requirement specification
- Meaning
- Category
- Kanji
- Specialized
- Add meaning
- Edit
- Delete
- Add reference
Alternative Scenario:
Exceptions:
UJD 77
UJD_VN | Software requirement specification
UJD 78
UJD_VN | Software requirement specification
UC0025 - Specification
Author Tuan NN
Actor:
Admin
Summary:
When Administrator want to add a vocabulary into database. They have to insert
all necessary data of vocabulary into “Add new vocabulary” screen
Goal:
Triggers
User must click on “Vocabulary management/ Add new” tab and input all
necessary information of vocabulary into the right fields then click on “Add new” button
Preconditions:
- Website is available
- All input data must be valid and have not existed in system
Post Conditions:
UJD 79
UJD_VN | Software requirement specification
- Hiragana
- Romaji
4 Fill information into all necessary The system validates the input data and
or mandatory fields and click then save new vocabulary data into
“Add” button database
- Hiragana
- Romaji
- Meaning
- Category
- Kanji
- Specialized
6 Fill information into all necessary The system validates the input data and
or mandatory fields and click then save new vocabulary data into
“Add” button database
- Vocabulary
- Meaning
- Sentence
8 Choose sentence and click “Add” The system validates the input data and
button then save new vocabulary data into
database
UJD 80
UJD_VN | Software requirement specification
Alternative Scenario:
Exceptions:
4 Do not fill full information Return Error message beside empty field
into fields then click “Add” and ask if user want to add with empty
button field.
6 Do not fill full information Return Error message beside empty field
into fields then click “Add” and ask if user want to add with empty
button field.
8 Do not fill full information Return Error message beside empty field
into fields then click “Add” and ask if user want to add with empty
button field.
UJD 81
UJD_VN | Software requirement specification
UJD 82
UJD_VN | Software requirement specification
UC0026 - Specification
Author TuanNN
Actor:
Admin
Summary:
When Administrator want to edit a vocabulary on database which has some new
meanings or errors
Goal:
Triggers
User must click on “Vocabulary management” then search for the vocabulary. User
click on “Edit” link on corresponding vocabulary. They edit necessary information in the
right fields then click on “Edit” button.
Preconditions:
- Website is available
- All input data must be valid and have not existed in system
Post Conditions:
Changed information of vocabulary has been saved into system database successfully
UJD 83
UJD_VN | Software requirement specification
- Hiragana
- Romaji
- Meaning
- Category
- Kanji
- Specialized
5 Edit vocabulary information and The system validates the input data and
click “Edit” button then save data into database
Alternative Scenario:
Exceptions:
4 Edit vocabulary information to The system validates the input data and
be similar to another existed return Error message and do not save
grammar and click “Edit” edited data into database
UJD 84
UJD_VN | Software requirement specification
button
Reference:
UC0027 - Specification
Author TuanNN
Actor:
Admin
Summary:
Goal:
Triggers
User must click on “Vocabulary management” then search for the vocabulary. User
click on “Delete” link on corresponding vocabulary.
Preconditions:
- Website is available
UJD 85
UJD_VN | Software requirement specification
Post Conditions:
4 Click on “Delete” link beside that Remove that vocabulary from list
vocabulary row
Exceptions:
Reference:
UJD 86
UJD_VN | Software requirement specification
UJD 87
UJD_VN | Software requirement specification
UC0028 - Specification
Author Minh PT
UJD 88
UJD_VN | Software requirement specification
Actor:
Admin
Summary:
Triggers
Click on “Grammar management” tab, input grammatical structure in the right text
box then click “Search” button
Preconditions:
- Website is available
Post Conditions:
UJD 89
UJD_VN | Software requirement specification
- Delete
Alternative Scenario:
Exceptions:
UJD 90
UJD_VN | Software requirement specification
UC0029 - Specification
Author Minh PT
UJD 91
UJD_VN | Software requirement specification
Actor:
Admin
Summary:
When Administrator wants to add a grammar into database. They have to insert all
necessary data of grammar into “Add Grammar” screen then click “Add” button
Triggers
User must click on “Grammar management/ Add New” and input all necessary
information of grammar into the right fields then click on “Add” button
Preconditions:
- Website is available
- All input data must be valid and have not existed in system
Post Conditions:
New grammatical structure has been saved into system database successfully
- Hiragana
- Romaji
- Level
- Meaning
- Use
- Lesson
3 Fill grammar information into all The system validates the input data and
necessary or mandatory fields and then save new grammar data into database
click “Add” button
UJD 92
UJD_VN | Software requirement specification
- Grammar
- Meaning
- Reference
5 Fill grammar information into all The system validates the input data and
necessary or mandatory fields and then save new grammar data into database
click “Add” button
Alternative Scenario:
Exceptions:
3 Do not fill full information Return Error message and request user
into fields then click “Add” input data into all fields
button
5 Do not fill full information Return Error message and request user
into fields then click “Add” input data into all fields
button
UJD 93
UJD_VN | Software requirement specification
UJD 94
UJD_VN | Software requirement specification
UC0030 - Specification
Author Minh PT
Actor:
Admin
Summary:
Triggers
User must click on “Grammar management” then search for the grammatical
structure. User click on “Edit” link corresponding with grammar which want to edit. Users
edit necessary information of grammar in the right fields then click on “Edit” button.
Preconditions:
- Website is available
- All input data must be valid and have not existed in system
UJD 95
UJD_VN | Software requirement specification
Post Conditions:
Changed information of grammar has been saved into system database successfully
- Hiragana
- Romaji
- Level
- Meaning
- Use
- Lesson
4 Edit grammar information and The system validates the input data and
click “Edit” button then save data into database
Alternative Scenario:
Exceptions:
4 Edit grammar information to The system validates the input data and
be similar to another existed return Error message and do not save
grammar and click “Edit” edited data into database
UJD 96
UJD_VN | Software requirement specification
button
Reference:
Author Minh PT
Actor:
Admin
Summary:
When Administrator want to delete a grammar in database. Admin will search that
grammar then click “Delete” link. When deleted finished, that grammar no longer exist in
database.
Triggers
User must click on “Grammar management” then search for the grammatical
structure. User click on “Delete” link corresponding with grammar which want to delete.
Preconditions:
- Website is available
Post Conditions:
UJD 97
UJD_VN | Software requirement specification
UJD 98
UJD_VN | Software requirement specification
UJD 99
UJD_VN | Software requirement specification
UC0032 - Specification
Author Minh PT
UJD 100
UJD_VN | Software requirement specification
Actor:
Admin
Summary:
Triggers
Click on “Reading management” tab, choose level of reading document in the right
text box then click “Search” button
Preconditions:
Post Conditions:
Alternative Scenario:
UJD 101
UJD_VN | Software requirement specification
Exceptions:
UJD 102
UJD_VN | Software requirement specification
100 characters
UJD 103
UJD_VN | Software requirement specification
UJD 104
UJD_VN | Software requirement specification
UC0030 - Specification
Author Minh PT
Actor:
Admin
Summary:
When Administrator want to add new reading document into database. They have
to insert all necessary data of reading document into “Add new reading” screen
Triggers
User must click on “Reading management/ Add new” tab and input all necessary
information of grammar into the right fields then click on “Add new” button
Preconditions:
- All input data must be valid and have not existed in system
Post Conditions:
UJD 105
UJD_VN | Software requirement specification
New reading document has been saved into system database successfully
- Code
- Title
- Level
3 Fill reading document The system validates the input data and
information into all necessary or then save new reading document data into
mandatory fields and click “Add ” database
button
- Hiragana
- Meaning
- Kanji
- Type
5 Fill reading document The system validates the input data and
information into all necessary or then save new reading document data into
mandatory fields and click “Add ” database
button
- Content
- Question
- Answer
- Meaning
7 Fill reading document The system validates the input data and
information into all necessary or then save new reading document data into
mandatory fields and click “Add ” database
button
UJD 106
UJD_VN | Software requirement specification
Alternative Scenario:
Exceptions:
3 Do not fill full information Return Error message beside empty field
into fields then click “Add and ask if user want to add with empty
new” button field.
5 Do not fill full information Return Error message beside empty field
into fields then click “Add and ask if user want to add with empty
new” button field.
7 Do not fill full information Return Error message beside empty field
into fields then click “Add and ask if user want to add with empty
new” button field.
UJD 107
UJD_VN | Software requirement specification
UJD 108
UJD_VN | Software requirement specification
UJD 109
UJD_VN | Software requirement specification
UJD 110
UJD_VN | Software requirement specification
UC0034 - Specification
Author Minh PT
Actor:
Admin
Summary:
When Administrator want to edit reading document on database which has some
new meanings or errors
Triggers
User must click on “Reading management” then search for the reading document.
User click on “Edit” link to corresponding reading document. They edit necessary
information of reading document in the right fields then click on “Edit” button.
Preconditions:
- All input data must be valid and have not existed in system
Post Conditions:
Changed information of reading document has been saved into system database
successfully
UJD 111
UJD_VN | Software requirement specification
- Code
- Title
- Level
4 Edit reading document The system validates the input data and
information and click “Edit” then save data into database
button
- Hiragana
- Meaning
- Kanji
- Type
6 Edit reading document The system validates the input data and
information and click “Edit” then save data into database
button
- Content
- Question
- Answer
- Meaning
8 Edit reading document The system validates the input data and
information and click “Edit” then save data into database
button
UJD 112
UJD_VN | Software requirement specification
Alternative Scenario:
4 Edit reading information then Do not save edited data then redirect to
click to another link selected page
6 Edit reading information then Do not save edited data then redirect to
click to another link selected page
8 Edit reading information then Do not save edited data then redirect to
click to another link selected page
Exceptions:
4 Edit reading information to The system validates the input data and
be similar to another existed return Error message and do not save
reading and click “Edit” edited data into database
button
6 Edit reading information to The system validates the input data and
be similar to another existed return Error message and do not save
reading and click “Edit” edited data into database
button
8 Edit reading information to The system validates the input data and
be similar to another existed return Error message and do not save
reading and click “Edit” edited data into database
button
Reference:
UJD 113
UJD_VN | Software requirement specification
UC0035 - Specification
Author Minh PT
Actor:
Admin
Summary:
Triggers
User must click on “Reading management” then search for the reading document.
User click on “Delete” link on corresponding reading document.
Preconditions:
Post Conditions:
UJD 114
UJD_VN | Software requirement specification
3 Click on “Delete” link beside that Displays pop up to confirm if they really
reading document row want to remove that reading document
4 Click “Yes” button on popup Closes the popup then remove that
reading document name from reading list
Alternative Scenario:
4 Click close icon of the popup Only closes the popup, does not remove
that reading document
Exceptions:
4 Click “Cancel” button on Only closes the popup, does not remove
popup that reading document
Reference:
UJD 115
UJD_VN | Software requirement specification
UJD 116
UJD_VN | Software requirement specification
search conversation
UJD 117
UJD_VN | Software requirement specification
UC0036 - Specification
Author Minh PT
UJD 118
UJD_VN | Software requirement specification
Actor:
Admin
Summary:
Triggers
Preconditions:
- Website is available
Post Conditions:
UJD 119
UJD_VN | Software requirement specification
Alternative Scenario:
Exceptions:
UJD 120
UJD_VN | Software requirement specification
1 Title
UJD 121
UJD_VN | Software requirement specification
UC0037 - Specification
Author Minh PT
Actor:
Admin
Summary:
When Administrator wants to add new conversation into database. They have to
insert all necessary data of conversation into “Add Conversation” screen
Triggers
User must click on “Conversation management/ Add New” and input all necessary
UJD 122
UJD_VN | Software requirement specification
information of conversation into the right fields then click on “Add” button
Preconditions:
- Website is available
- All input data must be valid and have not existed in system
Post Conditions:
- Title
- Level
- Image
3 Fill conversation information into The system validates the input data and
all necessary or mandatory fields then save new conversation data into
and click “Add” button database
5 Fill conversation information into The system validates the input data and
all necessary or mandatory fields then save new conversation data into
and click “Add” button database
UJD 123
UJD_VN | Software requirement specification
Alternative Scenario:
Exceptions:
3 Do not fill full information Return Error message and request user
into fields then click “Add” input data into all fields
button
5 Do not fill full information Return Error message and request user
into fields then click “Add” input data into all fields
button
UJD 124
UJD_VN | Software requirement specification
UJD 125
UJD_VN | Software requirement specification
UJD 126
UJD_VN | Software requirement specification
5000 characters
UC0038 - Specification
Author Minh PT
Actor:
Admin
Summary:
When Administrator want to edit conversation in database which has some new
meanings or errors. When edit finished, new meaning will be updated
Triggers
User must click on “Conversation management” then search for the conversation.
User click on “Edit” link on corresponding conversation. They edit necessary information
of conversation in the right fields then click on “Edit” button.
Preconditions:
- Website is available
- All input data must be valid and have not existed in system
UJD 127
UJD_VN | Software requirement specification
Post Conditions:
- Title
- Level
- Image
4 Edit conversation information and The system validates the input data and
click “Edit” button then save data into database
- Sub-title
- Hiragana
- Romaji
- Meaning
- File
6 Edit conversation content The system validates the input data and
information and click “Edit” then save data into database
button
Alternative Scenario:
UJD 128
UJD_VN | Software requirement specification
4 Edit conversation then click to Do not save edited data then redirect to
another link selected page
6 Edit conversation content then Do not save edited data then redirect to
click to another link selected page
Exceptions:
6 Click “Edit” button The system validates the input data and
return Error message and do not save
edited data into database
Reference:
Author Minh PT
UJD 129
UJD_VN | Software requirement specification
Actor:
Admin
Summary:
Triggers
User must click on “Conversation management” then search for the conversation.
User click on “Delete” link on corresponding conversation.
Preconditions:
- Website is available
Post Conditions:
Exceptions:
UJD 130
UJD_VN | Software requirement specification
Reference:
UJD 131
UJD_VN | Software requirement specification
UJD 132
UJD_VN | Software requirement specification
UC0040 - Specification
Author Minh PT
Actor:
Admin
Summary:
When Administrator wants to search video in database. User input title of video
then click “Search” button
Triggers
Click on “Video management” tab, input title of video in the right text box then
click “Search” button
Preconditions:
- Website is available
Post Conditions:
UJD 133
UJD_VN | Software requirement specification
3 Fill information of the video that Displays search result as a table with
they want to find into these fields these elements:
then click “Search” button
- No
- Title
- Link
- Edit
- Delete
Alternative Scenario:
Exceptions:
3 Fill information of the video Return Error message to inform that video
that they want to find (that do cannot be found
not exited in database) into
these fields then click
“Search” button
UJD 134
UJD_VN | Software requirement specification
UC0041 - Specification
Author Minh PT
Actor:
Admin
Summary:
When Administrator wants to add new video into database. They have to insert all
necessary data of video into “Add Video” screen
Triggers
User must click on “Video management/ Add New” tab and input all necessary
information of video into the right fields then click on “Add” button
Preconditions:
- Website is available
UJD 135
UJD_VN | Software requirement specification
- All input data must be valid and have not existed in system
Post Conditions:
- Title
- Link
3 Fill video information into all The system validates the input data and
necessary or mandatory fields and then save new video data into database
click “Add” button
Alternative Scenario:
3 Click on another link Do not save new video data into database
then redirect to selected page
Exceptions:
3 Do not fill full information Return Error message and request user
into fields then click “Add” input data into all fields
button
UJD 136
UJD_VN | Software requirement specification
UC0042 - Specification
Author Minh PT
Actor:
Admin
Summary:
When Administrator wants to edit video in database which has some new meanings
or errors. When edit finished, new meaning will be updated
UJD 137
UJD_VN | Software requirement specification
Triggers
User must click on “Video management” then search for the video. User click on
“Edit” link corresponding with video. User edits necessary information of video in the right
fields then click on “Edit” button.
Preconditions:
- Website is available
- All input data must be valid and have not existed in system
Post Conditions:
Changed information of video has been saved into system database successfully
- Title
- Link
4 Edit video information and click The system validates the input data and
“Edit” button then save data into database
Alternative Scenario:
4 Edit video then click to Do not save edited data then redirect to
another link selected page
UJD 138
UJD_VN | Software requirement specification
Exceptions:
4 Edit video to be similar The system validates the input data and
to another existed video return Error message and do not save
and click “Edit” button edited data into database
Reference:
Author Minh PT
Actor:
Admin
Summary:
Triggers
User must click on “Video management” then search for the video. User click on
“Delete” link on corresponding video.
Preconditions:
- Website is available
Post Conditions:
UJD 139
UJD_VN | Software requirement specification
Reference:
UJD 140
UJD_VN | Software requirement specification
UJD 141
UJD_VN | Software requirement specification
UC0044 - Specification
Author Minh PT
UJD 142
UJD_VN | Software requirement specification
Actor:
Admin
Summary:
When Administrator wants to search listening article in database. User choose level
of listening level then click “Search” button
Triggers
Click on “Listening practice management” tab, choose level in the right text box
then click “Search” button
Preconditions:
- Website is available
Post Conditions:
Alternative Scenario:
UJD 143
UJD_VN | Software requirement specification
Exceptions:
UJD 144
UJD_VN | Software requirement specification
UJD 145
UJD_VN | Software requirement specification
UC0045 - Specification
Author Minh PT
Actor:
Admin
Summary:
When Administrator wants to add new listening article into database. They have to
insert all necessary data of listening article into “Add new listening” screen
Triggers
User must click on “Listening management/ Add New” and input all necessary
information of listening article into the right fields then click on “Add” button
Preconditions:
- Website is available
- All input data must be valid and have not existed in system
Post Conditions:
UJD 146
UJD_VN | Software requirement specification
New listening article has been saved into system database successfully
- Title
- Level
3 Fill listening article information The system validates the input data and
into all necessary or mandatory then save new listening article data into
fields click “Add” button database
Alternative Scenario:
3 Click on another link Do not save new listening article data into
database then redirect to selected page
5 Click on another link Do not save new source file data into
database then redirect to selected page
Exceptions:
UJD 147
UJD_VN | Software requirement specification
3 Do not fill full information Return Error message and request user
into fields then click “Add” input data into all fields
button
5 Do not fill full information Return Error message and request user
into fields then click “Add” input data into all fields
button
UJD 148
UJD_VN | Software requirement specification
UJD 149
UJD_VN | Software requirement specification
UC0046 - Specification
Author Minh PT
Actor:
Admin
Summary:
When Administrator wants to edit listening article in database which has some new
meanings or errors. When edit finished, new meaning will be updated
Triggers
User must click on “Listening management” then search for the listening article.
User click on “Edit” link corresponding with listening article. They edit necessary
information of listening article in the right fields then click on “Edit” button.
Preconditions:
- Website is available
- All input data must be valid and have not existed in system
Post Conditions:
UJD 150
UJD_VN | Software requirement specification
Changed information of listening article has been saved into system database
successfully
- Title
- Level
4 Edit listening article information The system validates the input data and
and click “Edit” button then save data into database
5 Click on “View details/ Edit” link Display “Edit listening” screen that
corresponding contains the information of chosen
listening article with these elements:
- File
- Question
- Script
- Meaning
- Answer
6 Edit listening article information The system validates the input data and
and click “Edit” button then save data into database
Alternative Scenario:
4 Edit listening article then click Do not save edited data then redirect to
to another link selected page
UJD 151
UJD_VN | Software requirement specification
6 Edit listening article then click Do not save edited data then redirect to
to another link selected page
Exceptions:
4 Edit listening article to be The system validates the input data and
similar to another existed return Error message and do not save
listening article click “Edit” edited data into database
button
6 Edit listening article to be The system validates the input data and
similar to another existed return Error message and do not save
listening article click “Edit” edited data into database
button
Reference:
Author Minh PT
UJD 152
UJD_VN | Software requirement specification
Actor:
Admin
Summary:
Triggers
User must click on “Listening article management” then search for the listening
article. User click on “Delete” link corresponding with listening article.
Preconditions:
- Website is available
Post Conditions:
Reference:
UJD 153
UJD_VN | Software requirement specification
UJD 154
UJD_VN | Software requirement specification
test
UC0048 - Specification
Author Minh PT
UJD 155
UJD_VN | Software requirement specification
Actor:
Admin
Summary:
When Administrator wants to search test article in database. User choose test level
then click “Search” button.
Triggers
Click on “Test management” tab, choose level in the right text box then click
“Search” button
Preconditions:
- Website is available
Post Conditions:
3 Choose level of the test that they Displays search result as a table with
want to find then click “Search” these elements:
button
- No
- Title
- Category
- Level
- Content
- Edit
- Delete
Alternative Scenario:
UJD 156
UJD_VN | Software requirement specification
Exceptions:
3 Choose level of the test that Return Error message to inform that test
they want to find (that do not cannot be found
exited in database) into these
fields then click “Search”
button
UJD 157
UJD_VN | Software requirement specification
characters
UJD 158
UJD_VN | Software requirement specification
UC0049 - Specification
Author Minh PT
UJD 159
UJD_VN | Software requirement specification
Actor:
Admin
Summary:
When Administrator want to add new test into database. They have to insert all
necessary data of test into “Add new test” screen
Triggers
User must click on “Test management/ Add New” and input all necessary
information of test into the right fields then click on “Add” button
Preconditions:
- Website is available
- All input data must be valid and have not existed in system
Post Conditions:
- Title
- Category
- Level
- Content
3 Fill test information into all The system validates the input data and
necessary or mandatory fields and then save new test data into database
click “Add” button
4 Click on “Title link/Add new Display “Add New Question” screen that
question” contains these elements:
- Title
UJD 160
UJD_VN | Software requirement specification
- Question
- Answer 1
- Correct answer 1
- Answer 2
- Correct answer 2
- Answer 3
- Correct answer 3
- Answer 4
- Correct answer 4
5 Fill test information into all The system validates the input data and
necessary or mandatory fields and then save new test data into database
click “Add” button
Alternative Scenario:
3 Click on another link Do not save new test data into database
then redirect to selected page
Exceptions:
3 Do not fill full information Return Error message and request user
into fields then click “Add” input data into all fields
button
5 Do not fill full information Return Error message and request user
into fields then click “Add” input data into all fields
button
UJD 161
UJD_VN | Software requirement specification
UJD 162
UJD_VN | Software requirement specification
UJD 163
UJD_VN | Software requirement specification
UC0050 - Specification
Author Minh PT
Actor:
Admin
Summary:
When Administrator want to edit test in database that has some new meanings or
errors. When edit finished, new meaning will be updated
Triggers
User must click on “Test management” then search for the test. User click on
“Edit” link on corresponding test. User edits necessary information of test in the right fields
UJD 164
UJD_VN | Software requirement specification
Preconditions:
- Website is available
- All input data must be valid and have not existed in system
Post Conditions:
Changed information of test has been saved into system database successfully
- Title
- Category
- Level
- Content
4 Edit test information and click The system validates the input data and
“Edit” button then save data into database
Alternative Scenario:
4 Edit test then click to another Do not save edited data then redirect to
link selected page
UJD 165
UJD_VN | Software requirement specification
Exceptions:
Reference:
Author Minh PT
Actor:
Admin
Summary:
Triggers
User must click on “Test management” then search for the test. User click on
“Delete” link corresponding with test.
Preconditions:
- Website is available
Post Conditions:
UJD 166
UJD_VN | Software requirement specification
Reference:
UJD 167
UJD_VN | Software requirement specification
UC0055 – Specification
Author Minh PT
UJD 168
UJD_VN | Software requirement specification
Actor:
Admin
Summary:
When administrator wants to search question from member. User choose data then
click “Search” button.
Triggers
Click on “Contact Management ” tab, choose type of data in the right text box then
click “Search” button
Preconditions:
- Website is available
Post Conditions:
3 Choose type of contact that they Displays search result as a table with
want to find then click “Search” these elements:
button
- No
- Content
- Type
UJD 169
UJD_VN | Software requirement specification
- Status
- Reply
- Delete
Alternative Scenario:
Exceptions:
3 Fill information that they want Return Error message to inform that
to find (that do not exited in cannot be found
database) into these fields then
click “Search” button
UJD 170
UJD_VN | Software requirement specification
2 Content Question
UC0056 - Specification
Author Minh PT
UJD 171
UJD_VN | Software requirement specification
Actor:
Admin
Summary:
Triggers
Preconditions:
- Website is available
Post Conditions:
- Content
- Reply
4 Input the answer and click The answer of question will be sent to
“Reply” button member
UJD 172
UJD_VN | Software requirement specification
Alternative Scenario:
Exceptions:
Reference:
Author Minh PT
UJD 173
UJD_VN | Software requirement specification
Actor:
Admin
Summary:
Triggers
User must click on “Contact management” then search for the test. User click on
“Delete” link corresponding with test.
Preconditions:
- Website is available
Post Conditions:
Reference:
UJD 174
UJD_VN | Software requirement specification
UJD 175
UJD_VN | Software requirement specification
UJD 176
UJD_VN | Software requirement specification
UJD 177
UJD_VN | Software requirement specification
UJD 178
UJD_VN | Software requirement specification
UC0053 - Specification
Author Minh PT
Actor:
Admin
Summary:
Triggers
UJD 179
UJD_VN | Software requirement specification
Preconditions:
- Website is available
- All input data must be valid and have not existed in system
Post Conditions:
UJD 180
UJD_VN | Software requirement specification
- Approved
2. Grammar:
- Hiragana
- Romaji
- Level
- Meaning
- Use
- Lesson
- Approved
3. Vocabulary:
- Hiragana
- Romaji
- Meaning
- Category
- Kanji
- Specialized
- Approved
5 Edit or add more information and The system validates the input data and
Click “Approved” button then save data into database
Alternative Scenario:
Exceptions:
5 Fill information that exited in Return Error message to inform that data
database into fields then click is exiting in database
“Approved” button
Reference:
1.6.15.2.2 UC0056: < Contact’s content Management > Delete contribute content
UJD 181
UJD_VN | Software requirement specification
UC0054 - Specification
Author Minh PT
Actor:
Admin
Summary:
When Administrator wants to delete a contribute content. Admin will search that
content then click “Delete” link corresponding.
Triggers
Preconditions:
- Website is available
Post Conditions:
UJD 182
UJD_VN | Software requirement specification
Management ” tab
Reference:
1.7.1 Reliability
- Mean time between failures: The mean time between each failure is expected to be
about 480 hours of using.
- Mean time to repair: Immediately when Administrator finds out problem or website is
attacked/hacked by someone. Average 1 day.
- The maximum bugs per function are 2 bugs/a function when user uses software
within 2 months. The average number of bugs in the software during system testing is
about to be around 1 bugs/1000 LOC.
- The database must be backed up daily and can be recovered if necessary
1.7.2.1 Availability
The application must be available 95% of time. Users can access to it everywhere from their
Web browser with internet connection.
UJD 183
UJD_VN | Software requirement specification
● Text: All texts bases on Helvetica style and title or label will use upper case with the first
letter.
1.7.4 Maintainability
- Coding standards and naming conventions
Output of the project must include coding standards and naming conventions
documentations. Implementation code must be easy to maintain.
All code must be clearly commented, including class, method documentations.
If some components are reused, the documentations of those components must
also be included.
- Design
The design of the system must be loosely coupled that chances on some module
will not affect others.
- Logging
All the errors should be logged, supporting for bug fixing and maintenance.
All strange or sensitive situations should also be logged.
1.7.5 Usability
Usability Requirements support the following from the perspective of its primary users:
● Efficiency of use: user can complete each function in less than 12 actions
● Intuitiveness: all help/error messages are simple to understand; user can know exactly
how to do each feature after one time using it.
UJD 184