diff --git a/docs/api/tutorial-dev-journey.md b/docs/api/tutorial-dev-journey.md index 699ab822aec32..f5fae4ace3856 100644 --- a/docs/api/tutorial-dev-journey.md +++ b/docs/api/tutorial-dev-journey.md @@ -16,7 +16,7 @@ To identify the potential users' needs, Dave has met with some conscious consume ### Developer journeys - []()Dev Journey 1: Comparing sodas for Anna -- []()Dev Journey 2: Finding healthy breakfast cereals for Stefano +- []()Dev Journey 2: Finding healthy breakfast cereals for Stefano - []()Dev Journey 3: Adding missing products - []()Dev Journey 4: Get the Nutri-Score - []()Dev Journey 5: Get the Eco-Score diff --git a/docs/introduction/get-the-nutriscore.md b/docs/introduction/get-the-nutriscore.md new file mode 100644 index 0000000000000..2200e8a942cf9 --- /dev/null +++ b/docs/introduction/get-the-nutriscore.md @@ -0,0 +1,96 @@ + +### Introduction +- If you can't get the information on a specific product, you can get your user to send photos and data, that will then be processed by Open Food Facts AI and contributors to get the computed result you want to show them. +- You can implement the complete flow below so that they get immediately the result with some effort on their side. +- That will ensure user satisfaction + +### Display Nutri-Score knowledge panels - All the logic below in 5 lines of code ! +- The Knowledge Panels are already implemented in the Dart package +- They are simple to implement from the JSON API +- They allow you to consume present and future knowledge from Open Food Facts + +### Using the official visual assets of the Nutri-Score + +use the official assets to display de nutriscore. You can get v1 logos here: [NutriScore variants](https://drive.google.com/drive/u/1/folders/13SL2hgqYHSLMhYjMze9nYXV9GOdGMBgc) + +### Getting ready for Nutri-Score V2 +- Nutri-Score V2 has a new computation method, which now requires the ingredient list, a category, and of course the nutrition table +- It also has a transition period new logo, to indicate you are using the new computation. It is not compulsory to use it, but it will save you from a lot of questions from your users ("Do you have the new formula ?") +- You can get the new assets by contacting reuse@openfoodfacts.org. We will make them public as soon as possible. + +### Manual version: Getting the Nutri-Score v1 value (we don't recommand the manual way anymore, especially with v2 around the corner) + +### Data completion flow + +Here are the different messages to use according to the state: + +#### Add a message if we have a category but no Nutri-Score + +
if "en:categories-completed" in states_tags AND nutrition_grade=Null
+ +
"We could not compute an Nutri-Score for this product. It might be that the category is an exception. If you believe this is an error, you can email contact@thenameofyourapp.org"
+ +- List of exceptions: +- You can get states with [https://world.openfoodfacts.org/api/v0/product/3414280980209.json?fields=ecoscore_grade,states_tags ](https://world.openfoodfacts.org/api/v0/product/3414280980209.json?fields=ecoscore_grade,states_tags) + +#### Add a message if we have a category but no nutrition + +
if "en:categories-completed" in states_tags  AND "en:nutrition-facts-to-be-completed" in states_tags
pre> + +- Prompt: "Add nutrition facts to compute the Nutri-Score" + +- Add a one-click option to indicate no nutrition facts on the packaging + - "This product doesn't have nutrition facts" + +#### Add a message if we have nutrition but no category + +
if "en:categories-to-be-completed" in states_tags AND "en:nutrition-facts-completed" in states_tags
+ +- Prompt: "Add a category to compute the Nutri-Score" + +#### Help the user add the category if it is missing + +- You can use our Robotoff API to get your users to validate a prediction + +- [Robotoff Questions](https://docs.google.com/document/d/1IoDy0toQrrqtWHvDYp2rEVw84Yq1J0x2pt-0RGTm7h0/edit) + +#### Add a message if we have no category and no nutrition + +
if "en:categories-to-be-completed" in states_tags  AND "en:nutrition-facts-to-be-completed" in states_tags
+ +- Prompt: "Add nutrition facts and a category to compute the Nutri-Score" + +#### Add a one-click option to indicate no nutrition facts on the packaging + +- This product doesn't have nutrition facts + +#### Add a message if the nutrition image is missing + +
if "en:nutrition-photo-to-be-selected" in states_tags OR "en:photos-to-be-uploaded" in states_tags
+ +#### Add a message if the nutrition image is obsolete using the image refresh API + +- + +#### Add Nutri-Score disclaimers + +##### a message if fibers are missing +
+msgctxt "nutrition_grade_fr_fiber_warning"
+msgid "Warning: the amount of fiber is not specified, their possible positive contribution to the grade could not be taken into account."
+
+##### a message if fruit/nuts are missing +
+msgctxt "nutrition_grade_fr_no_fruits_vegetables_nuts_warning"
+msgid "Warning: the amount of fruits, vegetables and nuts is not specified, their possible positive contribution to the grade could not be taken into account."
+
+##### a message if fruits/nuts is an estimate from ingredients +
+msgctxt "nutrition_grade_fr_fruits_vegetables_nuts_estimate_warning"
+msgid "Warning: the amount of fruits, vegetables and nuts is not specified on the label, it was estimated from the list of ingredients: %d%"
+
+##### a message if fruits/nuts is an estimate from category +
+msgctxt "nutrition_grade_fr_fruits_vegetables_nuts_from_category_warning"
+msgid "Warning: the amount of fruits, vegetables and nuts is not specified on the label, it was estimated from the category (%s) of the product: %d%"
+