# [CS304] Requirement Analysis Report

## Project Name: JUST-SAY-IT

## Project Member

| Name | SID |
| ------ | -------- |
| 黄慧惠 | 12010336 |
| 王思懿 | 12010339 |
| 张嘉浩 | 12010423 |
| 安钧文 | 12012109 |
| 孙锐 | 12012308 |

## 1. Overview

### 1.1 Motivation and Background

The school forum is an important platform that allows students, faculty members, and everyone who cares about SUSTech to come together and **discuss various issues related to the school**. The purpose of the forum is to create an environment where everyone can **share their thoughts, ideas, and concerns** about the school. By doing so, we can work together to make our school a better place for everyone.

- Increased student engagement
When students feel that their voices are heard and that their ideas are valued, they are more likely to engage in school-related activities and take an active role in their own learning.
- Improved school culture
By fostering an environment where students can share their thoughts and ideas, schools can create a more inclusive and collaborative school culture.

### 1.2 Target User or Clients Characteristics

The target users of our school forum are members of the school community, including students, staffs and anyone who cares about SUSTech.

Characteristics of Students

- Interested in connecting with peers and discussing school-related topics
- Active learners who are curious and eager to learn

Characteristics of Staffs

- Passionate about teaching and supporting student learning
- Experienced in their subject areas and knowledgeable about school policies

### 1.3 Project Scope

The system is designed to be bounded within a **forum system** in which users can perform regular forum actions such as **post messages** and **reply to threads**. The system should also allow user **account management**, where users can manage and customize their account details. Additionally, the system should contain **specifications that tailor to the target users** (i.e., SUSTech students and teachers), for example, allow CAS login and SUSTech related sub-forums (e.g., SUSTech diners, SUSTech courses, etc.).

### 1.4 Overall Goal

We aim to develop a **Reddit-like forum website** on which the users could exchange information and communicate conveniently and efficiently. Users could navigate to **different spaces** in the forum, such as exchanging graduate application and sharing SUSTech course information, so that they could find the information they need with ease. In order to promote the quality of each thread, user could **upvote or downvote each thread**, thus the better quality threads could be seen by more users.

Each user is able to **customize their account information**, for instance, avatar and username.

We also plan to implement a simplified version of our website on **WeChat applets**, so that the users could check out the forum wherever they are and whenever they want.

## 2. Development Process

### 2.1 Process Models

The type of process to be followed is **Kanban**.

Reasons for choosing kanban:
- Visualization: Kanban emphasizes the visualization of project workflows and visualization can help improve efficiency and quality.
- Limited Work-in-progress(WIP): 5
- Flexibility: During the development process, we will continue to adjust requirements and priorities of project according to the feedback based on general features, like adding tasks constantly to the backlog.

### 2.2 Project Schedule


Project manager: 安钧文
Business manager: 黄慧惠
Technical architect: 孙锐，王思懿，张嘉浩


## 3. Suggested Deliverables

### 3.1 Milestone 2 Deliverable

Complete a forum with the following basic functions:

- Account management: user registration and login functionality; favorite posts; Different levels of user access
- Different spaces of forums for users to post(with basic post interaction functionalities including upvoting, downvoting, favorite, comment)
- A search function to allow users to find specific information quickly and easily

### 3.2 Milestone 3 Deliverable

The following features can be added to improve our project

- Privacy handling: users can choose to post anonymously to protect their privacy
- More detailed account management features can be added: private chat system; remind the user if new comments/likes/private messages received
- A file-sharing system for users to share resources among others; A StackOverFlow-like code block can be added in post for more convenient code sharing
- Post recommendation system at homepage(optional, can simply sort posts by "newest" & "hottest")
- Word cloud to show the public's concern vividly
- Improve specific spaces like “Studying Abroad" with more detailed features. For instance, we can provide a utility tool to assist users filter universities and achieve information about different universities' programs
- A Wechat applet will also be set up, with most of the website features implemented

## 4. Requirements

### 4.1 Functional Requirements
#### 4.1.1 Functional Requirement 1

Input: keywords provided by the user in the search box

Processing: find posts containing keywords

Output: posts containing keywords

Description: The system should provide a keyword search service

#### 4.1.2 Functional Requirement 2

Input: Users click on the “space selection button”

Processing: Filter posts belonging to the corresponding space

Output: Output posts belonging to the corresponding space

Description: The system should provide different forum spaces and display the content of different spaces

#### 4.1.3 Functional Requirement 3

Input: The user provides an account and password to log in, or click the Favorites button.

Processing: The system adds the user's operation to the corresponding database.

Output: Display "successful operation" or "failed operation"

Description: Each user will have an account. The system provides "Register", "Login", "Favorite Posts" and other functions for each account.

#### 4.1.4 Functional Requirement 4

Input: The user edits the post content and taps the "Publish/Cancel" button

Processing: The system records the published post to the database

Output: Display the published posts in the page

Description: The system allows the user to publish different types of content.

#### 4.1.5 Functional Requirement 5

Input: Click on the "Anonymous" button when publishing

Processing: The system records the user's choice of whether to be anonymous or not, and determines whether to display the user based on that choice when displaying the post.

Output: Whether the account that published the post is shown as anonymous or not

Description:The system allows users to be anonymous.

#### 4.1.6 Functional Requirement 6

Input: User's operation in WeChat mini program

Processing: Implement the same functions as the web page

Output: Display the page similar to the web page

Description: Users can use WeChat mini program

#### 4.1.7 Functional Requirement 7 (optional)

Input:The user chooses who to chat with privately, and the content entered by user A

Processing: The system sends the content to another user B

Output: The system prompts user B and displays the private chat content.

Description:The system allows user A to chat privately with user B.

#### 4.1.8 Functional Requirement 8 (optional)

Input: Each click and favorite of the user

Processing: The system calculates the user's feature vector and analyzes the user's preferences

Output: The system displays the posts with high overlap with the user's feature vector

Description: The system automatically recommends content of interest to the user

### 4.2 Non-Functional Requirements

#### 4.2.1 Quality requirements

##### 4.2.1.1 Quality requirement 1

Description: The overall reliability of the system should be above 99.99%.

##### 4.2.1.2 Quality requirement 2

Description: In terms of performance, the response time is less than 1.5 seconds during general hours and less than 4 seconds during peak hours.

##### 4.2.1.3 Quality requirement 3

Description: About usability, users learn to use the software according to the prompts in less than 5 minutes.

##### 4.2.1.4 Quality requirement 4

Description: The delivered system must be unit tested and 100% covered.

#### 4.2.2 Safety Requirements

##### 4.2.2.1 Safety Requirement 1

Description: Strict permission access control. After authentication, users can only access data and perform operations within their permission.

##### 4.2.2.2 Safety Requirement 2

Description: Ensure that user accounts and passwords cannot be leaked or misused.

##### 4.2.2.3 Safety Requirement 3

Description: Ensure that anonymous posts do not reveal personal information.

## 5. Constraints

### 5.1 Operation Environment

Front-end Environment: Next.js

Back-end Environment: Huawei Cloud with CentOS 7

### 5.2 Design and Implementation

Development Language: TypeScript, Java, SQL

Development Tools: Jmeter, Apifox, Github, IntelliJ IDEA, VScode

Implementation: Software systems should be delivered by the end of term and strictly follow the given process specifications.