OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
openproject/docs/getting-started/work-packages-introduction/README.md

91 lines
5.3 KiB

---
sidebar_navigation:
title: Work packages introduction
priority: 700
description: Introduction to work packages in OpenProject.
robots: index, follow
keywords: work packages introduction, attributes, values, task
---
# Introduction to Work Packages
In this document you will get a first introduction to work packages. You will find out how to create and update work packages in a project.
For further documentation, please visit our [user guide for work packages](../../user-guide/work-packages).
| Topic | Content |
| ------------------------------------------------------------ | --------------------------------------------------------- |
| [What is a work package?](#what-is-a-work-package?) | Find out what a work package in OpenProject is. |
| [Create a new work package](#create-a-new-work-package) | How to create a new work package in a project? |
| [Open and edit a work package](#open-and-edit-a-work-package) | How to open and make changes to an existing work package? |
| [Activity of work packages](#activity-of-work-packages) | See all changes in a work package. |
<video src="https://openproject-docs.s3.eu-central-1.amazonaws.com/videos/OpenProject-Work-Packages.mp4" type="video/mp4" controls="" style="width:100%"></video>
## What is a work package?
A work package in OpenProject can basically be everything you need to keep track off within your projects. It can be e.g. a task, a feature, a bug, a risk, a milestone or a project phase. These different kinds of work packages are called **work package types**.
## Create a new work package
To get started, create a new work package in your project, [open the project](#open-an-existing-project) with the project drop-down menu, navigate to the **module work packages** in the project menu.
Within the work packages module, click the green + Create button to create a new work package. In the drop down menu, choose which type of work package you want to create, e.g. a task or a milestone.
![create-work-package](create-work-package-1569611257373.png)
A split screen view is opened with the new work package form on the right and the list of already existing work packages on the left.
If there are not yet any work packages in the project, you will see a message that there are no work packages to be displayed in the list.
In the empty form on the right, you can enter all relevant information for this work package, e.g. the subject and a description, set an assignee, a due date or any other field. The fields you can populate are called **work package attributes**. Also, you can add attachments with copy & paste or with drag and drop.
Click the green **Save** button to create the work package.
![split-screen-work-packages](split-screen-work-packages.png)
The work package will the be displayed in the list view:
![list-view-work-package](1569611758166.png)
Another option to create a work package is to do it from the header menu. The [work package types](../../user-guide/projects/proejct-settings/work-package-types/#work-pacakge-types) that are activated, will be shown and you can select the relevant work package type to be created.
![create-work-package-header](create-work-package-header.png)
Once you click on the work package type that you want to create, the work package detail view opens and you have to **select the project** that you want to create the work package for.
![create-work-package-define-project](create-work-package-define-project.png)
Then you follow the same steps as mentioned above to fill in the your work package attributes and save it.
## Open and edit a work package
To open and edit an existing work package from the list, select the work package in the list which you want to edit and click on the **open details view** icon in the work package list or on top of the list to open the split screen view. Other ways to open it would be to double-click on the work package or to click on the work package ID.
![open-details-view-work-packages](open-details-view-work-packages.png)
By clicking through the list on the left hand side you will see the details of each work package on the right in the split screen.
Click in any of the fields to **update a work package**, e.g. description. Click the checkmark at the bottom of the input field to save changes.
![edit-work-package](1569612205009.png)
To **update the status**, click on the highlighted displayed status on top of the form and select the new status from the drop-down.
![update-status](1569612428626.png)
## Activity of work packages
To keep informed about all changes to a work package, open the **ACTIVITY** tab in the details view.
Here you will see all changes which have been made to this work package.
You can also insert a comment at the end of the Activity list.
![activity-work-packages](activity-work-packages.png)
Expanding documentation (#9091) * changed screenshots for projects chapter * changed screenshots in gantt chart chapter * moved "aggregation by project" from work packages to Gantt chart chapter * changed some links * move reference to Excel sync out of Gantt chart chapter * small changes * add initial setup section for administrators to documentation Idea and main content from @ivangriggs Co-Authored-By: ivangriggs <77022874+ivangriggs@users.noreply.github.com> * smaller improvements to docs * improve documentation of manual and automatic scheduling mode * small improvements in docs * small changes * adding section for search options in OpenProject * move section about hourly rate defintion to system admin guide * formatting changes * explaining assignee filter options * change section header to make it detectable when searching for "projects overview" * clean up table of contents, make titles consistent, remove excessive space characters, etc. * update screenshots * changes to project overview docs * add screenshot for search bar * make info about aggregation of changes in activity and notifications easier detectable * small improvements * add info about non member and anonymous role * changes/additions * small changes * add additional options to access context menu * add sum feature for work package list to docs and change screenshot * add/improve info about email notifications * link fixes (necessary due to structural changes in documentation) * working in review comments * changes for time tracking activities * change screen shots for wiki - more functions section * change screenshots and improve description for meetings * improve detectability of mention feature * move FAQ in authentication * add how to reset password * improve explanation on how to un-archive projects * mention Mattermost integration * small correction
4 years ago
The aggregation of changes in the Activity list can be configured in the [system administration](../../system-admin-guide/system-settings/display-settings/#time-and-date-formatting,-aggregation-of-changes-in-activity).
5 years ago
To find out more about the work package functionalities, please visit our detailed [user guide for work packages](../../user-guide/work-packages).