Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation: Add Dashboard Documentation. (https://github.com/woocommerce/woocommerce-admin/pull/3491) 

* Create Dashboard doc.

* intro, dashboard sections, and performance indicators.

* few more udpates.

* Updates per feedback.
This commit is contained in:
Timmy Crawford 2020-02-14 12:58:00 -08:00 committed by GitHub
parent 3435c7d51a
commit ae11c1a0de
1 changed files with 78 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
plugins/woocommerce-admin/docs/woocommerce.com/analytics-dashboard.md Normal file
View File

@ -0,0 +1,78 @@
# WooCommerce Dashboard
The new dashboard in WooCommerce has been designed to allow you to keep track of the statistics and data that matter most to your site. Each section of the dashboard can be fully customized to meet the needs of your store, and also act as launching points to dive deeper into other Analytics Reports.
The dashboard is comprised of three sections: Performance Indicators, Charts, and Leaderboards. The data presented in these sections are controlled by the Date Picker which appears at the top of the page. This lets you quickly look at data for a number of preset date ranges like week, month, quarter, and year to date, or to select a specific date range to view.
Furthermore these sections can be re-ordered, re-named, or even toggled off if you don't want to view a particular section(s).
## Customizing Dashboard Sections
To customize dashboard sections, click the kebab menu in the top right corner of the section. The first item that appears in this menu is the ability to toggle the display of the various stats that are shown in the section. Below that you will find options for renaming the section, moving it up or down, or removing it entirely from the dashboard.
### Adding a Dashboard Section
If you removed a dashboard section, or you have an extension installed that adds in an option for a new section, a plus icon will appear at the bottom of your dashboard. Clicking that plus will allow you to insert previously removed sections, or add in new ones.
## Performance Indicator Section
By default the Performance Indicators section is what appears at the top of your dashboard below the Date Picker. Each performance indicator will display a label informing you of the statistic that is being presented, the value of that statistic for the date range selected, a percentage change over the prior period along with a trend arrow of up/down/same, and the value for the previous period that is being compared.
Beyond giving you a quick glimpse into the statistic, Peroformance Indicators also act as a quick shortcut to dive deeper into the data behind the stat. For example, clicking on the Total Sales indicator will open up the Revenue Report for the date range that has been selected on the Dashboard. From there you can view associated charts, and tabular data for deeper analysis.
Using the customization menu in the top right corner of the section, you can toggle the display of the following default performance indicators:
| Indicator Name | Description | Links To ( Report Name > Chart Name ) |
|---|---|---|
| Total Sales | Gross Sales - Returns - Coupons + Taxes + Shipping | Revenue Report > Total Sales |
| Net Sales | Gross Sales - Returns - Coupons | Revenue Report > Net Sales |
| Orders | The number of new orders placed for a selected date range | Orders Report > Orders |
| Average Order Value | Net Sales / Orders | Orders Report > Average Order Value |
| Items Sold | The discrete number of items sold. | Products Report > Items Sold |
| Refunds | Money returned to the customer via a refund | Revenue Report > Refunds |
| Discounted Orders | The count of orders with a coupon applied. | Coupons Report > Orders Count |
| Net Discount Amount | Total sum of discounts from coupons. | Coupons Report > Amount |
| Total Tax | Order Tax + Shipping Tax | Taxes Report > Total Tax |
| Order Tax | The total of tax applied to items in an order | Taxes Report > Order Tax |
| Shipping Tax | The total of tax applied to shipping in an order | Taxes Report > Shipping Tax |
| Shipping | The shipping charges associated with an order or refund. | Revenue Report > Shipping |
| Downloads | Total count of downloaded files | Downloads Report > Download Count |
| Gross Sales | Sale price of product(s) x quantity ordered. Does not include refunds, coupons, taxes or shipping | Revenue Report > Gross Sales |
## Charts Section
The next section displayed by default is Charts. The customization menu again allows you to toggle the display of charts that are most useful for your Store. The following charts are available to display in this section:
| Chart Name | Description | Links To ( Report Name > Chart Name ) |
|---|---|---|
| Total Sales | Gross Sales - Returns - Coupons + Taxes + Shipping | Revenue Report > Total Sales |
| Net Sales | Gross Sales - Returns - Coupons | Revenue Report > Net Sales |
| Orders | The number of new orders placed for a selected date range | Orders Report > Orders |
| Average Order Value | Net Sales / Orders | Orders Report > Average Order Value |
| Items Sold | The discrete number of items sold. | Products Report > Items Sold |
| Refunds | Money returned to the customer via a refund | Revenue Report > Refunds |
| Discounted Orders | The count of orders with a coupon applied. | Coupons Report > Orders Count |
| Gross Discount Amount | Total sum of discounts from coupons. | Coupons Report > Amount |
| Total Tax | Order Tax + Shipping Tax | Taxes Report > Total Tax |
| Order Tax | The total of tax applied to items in an order | Taxes Report > Order Tax |
| Shipping Tax | The total of tax applied to shipping in an order | Taxes Report > Shipping Tax |
| Shipping | The shipping charges associated with an order or refund. | Revenue Report > Shipping |
| Downloads | Total count of downloaded files | Downloads Report > Download Count |
### Chart Interval Options
The charts section has a control which allows you to set the time interval to display in the charts. The options displayed in the interval drop down are determined by how long of a date range you currently have selected in the Date Picker.
| Length of Date Range | Interval Options |
|---|---|
| One year or more | 'day', 'week', 'month', 'quarter', 'year' |
| 90 days to 1 year | 'day', 'week', 'month', 'quarter' |
| 1 month - 89 days | 'day', 'week', 'month' |
| 1 week - 28 days | 'day', 'week' |
| 1 day - 1 week | 'day' |
| 1 day | 'day', 'hour' |
### Chart Type Option
The last way you can customize the appearance of the charts is the ability to toggle between Line and Bar charts. Your selection chosen here will be saved to your user options and used on subsequent visits to the WooCommerce Dashboard.
## Leaderboard Section
The final section on the Dashboard allows you to view four different "Leaderboards" for your store's statistics. Like the other two sections, you can also toggle the visibility of the leaderboards via the customization menu. By default you have the following four Leaderboards to choose from:
- Top Customers, Total Spend
- Top Coupons, Number of Orders
- Top Categories, Items Sold
- Top Products, Items Sold