Skip to content

Commit

Permalink
Merge pull request #95 from Manoharan-Ajay-Anand/branch-user-guide-intro
Browse files Browse the repository at this point in the history
Update User Guide intro and disclaimer
  • Loading branch information
Imranr2 authored Oct 14, 2021
2 parents b4ba13d + 56c7e42 commit 537f243
Show file tree
Hide file tree
Showing 3 changed files with 199 additions and 79 deletions.
14 changes: 8 additions & 6 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -711,20 +711,22 @@ Priorities: High - (must have), Medium - (nice to have), Low - (unlikely to hav

1. Usability Requirements:
* Should work on systems with Java 11 and above.
* Should work on Windows, Linux and macOS.

2. Business/Domain Requirements:
* All quantities in the application are from 0 to 40000.

3. Data Requirements:
* Data of clients and orders should persist after the app closes.
* Data of clients, orders and ingredients should persist after the app closes.

### Glossary

* **Mainstream OS**: Windows, Linux, Unix, OS-X
* **Private contact detail**: A contact detail that is not meant to be shared with others
* **BTBB**: BobTheBodyBuilder
* **Client**: A member of the gym
* **Booking**: A fixed time period (of 1 hour 30 minutes) that a client can use the gym’s facilities
* **Mainstream OS**: Windows, Linux and macOS
* **BTBB**: BobTheBistroBoss
* **Client**: Client information that can be copied to orders
* **Ingredient**: Ingredient information that is stored in inventory and orders
* **Inventory**: Keeps track of ingredients and their quantities
* **Order**: Meal order sold to a client

#### Prefix Glossary

Expand Down
Loading

0 comments on commit 537f243

Please sign in to comment.