interior construction quotation systemsoftware requirement document report 3 user requirements

<span class="text_page_counter">Trang 1</span><div class="page_container" data-page="1">

<b>Interior construction quotation systemSoftware Requirement Document</b>

<b>Report 3 - User Requirements</b>

<b>Group 4:</b>

SE180121 - Trần Mai Quang KhảiSE180163 - Nguyễn Hoàng DũngSE182530 - Bùi Phước Lộc

SE182598 - Trương Tuấn KiệtSE183117 - Nguyễn Vũ Thảo ViSE173662 - Trần Ngọc Quý Long

– HoChiMinh, 17 April 2024 –

<small>th</small>

</div><span class="text_page_counter">Trang 3</span><div class="page_container" data-page="3">

<small>11/04/2024A</small> Include online transactions that help users save time.

<small>12/04/2024D</small> Remove online transactions.

*A - Added M - Modified D - Deleted

</div><span class="text_page_counter">Trang 4</span><div class="page_container" data-page="4">

<b>III. User Requirements</b>

<b>1. Actors</b>

1 Customers

The Customers are those who find the system website and are interested in using it fordesigning their home interior. The customers are provided with numerous design optionsto choose from with the support of an image-generating AI helping the idea brainstormingprocess. Afterwards, they will be assisted in the blueprint designing process and theinterior construction process by the designers and constructors of the system company.

2 Designers

The Designers are either the system staff or freelancers hired via online contracts. Theirmain goal is to design an interior blueprint based on the ideas the customers send afterinputting them on the system website. Upon completion, the blueprint will be sent backto the customers for confirmation. In the case the customers do not accept it, theblueprint will be redesigned with the addition of customers’ feedback.

3 Constructors

The Constructors are the system employees who will handle the interior constructionbased on the blueprint provided by the designers with the customers’ confirmation. Theirobjectives include contacting suppliers for materials and tools, taking measurements, andfinally, constructing. While the construction is in progress, the constructors will make aweekly report on the progress. In addition, they will also handle the quotation-gatheringprocess to sum up the payment.

4 Suppliers ^{The suppliers are the affiliated parties with the constructors, who will provide them with}_{the necessary materials, furniture, decorations, and tools required for the construction.}

5 AI

The AI is an artificial intelligence system designed to generate images based on users’inputs. The system was built by another company and was bought by the current system.The AI was trained again using the system dataset to accept more parameters, allowingmore diversity in users’ choices and the generated image higher precision.

6 Admin

The administrators are the system employees who oversee the entire interaction betweencustomers and the system staff. They will have access to the user details of all relatedparties, including the customers, the designers, the constructors, and the suppliers. Withthat authority, their main goal is to preserve the information's validity and transmit it tothose who need it.

</div><span class="text_page_counter">Trang 5</span><div class="page_container" data-page="5">

<b>2. Use Cases2.1 Diagram</b>

<b>2.2 Descriptions</b>

a) UC-01: Input design idea

<b>ID and Name: UC-01 Input design idea</b>

Created By: Nguyễn Hoàng Dũng Date Created: 04/15/2024

Primary Actor: Customers Secondary Actors: Interior Construction Quoting SystemDescription: Upon entering the system website, customers will be welcomed with a number of design

options they can choose from. The options can be in the form of select forms, radio buttons,checkboxes, text boxes, and so on. After choosing all of the mandatory inputs, two buttonswould appear: “Generate sample design” and “Submit design idea”. The former grants thecustomers the ability to generate a sample design based on their inputs, while the latter wouldsubmit all of the customers’ choices as well as the AI design if they wanted to. Afterwards, aninfo form will appear, prompting the customers to input their personal details for contactpurposes.

Trigger: Customers enter the system website and are interested in using the system for designing theirhome interior.

Preconditions: PRE-1. Customers have entered the system website

Postconditions: POST-1: A message box will appear to show the submission status of either successful or failed.POST-2: A call will be made to the customers as soon as possible while in working hours tovalidate the customers’ information.

<b>Normal Flow: 1.0 Input design idea</b>

</div><span class="text_page_counter">Trang 6</span><div class="page_container" data-page="6">

2. The system redirects the user to the design page.

3. The customers can choose the design options that satisfy their needs.

4. After choosing all of the mandatory options, two buttons will appear: the “Generatesample design” and the “Submit design idea”. (See 1.2)

5. When the customers click the “Submit design idea” button, a message box will appearinforming them about the submission status, either successful or failed. (See 1.0.E1)6. A user information form will appear for customers to fill in, such as the customer’s name,

constructing location, time, and contact details,…

<b>Alternative Flows: 1.1 Go to the design page directly.</b>

1. Before entering the system website’s home page, the customers can choose the link thatdirects to the design page on the Google search page or type the URL link directly on theURL address bar.

2. Go to step 3 of the normal flow.

<b>1.2 Generate sample design</b>

1. If the customers click the “Generate sample design” button, the AI will generate a sampledesign based on the customers’ choices.

2a. If the customers want to change their ideas, go to step 3 of the normal flow. 2b. If the customers want to confirm their idea, to go step 5.

