discussion nest website software requirement specification

b.Screen Detail For Admin # Feature Screen Description 1 Log in Log in Allow admin to login the web application by entering right username and password 2 Sign up Sign up Allow admin t

Discussion Nest Website

Software Requirement Specification

– CanTho, November 2023 –

RECORD OF CHANGES

Date A* M,

D

3/Oct A KhangTNT Added screen flow and screen details

3/Oct A DuongNH Added functional requirements

4/Oct A ThuanLM Added introduction

4/Oct A KhangTNT Added entity relationship diagram

17/Oct M KhangTNT Modified screen flow and screen details

17/Oct M DuongCDQ Modified entity relationship diagram

17/Oct M DuongNH Modified functional requirements

5/Nov M KhangTNT Modified screen flow and screen details

5/Nov M DuongCDQ Modified introduction

5/Nov M KhangTNT Modified entity relationship diagram

5/Nov M KhangTNT Modified context diagram

5/Nov A ThuanLM Added User Authorization

5/Nov A ThuanLM Added Non-screen functions

5/Nov M DuongNH Modified functional requirements

*A - Added M - Modified D - Deleted

Table Of Content

I.Overview 5

1.Introduction 5

2 System Functions 7

a.Screen Flow For Admin 7

b.Screen Detail For Admin 8

c.Screen Flow for User 11

d.Screen Detail For User 12

e.Screen Flow For Guest 15

f.Screen Detail For Guest 16

g User Authorization 16

3 Entity Relationship Diagram 22

II Functional Requirements 26

I.Overview

1.Introduction

Pointhub is an interactive online platform that aims to solve the common difficulties that developers and programmers face in their daily work Serving as an essential resource in the tech community, Pointhub plays a critical role in connecting a diverse group of individuals, ranging from beginners in coding to experienced software engineers, in their quest to gain and share knowledge related to software development

Figure : Context Diagram

2 System Functions

a.Screen Flow For Admin

Figure : Screen Flow For Admin

b.Screen Detail For Admin

# Feature Screen Description

1 Log in Log in Allow admin to login the web application by entering right username and password

2 Sign up Sign up Allow admin to create an account in the web application, they have to enter some of their personal information

3 Home Home Displays a list of questions, the top 5 popular users, allows users to search for questions by title or content, filter

questions by topic, and provides pagination for convenient navigation

4 Admin profile Profile Displays comprehensive information about the user's activity details, social media accounts, about, user's posts,

user's followers, user's bookmarks

5 List user User List View of all registered users in the web and can delete user

6 Search user User List Feature is a specialised search functionality designed for administrators or moderators of a forum or community

platform by name

7 Delete user User List Provides administrators or users with appropriate privileges the ability to permanently remove a user account

from the forum It's a vital feature for managing user accounts, particularly in cases of violations or account closure requests

8 My question Profile Displays a list of questions created

9 My Question

detail

Question detail This page displays the details of a question created by the user, including the title, content, comments, and related

activities and delete question

10 Delete my

Question

Question detail Allows users to remove a question that they have previously posted on the forum This feature provides users

with the ability to manage and maintain the content they have contributed to the community

11 Question detail Question detail This page displays the details of a question including the title, content, comments, and related activities and

report, bookmarks

question community guidelines, contains inappropriate content, or requires attention

13 Rate question Question detail Allows users to provide feedback on the quality or relevance of a specific question by like or dislike button

14 Bookmark list Profile Accessible from the user's profile, enables users to save and keep track of specific questions that they find

interesting or want to revisit later

15 Follow user Profile Shows a list of all other users following this account

16 Search

question

Home Provides users with a search bar to find specific questions by entering keywords, titles, or content This feature

assists users in quickly locating relevant topics within the forum

17 List ordered

question

Home Organises questions in a specified order or sequence based on topic It allows users to view questions in a

customised order

18 Add comment Question detail Allows users to participate in discussions by providing comments on a specific question Users can share their

thoughts, insights, or additional information related to the question

19 All comment Question detail This page displays all the comments on a specific question

20 Comment

detail

Question detail Displays the details of a specific comment on a question, including its content and information about the

comment's creator and can rate the comment

21 Report

comment

Question detail Allows users to report specific comments that they believe violate community guidelines, contain inappropriate

content, or require attention

22 Replies

comment

Question detail Allows users to view and access replies or responses to a specific comment within a question's discussion thread

It facilitates the reading of threaded conversations

23 Rate comment Question detail Enables users to provide feedback on individual comments by assigning a rating based on the comment's quality,

relevance, or helpfulness by like or dislike button

c.Screen Flow for User

Figure : Screen Flow For User

d.Screen Detail For User

# Feature Screen Description

1 Log in Log in Allow user to login the web application by entering right username and password

2 Sign up Sign up Allow user to create an account in the web application, they have to enter some of their personal information

3 Home Home Displays a list of questions, the top 5 popular users, allows users to search for questions by title or content, filter

questions by topic, and provides pagination for convenient navigation

4 My profile User profile Displays comprehensive information about the user's activity details, social media accounts, about, user's posts,

user's followers, user's bookmarks

5 Add question Ask question This page allows users to post new questions Users need to provide a title and content according to form for

their questions

6 List question Home Displays all questions in the site in order of newest

7 My question User profile Displays a list of questions created by the user

8 My Question

detail

Question detail This page displays the details of a question created by the user, including the title, content, comments, and related

