Merge pull request #28 from AY2526S2-CS2103T-T08-2/revert-26-master

Revert "Clean DG"

Author: oofyneril

docs/DeveloperGuide.md

@@ -4,7 +4,7 @@
   pageNav: 3
 ---
 
-# MALAdress Developer Guide
+# AB-3 Developer Guide
 
 <!-- * Table of Contents -->
 <page-nav-print />
@@ -323,6 +323,94 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 **Extensions**
 
 
+* 2a. Invalid phone format - System shows error message and does not add.
+
+* 3a.Duplicate contact detected - System rejects add and shows duplicate error.
+
+
+
+**Use case: Tag a contact as supplier/customer and update remarks**
+System updates the conta
+
+#### Design considerations:
+
+**Aspect: How undo & redo executes:**
+
+* **Alternative 1 (current choice):** Saves the entire address book.
+    * Pros: Easy to implement.
+    * Cons: May have performance issues in terms of memory usage.
+
+* **Alternative 2:** Individual command knows how to undo/redo by
+  itself.
+    * Pros: Will use less memory (e.g. for `delete`, just save the person being deleted).
+    * Cons: We must ensure that the implementation of each individual command are correct.
+
+_{more aspects and alternatives to be added}_
+
+### \[Proposed\] Data archiving
+
+_{Explain here how the data archiving feature will be implemented}_
+
+
+--------------------------------------------------------------------------------------------------------------------
+
+## **Documentation, logging, testing, configuration, dev-ops**
+
+* [Documentation guide](Documentation.md)
+* [Testing guide](Testing.md)
+* [Logging guide](Logging.md)
+* [Configuration guide](Configuration.md)
+* [DevOps guide](DevOps.md)
+
+--------------------------------------------------------------------------------------------------------------------
+
+## **Appendix: Requirements**
+
+### Product scope
+
+**Target user profile**:
+
+* has a need to manage a significant number of contacts
+* prefer desktop apps over other types
+* can type fast
+* prefers typing to mouse interactions
+* is reasonably comfortable using CLI apps
+
+**Value proposition**: manage contacts faster than a typical mouse/GUI driven app
+
+
+### User stories
+
+Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`
+
+| Priority | As a …​                                    | I want to …​                 | So that I can…​                                                        |
+|----------|--------------------------------------------|------------------------------|------------------------------------------------------------------------|
+| `* * *`  | new user                                   | see usage instructions       | refer to instructions when I forget how to use the App                 |
+| `* * *`  | user                                       | add a new person             |                                                                        |
+| `* * *`  | user                                       | delete a person              | remove entries that I no longer need                                   |
+| `* * *`  | user                                       | find a person by name        | locate details of persons without having to go through the entire list |
+| `* *`    | user                                       | hide private contact details | minimize chance of someone else seeing them by accident                |
+| `*`      | user with many persons in the address book | sort persons by name         | locate a person easily                                                 |
+
+*{More to be added}*
+
+### Use cases
+
+(For all use cases below, the **System** is the `AddressBook` and the **Actor** is the `user`, unless specified otherwise)
+
+**Use case: Add a supplier/customer contact with contact info**
+
+**MSS**
+
+1.  The user enters the add command with name and phone.
+2.  System shows “successfully saved” message
+3.  System refreshed the UI contact list with the latest added contact.
+
+    Use case ends.
+
+**Extensions**
+
+
 * 2a. Invalid phone format - System shows error message and does not add.
 * 3a.Duplicate contact detected - System rejects add and shows duplicate error.
 
@@ -394,6 +482,46 @@ System updates the contact with the new tag and updated remarks.
 
 Given below are instructions to test the app manually.
 
+ct with the new tag and updated remarks.
+
+
+**MSS**
+
+1.  The user enters a tag command with a supplier or consumer tag and its remarks.
+2.  The system shows a “successfully updated” message.
+3.  System refreshed the UI contact list with the latest added contact.
+
+    Use case ends.
+
+**Extensions**
+
+
+* 2a. Invalid phone format - System shows error message and does not add.
+
+* 3a.Duplicate contact detected - System rejects add and shows duplicate error.
+
+
+*{More to be added}*
+
+### Non-Functional Requirements
+
+1.  Should work on any _mainstream OS_ as long as it has Java `17` or above installed.
+2.  Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.
+3.  A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.
+
+*{More to be added}*
+
+### Glossary
+
+* **Mainstream OS**: Windows, Linux, Unix, MacOS
+* **Private contact detail**: A contact detail that is not meant to be shared with others
+
+--------------------------------------------------------------------------------------------------------------------
+
+## **Appendix: Instructions for manual testing**
+
+Given below are instructions to test the app manually.
+
 <box type="info" seamless>
 
 **Note:** These instructions only provide a starting point for testers to work on;