Exceptions: <b>1.0.E1 Pop-up login form in case the customers have not logged in.</b>

1. After clicking the “Submit Design Idea”, if the customers have not signed in, they will beprompted with a login form in order to contact the customers for affirmation.

2. The customers enter all of the mandatory input fields, including email, and phone numberfields for contact purposes.

3. After logging in, go to step 8.Priority: High

Business Rules: NoneOtherInformation:

1. Expect a high frequency of executing this use case within the first 2 weeks after the systemis released.

2. The customers can cancel the operation at any time prior to confirming it.

b) UC-02: Generate sample design

<b>ID and Name: UC-02 Generate sample design</b>

Created By: Nguyễn Hoàng Dũng Date Created: 04/16/2024

Primary Actor: Artificial Intelligence Secondary Actors: Interior Construction Quoting System, Customers

Description: Based on the customers’ chosen options, the AI will generate several sample design imagesthat customers can choose to base their designs on.

</div><span class="text_page_counter">Trang 7</span><div class="page_container" data-page="7">

Preconditions: PRE-1: Customers have to select all mandatory options.

PRE-2: Customers have to click the “Generate Sample Design” button.Postconditions: POST-1: A set of sample design images will appear after a few seconds.

<b>Normal Flow: 2.0 Generate sample design</b>

1. After the customers have chosen all of the mandatory design options, the option to clickthe “Generate Sample Design” will open.

2. The AI system will be prompted to generate several sample design images.Alternative Flows: None

Exceptions: NonePriority: MidBusiness Rules: None

1. The AI will take several seconds to a minute to generate a set of design ideas.

c) UC-03: Log In

<b>ID and Name: UC-03 Log In</b>

Created By: Nguyễn Hoàng Dũng Date Created: 04/16/2024Primary Actor: Customers, Designers,

Constructors, Admin

Secondary Actors: Interior Construction Quoting System

Description: Customers who come to the system can either log into an existing account or create a new oneinstead. An account is needed to make order happen.

Trigger: Customers can click the log-in button on the nav bar or automatically open the login form ifusers have not signed in while submitting the design idea.

Preconditions: None

Postconditions: POST-1: The system website will display a message of either successfully or failed to login. If itis successful, the nav bar of the system website will display the customers’ usernames.

<b>Normal Flow: 3.0 Log in</b>

1. The customers enter the system website’s home page.2. Click the log-in link to redirect to the log-in page. (See 3.2)3. Input the username and password, then press the “Log In” button.

4. Customers will be redirected to the home page and the navigation bar will display thecustomer's username with a prompt stating successfully login. (See 3.0.E1)

<b>Alternative Flows: 3.1 Log In while choosing design options (See US-1 flow 1.0)</b>

1. If the customers have not signed in prior to entering the design page, a login form willappear after clicking the “Submit Design Idea” button.

</div><span class="text_page_counter">Trang 8</span><div class="page_container" data-page="8">

<b>3.2 Register if the customers do not have an account</b>

1. Press the “Register new account” button displayed on the login page.

2. Enter the needed information, such as username, password, email, phone number, and soon.

3. Click the “Register” button.

4. If successfully creating an account, the customers will be redirected to the login pageagain, then go to step 3 in the normal flow.

Exceptions: <b>3.0.E1 Customers do not have an account</b>

1. If the customers do not have an account, follow Alternative Flow 3.2.Priority: High

Business Rules: BR-06OtherInformation:

d) UC-04: Upload blueprint

<b>ID and Name: UC-04 Upload blueprint</b>

Created By: Nguyễn Hoàng Dũng Date Created: 04/16/2024

Primary Actor: Designers Secondary Actors: Interior Construction Quoting System, Customers

Description: This function allows the designers to upload the blueprint to the dashboard for the customersto see. For this use case to take place, the <b>UC-01</b> needs to happen first.

Trigger: After the customers have submitted their design ideas, and the designers have validated theorder with the customer.

Preconditions: PRE-1: Have filled in the user’s information form

Postconditions: POST-1: A message box will appear stating the submission status of either successful or failed.

<b>Normal Flow: 4.0 Upload blueprint</b>

1. Upon receiving the design ideas, make contact with the customers as soon as possible tovalidate the integrity of the order. (See 4.0.E1)

2. Start designing the blueprint based on the design ideas using an external application.3. Upload the blueprint onto the dashboard.

4. Wait for customers’ responses on the blueprint.

a. If the customers are satisfied with the blueprint, proceed to the next phase.b. If the customers are not satisfied with the blueprint, collect feedback from them and

go to step 2 for redesign.

<b>Alternative Flows: None</b>

Exceptions: <b>4.0.E1 The customers make additional requests while in contact</b>

</div><span class="text_page_counter">Trang 9</span><div class="page_container" data-page="9">

that are not an option using the system.Priority: Mid

Business Rules: BR-09, BR-12Other

1. While in the blueprint designing process, the customers can directly make contact with thedesigners to make some changes to the design.

e) UC-05: Upload info

<b>ID and Name: UC-05 Upload info</b>

Created By: Nguyễn Hoàng Dũng Date Created: 04/16/2024Primary Actor: Customers, Designers,

