Difference between revisions of "Folksonomy Engine"

Revision as of 07:37, 15 September 2021

The goal of Folksonomy engine is to unleash an ocean of new usages regarding food knowledge. Folksonomy engine allows all kind of people — citizens, researchers, journalists, professionals, artists, communities, innovators... — to enrich and use Open Food Facts, thanks to free tags and properties for your own use or to enrich the shared knowledge. Open Food Facts, as the biggest open-food database in the world, already feeds hundreds of data reuses. It will allow thousands of new apps and new usages.

Documentation and communication

Short presentation (4 pages)
https://docs.google.com/document/d/1vYOAXGCatRx_wThW-JvOiM7P6VIIlweXr4uCOAhvEgU/ Folksonomy Whitepaper
Project document Wiki page. (This current document)

Other directories/documents (if any)

Main directory for documentation

Code and bug tracking on Github:

Folksonomy Engine repo: this repository centralise issues and discussions dedicated to the whole project

Slack channel: #folksonomy_engine

Who

Skills needed (in short)

Project management
Dev

Project team:

Project manager: Lucas
Project owner: Charles
End-user tester: ?
Dev: Stéphane
Others?

Use cases

Health and food safety
Cooking and preparation
Grocery Apps
Product qualities
(Bad) Food Marketing
1. List properties of products targeting particular people
2. List properties of products related to consumers behavior

See, some use cases we are starting to investigate.

How

As of today, Open Food Facts is made of a set of predefined properties (about 20 types of properties such as the product name, the product weight, the ingredients, the nutrients, etc.). Folksonomy engine will add several kinds of new individual data properties to Open Food Facts or Open Products Facts. In fact the scope of such new data properties is nearly endless, so we intend to get feedback from the community to define which one we should implement and how the user interface should look like.

Social tagging

Social tagging can be introduced in different ways. Simpler forms as Hashtags or Text Tags or more complex ones as individual attributes in units.

Text Tags

There are many ways to implement social tagging inside of text, as simple plain keywords or more sophisticated forms with colors or different types of tags. The list of tags can be completely free for the user, predefined by admins or curated by admins.

Individual properties and attributes

Properties, or material facts, allowing to specify a value or multiple values for the corresponding product. Eg. it allows adding free properties with values.

Example: This product height is 35 cm, which ends up in a tag like [height = 35cm].

Sometimes a property can have multiple values:

Example: This product has to be recalled if produced on 2020-03-31, 2020-04-01, 2020-04-02. [Recall: if produced from 2020-03-31 - 2020-04-02]

Deliverable	Date	Who
D1. Ideation document: uses cases (report in wiki page) define first use cases (see D6)	Feb.	XX
D2. Functional and technical specifications (architecture design) (report in wiki page) Functional use cases and specifications. Technical specifications.	September	Charles Stéphane (Review)
D3. Server-side implementation (database and web UI): properties’ database implementation and CRUD interfaces with a minimal UI to validate the design: database implementation (new database or new fields) CRUD interfaces in the backend (Product Opener) web interfaces (in production)	September	Christian (dev) Charles (tests)
D4. Search and discovery integration and APIs. Making properties accessible using simple search and a discovery engine; integration with the advanced search; API access all dev in the backend	April-May	Stéphane (dev) XX (tests)
D5. Mobile UI integration on the Open Food Facts apps	June	XX
D6. Three uses cases: move ambiguous “Nutriscore Experiment” labels in tags XXXX (to be found) XXXX (to be found)	Sep.	XX

Wishful deliverables

Here we put wishful deliverables if any.

Tool to monitor tag usages.
Workshop for contributors.

Questions/ideas

What about a deliverable dedicated to communication?
Use case in collaboration with scientists?

@@ Line 1: / Line 1: @@
+[[Category:Folksonomy Engine]]
+[[Category:Roadmap]]
 The goal of '''Folksonomy engine''' is to unleash an ocean of new usages regarding food knowledge. Folksonomy engine allows all kind of people — citizens, researchers, journalists, professionals, artists, communities, innovators... — to enrich and use Open Food Facts, thanks to '''free tags and properties''' for your own use or to enrich the shared knowledge. Open Food Facts, as the biggest open-food database in the world, already feeds hundreds of data reuses. It will allow thousands of new apps and new usages.
@@ Line 8: / Line 10: @@
 Other directories/documents (if any)
 * [https://drive.google.com/drive/u/0/folders/1U7OkC6ZTg3kk_3w5mPGnb1cl5mStFqBQ Main directory for documentation]
+Code and bug tracking on Github:
+* [https://github.com/openfoodfacts/folksonomy_engine Folksonomy Engine repo]: this repository centralise issues and discussions dedicated to the whole project
+* [https://github.com/openfoodfacts/folksonomy_api Folksonomy Engine API]
+* [https://github.com/openfoodfacts/folksonomy_frontend Folksonomy Engine frontend]
 Slack channel: [https://app.slack.com/client/T02KVRT1Q/C01M1T2E8L8/thread/C0116U37JCE-1611738330.008000 #folksonomy_engine]
@@ Line 24: / Line 32: @@
 == Use cases ==
-. Health and food safety
+#  Health and food safety
-. Cooking and preparation
+#  Cooking and preparation
-. Grocery Apps
+#  Grocery Apps
-. Product qualities
+#  Product qualities
-. (Bad) Food Marketing
+#  (Bad) Food Marketing
-.1. List properties of products targeting particular people
+## List properties of products targeting particular people
-.2. List properties of products related to consumers behavior
+## List properties of products related to consumers behavior
+See, [[Folksonomy Engine/Uses cases|some use cases]] we are starting to investigate.
 == How ==
-Needed deliverables.
+As of today, Open Food Facts is made of a set of predefined properties (about 20 types of properties such as the product name, the product weight, the ingredients, the nutrients, etc.).
+Folksonomy engine will add several kinds of new individual data properties to Open Food Facts or Open Products Facts. In fact the scope of such new data properties is nearly endless, so we intend to get feedback from the community to define which one we should implement and how the user interface should look like.
+=== Social tagging ===
+Social tagging can be introduced in different ways. Simpler forms as Hashtags or Text Tags or more complex ones as individual attributes in units.
+==== Text Tags ====
+There are many ways to implement social tagging inside of text, as simple plain keywords or more sophisticated forms with colors or different types of tags. The list of tags can be completely free for the user, predefined by admins or curated by admins.
+==== Individual properties and attributes ====
+Properties, or material facts, allowing to specify a value or multiple values for the corresponding product. Eg. it allows adding free properties with values.
+Example: This product height is 35 cm, which ends up in a tag like [height = 35cm].
+Sometimes a property can have multiple values:
+Example:  This product has to be recalled if produced on 2020-03-31, 2020-04-01, 2020-04-02.
+[Recall: if produced from 2020-03-31 - 2020-04-02]
 {| class="wikitable"
@@ Line 49: / Line 80: @@
 |-
 | D2. Functional and technical specifications (''architecture design'') (report in wiki page)
-| Feb.
-| XX
+* [[Folksonomy Engine/Functional use cases and specifications|Functional use cases and specifications]].
+* [[Folksonomy Engine/Technical specifications|Technical specifications]].
+| September
+| Charles
 Stéphane (Review)
 |
@@ Line 58: / Line 92: @@
 * CRUD interfaces in the backend (Product Opener)
 * web interfaces (in production)
-| March-April
+| September
-| Stéphane (dev)
+| Christian (dev)
-XX (tests)
+Charles (tests)
 |
 |-