Merge pull request #4645 from cielf/user_docs_cont_iii

User docs cont iii
rubyforgood · Sep 8, 2024 · e8e16fc · e8e16fc
2 parents fddaa0c + 3e4fb9a
commit e8e16fc
Show file tree

Hide file tree

Showing 23 changed files with 174 additions and 7 deletions.
diff --git a/docs/user_guide/bank/images/reports/reports_activity_graph_1.png b/docs/user_guide/bank/images/reports/reports_activity_graph_1.png
diff --git a/docs/user_guide/bank/images/reports/reports_activity_graph_2.png b/docs/user_guide/bank/images/reports/reports_activity_graph_2.png
diff --git a/docs/user_guide/bank/images/reports/reports_annual_survey_1.png b/docs/user_guide/bank/images/reports/reports_annual_survey_1.png
diff --git a/docs/user_guide/bank/images/reports/reports_annual_survey_2.png b/docs/user_guide/bank/images/reports/reports_annual_survey_2.png
diff --git a/docs/user_guide/bank/images/reports/reports_annual_survey_3.png b/docs/user_guide/bank/images/reports/reports_annual_survey_3.png
diff --git a/docs/user_guide/bank/images/reports/reports_annual_survey_4.png b/docs/user_guide/bank/images/reports/reports_annual_survey_4.png
diff --git a/docs/user_guide/bank/images/reports/reports_annual_survey_5.png b/docs/user_guide/bank/images/reports/reports_annual_survey_5.png
diff --git a/docs/user_guide/bank/images/reports/reports_distributions_by_county_1.png b/docs/user_guide/bank/images/reports/reports_distributions_by_county_1.png
diff --git a/docs/user_guide/bank/images/reports/reports_distributions_by_county_2.png b/docs/user_guide/bank/images/reports/reports_distributions_by_county_2.png
diff --git a/docs/user_guide/bank/images/reports/reports_itemized_1.png b/docs/user_guide/bank/images/reports/reports_itemized_1.png
diff --git a/docs/user_guide/bank/images/reports/reports_manufacturer_donations_1.png b/docs/user_guide/bank/images/reports/reports_manufacturer_donations_1.png
diff --git a/docs/user_guide/bank/images/reports/reports_manufacturer_donations_2.png b/docs/user_guide/bank/images/reports/reports_manufacturer_donations_2.png
diff --git a/docs/user_guide/bank/images/reports/reports_trends_1.png b/docs/user_guide/bank/images/reports/reports_trends_1.png
diff --git a/docs/user_guide/bank/images/reports/reports_trends_2.png b/docs/user_guide/bank/images/reports/reports_trends_2.png
diff --git a/docs/user_guide/bank/images/reports/reports_trends_3.png b/docs/user_guide/bank/images/reports/reports_trends_3.png
diff --git a/docs/user_guide/bank/reports_activity_graph.md b/docs/user_guide/bank/reports_activity_graph.md
@@ -1 +1,13 @@
-Not yet written
+DRAFT USER GUIDE
+# Activity Graph Report
+This report is merely a visual representation of the number of items processed over a time period.
+
+![activity_graph_default_view](images/reports/reports_activity_graph_1.png)
+
+If you want to see a time period other than the current year,  change the date range and click "Filter".  Note,  we recommend you use the little pop-up gizmo to enter your date range, as the format of the date range is very fussy.
+
+![activity_graph_with_date_range_gizmo](images/reports/reports_activity_graph_2.png)
+
+[Back to Manufacturers Donations](reports_manufacturers_donations.md)
+[Next: User Management](user_management.md)
+
diff --git a/docs/user_guide/bank/reports_annual_survey.md b/docs/user_guide/bank/reports_annual_survey.md
@@ -1 +1,38 @@
-Not yet written
+DRAFT USER GUIDE
+## Annual Survey
+The annual survey contains information useful for completing the NDBN or Alliance for Period Supplies annual survey, but also for grant writing.
+Each year's annual survey becomes available January 1 of the following
+
+## How to get the report
+
+Click on "Reports", then "Annual Survey" in the left-hand menu.  Then click on the year of the report you wish to view.
+![Navigation to annual report](images/reports/reports_annual_survey_1.png)
+
+This brings up the report.  
+
+![Annual Report_screen_1](images/reports/reports_annual_survey_2.png)
+![Annual Report_screen_2](images/reports/reports_annual_survey_3.png)
+![Annual Report_screen_3](images/reports/reports_annual_survey_4.png)
+![Annual Report_screen_4](images/reports/reports_annual_survey_5.png)
+
+### Recalculation
+If you have added information for that year since the last time you ran the report, you should recalculate the report by clicking "Recalculate Report" (A)
+You may want to recalculate older reports as they will not reflect any changes we made since they were generated.
+
+### Exporting
+You can also extract the report to a csv file by clicking "Export Report" (B)
+
+### Calculation notes
+
+1/ We are in the process of changing the calculations so that items in kits appear in the totals for each value.  
+At time of writing, the # of disposable and cloth diapers distributed include any diapers in kits,  but period supplies, adult incontinence, and other do not.
+At time of writing, purchased/donated supplies do not include any kit purchases/donations. ( We only know of one bank that currently has kits donated.)
+
+2/ % donated / purchased is based on the number of items acquired,  not the number of items distributed.
+
+3/ How we calculate per person values:  
+    If you have entered a non-zero value for an [item](inventory_items.md) in the quantity per individual field, we use that value.  Otherwise, we assume 50 of the item per individual. 
+[TODO:  When inventory_items.md is written,  point the above link to the right place in it.]
+
+
+[Prior: Trends](reports_trends.md)        [Next: Distributions by County](reports_distributions_by_county.md)
diff --git a/docs/user_guide/bank/reports_distribution_by_county.md b/docs/user_guide/bank/reports_distribution_by_county.md
diff --git a/docs/user_guide/bank/reports_distributions_by_county.md b/docs/user_guide/bank/reports_distributions_by_county.md
@@ -0,0 +1,20 @@
+DRAFT USER GUIDE
+# Distributions by County Report
+
+
+![distributions_by_county_default_view](images/reports/reports_distributions_by_county_1.png)
+
+This report shows the total items and estimated total market value of the distributed items for the time period.
+
+We use the area served information entered in each partner's [profile](pm_partner_profiles.md) to allocate the items that have been distributed to them.  If that information has not been provided,  the items you've distributed are put into the 'Unspecified' category.
+
+
+**N.B.** If you are using kits, please note that this treats each kit as an item,  rather than counting the items within the kits separately.
+
+If you want to see a time period other than the current year,  change the date range and click "Filter".  We recommend you use the little pop-up gizmo to enter your date range, as the format of the date range is very fussy.
+
+![distributions_by_county_with_date_range_gizmo](images/reports/reports_distributions_by_county_2.png)
+
+[Back to Annual Survey](reports_annual_survey.md)
+
+[Next: Manufacturer Donations Report](reports_manufacturers_donations.md)
diff --git a/docs/user_guide/bank/reports_itemized_reports.md b/docs/user_guide/bank/reports_itemized_reports.md
@@ -1 +1,19 @@
-Not yet written
+DRAFT USER GUIDE!
+
+# Itemized Reports
+
+The itemized reports break down the inventory by item over a given time period.   There are itemized reports for donations and for distributions.  
+The following will use the itemized report for distributions,  but the itemized report for donations basically works the same way.
+
+To show this report,  click on "Reports" in the left-hand menu, then "Distributions - Itemized"
+![Initial Itemized Reports view](images/reports/reports_itemized_1.png)
+
+The initial view that comes up will show the items distributed during the current calendar year. 
+[TODO:  Check if the filtration here is on issued_at or on the date of the line items]
+
+If the amount on hand is less than the minimum quantity you provided for that item (see [Items](inventory_items.md)), then the on hand amount will be highlighted in red.  
+
+You can change the timeframe that this report covers in the usual way -- use the gizmo that will appear if you click on the date range at the top of the report to set the dates, then click "Filter"
+
+
+[Prior -- Summary Reports](reports_summary_reports.md)    [Next -- Trends Reports](reports_trends.md)
diff --git a/docs/user_guide/bank/reports_manufacturers_donations.md b/docs/user_guide/bank/reports_manufacturers_donations.md
@@ -1 +1,26 @@
-Not yet written
+DRAFT USER GUIDE
+
+# Manufacturers Donations Report
+
+To access this report,  click 'Reports", then "Donations - Manufacturers"
+
+![manufacturer_donations_report_default](images/reports/reports_manufacturer_donations_1.png)
+
+
+This shows the number of items donated by manufacturers over the indicated time period (default current year), as well as the top manufacturers donating in that time period.
+[TODO:  Confirm -- is this true -- or is this still broken?]
+
+From here, you can click on the listed manufacturers to see a breakdown of their donations.
+
+Or enter a new donation (by clicking on "New Donation", naturally.)
+
+Or see all donations for the time period, by clicking on 'See more...'
+
+If you want to see a time period other than the current year,  change the date range and click "Filter".  We recommend you use the little pop-up gizmo to enter your date range, as the format of the date range is very fussy.
+
+![manufacturer_donations_date_range_gizmo](images/reports/reports_manufacturer_donations_2.png)
+
+
+[Back to Distributions by County](reports_distributions_by_county.md)
+
+[Next: Activity Graph](reports_activity_graph.md)
diff --git a/docs/user_guide/bank/reports_summary_reports.md b/docs/user_guide/bank/reports_summary_reports.md
@@ -1 +1,25 @@
-Not yet written
+DRAFT USER GUIDE
+# Summary Reports
+
+There are 3 Summary reports - one each for Distributions, Donations, and Purchases
+
+These each allow you to quickly get the number of items dealt with in a timeframe, plus links to recent activity
+
+## Distribution Summary
+This gives the number of items distributed -- initially year-to-date, but you can filter by whatever date range you wish.  This filtering works against the "issued_at" date on the distribution, rather than the date it was entered. 
+
+The report also gives the number of items that are in distributions that have an "issued at" in the future.
+
+The "recent distributions" section shows recently entered distributions that match the date filter.   That is,  whether or not a distribution shows here is based on the filter,  but the order depends on when it was entered -- latest first.
+[TODO: Marked up Screenshots]
+
+## Donation Summary
+This is quite similar to the Distribution summary, above.
+This gives the number of items donated -- initially year-to-date, but you can filter by whatever date range you wish.  This filtering works against the "issued on" date on the distribution, rather than the date it was entered.
+It also gives the total of monetary donations recorded in the system for that period
+The "recent donations" section shows recently entered donations that match the date filter.   That is,  whether or not a donation shows here is based on the filter,  but the order depends on when it was entered -- latest first.
+[TODO: Marked up Screenshots]
+
+## Purchase Summary
+This merely gives the amount spent during the period, along with recently entered purchases that match the date filter.  The filter works on the issued on date, but the ordering is by the creation date of the purchase.
+[TODO: Marked up Screenshots]
diff --git a/docs/user_guide/bank/reports_trends.md b/docs/user_guide/bank/reports_trends.md
@@ -1 +1,33 @@
-Not yet written
+DRAFT USER GUIDE
+# Trends Reports
+The trends reports (one each for Distributions, Donations, and Purchases) give you a picture of the activity on any item over the last 12 months. 
+
+The examples below will use the Distributions - Trends report, but everything is basically the same for Donations- Trends and Purchases - Trends.
+
+Please note that the levels for these reports may be up to 24 hours old -- we generate the overnight because it would be a very slow report otherwise.
+
+## Navigation
+To bring up the Distributions - Trends Report,  click on "Reports", then "Distributions - Trends" 
+
+This will bring up a blank "Monthly" Distributions report, like so: 
+
+![Blank trends report](images/reports/reports_trends_1.png)
+
+To see the activity on a particular item, click on that item.   You can click on as many as you want -- if, for instance, you want compare the distributions of multiple sizes, you can do that -- but in general, fewer will be better.
+
+(Our test data only has very recent data in it, so you'll see more bars, unless of course, you are a brand new bank!)
+
+![trends report with 2 items](images/reports/reports_trends_2.png)
+
+You can also hover over any month to see the numerical levels for the chosen items for that month.  
+
+![trends report with breakout](images/reports/reports_trends_3.png)
+
+To clear the items - either click on them again,  or click "Deselect All"
+
+You can click "Select All" to see *all* the items,  but that will produce a very busy visual.
+
+
+
+
+[Prior - Itemized reports](reports_itemized_reports.md)    [Next - Annual Survey](reports_annual_survey.md)