activities and delete question

9 Delete my

Question

Question detail Allows users to remove a question that they have previously posted on the forum This feature provides users

with the ability to manage and maintain the content they have contributed to the community

10 Question detail Question detail This page displays the details of a question including the title, content, comments, and related activities and

report, bookmarks

11 Report question Question detail Enables users to notify forum moderators or administrators about a specific question that they believe violates

community guidelines, contains inappropriate content, or requires attention

13 Bookmark list Profile Accessible from the user's profile, enables users to save and keep track of specific questions that they find

interesting or want to revisit later

14 Follow user Profile Shows a list of all other users following this account

15 Search question Home Provides users with a search bar to find specific questions by entering keywords, titles, or content This feature

assists users in quickly locating relevant topics within the forum

16 List ordered

question

Home Organises questions in a specified order or sequence based on topic It allows users to view questions in a

customised order

17 Add comment Question detail Allows users to participate in discussions by providing comments on a specific question Users can share their

thoughts, insights, or additional information related to the question

18 All comment Question detail This page displays all the comments on a specific question

19 Comment detail Question detail Displays the details of a specific comment on a question, including its content and information about the

comment's creator and can rate the comment

20 Report

comment

Question detail Allows users to report specific comments that they believe violate community guidelines, contain inappropriate

content, or require attention

21 Replies

comment

Question detail Allows users to view and access replies or responses to a specific comment within a question's discussion thread

It facilitates the reading of threaded conversations

22 Rate comment Question detail Enables users to provide feedback on individual comments by assigning a rating based on the comment's quality,

relevance, or helpfulness by like or dislike button

23 User profile Profile Displays comprehensive information about an individual forum user It provides a detailed overview of a user's

activity, social media accounts, about section, user posts, user followers

e.Screen Flow For Guest

Figure : Screen Flow For Guest

f.Screen Detail For Guest

# Feature Screen Description

1 Overview

Question

Overview Question

Allow guest can see all question without login

2 Question Detail Question Detail Allow guest can see detail of question

3 Register Register Allow guest register to become a user of website modify , create and comment question

4 Login Login Allow guest login into home page and do some trigger such as create, modify,question and comment

o Function Details: Authenticate the user's login credentials and verify that they are the author of the question, granting them access to the delete function Process the user's request to delete their own question by confirming their intention Remove the specified question from the application's database, ensuring that it is

no longer accessible to users

18 Delete other user question

o Function trigger:

Navigation path: /delete-question

Event: The feature is initiated when an administrator logs in, navigates to a question, and clicks on the “Delete” button to remove a question authored by another user

o Function description:

Actors/Role: Admin

Data Processing: The administrator selects a specific question authored by another user for deletion The system permanently removes the specified question from the “questions” table in database, ensuring

it is no longer accessible to users

Purpose: Empower administrators to moderate and manage content within the application by deleting questions authored by other users

o Screen layout: Question Detail

o Function Details: The administrator selects a specific question authored by another user for deletion The system permanently removes the specified question from the application's database, ensuring it is no longer accessible to users

19 Bookmark question

o Function trigger:

Navigation path: /bookmark-question

Event: The feature is initiated when a user is logged in and clicks on the "Bookmark" button associated with a specific question they want to save for later reference

o Function description:

Actors/Role: User/Admin

Data Processing: Process the user's request to bookmark a specific question by recording their choice to save the question for later Store the information about the bookmarked question in the user's profile, associating it with their account

o Purpose: Allow users to save questions for later reference, making it easier for them to revisit questions of interest

o Screen layout: User Profile

o Function Details: Process the user's request to bookmark a specific question by recording their choice to save the question for later Store information about the bookmarked question in the user's profile, creating a record that associates the question with the user's account

20 Follow user

o Function trigger:

Navigation path: /follow-user

Event: The feature is initiated when a user is logged in and clicks on the "Follow" button associated with another user profile

o Function description:

Actors/Role: User/Admin

Data Processing: Process the follower's request to follow another user, recording their choice to follow Establish a relationship between the follower and the followed user, indicating that the follower is following the other user

o Purpose: Enable users to establish a connection with other users by following their profiles

o Screen layout: User Profile

o Function Details: Process the follower's request to follow another user, recording their choice to follow Establish a relationship between the follower and the followed user, indicating that the follower is following the other user

21 Unfollow user

o Function trigger:

Navigation path: /follow-user

Event: The feature is initiated when a user, who is logged in, clicks on the "Following" button associated with another user they are currently following on their profile

o Function description:

Actors/Role: User/Admin

Data Processing: Process the follower's request to unfollow another user, removing the relationship between them as follower and followed user

o Purpose: Allow users to terminate their connection with other users by unfollowing their profiles

o Screen layout: User Profile

o Function Details: Process the follower's request to unfollow another user, removing the relationship between them as follower and followed user

22 Like and dislike reply

o Function trigger:

§ Navigation path: /like-reply, /dislike-reply

§ Event: The feature is initiated when a user, who is logged in, interacts with a reply to a post or

comment, clicks on the "Like" or "Dislike" icon associated with the reply

o Function description:

§ Actors/Role: User/Admin

§ Data Processing: Process the user's request to either like or dislike a reply, recording their choice and updating the reply's rating Update the rating or score of the reply based on the user's action (like or dislike)

o Purpose: allow users to express their opinion on replies by either liking or disliking them

o Screen layout: Question Detail