From 439a54f4c0636afd56b7c3f9484602e296a65391 Mon Sep 17 00:00:00 2001 From: ML-OpenP Date: Thu, 1 Oct 2020 17:45:31 +0200 Subject: [PATCH] Gantt, manual scheduling, work packages Improved docs for Gantt; prolonged docs for scheduling modes; added table of contents for chapter about work package relations [ci skip] --- docs/user-guide/gantt-chart/README.md | 33 +++++++++++++------ .../gantt-chart/scheduling/README.md | 4 ++- docs/user-guide/work-packages/README.md | 2 +- .../create-work-package/README.md | 8 ++++- .../README.md | 25 +++++++++++--- 5 files changed, 54 insertions(+), 18 deletions(-) diff --git a/docs/user-guide/gantt-chart/README.md b/docs/user-guide/gantt-chart/README.md index f0fe07f88550..cf1fa74b1dd8 100644 --- a/docs/user-guide/gantt-chart/README.md +++ b/docs/user-guide/gantt-chart/README.md @@ -15,7 +15,7 @@ The **Gantt chart** in OpenProject displays the work packages in a timeline. You -| Feature | Documentation for | +| Topic | Content | | ------------------------------------------------------------ | ------------------------------------------------------------ | | [Activate the Gantt chart](#activate-the-gantt-chart) | How to activate the Gantt chart in OpenProject? | | [Create a new element](#create-a-new-element-in-the-gantt-chart) | How to add a new item to the Gantt chart? | @@ -23,6 +23,7 @@ The **Gantt chart** in OpenProject displays the work packages in a timeline. You | [Gantt chart configuration](#gantt-chart-configuration) | How to configure the view of your Gantt chart, e.g. add labels? | | [Synchronize data from OpenProject to Excel](#synchronize-data-from-openproject-to-excel) | How to synchronize data from OpenProject to Excel? | | [Gantt chart views](#gantt-chart-views) | How to zoom in and out and activate the Zen mode? | +| [Understanding the colours and lines in the Gantt chart](#Understanding-the-colours-and-lines-in-the-Gantt-chart) | What do the clamps, lines and symbols in the Gantt chart mean? | @@ -44,7 +45,7 @@ In the **Gantt chart** you can schedule the work package with drag and drop and ### How to change the order of an item in the Gantt chart? -To change the order the elements in the Gantt chart. Click the **drag and drop** icon at the left hand side of the work package row. Drag the item to the new position. The blue line indicated the new position to drop the element. +Click the **drag and drop** icon (6 dots) at the left hand side of the work package row. Drag the item to the new position. The blue line indicates the new position to drop the element. @@ -52,13 +53,14 @@ To change the order the elements in the Gantt chart. Click the **drag and drop** ### How to change the duration of an element in the Gantt chart? -To change the duration of a phase in the Gantt chart view, click on the element in the Gantt chart. You can change the duration with drag and drop, shorten or prolong the duration and change start and due date. +To change the duration of a work package in the Gantt chart view, hover over the work package in the Gantt chart and use the little arrows on its ends to adjust the start date or finish date. This will shorten or prolong its duration. +To move a work package on the time line just click on it and drag and drop it to the desired point of time. This will change its startd and finish date. ## Relations in the Gantt chart In the Gantt chart you can track dependencies of work packages (e.g. phases, milestones, tasks). This way you can get an easy overview of what needs to be done in which order, e.g. what tasks need to be completed to achieve a milestone. -To add a dependency make right mouse click on an element in the Gantt chart. +To add a dependency right-click on an element in the Gantt chart. In the menu, choose **Add predecessor** or **Add follower**. @@ -67,20 +69,31 @@ Select the item which you want to create the dependency with. The precede and fo ![dependencies-gantt-chart](dependencies-gantt-chart-1566556144225.gif) -OpenProject does not yet include a baseline feature to compare scheduled versions. However, we are aware of the need for it and documented it. Please check [here](https://community.openproject.com/projects/openproject/work_packages/26448/activity) for an update. +*OpenProject does not yet include a baseline feature to compare scheduled versions. However, we are aware of the need for it and documented it. Please check here https://community.openproject.com/projects/openproject/work_packages/26448/activity for an update.* To find out about **how work packages behave**, when you move their predecessor or follower or change the date of a child work package please read our guide for the [Automatic and manual scheduling mode](/scheduling). +## Understanding the colours and lines in the Gantt chart +- A **blue line** connects two work packages, they are predecessor and follower. +- The **vertical red dotted line** indicates today's date. +- A **black clamp** indicates the duration from the start date of a work packages earliest starting child until the end date of a work packages latest ending child. +- A **red clamp** indicates the same as the black clamp, with an important difference: The clamp turns red if the dates derived from the children are before/after the manually scheduled dates.. The clambs are black in case the derived dates are "inside" the set dates (of this parent). +- A **diamond symbol** stands for a milestone. +- A **bar** stands for work packages like phases and tasks. + + + + ## Gantt chart configuration -To open the Gantt chart configuration, please open the **settings** icon with the three dots on the top right of the work package module. +To open the Gantt chart configuration, please open the **settings** icon with the three dots on the upper right of the work package module. Choose **Configure view ...** and select the tab **Gantt chart**. -Here you can **adapt the Zoom level**, or choose and Auto zoom which will select a Zoom level which best fits to your browser size to have optimal results on a page. +Here you can **adapt the Zoom level**, or choose Auto zoom which will select a Zoom level which best fits to your browser size to have optimal results on a page. -Also, you have **Label Configuration** for your Gantt chart. You can add up to three additional labels within the chart: On the left, on the right and on the far right. Just select which additional information you would need to have in the Gantt chart. This can be especially relevant if you want to print your Gantt chart. +Also, you have **Label Configuration** for your Gantt chart. You can add up to three additional labels within the chart: On the left, on the right and on the far right. Just select which additional information you would need to have in the Gantt chart. This can be especially relevant if you want to print your Gantt chart. -Click the **Apply** button to save your changes.() +Click the **Apply** button to save your changes. ![configure-gantt-chart](configure-gantt-chart.gif) @@ -118,7 +131,7 @@ For other browsers, please simply follow the browser's printing instruction to o You can synchronize your work packages data from OpenProject to Excel (and even convert from or to MS Project). You need to download an OpenProject plugin. -Follow our [Step by step guide how to synchronize your Excel Sheet with OpenProject](https://www.openproject.org/synchronize-excel-openproject/). +Follow our [Step by step guide how to synchronize your Excel Sheet with OpenProject](../integrations/Excel Synchronization). ## Gantt chart views diff --git a/docs/user-guide/gantt-chart/scheduling/README.md b/docs/user-guide/gantt-chart/scheduling/README.md index 8c9645d0bb47..665a32539517 100644 --- a/docs/user-guide/gantt-chart/scheduling/README.md +++ b/docs/user-guide/gantt-chart/scheduling/README.md @@ -12,7 +12,8 @@ keywords: gantt chart, automatic scheduling, manual scheduling, start date, fini # Automatic and manual scheduling mode
-The **Gantt chart** in OpenProject displays the work packages in a timeline. To schedule the work packages there is a **automatic scheduling mode (default)** and a **manual scheduling mode** (new in [release 11.0](../../../release-notes/11-0-0)). To add dependencies between work packages you can set them as predecessor or follower in the Gantt chart. The automatic and manual scheduling modes influence the work packages behaviour when changing dates of other related work packages. +To schedule the work packages in the Gantt chart there is a **automatic scheduling mode (default)** and a **manual scheduling mode** (new in [release 11.0](../../../release-notes/11-0-0)). To add dependencies between work packages you can set them as predecessor or follower in the Gantt chart. The automatic and manual scheduling modes influence the work packages' behaviour when changing dates of other related work packages. +
@@ -31,6 +32,7 @@ When [setting a dependency](../#relations-in-the-gantt-chart) between two work p - A work packages finish date is automatically determined by the finish date of its latest ending child. - When you move a work package past the set start date of its follower, the followers start date will be adjusted to its predecessors finish date. This is not the case the other way round. Example: Work package 1 ends on October 5th. Its follower work package 2 starts on October 13th. Now work package one gets delayed by ten days, you have to adjust the planning. When you the finish date of work package 1 to October 15th, the start date of work package 2 will automatically be set to October 16th. +- You can't change the dates of a work package with children (if it's in automatic scheduling mode). ## Manual scheduling mode diff --git a/docs/user-guide/work-packages/README.md b/docs/user-guide/work-packages/README.md index 46bf91f54714..2954d3128fe6 100644 --- a/docs/user-guide/work-packages/README.md +++ b/docs/user-guide/work-packages/README.md @@ -24,7 +24,7 @@ Work packages can be displayed in a projects timeline, e.g. as a milestone or a ## Overview -| Popular Topics | Description | +| Topic | Content | | ------------------------------------------------------------ | :----------------------------------------------------------- | | [Work packages views](work-package-views) | What is the difference between the work packages views: list view, split screen view, details view? | | [Create a work package](#create-work-packages) | How to create a new work package in OpenProject? | diff --git a/docs/user-guide/work-packages/create-work-package/README.md b/docs/user-guide/work-packages/create-work-package/README.md index 2e58b2c4596b..87f931cfd0d5 100644 --- a/docs/user-guide/work-packages/create-work-package/README.md +++ b/docs/user-guide/work-packages/create-work-package/README.md @@ -51,7 +51,13 @@ The new work package form will open in the split screen view. Enter all informat Click the green **Save** button. -![create-work-package-split-screen](1566303947314.png) +![](1566303947314.png) + + + +To find out **how to create a child work package** please click [here](../work-package-relations-hierachies/#adding-a-child-work-package). + + ## Add attachments to work packages diff --git a/docs/user-guide/work-packages/work-package-relations-hierarchies/README.md b/docs/user-guide/work-packages/work-package-relations-hierarchies/README.md index 1bfab9f21770..cba6292e9849 100644 --- a/docs/user-guide/work-packages/work-package-relations-hierarchies/README.md +++ b/docs/user-guide/work-packages/work-package-relations-hierarchies/README.md @@ -13,6 +13,15 @@ You can create work package hierarchies and relations. Hierarchies are a hierarchical relation (parent-child-relationship) vs. relations indicate any functional or timely relation (e.g. follows or proceeds, blocked by, part of, etc.) +| Topic | Content | +| ------------------------------------------------------------ | :----------------------------------------------------------- | +| [Work packages relations](work-package-relations) | How can I set a relation between two work packages and which relations can I set? | +| [Display relations in work package list](#Display-relations-in-work-package-list-(Premium-feature)) | How can I display the relations between two work packages in the work package list? | +| [Work package hierarchies](#Work-package-hierarchies) | What are work package hierarchies? Learn about parent and children work packages. | +| [Adding a child work package](#adding-a-child-work-package) | What are the possibilities to add children work packages? | +| [Change the parent work-package](#change-the-parent-work-package) | How can I change a work package's parent? | +| [Display work package hierarchies](#display-work-package-hierarchies) | Where can I find out about a work package's children an parent? | + ## Work package relations Work package relations indicate that work packages address a similar topic or create status dependencies. To create a relationship between two work packages: @@ -20,7 +29,7 @@ Work package relations indicate that work packages address a similar topic or cr 1. Select a work package, click on the **Relations** tab to open the relations tab and click the *+ Create new relations* link. 2. Select the type of relationship from the dropdown menu. 3. Enter the ID of the work package, to which the relation should be created and choose an entry from the dropdown menu. -4. Click the check icon. +4. Click the check mark. ![Add work package-Relations](Add-Relations-1024x507@2x.png) @@ -53,13 +62,19 @@ You can click on the number to display the work packages which have the relation ## Work package hierarchies -Work packages can be structured hierarchically, e.g. in order to break down a large work package into several smaller tasks. +Work packages can be structured hierarchically, e.g. in order to break down a large work package into several smaller tasks. This means that there's a parent work package that has at least one child work package. ## Adding a child work package -Open a work package and select the tab *Relations*. +There are **three ways to create a child work package**: + +1. Adding a child in the *Relations* tab in a work package's details view +2. Right-clicking on a work package in the work package list and select "Create new child" +3. Right-clicking on a work package in the work package list and select "Indent hierarchy" to add it as the child of the work package above it. + +### Adding a child in the *Relations* tab in a work package's details view -Click on *+ Create new child* to create a child work package. Alternatively, you can assign an existing child work package with *+ Add existing child*. +Open a work package and select the tab *Relations*. Click on *+ Create new child* to create a child work package. Alternatively, you can assign an existing child work package with *+ Add existing child*. ![User-guide-hierarchies](User-guide-hierarchies.png) @@ -67,7 +82,7 @@ Insert the name of the new work package and save the newly created work package ![create work package children](image-20200129144540902.png) -For more information on the work package creation take a look at the guideline on [creating a work package](#create-work-package). +For more information on the work package creation take a look at the guideline on [creating a work package](../create-work-package). ## Change the parent work package