Trigger: For Customers, during the Input Design idea process, a user’s info form will appear for them tofill in. As for the Designers, Constructors, or Suppliers, their info might already exist on thedatabase. If not, when they are assigned to a project, a user’s info form will be sent.Preconditions: None

Postconditions: POST-1: A message box will appear stating the upload status of either successful or failed.

<b>Normal Flow: 5.0 Upload info</b>

<b>● For Customers: See UC-01 flow 1.0</b>

1. After the customers have finished choosing all of the mandatory options, clicking the“Submit Design Idea” button will prompt them with a user’s info form.

2. Fill in all the fields then click the “Submit” button.

<b>● For Designers, Constructors, and Suppliers: See 5.0.E1</b>

1. When assigned to a project, a link to the user’s info form will be sent to the relatedparties’ emails.

2. Clicking the link will redirect them to the form page for them to fill in.

<b>Alternative Flows: None</b>

Exceptions: <b>5.0.E1 User’s info already exists on the system database</b>

In the scenario of the user’s info of the designers, constructors, or suppliers already existing onthe database, the admin will directly upload them onto the project dashboard. The actors canskip the normal flow.

Priority: Very highBusiness Rules: BR-06, BR-19

Other None

</div><span class="text_page_counter">Trang 10</span><div class="page_container" data-page="10">

g) UC-06: Manage user’s infoID and Name: UC-06 Manage user’s info

Primary Actor: Admin Secondary Actors: Interior Construction Quoting SystemDescription: This is the main function of the admin to manage the info of the designers, customers,

suppliers, and constructors.

Trigger: When the admin logs in with their account the user’s info list is displayed from the database,and the admin can manage them.

Preconditions: PRE-1: Users must input their info.

PRE-2: The one who logs in must be the system admin.Postconditions: POST-1: The admin must save after modifications.

<b>Normal Flow: 6.0 Manage user’s info.</b>

1. After users have inputted their info, they will be displayed for the admin

2. After the admin has made their modifications, the admin must press the save button toensure the info has been saved.

<b>Alternative Flows: None</b>

Exceptions: NonePriority: HighBusiness Rules: BR-06, BR-05

h) UC-07: Send users’ infoID and Name: UC-07 Send user’s info

Created By: Trương Tuấn KIệt Date Created: 04/16/2024

Primary Actor: Admin Secondary Actors: Interior Construction Quoting System, Customers, Designers, ConstructorsDescription: This is one of the main functions of the system managed by Admin, the ability to send required

project information to users via the system.

Trigger: Whenever users want to view information about the projects.Preconditions: PRE-1: Users’ info has been uploaded.

Postconditions: POST-1: The system will display information based on users’ roles.

</div><span class="text_page_counter">Trang 11</span><div class="page_container" data-page="11">

1. Admin login to the dashboard.

2. Receive and upload users' information to the dashboard based on users’ role3. Click the “Save” button.

<b>Alternative Flows: None</b>

Priority: Very highBusiness Rules: BR-05

i) UC-08: Receive customers’ design ideaID and Name: UC-08 Receive customers’ design idea

Created By: Trương Tuấn KIệt Date Created: 04/16/2024

Primary Actor: Designers Secondary Actors: Interior Construction Quoting System. Customers.

Description: In this use case, designers will receive customers’ design ideas in order to draw a specificblueprint for the apartment.

Trigger: After customers have submitted their design ideas to the system, the designers will be able toreceive those ideas.

Preconditions: None

Postconditions: POST-1: The system will display customers’ design ideas.Normal Flow: 8.0 Receive customers’ design ideas

1. Designers log in to the system.

2. Receive users' ideas to design the blueprint.3. Start designing.

<b>Alternative Flows: None</b>

Priority: MidBusiness Rules: BR-09

j) UC-09: Upload blueprintID and Name: UC-09 Upload blueprint

Created By: Trương Tuấn KIệt Date Created: 04/16/2024

Primary Actor: Designers Secondary Actors: Interior Construction Quoting System.

</div><span class="text_page_counter">Trang 12</span><div class="page_container" data-page="12">

Description: In this use case, after designers receive customers’ design ideas and finish designing theblueprint, they will upload it to the system. This case only occurs after<b> UC-09</b> has been done.Trigger: After customers have submitted their design ideas to the system, the designers will be able to

receive those ideas.Preconditions: None

Postconditions: POST-1: Blueprint uploaded to the system and designers should contact customers as soon aspossible.

Normal Flow: 9.0 Upload blueprint

1. Designers log in to the system.2. Upload the blueprint to the system.3. Click the “save” button.

4. Contact the customer about the blueprint.

<b>Alternative Flows: None</b>

Priority: MidBusiness Rules: BR-09

Trigger: Users upload quotations to the system, and the system sends them to the customersPreconditions: PRE-1: All of the related parties have participated in the project.

Postconditions: POST-1: The system has confirmed and verified the accuracy of the data in the quotation afterupload.

<b>Normal Flow: 10.0 Upload Quotation</b>

1. Accessing the System

2. Navigating to the Dashboard Section3. Reviewing Details

4. Confirmation

</div>