[IMP] PLM: Fix formating, add images, clarify #12725

slinkous · 2025-03-31T22:19:15Z

No description provided.

robodoo · 2025-03-31T22:19:18Z

content/applications/inventory_and_mrp/plm/manage_changes/eco_type.rst

Felicious

I think the content looks good to me, @slinkous ! I'm just requesting changes so I can double-check the links after you take a look (:

content/applications/inventory_and_mrp/plm/manage_changes/eco_type.rst

Felicious

Approved (: @slinkous

Almost all my comments were optional suggestions, except for formatting the links and the one extra colon. This is such a good sign, since that means I only have nitpicks to "catch" in reviews, and it's only your 3rd PR! 😍

After you take a look, tag us-doc-review and @zac in the comments to ask for a final review :D

content/applications/inventory_and_mrp/plm/manage_changes/eco_type.rst

space Final changes, I hope

slinkous · 2025-04-04T18:10:17Z

Ready for review! Tia @StraubCreative @odoo/us-doc-review

StraubCreative

Hi @slinkous

I think there's still more to go on this doc; it may need a significant rework to get it up to quality.

Overview of my comments:

remove all vague/important-sounding sentences in favor of more concise language
too much essentials content; I'd spend more time going into more depth around eco type configuration and use cases (PLM is an important app for mrp/engineer-based businesses, we should cover how it works much more deeply, in context for how it's used)
the proposed rewrites in general seem superficial / not necessary? However, necessity is a core requirement for proposing changes...

More details below, please let me know if you have any questions!

StraubCreative · 2025-04-04T18:29:45Z

content/applications/inventory_and_mrp/plm/manage_changes/eco_type.rst

+Engineering change orders (ECOs) are categorized by the type of change they represent and their
+statuses are tracked via stages. Both |ECO| types and stages are defined by the user and can be
+customized to the specific needs of a business or industry.

-For example, an electronic chip manufacturer might use 'New Product Introduction', 'Product
-Improvement', 'Component Change', and 'Firmware Update' |ECO| types. Then, designers and engineers
-can focus on |ECOs| in the 'New Product Introduction' and 'Product Improvement' projects, avoiding
-unrelated supplier change or firmware update |ECOs|.
+ECO types
+=========

-Create ECO type
-===============
+*Engineering change orders* (ECOs) require an |ECO| type to organize and track changes to products
+and bills of materials (BoMs). Like a :doc:`product
+type<../../inventory/product_management/configure/type>`, |ECO| types are highly customizable and
+specific to the needs of individual businesses. Each |ECO| type separates |ECOs| into different
+projects in the :guilabel:`PLM Overview`, ensuring collaborators and stakeholders only view and
+assist with relevant |BOM| improvements.


Lines 12-24: can rewrite for clarity (can probably condense into 2 sentences)

StraubCreative · 2025-04-04T18:29:58Z

content/applications/inventory_and_mrp/plm/manage_changes/eco_type.rst

-===============
+*Engineering change orders* (ECOs) require an |ECO| type to organize and track changes to products
+and bills of materials (BoMs). Like a :doc:`product
+type<../../inventory/product_management/configure/type>`, |ECO| types are highly customizable and


need a space here

Suggested change

type<../../inventory/product_management/configure/type>`, |ECO| types are highly customizable and

type <../../inventory/product_management/configure/type>`, |ECO| types are highly customizable and

StraubCreative · 2025-04-04T18:36:13Z

content/applications/inventory_and_mrp/plm/manage_changes/eco_type.rst

+projects in the :guilabel:`PLM Overview`, ensuring collaborators and stakeholders only view and
+assist with relevant |BOM| improvements.
+
+.. example::


Good example but could be simpler and more relevant to common use-cases (instead of changing defaults, could just add one new one to indicate that the business is scaling its engineering ops, more likely and easier to understand.)

StraubCreative · 2025-04-04T18:37:44Z

content/applications/inventory_and_mrp/plm/manage_changes/eco_type.rst

 Additionally, required approvers can be added to each stage, ensuring that changes to the production
 |BOM| cannot proceed until the approver reviews and approves the |ECO|. Doing so prevents errors on
-the production |BOM| by enforcing at least one review of suggested changes before they're applied on
-a production |BOM|.
+the production |BOM| by enforcing at least one review of suggested changes before they are applied
+on a production |BOM|.

-For best practice, there should be at least one *verification* stage, which is a stage with a
+The most common practice is to have at least one *verification* stage, which is a stage with a
 required approver, and one *closing* stage, which stores |ECOs| that have been either cancelled or
 approved for use as the next production |BOM|.


StraubCreative · 2025-04-04T18:38:45Z

