diff --git a/docs/README.md b/docs/README.md index 24438006..ec0d430f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,6 +13,9 @@ Understanding the key terms used in the Lot Occupancy System. ## 👩 User Documentation +[**Lot Occupancies**](workOrders.md)
+What are work orders? How do they work? + [**Work Orders**](workOrders.md)
What are work orders? How do they work? diff --git a/docs/adminFees.md b/docs/adminFees.md index 6b0fbe41..82668a8f 100644 --- a/docs/adminFees.md +++ b/docs/adminFees.md @@ -6,7 +6,7 @@ ![Fee Management](images/adminFees.png) -Fees can be applied to occupancy records. +Fees can be applied to [occupancy records](lotOccupancies.md). Each fee includes the following properties. - A category, name, and description. diff --git a/docs/adminOccupancyTypes.md b/docs/adminOccupancyTypes.md index 9c51c63f..e5005d41 100644 --- a/docs/adminOccupancyTypes.md +++ b/docs/adminOccupancyTypes.md @@ -7,4 +7,8 @@ ![Occupancy Type Management](images/adminOccupancyTypes.png) Each occupancy record is assigned a type. -Those types can have custom data fields associated with them. \ No newline at end of file +Those types can have custom data fields associated with them. + +## Related Links + +- [Lot Occupancies](lotOccupancies.md) diff --git a/docs/images/lotOccupancyAddFee.png b/docs/images/lotOccupancyAddFee.png new file mode 100644 index 00000000..569dfa83 Binary files /dev/null and b/docs/images/lotOccupancyAddFee.png differ diff --git a/docs/images/lotOccupancyEdit.png b/docs/images/lotOccupancyEdit.png new file mode 100644 index 00000000..7cf3e7df Binary files /dev/null and b/docs/images/lotOccupancyEdit.png differ diff --git a/docs/lotOccupancies.md b/docs/lotOccupancies.md new file mode 100644 index 00000000..bc34bff9 --- /dev/null +++ b/docs/lotOccupancies.md @@ -0,0 +1,60 @@ +[Home](https://cityssm.github.io/lot-occupancy-system/) +• +[Help](https://cityssm.github.io/lot-occupancy-system/docs/) + +# Lot Occupancies + +![Lot Occupancy Edit](images/lotOccupancyEdit.png) + +Lot occupancies records track the people who occupy lots. +In the context of a cemetery management system, occupancy records can track the names of +preneed owners or those interred in burial sites. + +## Main Details + +Occupancy records include the following details. + +**Occupancy Type**
+Occupancy types are [completely customizable](adminOccupancyTypes.md), +and can be used to categorize the nature of the occupancy. + +**Lot**
+_"Burial Site" in the screenshot._
+The location where the occupancy is taking place. + +**Start Date**
+_"Interment Date" in the screenshot._
+The date when the lot is considered occupied. + +**End Date**
+The date when the lot is no longer considered occupied. + +**Additional Fields**
+Additional fields can be added to the occupancy record depending on the selected occupancy type. + +## Occupants + +Occupancy records can have any number of people associated with them. +In the context of a cemetery management system, +occupants may be preneed owners, funeral directors, or the deceased. +Each occupant can include an occupant type, name, address, phone number, and email address. + +## Comments + +Comments offer open logging that can track various details that arise throughout the occupancy. + +## Fees + +![Add Fee](images/lotOccupancyAddFee.png) + +Occupancies can have fees associated with them. The available fees depend on the set occupancy type +and the related lot type. + +## Transactions + +Transactions are used to pay down applied fees. + +## Related Links + +- [Occupancy Type Management](adminOccupancyTypes.md) +- [Fee Management](adminFees.md) diff --git a/docs/terminology.md b/docs/terminology.md index b983d30c..3d2ee2d9 100644 --- a/docs/terminology.md +++ b/docs/terminology.md @@ -21,6 +21,6 @@ For example in the context of a cemetery system, John Doe has passed away and ha For example in the context of a marina, Jane Smith and her boat are renting a slip for a week. -- Jane Doe, and possibly the others on her boat, would be considered **renters (occupants)**. +- Jane Smith, and possibly the others on her boat, would be considered **renters (occupants)**. - A **reservation (occupancy)** record would be created for the duration of her stay, and associated with the **slip (lot)** of choice. - The **slip (lot)** is associated with the **marina (map)** where the slip is located. diff --git a/docs/workOrders.md b/docs/workOrders.md index 2966ab2c..a727d222 100644 --- a/docs/workOrders.md +++ b/docs/workOrders.md @@ -19,7 +19,8 @@ Note that when creating a work order, if the work order number field is left bla a new work order number can be generated based on the format of your choice. **Work Order Type**
-The work order types are completely customizable and can be used to categorize work orders. +The work order types are [completely customizable](adminConfigTables.md) +and can be used to categorize work orders. **Description**
The work order description can describe the overall theme of the work order,