Skip to content

Commit 0b55c39

Browse files
authored
Merge pull request #80 from benedictkhoomw/dg
Fix DG Use Case Formatting
2 parents a6c9d4f + 8ad33d8 commit 0b55c39

File tree

1 file changed

+50
-25
lines changed

1 file changed

+50
-25
lines changed

docs/DeveloperGuide.md

+50-25
Original file line numberDiff line numberDiff line change
@@ -295,15 +295,18 @@ Use case ends.
295295

296296
**Extensions**
297297

298-
* 1a. The resident's details are incorrectly formatted (e.g phone number/email/year format does not conform, OR room number is invalid).
298+
* 1a. The resident's details are incorrectly formatted (e.g. phone number/email/year format does not conform, OR room number is invalid).
299299
* 1a1. SunRez displays an error stating which field is incorrectly formatted and requests the user to try again after fixing the stated error.
300-
Use case ends.
300+
301+
Use case ends.
301302
* 1b. The resident's phone number or email are in use by an existing resident.
302303
* 1b1. SunRez displays an error stating which field is already in use and requests the user to try again after fixing the stated error.
303-
Use case ends.
304-
* 2a. Sunrez encounters an error while saving the content.
304+
305+
Use case ends.
306+
* 2a. SunRez encounters an error while saving the content.
305307
* 2a1. SunRez shows an error message and requests the user to try their command again.
306-
Use case ends.
308+
309+
Use case ends.
307310

308311

309312
### UC-002 List all residents
@@ -318,6 +321,7 @@ Use case ends.
318321
**Extensions**
319322

320323
* 2a. The list is empty.
324+
321325
Use case ends.
322326

323327

@@ -334,7 +338,8 @@ Use case ends.
334338

335339
* 2a. There are no residents matching the keywords.
336340
* 2a1. An empty list is displayed.
337-
Use case ends.
341+
342+
Use case ends.
338343

339344
### UC-004 Edit a resident record
340345

@@ -350,10 +355,12 @@ Use case ends.
350355
**Extensions**
351356

352357
* 2a. The list of residents is empty.
358+
353359
Use case ends.
354360
* 3a. The resident's details are invalid (e.g phone number/email/dob format does not conform, OR room number is invalid).
355361
* 3a1. SunRez shows an error message stating which field is incorrectly formatted and requests the user to try again.
356-
Use case resumes at step 2.
362+
363+
Use case resumes at step 2.
357364

358365

359366
### UC-005 Delete a resident
@@ -370,10 +377,12 @@ Use case ends.
370377
**Extensions**
371378

372379
* 2a. The list of residents is empty.
380+
373381
Use case ends.
374382
* 3a. The specified resident does not exist.
375-
* SunRez shows an error message.
376-
Use case resumes at step 2.
383+
* 3a1. SunRez shows an error message.
384+
385+
Use case resumes at step 2.
377386

378387

379388
### UC-006 Add a room
@@ -388,7 +397,8 @@ Use case ends.
388397
**Extensions**
389398
* 1a. The room's details are invalid (e.g room number format is not valid).
390399
* 1a1. SunRez shows an error stating which field is incorrectly formatted and requests the user to try again after fixing the stated error.
391-
Use case ends.
400+
401+
Use case ends.
392402

393403

394404
### UC-007 List all rooms
@@ -414,11 +424,13 @@ Use case ends.
414424

415425
**Extensions**
416426

417-
* 2a. The list of rooms is empty.
427+
* 2a. The list of rooms is empty.
428+
418429
Use case ends.
419-
* 3a. The room's details are invalid (e.g room number format is not valid).
430+
* 3a. The room's details are invalid (e.g. room number format is not valid).
420431
* 3a1. SunRez shows an error message stating which field is incorrectly formatted and requests the user to try again.
421-
Use case resumes at step 2.
432+
433+
Use case resumes at step 2.
422434

423435

424436
### UC-010 Delete a room
@@ -436,9 +448,10 @@ Similar to *UC-005 Delete a resident*, just replace resident with room.
436448
Use case ends.
437449

438450
**Extensions**
439-
* 1a. The issue's details are invalid (e.g invalid room number).
440-
* 1a1. SunRez shows an error stating which field is incorrectly formatted and requests the user to try again after fixing the stated error.
441-
Use case ends.
451+
* 1a. The issue's details are invalid (e.g. invalid room number).
452+
* 1a1. SunRez shows an error stating which field is incorrectly formatted and requests the user to try again after fixing the stated error.
453+
454+
Use case ends.
442455

443456

444457
### UC-012 List all issues
@@ -463,10 +476,12 @@ Use case ends.
463476
**Extensions**
464477

465478
* 2a. The list of issue is empty.
479+
466480
Use case ends.
467481
* 3a. The issue's details are invalid (e.g invalid room number).
468482
* 3a1. SunRez shows an error message stating which field is incorrectly formatted and requests the user to try again.
469-
Use case resumes at step 2.
483+
484+
Use case resumes at step 2.
470485

471486

472487
### UC-015 Close an issue
@@ -483,10 +498,12 @@ Use case ends.
483498
**Extensions**
484499

485500
* 2a. The list is empty.
486-
Use case ends.
501+
502+
Use case ends.
487503
* 3a. The given index is invalid.
488504
* 3a1. SunRez shows an error message.
489-
Use case resumes at step 2.
505+
506+
Use case resumes at step 2.
490507

491508
### UC-016 Delete an issue
492509

@@ -505,7 +522,8 @@ Use case ends.
505522

506523
* 1a. There are no previous commands that change state.
507524
* 1a1 SunRez shows an error message.
508-
Use case ends.
525+
526+
Use case ends.
509527

510528
### UC-018 Redo Previous Command
511529

@@ -520,7 +538,8 @@ Use case ends.
520538

521539
* 1a. There are no previously undone commands.
522540
* 1a1 SunRez shows an error message.
523-
Use case ends.
541+
542+
Use case ends.
524543

525544
### UC-019 Allocate a Room
526545

@@ -534,10 +553,12 @@ Use case ends.
534553
**Extensions**
535554

536555
* 2a. There are no unassigned residents or unassigned.
556+
537557
Use case ends.
538558
* 3a. The given index is invalid.
539559
* 3a1. SunRez shows an error message.
540-
Use case resumes at step 2.
560+
561+
Use case resumes at step 2.
541562

542563

543564
### UC-020 Deallocate a Room
@@ -552,10 +573,12 @@ Use case ends.
552573
**Extensions**
553574

554575
* 2a. There are no unassigned residents or unassigned.
576+
555577
Use case ends.
556578
* 3a. The given index is invalid.
557579
* 3a1. SunRez shows an error message.
558-
Use case resumes at step 2.
580+
581+
Use case resumes at step 2.
559582

560583

561584
### UC-021 Access Command History
@@ -590,11 +613,13 @@ Use case ends.
590613

591614
* 1a. Alias name is invalid.
592615
* 1a1. SunRez shows an error message.
593-
Use case ends.
616+
617+
Use case ends.
594618

595619
* 2a. An alias with the same name exists.
596620
* 2a1. SunRez overwrites the existing alias.
597-
Use case resumes from step 3.
621+
622+
Use case resumes from step 3.
598623

599624
## Non-Functional Requirements
600625

0 commit comments

Comments
 (0)