24 lines
1.3 KiB
ReStructuredText
24 lines
1.3 KiB
ReStructuredText
Gamification module documentation
|
|
=================================
|
|
|
|
The Gamification module holds all the module and logic related to goals, plans and badges. The computation is mainly done in this module, other modules inherating from it should only add data and tests.
|
|
|
|
Goals
|
|
-----
|
|
A **Goal** is an objective applied to an user with a numerical target to reach. It can have a starting and end date. Users usually do not create goals but relies on goal plans.
|
|
|
|
A **Goal Type** is a generic objective that can be applied to any structure stored in the database and use numerical value. The creation of goal types is quite technical and should rarely be done. Once a generic goal is created, it can be associated to several goal plans with different numerical targets.
|
|
|
|
A **Goal Plan** (also called Challenge in the interface) is a a set of goal types with a target value to reach applied to a group of users. It can be periodic to create and evaluate easily the performances of a team.
|
|
|
|
Badges
|
|
------
|
|
A **Badge** is a symbolic token granted to a user as a sign of reward. It can be offered by a user to another freely or with some required conditions (selected users, max. number of time per month, etc.).
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
goal_type
|
|
goal
|
|
gamification_plan_howto
|
|
|