From 470f8d40159773fa248ed7cd18ee25630f3ab401 Mon Sep 17 00:00:00 2001 From: Oliver Date: Thu, 29 Dec 2022 00:01:29 +1100 Subject: [PATCH] Part stocktake (#408) * Add part stockdate docs * Stocktake notes --- docs/part/stocktake.md | 25 +++++++++++++++++++++++++ docs/part/views.md | 6 ++++++ mkdocs.yml | 1 + 3 files changed, 32 insertions(+) create mode 100644 docs/part/stocktake.md diff --git a/docs/part/stocktake.md b/docs/part/stocktake.md new file mode 100644 index 0000000..9ba8dcb --- /dev/null +++ b/docs/part/stocktake.md @@ -0,0 +1,25 @@ +--- +title: Part Stocktake +--- + +## Part Stocktake + +The *Part Stocktake* tab provides historical stock level information for a particular part. The stock history data displayed here is provided by the users, by performing part stocktake as required. + +Each stocktake entry is recorded, storing the following data: + +| Parameter | Description | +| --- | --- | +| Date | The date at which the particular stocktake was perfomred | +| User | The user who performed the stocktake | +| Quantity | The total available part quantity at the specified date | +| Notes | Any extra notes associated with the particular stocktake | + +### Performing a Stocktake + +To perform a new stocktake, press the *Stocktake* button located at the top-right corner of the stocktake data table. + +Here the user is presented with currently known "in stock" quantities, and can manually input a total available stock number. + +!!! tip "Make sure it counts" + It is the responsibility of the user to ensure that the stocktake data entered here are accurate diff --git a/docs/part/views.md b/docs/part/views.md index 34d1eb7..bbdb711 100644 --- a/docs/part/views.md +++ b/docs/part/views.md @@ -2,6 +2,8 @@ title: Part Views --- +## Part Views + The main part view is divided into 4 different panels: 1. Categories @@ -126,6 +128,10 @@ The *Sales Orders* tab shows a list of the sales orders for this part. It provid The *Scheduling* tab provides an overview of the *predicted* future availability of a particular part. Refer to the [scheduling documentation](./scheduling.md) for further information. +### Stocktake + +The *Stocktake* tab provide historical stock level information, based on user-provided stocktake data. Refer to the [stocktake documentation](./stocktake.md) for further information. + ### Tests If a part is marked as *trackable*, the user can define tests which must be performed on any stock items which are instances of this part. [Read more about testing](./test.md). diff --git a/mkdocs.yml b/mkdocs.yml index 98e5012..6e00eb2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -83,6 +83,7 @@ nav: - Tests: part/test.md - Pricing: part/pricing.md - Scheduling: part/scheduling.md + - Stocktake: part/stocktake.md - Notifications: part/notification.md - Stock: - Stock Items: stock/stock.md