[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] 01/02: inventory management design document
|
From: |
gnunet |
|
Subject: |
[taler-docs] 01/02: inventory management design document |
|
Date: |
Fri, 19 Mar 2021 23:23:31 +0100 |
This is an automated email from the git hooks/post-receive script.
sebasjm pushed a commit to branch master
in repository docs.
commit 7e4e5549541fd0a5bacd574b98812f19142cc9b5
Author: Sebastian <sebasjm@gmail.com>
AuthorDate: Fri Mar 19 19:21:00 2021 -0300
inventory management design document
---
...ion.svg => backoffice-order-list.pagination.svg | 0
...-order-list.v2.svg => backoffice-order-list.svg | 0
backoffice-product-create.with-stock.svg | 16 ++++
backoffice-product-create.without-stock.svg | 16 ++++
backoffice-product-list.actions.svg | 16 ++++
backoffice-product-list.svg | 16 ++++
backoffice-product-update.svg | 16 ++++
.../016-backoffice-order-managment.rst | 24 +++---
.../017-backoffice-inventory-managment.rst | 96 +++++++++++++++++++++-
9 files changed, 184 insertions(+), 16 deletions(-)
diff --git a/backoffice-order-list.v2-pagination.svg
b/backoffice-order-list.pagination.svg
similarity index 100%
rename from backoffice-order-list.v2-pagination.svg
rename to backoffice-order-list.pagination.svg
diff --git a/backoffice-order-list.v2.svg b/backoffice-order-list.svg
similarity index 100%
rename from backoffice-order-list.v2.svg
rename to backoffice-order-list.svg
diff --git a/backoffice-product-create.with-stock.svg
b/backoffice-product-create.with-stock.svg
new file mode 100644
index 0000000..4027af8
--- /dev/null
+++ b/backoffice-product-create.with-stock.svg
@@ -0,0 +1,16 @@
+<svg version="1.1" xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 827 1012"
width="827" height="1012">
+ <!-- svg-source:excalidraw -->
+ <!-- payload-type:application/vnd.excalidraw+json --><!-- payload-version:2
--><!-- payload-start
-->eyJ2ZXJzaW9uIjoiMSIsImVuY29kaW5nIjoiYnN0cmluZyIsImNvbXByZXNzZWQiOnRydWUsImVuY29kZWQiOiJ4nO1daVfqyNr93r/CZX9t0zVcdTAwMGbnXHUwMDFig7PigID4rrtcXFx1MDAxMVx1MDAwMkSZXGZcdTAwMDHEe+9/f59Cj1x1MDAwNJJgRNHYV85Z3YdcZiSp2vuZalfl339sbGz6k76z+Wtj03mo2W237tnjzb/M9pHjXHLcXlx1MDAxN3aR6fdBb+jVpke2fL8/+PX337MzrFqv83SW03Y6TtdcdTAwMWbAcf9cdTAwMDffNzb+Pf1v4DqeU/PtbrPtTE+Y7lxuXFxcbsnFrYVed3pZxlx1MDAxOFeYXHUwM
[...]
+ <defs>
+ <style>
+ @font-face {
+ font-family: "Virgil";
+ src: url("https://excalidraw.com/Virgil.woff2";);
+ }
+ @font-face {
+ font-family: "Cascadia";
+ src: url("https://excalidraw.com/Cascadia.woff2";);
+ }
+ </style>
+ </defs>
+ <rect x="0" y="0" width="827" height="1012" fill="#ffffff"></rect><g
transform="translate(10 10) rotate(0 403.5 496)"><path d="M0.6120161302387714
0.2306227557361126 C176.34838936785238 0.22690063446387648, 354.00070575121794
-0.3170953896678985, 807.453930426389 -0.3243877775967121
M-0.0015226308256387712 0.1010874155908823 C310.84229007391264
-3.3018346436135477, 621.1829346725718 -3.3442769773118206, 807.3457405503839
-0.35789241753518586 M807.2221156604588 0.14504600688815117 C807. [...]
\ No newline at end of file
diff --git a/backoffice-product-create.without-stock.svg
b/backoffice-product-create.without-stock.svg
new file mode 100644
index 0000000..04aabeb
--- /dev/null
+++ b/backoffice-product-create.without-stock.svg
@@ -0,0 +1,16 @@
+<svg version="1.1" xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 827 838"
width="827" height="838">
+ <!-- svg-source:excalidraw -->
+ <!-- payload-type:application/vnd.excalidraw+json --><!-- payload-version:2
--><!-- payload-start
-->eyJ2ZXJzaW9uIjoiMSIsImVuY29kaW5nIjoiYnN0cmluZyIsImNvbXByZXNzZWQiOnRydWUsImVuY29kZWQiOiJ4nO1cXFlT28hcdTAwMWF9n19BMa+D0t1fr3kzNjDsXHUwMDEws8TcukVcdEvYXHUwMDAyb0jyXHUwMDAyc+e/369cdTAwMDWDZVsyXHUwMDFhg4NTlSSVwlpoufuc862tv35bW1uPXHUwMDFme/7617V1f1R3W4FcdTAwMTe6w/U/7PGBXHUwMDFmRkG3g6dY8jnq9sN6cmUzjnvR1y9fxnc49W77+S6/5bf9Tlx1MDAxY+F1/8HPa2t/Jf+nxlx0/Xrsdlx1MDAxYS0/uSE5NVx1MDAxZYpSMX30qNtJhqVSg
[...]
+ <defs>
+ <style>
+ @font-face {
+ font-family: "Virgil";
+ src: url("https://excalidraw.com/Virgil.woff2";);
+ }
+ @font-face {
+ font-family: "Cascadia";
+ src: url("https://excalidraw.com/Cascadia.woff2";);
+ }
+ </style>
+ </defs>
+ <rect x="0" y="0" width="827" height="838" fill="#ffffff"></rect><g
transform="translate(10 10) rotate(0 403.5 409)"><path d="M0.6120161302387714
0.2306227557361126 C176.34838936785238 0.22690063446387648, 354.00070575121794
-0.3170953896678985, 807.453930426389 -0.3243877775967121
M-0.0015226308256387712 0.1010874155908823 C310.84229007391264
-3.3018346436135477, 621.1829346725718 -3.3442769773118206, 807.3457405503839
-0.35789241753518586 M807.2221156604588 0.14504600688815117 C807.6 [...]
\ No newline at end of file
diff --git a/backoffice-product-list.actions.svg
b/backoffice-product-list.actions.svg
new file mode 100644
index 0000000..a223217
--- /dev/null
+++ b/backoffice-product-list.actions.svg
@@ -0,0 +1,16 @@
+<svg version="1.1" xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 1115 672"
width="1115" height="672">
+ <!-- svg-source:excalidraw -->
+ <!-- payload-type:application/vnd.excalidraw+json --><!-- payload-version:2
--><!-- payload-start
-->eyJ2ZXJzaW9uIjoiMSIsImVuY29kaW5nIjoiYnN0cmluZyIsImNvbXByZXNzZWQiOnRydWUsImVuY29kZWQiOiJ4nO2dWXPiStKG78+vcHhuXHUwMDA3T+3LuTOrWW1cdTAwMTaz+JtcdFx1MDAwMoRcdTAwMDBcdTAwMTmBQFx1MDAxMuvE/PdP0H2MXHUwMDAwXHSEbWzRp1x1MDAxZERHW4slpCezMrPeqvrvXHUwMDFmNze39nKs3v55c6sulJaudczW/Paf6+0z1bQ0Y+TsQpvfLWNqKpsj+7Y9tv7817+2Z9wpxvDHWaquXHUwMDBl1ZFtOcf9n/P7zc1/N/+6rmOqit1cdTAwMWH1dHVzwmaX61JcYuxvLVx1MDAxOKPNZ
[...]
+ <defs>
+ <style>
+ @font-face {
+ font-family: "Virgil";
+ src: url("https://excalidraw.com/Virgil.woff2";);
+ }
+ @font-face {
+ font-family: "Cascadia";
+ src: url("https://excalidraw.com/Cascadia.woff2";);
+ }
+ </style>
+ </defs>
+ <rect x="0" y="0" width="1115" height="672" fill="#ffffff"></rect><g
transform="translate(10 10) rotate(0 547.5 326)"><path d="M0.28300008848309516
-0.10272883251309395 C322.7684008703567 -3.249135070387274, 646.6541930401697
-3.1787367158569397, 1095.0694143541157 0.3002875201404095
M-0.14274714626371862 -0.14749729596078395 C435.26786967543893
-1.4277095694653688, 870.4879770824687 -1.2544425983540712, 1095.0382535990327
0.13947891034185886 M1095.5105304963886 0.6175911776721478 C109 [...]
\ No newline at end of file
diff --git a/backoffice-product-list.svg b/backoffice-product-list.svg
new file mode 100644
index 0000000..804b0a3
--- /dev/null
+++ b/backoffice-product-list.svg
@@ -0,0 +1,16 @@
+<svg version="1.1" xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 1115 672"
width="1115" height="672">
+ <!-- svg-source:excalidraw -->
+ <!-- payload-type:application/vnd.excalidraw+json --><!-- payload-version:2
--><!-- payload-start
-->eyJ2ZXJzaW9uIjoiMSIsImVuY29kaW5nIjoiYnN0cmluZyIsImNvbXByZXNzZWQiOnRydWUsImVuY29kZWQiOiJ4nO2dW1PqWlx1MDAxMsffz6ew9rxcdTAwMWWcdb+cN+WugHKRizOnLFxiXHUwMDAxXCKBXHUwMDAwXHTXqfnus4L7SIRcdTAwMDSjO4xcdTAwMTlcdTAwMDfL2rVJXGLE5Ned7tX/1etfv11cXPxw1lx1MDAxM/3HXHUwMDFmXHUwMDE3P/SV1jaN7qy9/PG7u32hz2zDXHUwMDFhq11o+9q25jNt+86B40zsP/7+991cdTAwMTGXmjV6OUo39ZE+dmz1vn+o11x1MDAxN1x1MDAxN//a/qv2XHUwMDE4XffYa
[...]
+ <defs>
+ <style>
+ @font-face {
+ font-family: "Virgil";
+ src: url("https://excalidraw.com/Virgil.woff2";);
+ }
+ @font-face {
+ font-family: "Cascadia";
+ src: url("https://excalidraw.com/Cascadia.woff2";);
+ }
+ </style>
+ </defs>
+ <rect x="0" y="0" width="1115" height="672" fill="#ffffff"></rect><g
transform="translate(10 10) rotate(0 547.5 326)"><path d="M0.28300008848309516
-0.10272883251309395 C322.7684008703567 -3.249135070387274, 646.6541930401697
-3.1787367158569397, 1095.0694143541157 0.3002875201404095
M-0.14274714626371862 -0.14749729596078395 C435.26786967543893
-1.4277095694653688, 870.4879770824687 -1.2544425983540712, 1095.0382535990327
0.13947891034185886 M1095.5105304963886 0.6175911776721478 C109 [...]
\ No newline at end of file
diff --git a/backoffice-product-update.svg b/backoffice-product-update.svg
new file mode 100644
index 0000000..5585d5e
--- /dev/null
+++ b/backoffice-product-update.svg
@@ -0,0 +1,16 @@
+<svg version="1.1" xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 827 1012"
width="827" height="1012">
+ <!-- svg-source:excalidraw -->
+ <!-- payload-type:application/vnd.excalidraw+json --><!-- payload-version:2
--><!-- payload-start
-->eyJ2ZXJzaW9uIjoiMSIsImVuY29kaW5nIjoiYnN0cmluZyIsImNvbXByZXNzZWQiOnRydWUsImVuY29kZWQiOiJ4nO1dWXfiSNJ971/hU/Pa1uS+9Fx1MDAxYlx1MDAxOLxcdTAwMWIv2GD8nTk+XHUwMDAyZFx1MDAxMGazXHUwMDEwm2fmv3+R2GVcdTAwMDSSQLbBpeoxXaerXHUwMDAwXHQteW9E3MjI0L//2Nn54U/7zo+/dn44k5rdduuePf7xp/l85HhcdTAwMDO314WvyOz9oDf0arMtm77fXHUwMDFm/PXPf873sGq9zsteTtvpOF1/XHUwMDAw2/1cdTAwMWa839n59+z/geN4Ts23u422M9th9lXgUEguf1rodWeHZ
[...]
+ <defs>
+ <style>
+ @font-face {
+ font-family: "Virgil";
+ src: url("https://excalidraw.com/Virgil.woff2";);
+ }
+ @font-face {
+ font-family: "Cascadia";
+ src: url("https://excalidraw.com/Cascadia.woff2";);
+ }
+ </style>
+ </defs>
+ <rect x="0" y="0" width="827" height="1012" fill="#ffffff"></rect><g
transform="translate(10 10) rotate(0 403.5 496)"><path d="M0.6120161302387714
0.2306227557361126 C176.34838936785238 0.22690063446387648, 354.00070575121794
-0.3170953896678985, 807.453930426389 -0.3243877775967121
M-0.0015226308256387712 0.1010874155908823 C310.84229007391264
-3.3018346436135477, 621.1829346725718 -3.3442769773118206, 807.3457405503839
-0.35789241753518586 M807.2221156604588 0.14504600688815117 C807. [...]
\ No newline at end of file
diff --git a/design-documents/016-backoffice-order-managment.rst
b/design-documents/016-backoffice-order-managment.rst
index 6716c24..1fba8f3 100644
--- a/design-documents/016-backoffice-order-managment.rst
+++ b/design-documents/016-backoffice-order-managment.rst
@@ -17,7 +17,7 @@ Requirements
============
Access all information provided from the Merchant Backend API in a
-understandable and accesible way
+understandable and accessible way
User should use the backoffice to manage orders by:
@@ -32,7 +32,7 @@ Proposed Solution
Listing orders
--------------
-.. image:: ../backoffice-order-list.v2.svg
+.. image:: ../backoffice-order-list.svg
:width: 800
Will show the SearchBar component that allow multiple filter.
@@ -67,10 +67,10 @@ An export button will allow the user to download the result
page in CSV format.
An infinity scroll is propose instead of a pagination, reasons:
-* users usually does not jump from one page to anoter using random access
+* users usually does not jump from one page to another using random access
* if the user want to search, is going to limit the result using filters
* no need to go back after loading more result
-* it could be triggered by scrollin, with buttons (or both)
+* it could be triggered by scrolling, with buttons (or both)
Create orders
-------------
@@ -102,7 +102,7 @@ action buttons that allow the following:
Order details
-------------
-Status text should be set with a backgournd color for easier recognition when
+Status text should be set with a background color for easier recognition when
indicated:
* paid: green
@@ -172,7 +172,7 @@ collapsed as default. show disabled if unpaid
* total tax
* sum at the bottom
-* horizontal timeline of importants dates in the contract
+* horizontal timeline of important dates in the contract
* start at contract creation time
* show current date
@@ -199,7 +199,7 @@ If there is any refund:
* show total refund from ``refund_amount``
* a + sign to show more information
-* if exapanded show a timeline vertically showing amount a reason
+* if expanded show a timeline vertically showing amount a reason
``refund_details``
Show a small notice telling that the refund is going to take ``refund_delay``
time.
@@ -212,13 +212,13 @@ Ask for:
* reason: concatenation of the next values
* drop down options: duplicated, fraudulent, requested by customer, other
- * aflter selecting, free text for aditional information
+ * after selecting, free text for additional information
Alternatives
============
-order list was originaly thought with pagination footer
+order list was originally thought with pagination footer
.. image:: ../backoffice-order-list.v2-pagination.svg
:width: 800
@@ -227,12 +227,12 @@ ascending boolean flag cloud be eliminated using the load
before and load after
and a design without random access to pages was proposed
-Q&A
-===
+Discussion / Q&A
+================
* Shall we show merchant information from the ContractTerm in the order detail?
-* Order creation was first thouth as out of scope but should be useful for
+* Order creation was first thought as out of scope but should be useful for
testing purpose or when frontend is not yet integrated with taler merchant
backend. Shall we skip it?
diff --git a/design-documents/017-backoffice-inventory-managment.rst
b/design-documents/017-backoffice-inventory-managment.rst
index f896c44..e8c1a33 100644
--- a/design-documents/017-backoffice-inventory-managment.rst
+++ b/design-documents/017-backoffice-inventory-managment.rst
@@ -4,18 +4,19 @@ Design Doc 017: Backoffice Inventory Management
Summary
=======
-This document describe the complete list features for inventory management and
how
-will be shown.
+This document describe the complete list features for inventory management and
+how will be shown.
Motivation
==========
+User will use the backoffice to manage their inventory, prices and update
stock.
Requirements
============
Access all information provided from the Merchant Backend API in a
-understandable and accesible way
+understandable and accessible way
User should use the backoffice to manage inventory by:
@@ -23,19 +24,106 @@ User should use the backoffice to manage inventory by:
* updating the products information
* inspecting inventory list
* deleting products from the inventory list
-* accesing detailed information of a product
Proposed Solution
=================
+Inspecting inventory
+--------------------
+.. image:: ../backoffice-product-list.svg
+ :width: 800
+Listing the product will shown this columns:
+
+* image
+* description
+* sell price
+* total taxes
+* profit (price - taxes)
+* stock left (with next_restock in days if present)
+* stock sold
+
+Actions will be
+
+* modify
+* delete: with a confirm popup, it may fail if have some locked
+
+Create and Update Product form
+------------------------------
+
+Creating without stock
+**********************
+
+.. image:: ../backoffice-product-create.with-stock.svg
+ :width: 800
+
+Creating with defined stock
+***************************
+
+.. image:: ../backoffice-product-create.without-stock.svg
+ :width: 800
+
+Updating
+***************************
+
+.. image:: ../backoffice-product-update.svg
+ :width: 800
+
+Update product will use the same form except for the ``product_id``
+
+* product_id: BACKOFFICE_URL + id
+* description: split in two fields, concatenated with a line separator
+
+ * name: required, one line
+ * extra: optional, free text area
+
+* description localized: list with
+
+ * lang: dropdown list with supported lang + custom
+ * description: text area
+
+* unit: string
+* price: amount
+* image: image box that allows upload when clicked
+* taxes: list with
+
+ * name: string
+ * value: amount
+
+* Stock: button that opens more fields for stock control
+
+ * initial stock: number
+ * address: first collapsed, then field for Location
+ * next_restock: date
+ * cancel: button to set the stock to infinity, closing the section
+
+
Alternatives
============
+* price and stock columns in the list can be merged into a more complex column
+ with the same information
+* rows in the table can be expandable when clicked to get access to some common
+ actions like increase stock or change price
+.. image:: ../backoffice-product-list.actions.svg
+ :width: 800
+
+* detail page was intentionally left out since all information can be access
+ from the update page
Q&A
===
+* can we add the quantity locked in the product description? so we can add it
+ to the inventory list to reflect the current activity.
+
+* can we allow add extra data like order has in contractTerm?, this could be
+ useful for frontend apps. example of usage: country/state to where the
product
+ is sold since taxes may vary
+
+
+
+
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.