Skip to content

Commit f76661b

Browse files
Merge pull request #196 from samuelloh/Major_enhancement
use cases
2 parents bed4c95 + 850dcf2 commit f76661b

File tree

1 file changed

+119
-1
lines changed

1 file changed

+119
-1
lines changed

docs/DeveloperGuide.adoc

Lines changed: 119 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1371,6 +1371,124 @@ Use case ends.
13711371
+
13721372
Use case resumes at step 2.
13731373

1374+
1375+
[discrete]
1376+
=== Use Case: View a student's profile page
1377+
1378+
*MSS*
1379+
1380+
1. User requests to list students.
1381+
2. Student list panel shows a list of students.
1382+
3. User requests to view profile page of a student.
1383+
4. Browser panel shows profile page of student.
1384+
+
1385+
Use case ends.
1386+
1387+
*Extensions*
1388+
1389+
[none]
1390+
* 2a. The list is empty.
1391+
+
1392+
Use case ends.
1393+
1394+
[none]
1395+
* 3a. The given index is invalid.
1396+
** 3a1. Error message shown.
1397+
** 3a2. User enters another index.
1398+
+
1399+
Use case resumes at step 3.
1400+
1401+
* 3b. There is no XML data currently.
1402+
** 3b1. Error message shown.
1403+
+
1404+
Use case ends.
1405+
1406+
[discrete]
1407+
=== Use Case: Edit a student's profile picture
1408+
1409+
*MSS*
1410+
1411+
1. User requests to list students.
1412+
2. Student list panel shows a list of students.
1413+
3. User requests to edit a student's profile picture.
1414+
4. Command box shows updated picture.
1415+
+
1416+
Use case ends.
1417+
1418+
*Extensions*
1419+
1420+
[none]
1421+
* 2a. The list is empty.
1422+
+
1423+
Use case ends
1424+
1425+
[none]
1426+
* 3a. The given index is invalid.
1427+
** 3a1. Error message shown.
1428+
** 3a2. User enters another index.
1429+
+
1430+
Use case resumes at step 3.
1431+
1432+
* 3b. The file path of the picture does not exist.
1433+
** 3b1. Error message shown.
1434+
** 3b2. User can enter another file path to the desired picture file.
1435+
+
1436+
Use case resumes at step 3.
1437+
1438+
* 3c The file path does not end with an extension of '.png' or '.jpg'.
1439+
** 3c1. Error message shown.
1440+
** 3c2. User can enter another file path to the desired picture file.
1441+
+
1442+
Use case resumes at step 3.
1443+
1444+
* 4a User is at the profile page while entering `editPicture` command.
1445+
** 4a1. Profile picture on the profile page changes
1446+
+
1447+
Use case ends.
1448+
1449+
[discrete]
1450+
=== Use Case: Edit a student's miscellaneous information
1451+
1452+
*MSS*
1453+
1454+
1. User requests to list students.
1455+
2. Student list panel shows a list of students.
1456+
3. User requests to edit a student's miscellaneous information.
1457+
4. Command box shows command success.
1458+
+
1459+
Use case ends.
1460+
1461+
*Extensions*
1462+
1463+
[none]
1464+
* 2a. The list is empty.
1465+
+
1466+
Use case ends
1467+
1468+
[none]
1469+
* 3a. The given index is invalid.
1470+
** 3a1. Error message shown.
1471+
** 3a2. User enters another index.
1472+
+
1473+
Use case resumes at step 3.
1474+
1475+
* 3b. No fields are entered.
1476+
** 3b1. Error message shown.
1477+
** 3b2. User enters command with specific fields which are desired to edit.
1478+
+
1479+
Use case resumes at step 3.
1480+
1481+
* 3c The prefixes are wrong.
1482+
** 3c1. Error message shown.
1483+
** 3c2. User enters command with proper prefixes to changes desired
1484+
+
1485+
Use case resumes at step 3.
1486+
1487+
* 4a User is at the profile page while entering `editMisc` command.
1488+
** 4a1. The miscellaneous information portion is updated.
1489+
+
1490+
Use case ends.
1491+
13741492
[discrete]
13751493
=== Use case: Show a student's dashboard
13761494

@@ -1523,7 +1641,7 @@ Use case resumes at step 2.
15231641
+
15241642
Use case resumes at step 2.
15251643

1526-
_{More to be added}_
1644+
15271645

15281646
[appendix]
15291647
== Non Functional Requirements

0 commit comments

Comments
 (0)