lot occupancy documentation

deepsource-autofix-76c6eb20
Dan Gowans 2022-11-02 10:24:11 -04:00
parent 1797567a37
commit 91277152b4
8 changed files with 72 additions and 4 deletions

View File

@ -13,6 +13,9 @@ Understanding the key terms used in the Lot Occupancy System.
## 👩 User Documentation ## 👩 User Documentation
[**Lot Occupancies**](workOrders.md)<br />
What are work orders? How do they work?
[**Work Orders**](workOrders.md)<br /> [**Work Orders**](workOrders.md)<br />
What are work orders? How do they work? What are work orders? How do they work?

View File

@ -6,7 +6,7 @@
![Fee Management](images/adminFees.png) ![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. Each fee includes the following properties.
- A category, name, and description. - A category, name, and description.

View File

@ -8,3 +8,7 @@
Each occupancy record is assigned a type. Each occupancy record is assigned a type.
Those types can have custom data fields associated with them. Those types can have custom data fields associated with them.
## Related Links
- [Lot Occupancies](lotOccupancies.md)

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 112 KiB

View File

@ -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**<br />
Occupancy types are [completely customizable](adminOccupancyTypes.md),
and can be used to categorize the nature of the occupancy.
**Lot**<br />
_"Burial Site" in the screenshot._<br />
The location where the occupancy is taking place.
**Start Date**<br />
_"Interment Date" in the screenshot._<br />
The date when the lot is considered occupied.
**End Date**<br />
The date when the lot is no longer considered occupied.
**Additional Fields**<br />
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)

View File

@ -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. 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. - 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. - The **slip (lot)** is associated with the **marina (map)** where the slip is located.

View File

@ -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. a new work order number can be generated based on the format of your choice.
**Work Order Type**<br /> **Work Order Type**<br />
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**<br /> **Description**<br />
The work order description can describe the overall theme of the work order, The work order description can describe the overall theme of the work order,