content/applications/inventory_and_mrp/plm/manage_changes/eco_type.rst

@@ -84,51 +109,40 @@ filling it in, click the :guilabel:`Add` button to finish adding the stage.
   Adding another stage helps the product manager track unassigned tasks.

   .. image:: eco_type/create-stage.png
-      :align: center
      :alt: Create a new stage in a project for an ECO type.


lines 97-112: Essentials content, can omit.

StraubCreative · 2025-04-04T18:39:58Z

content/applications/inventory_and_mrp/plm/manage_changes/eco_type.rst

+Use case: configuring verification and closing stages
+-----------------------------------------------------

-To configure a verification stage, hover over the intended stage, and select the :guilabel:`⚙️
-(gear)` icon. Then, click :guilabel:`Edit` to open a pop-up window.
+Verification stage
+~~~~~~~~~~~~~~~~~~


Disagree with the heading changes here
this isn't a use-case, it's a series of explicit instructions

StraubCreative · 2025-04-04T18:40:58Z

content/applications/inventory_and_mrp/plm/manage_changes/eco_type.rst


-Configure the verification stage in the edit stage pop-up window, by checking the box for
+To configure a verification stage, hover over the intended stage, and select the :icon:`fa-gear`


Took too long for us to get here, can move up in context near line 84.

StraubCreative · 2025-04-04T18:42:09Z

content/applications/inventory_and_mrp/plm/manage_changes/eco_type.rst

-   :align: center
-   :alt: Show configurations of the closing stage.
-
+   :alt: Configuration of the closing stage.


Lines 137+
Essentials content, can remove.

C3POdoo requested a review from a team March 31, 2025 22:20

slinkous added the 2 label Mar 31, 2025

slinkous requested a review from Felicious March 31, 2025 23:00

slinkous commented Mar 31, 2025

View reviewed changes

content/applications/inventory_and_mrp/plm/manage_changes/eco_type.rst Outdated Show resolved Hide resolved

slinkous commented Mar 31, 2025

View reviewed changes

content/applications/inventory_and_mrp/plm/manage_changes/eco_type.rst Outdated Show resolved Hide resolved

Felicious requested changes Apr 1, 2025

View reviewed changes

slinkous force-pushed the 18.0-plm-eco-type-stul branch from 749ccae to 32bbd77 Compare April 2, 2025 17:47

C3POdoo requested review from a team April 2, 2025 17:49

slinkous force-pushed the 18.0-plm-eco-type-stul branch from 32bbd77 to 8946af5 Compare April 2, 2025 18:12

slinkous requested a review from Felicious April 2, 2025 18:39

Felicious approved these changes Apr 3, 2025

View reviewed changes

slinkous self-assigned this Apr 4, 2025

[IMP] PLM: Fix formating, add images, clarify

bb1db14

space Final changes, I hope

slinkous force-pushed the 18.0-plm-eco-type-stul branch from f8cbe4b to bb1db14 Compare April 4, 2025 17:20

StraubCreative requested review from a team and removed request for a team April 4, 2025 18:25

StraubCreative requested changes Apr 4, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[IMP] PLM: Fix formating, add images, clarify #12725

[IMP] PLM: Fix formating, add images, clarify #12725

slinkous commented Mar 31, 2025

robodoo commented Mar 31, 2025

Felicious left a comment

Felicious left a comment

slinkous commented Apr 4, 2025 •

edited by StraubCreative

Loading

StraubCreative left a comment •

edited

Loading

StraubCreative Apr 4, 2025

StraubCreative Apr 4, 2025

StraubCreative Apr 4, 2025

StraubCreative Apr 4, 2025

StraubCreative Apr 4, 2025

StraubCreative Apr 4, 2025

StraubCreative Apr 4, 2025

StraubCreative Apr 4, 2025

	type<../../inventory/product_management/configure/type>`, \|ECO\| types are highly customizable and
	type <../../inventory/product_management/configure/type>`, \|ECO\| types are highly customizable and


		Configure the verification stage in the edit stage pop-up window, by checking the box for
		To configure a verification stage, hover over the intended stage, and select the :icon:`fa-gear`

[IMP] PLM: Fix formating, add images, clarify #12725

Are you sure you want to change the base?

[IMP] PLM: Fix formating, add images, clarify #12725

Conversation

slinkous commented Mar 31, 2025

robodoo commented Mar 31, 2025

Felicious left a comment

Choose a reason for hiding this comment

Felicious left a comment

Choose a reason for hiding this comment

slinkous commented Apr 4, 2025 • edited by StraubCreative Loading

StraubCreative left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

slinkous commented Apr 4, 2025 •

edited by StraubCreative

Loading

StraubCreative left a comment •

edited

Loading