[#58113] 14.6 Documentation: Progress reporting changes https://commu…

…nity.openproject.org/work_packages/58113

[#58113] 14.6 Documentation: Progress reporting changes

https://community.openproject.org/work_packages/58113

docs/system-admin-guide/manage-work-packages/README.md

@@ -11,11 +11,12 @@ Manage work packages in OpenProject.
 
 ## Overview
 
-| Popular Topics                      | Description                                                  |
-| ----------------------------------- | :----------------------------------------------------------- |
-| [Settings](work-package-settings)   | Configure general work package settings and defaults, such as display options and more. |
-| [Types](work-package-types)         | Create and manage work package types.                        |
-| [Status](work-package-status)       | Create and manage work package status.                       |
-| [Workflows](work-package-workflows) | Create and manage workflows for work packages in OpenProject. |
-| [Custom actions](custom-actions)    | Create custom actions for work packages (Enterprise add-on). |
-| [FAQs](work-packages-faq)           | Frequently asked questions about work packages in OpenProject. |
+| Popular Topics                                        | Description                                                  |
+| ----------------------------------------------------- | :----------------------------------------------------------- |
+| [Settings](work-package-settings)                     | Configure general work package settings and defaults, such as display options and more. |
+| [Types](work-package-types)                           | Create and manage work package types.                        |
+| [Status](work-package-status)                         | Create and manage work package status.                       |
+| [Progress-reporting](work-package-progress-reporting) | Manage work package progress reporting settings.             |
+| [Workflows](work-package-workflows)                   | Create and manage workflows for work packages in OpenProject. |
+| [Custom actions](custom-actions)                      | Create custom actions for work packages (Enterprise add-on). |
+| [FAQs](work-packages-faq)                             | Frequently asked questions about work packages in OpenProject. |

docs/system-admin-guide/manage-work-packages/work-package-progress-tracking/README.md

@@ -0,0 +1,36 @@
+---
+
+sidebar_navigation:
+  title: Progress tracking
+  priority: 965
+description: Manage Work package progress tracking.
+keywords: work package progress tracking, percentage complete, % complete
+---
+
+# Manage work package progress tracking
+
+Progress tracking is a 
+
+Administrators will see a new page under *Administration* → *Work packages* called **Progress tracking** with three settings:
+
+![Progress tracking settings under OpenProject administration](openproject_system_guide_progress_tracking_settings.png)
+
+- **Progress calculation mode** lets you select between *work-based* and *status-based* modes.
+
+- Calculation of % Complete hierarchy totals
+
+   lets you pick between: 
+
+  - Weighted by work: The total *% Complete* will be weighted against the *Work* of each work package in the hierarchy. Work packages without *Work* will be ignored (current behaviour)
+  - Simple average: *Work* is ignored and the total *% Complete* will be a simple average of *% Complete* values of work packages in the hierarchy
+
+- % Complete when status is closed
+
+   lets you chose what happens to 
+
+  % Complete
+
+   when you close a work package (even in work-based mode): 
+
+  - No change, where the value of *% Complete* will not change even when a work package is closed
+  - Automatically set to 100%, where a closed work package is considered complete.

docs/system-admin-guide/manage-work-packages/work-package-settings/README.md

@@ -14,31 +14,12 @@ To change basic settings for work package tracking in OpenProject, navigate to *
 You can adjust the following:
 
 1. **Allow cross-project work package relations**, i.e. that work packages created in one project can have relations to work packages in another project, for example parent-children work packages.
-
 2. **Display subprojects work packages in main projects** by default. This way the work packages of subprojects will always be visible in the main project if a user has the corresponding role in the subproject to see work packages.
-
 3. **Use current date as start date for new work packages**. This way the current date will always be set as a start date if your create new work packages. Also, if you copy projects, the new work packages will get the current date as start date.
-
-4. **Progress calculation** lets you pick between two modes for how the **% Complete** field is calculated for work packages.
-  - **Work-based**: % Complete is automatically calculated based on Work and Remaining work values for that work package, both of which are then necessary to have a value for % Complete.
-
-  - **Status-based**: you will have to define fixed % Complete values for each [work package status](../work-package-status), which will update automatically when team members update the status of their work packages.
-
-    > [!NOTE]
-    > When switching progress calculation mode from one to another, you will see a warning message.
-    >
-    > - Changing progress calculation mode from work-based to status-based will result in all existing *% Complete* values to be lost and replaced with values associated with each status. Existing values for *Remaining work* may also be recalculated to reflect this change. This action is not reversible.
-    >
-    > - Changing progress calculation mode from status-based to work-based will make % Complete a non-editable field whose value is derived from Work and Remaining work. Existing values for % Complete are preserved. If values for Work and Remaining work were not present, they will be required in order to change % Complete.
-    
-    ![Warning message when changing progress calculation mode in OpenProject administration](openproject_system_guide_work_package_settings_warning.png)
-
-
-
-5. **Default highlighting mode** (Enterprise add-on) defines which should be the default [attribute highlighting](../../../user-guide/work-packages/work-package-table-configuration/#attribute-highlighting-enterprise-add-on) mode, e.g. to highlight the following criteria in the work package table. This setting is only available for Enterprise on-premises and Enterprise cloud users.
+4. **Default highlighting mode** (Enterprise add-on) defines which should be the default [attribute highlighting](../../../user-guide/work-packages/work-package-table-configuration/#attribute-highlighting-enterprise-add-on) mode, e.g. to highlight the following criteria in the work package table. This setting is only available for Enterprise on-premises and Enterprise cloud users.
 
    ![default highlighting mode](openproject_system_guide_default_highlighting_mode.png)
 
-6. Customize the appearance of the work package lists to **define which work package attributes are displayed in the work package lists by default and in what order**.
+5. Customize the appearance of the work package lists to **define which work package attributes are displayed in the work package lists by default and in what order**.
 
 Do not forget to save your changes with the green **Save** button at the bottom.

docs/user-guide/time-and-costs/progress-tracking/README.md

@@ -10,7 +10,9 @@ keywords: Progress tracking, estimated time, remaining time, work, % complete, p
 
 OpenProject lets you track and monitor the progress of your work packages.
 
-> **Note:** Since OpenProject 14.0, the way progress is reported and calculated has changed significantly. Please read the documentation below to understand how OpenProject handles work and progress estimates.
+> [!IMPORTANT]
+> In OpenProject 14.0, the way progress is reported and calculated has changed significantly. Refer to [this blog article](https://www.openproject.org/blog/changes-progress-work-estimates/) to follow the changes. 
+> **In OpenProject 14.6 some of the changes made in 14.0 were removed and updated**. Please read the documentation below and [this blog post](https://www.openproject.org/blog/updates-to-progress-tracking-in-14-6-based-on-user-feedback/) to understand how OpenProject handles work and progress estimates.
 
 ## Terms
 
@@ -22,7 +24,8 @@ OpenProject lets you track and monitor the progress of your work packages.
 | Estimated time   | Work                  |
 | Remaining time   | Remaining work        |
 
->**Note**: You will still find the new attributes if you search using their older names (in the list of filters, for example).
+>[!NOTE]
+> You will still find the new attributes if you search using their older names (in the list of filters, for example).
 
 ## Units of measurement
 
@@ -50,14 +53,21 @@ The default setting is set to be 8 hours per day. Your administrator can change
 
 OpenProject offers two modes for reporting progress:
 
-- **Work-based progress reporting** enables you to automatically derive progress based on the values you enter for Work and Remaining work
-- **Status-based progress reporting** allows you to assign fixed % Complete values to statuses, and automatically derive Remaining work based on the values for Work you can enter
+- **Work-based progress reporting** enables you to automatically derive progress based on the values you enter for Work and Remaining work. You can also manually enter a value for % Complete. 
+- **Status-based progress reporting** allows you to assign fixed % Complete values to statuses, and automatically derive Remaining work based on the values for Work you can enter.
 
->**Note:** The administrator of your instance will have selected a mode for the entire instance. If you are an administrator, you can modify this by following our [admin guide on work package settings](../../../system-admin-guide/manage-work-packages/work-package-settings).
+> [!NOTE]
+> The administrator of your instance will have selected a mode for the entire instance. If you are an administrator, you can modify this by following our [admin guide on work package settings](../../../system-admin-guide/manage-work-packages/work-package-settings).
 
 ### Work-based progress reporting
 
-% Complete is an automatically calculated value that is a function of Work and Remaining work, unless % Complete is configured to be [set by status](#status-based-progress-reporting).
+In the work-based progress reporting mode % Complete can either be automatically calculated based on the values of Work and Remaining work, or entered manually. 
+
+#### Manual values for % Complete
+
+If you you prefer to enter the values for % Complete manually, you can. 
+
+#### Automatic values for % Complete
 
 >**% Complete** is work done (**Work** - **Remaining work**) divided by **Work**, expressed as a percentage. For example, if Work is set at 50h and Remaining work is 30h, this means that % Complete is _(50h-30h)/50h))_ = **40%**. Please note that these calculations are independent and unrelated to the value of **Spent time** (which is based on actual time logged).
 
@@ -67,7 +77,8 @@ This means that for a work package to have a value for % Complete, both Wor
 
 This allows you to edit Work or Remaining work and get a preview of the updated % Complete value before saving changes. Changing any one field will automatically update the other two.
 
->**Note:** If you enter a value for Remaining work that is higher than Work, you will see an error message telling you that this is not possible. You will have to enter a value lower than Work to be able to save the new value.
+> [!NOTE]
+> If you enter a value for Remaining work that is higher than Work, you will see an error message telling you that this is not possible. You will have to enter a value lower than Work to be able to save the new value.
 >
 >Additionally, the value for Remaining work cannot be removed if a value for Work exists. If you wish to unset Remaining work, you need to also unset Work.
 
@@ -89,15 +100,17 @@ In Status-based progress reporting mode, Work is not a required value. However,
 
 This allows you to edit % Complete (by changing status) or Work and get a preview of the updated Remaining work before saving changes.
 
->**Note:** In the upcoming version, statuses cannot have an empty % Complete value in status-based progress reporting mode.When upgrading, all statuses that do not have a value will take the default value of 0%.
+> [!NOTE]
+> In the upcoming version, statuses cannot have an empty % Complete value in status-based progress reporting mode.When upgrading, all statuses that do not have a value will take the default value of 0%.
 
 ## Hierarchy totals
 
 OpenProject will automatically show totals for Work, Remaining work and % Complete in a work package hierarchy (any parent with children). These appear in a work package table as a number with a Σ sign next to it, indicating that it is a total of the values of the parent _and_ children.
 
 ![Hierarchy totals for Work, Remaining work and % Complete](hierarchy-totals-days.png)
 
-> **Note**: The total % Complete value of a hierarchy is a weighted average tied to Work. For example, a feature with Work set to 50h that is 30% done will influence the total of % Complete of the parent more than a feature with Work set to 5h that is 70% done.
+> [!NOTE]
+> The total % Complete value of a hierarchy is a weighted average tied to Work. For example, a feature with Work set to 50h that is 30% done will influence the total of % Complete of the parent more than a feature with Work set to 5h that is 70% done.
 
 ### Excluding certain work packages from totals