From 5ca906928ca56ec83f7a02ecd8aa06ba04738e33 Mon Sep 17 00:00:00 2001 From: Sergi Almacellas Abellana Date: Mon, 30 Mar 2026 22:13:32 +0200 Subject: [PATCH] Update documentation of production work module --- modules/production_work/CHANGELOG | 13 +++ modules/production_work/doc/design.rst | 100 +++++++++++++++++++++++ modules/production_work/doc/index.rst | 66 ++------------- modules/production_work/doc/releases.rst | 7 ++ 4 files changed, 127 insertions(+), 59 deletions(-) create mode 100644 modules/production_work/doc/design.rst create mode 100644 modules/production_work/doc/releases.rst diff --git a/modules/production_work/CHANGELOG b/modules/production_work/CHANGELOG index 59a33fb2dc..2e260b37ae 100644 --- a/modules/production_work/CHANGELOG +++ b/modules/production_work/CHANGELOG @@ -40,46 +40,59 @@ Version 6.6.0 - 2022-10-31 * Bug fixes (see mercurial logs for details) Version 6.4.0 - 2022-05-02 +-------------------------- * Bug fixes (see mercurial logs for details) * Add support for Python 3.10 * Remove support for Python 3.6 Version 6.2.0 - 2021-11-01 +-------------------------- * Bug fixes (see mercurial logs for details) Version 6.0.0 - 2021-05-03 +-------------------------- * Bug fixes (see mercurial logs for details) Version 5.8.0 - 2020-11-02 +-------------------------- * Bug fixes (see mercurial logs for details) * Remove support for Python 3.5 * Add start and stop buttons on works Version 5.6.0 - 2020-05-04 +-------------------------- * Bug fixes (see mercurial logs for details) * Make work center not required on request and draft states Version 5.4.0 - 2019-11-04 +-------------------------- * Bug fixes (see mercurial logs for details) Version 5.2.0 - 2019-05-06 +-------------------------- * Bug fixes (see mercurial logs for details) Version 5.0.0 - 2018-10-01 +-------------------------- * Bug fixes (see mercurial logs for details) * Remove support for Python 2.7 Version 4.8.0 - 2018-04-23 +-------------------------- * Bug fixes (see mercurial logs for details) Version 4.6.0 - 2017-10-30 +-------------------------- * Bug fixes (see mercurial logs for details) Version 4.4.0 - 2017-05-01 +-------------------------- * Bug fixes (see mercurial logs for details) Version 4.2.0 - 2016-11-28 +-------------------------- * Bug fixes (see mercurial logs for details) Version 4.0.0 - 2016-05-02 +-------------------------- * Initial release diff --git a/modules/production_work/doc/design.rst b/modules/production_work/doc/design.rst new file mode 100644 index 0000000000..0ff50f4761 --- /dev/null +++ b/modules/production_work/doc/design.rst @@ -0,0 +1,100 @@ +****** +Design +****** + +The *Production Work Module* introduces or extends the following concepts. + +.. _model-production.work.center: + +Work Center +=========== + +A *Work Center* represents a specific area or a machine in which a particular +set of `Operations ` is +performed. +Work centers can be organized into a tree structure representing a production +chain, with each work center linked to a `Category +`. +The cost of each work center can be defined using different methods, such as +per cycle or per hour. + +.. seealso:: + + The *Work Centers* can be accessed via the main menu: + + |Production --> Configuration --> Work Centers|__ + + .. |Production --> Configuration --> Work Centers| replace:: :menuselection:`Production --> Configuration --> Work Centers` + __ https://demo.tryton.org/model/production.work.center + +.. _model-production.work.center.category: + +Work Center Category +==================== + +The *Work Center Category* concept provides a way of grouping `Work Centers +`. + +.. seealso:: + + The list of *Work Center Categories* can be accessed via the main menu item: + + |Production --> Configuration --> Work Center Categories|__ + + .. |Production --> Configuration --> Work Center Categories| replace:: :menuselection:`Production --> Configuration --> Work Center Categories` + __ https://demo.tryton.org/model/production.work.center.category + +.. _model-production.work: + +Work +==== + +A *Work* represents an `Operation +` assigned to a `Work +Center ` as part of a `Production order +`. + +Each work, at any time, can ben in one of several different states. +A work progresses through these states until it is done. +During this process, the number and the duration of each cycle are recorded to +calculate the total cost of the work. + +.. seealso:: + + The list of *Works* can be accessed via the main menu: + + |Production --> Works|__ + + .. |Production --> Works| replace:: :menuselection:`Production --> Works` + __ https://demo.tryton.org/model/production.work + +.. _model-production.routing.operation: + +Operation +========= + +When the *Production Work Module* is activated, the operation can be linked to +a `Work Center Category ` which +determines which `Work Centers ` can support the +operation. + +.. seealso:: + + The `Operation ` + concept is introduced by the :doc:`Production Routing Module + `. + +.. _model-production: + +Production +========== + +When the *Production Work Module* is activated, the production gains new +properties such as the main `Work Center ` and +the list of `Works ` that are defined by default from +the `Routing `. + +.. seealso:: + + The `Production ` concept is introduced by the + :doc:`Production Module `. diff --git a/modules/production_work/doc/index.rst b/modules/production_work/doc/index.rst index 2341702cab..80ff2af395 100644 --- a/modules/production_work/doc/index.rst +++ b/modules/production_work/doc/index.rst @@ -1,64 +1,12 @@ +###################### Production Work Module ###################### -The production work module allows to manage work order for each production. -It also adds in the production cost for the work cost. +The *Production Work Module* adds work orders and their associated costs for each +production. -Work Center -*********** +.. toctree:: + :maxdepth: 2 -Work center are places in the warehouse where production operations are -performed. They can be organized in a tree structure and each center can be -linked to a category. A cost can be defined on the work center with two -methods: ``Per Cycle`` or ``Per Hour``. - -Work -**** - -Works define for a production which operation to do at which work center. -They also contains the number of cycles consumed to perform the operation. - -The work can be in one of these states: - -* Request - - The linked production is still waiting. - -* Draft - - The production has started but no cycle was already consumed. - -* Waiting - - There are some draft cycles planned. - -* Running - - There is at least one running cycle. - -* Finished - - All the cycles are done (or cancelled). - -* Done - - The production is done. - -The works are created on the waiting production using the linked routing. For -each step of the routing, a work is created with the operation. The work center -is set if the operation has a work center category, by choosing a children work -center of this category. Or if the operation has no category, it is the -production work center that is used. - -Cycle -***** - -Cycles are used to count the consumption and the duration of the work. It also -records the effective cost from the work center. - -The cycle can be in one of this states: - -* Draft -* Running -* Done -* Cancelled + design + releases diff --git a/modules/production_work/doc/releases.rst b/modules/production_work/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/production_work/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG