Docs/12.1 (#10167)
task/40956-update-docs-for-121 * Update to docs for 12.1 Changed user guide Established subdirectory "team-planner" Started editing README for team-planner * Docs changes for 12.1 Further edits to README of team-planner subdirectory: -Intro into functionality -getting started -more features explained * Update README.md * Update readme Team planner Additional edits to team planner readme file * Update README.md * Project status README Update for 12.1 Project status update for 12.1 (WP #34708): -Added new screenshots to reflect 3 add'l status choices: Not Started, Finished, and Discontinued Directory: docs/user-guide/projects/project-status/REAMDME.md * Calendar Module v12.1 Update Updated snapshots to most current version, explained "Visibility settings", and introduced/explained multiple calendars, Favorite, Public and Private functions [#36322] Save different views in calendar module https://community.openproject.org/work_packages/36322 * Update to the Team Planner Update to the Team Planner as well as functionality of the Planning Calendar. There were several additional features that were added to the Team Planner that were not captured in the last edit, such as the "include projects" filter button. [#40956] Update Docs for 12.1 https://community.openproject.org/work_packages/40956 * Use Cases I added a new folder/repository called "Use Cases". Use cases are frequently asked for how-to scenarios and workarounds. The main README is basically a Table of Contents with links. I have also added 2 use cases, Portfolio Management and Resource Management. This is is not associated with a specific work package, but rather a value-add to customers * Update Images Updated images included in initial edits, from randomly generated, numerical file names created by pasting, to more descriptive image names and description. This was done for updates triggered by v12.1: - User guide -> Modules (update) - Team planner (new) - Calendar (update) - Use cases (new) * Style guide related changes Style Guide related changes/adjustments to: - Docs/User Guide/Team Planner - Docs/User Guide/Calendar - Docs/Use Cases/* Detail: Corrected inverted quotation marks use for buttons, and replaced by bold font instead * fix(docs-12.1): typofix in name & url for new section * fix(docs12.1): resolve review issues * fix(docs12.1): use relative links for internal doc links Co-authored-by: as-op <a.sandorf@openproject.com>pull/10596/head
Fweber1331
3 years ago
committed by
GitHub
parent
eb1fdab53a
commit
ce71787d45
@ -0,0 +1,16 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Use Cases |
||||
priority: 955 |
||||
description: Step-by-step instruction about various use cases |
||||
robots: index, follow |
||||
keywords: use-cases |
||||
--- |
||||
|
||||
# OpenProject Use Cases |
||||
|
||||
| Use Case | Description | |
||||
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
||||
| [Portfolio Management](portfolio-management) | This guide provides detailed step-by-step instruction on how to set up an overview of your project portfolio and create custom reports using the Project Overview, Wiki and the Rich text (WYSIWYG) editor in OpenProject. | |
||||
| [Resource Management](resource-management) | OpenProject does not have the automated functionality to provide detailed resource management or employee work capacity calculations. This guide with detailed step-by-step instructions introduces a workaround that can provide an avenue to accomplish this manually and visually beyond the functionality the Team Planner Module provides. | |
||||
|
||||
@ -0,0 +1,38 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Portfolio Management and Custom Reporting |
||||
priority: 900 |
||||
description: Step-by-step instruction about portfolio management and custom reporting |
||||
robots: index, follow |
||||
keywords: use-case, portfolio management |
||||
--- |
||||
|
||||
# Use Case: Portfolio Management and Custom Reporting Options |
||||
|
||||
Step 1: To view all projects, first select the *project chooser drop-down*, the chose *View all projects* |
||||
|
||||
 |
||||
|
||||
Step 2: You can sort and filter this view using custom fields, such as *Initiative* or *Status.* If you have not added useful custom fields, please see [here](../../system-admin-guide/custom-fields/). |
||||
|
||||
Step 3: Press the **floppy disk icon** to save and name your view once you are happy with the information that is displayed. You can also add this view as a favorite to the black bar on the left. |
||||
|
||||
## Creating Custom Reports |
||||
|
||||
You can create advanced project reports by using the same techniques and the print function (**CTRL+P**), then saving as PDF, for example. The print function in OpenProject is optimized for reporting purposes. Only information displayed in the main screen area is included. None of the designs or side or top menus are in it. |
||||
|
||||
For more advanced requirements, using the Wiki is another powerful tool. For more information about how to use the Wiki function, please consult: [Wiki](../../user-guide/wiki/) |
||||
|
||||
The Wiki function allows you to build complete custom reports using embedded work package tables, macros and even embedded calculations. |
||||
|
||||
Here is an example of how a wiki could look: |
||||
|
||||
 |
||||
|
||||
And how the dynamic data, such as calculations, filters, macros and reference language work behind the scenes: |
||||
|
||||
 |
||||
|
||||
For more information about the syntax and how the attributes work [here](../../user-guide/wysiwyg/). |
||||
|
||||
If you like to work with multiple Wiki-based reports, you can create an umbrella Wiki page as a table of content, for example, on which all the other reports are listed. See more info on Wiki and the use of Macros [here](../../user-guide/wiki/). |
||||
|
After Width: | Height: | Size: 7.2 KiB |
|
After Width: | Height: | Size: 17 KiB |
|
After Width: | Height: | Size: 20 KiB |
|
After Width: | Height: | Size: 19 KiB |
@ -0,0 +1,38 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Resource Management |
||||
priority: 990 |
||||
description: Step-by-step instruction about resource management |
||||
robots: index, follow |
||||
keywords: use-case, resource management |
||||
--- |
||||
|
||||
# Use Case: Resource Management |
||||
|
||||
**Note:** This is a workaround. OpenProject does not have the automated functionality to provide detailed resource management or employee work capacity calculations. |
||||
|
||||
 |
||||
|
||||
Step 1: Select a project and go to the work package overview. |
||||
|
||||
Step 2: Either use existing fields, **Estimated time** and **Spent time**, or create custom fields (i.e. **Est. Scope (h)** and **Time spent (h)**) |
||||
|
||||
Step 3: Either insert the standard fields to the view, or insert the custom fields if created in Step 2 |
||||
|
||||
Step 4: Then sort and filter all work packages and group by assignee. |
||||
|
||||
Step 5: Save your view |
||||
|
||||
You could also add the Gantt view to add an additional dimension to your overview |
||||
|
||||
 |
||||
|
||||
This will provide a rough overview of the various tasks assigned to a specific person or team. Using the Gantt view in addition provides additional overview of how these tasks happen in terms of timelines. It’s a visual way of looking at roughly how many tasks are assigned to an individual and gives you an estimate about the timeline, allowing for adjustments in assignments and timing to be made to balance your resources a little bit. Using filters and the (+) zoom function will help to focus the Gantt view to only tasks that are scheduled in let’s say the next 30 days. These functions can help focus in on showing relevant results only. |
||||
|
||||
You can also use the sum function inside of **[⋮]** -> ***Configure view*** -> ***Display settings*** -> check ***Display Sums*** box: |
||||
|
||||
 |
||||
|
||||
 |
||||
|
||||
**Limitations:** This workaround can provide an overview of who works on what and when, but it is unfortunately not a solid capacity management tool. It just provides a quick visual estimate. |
||||
|
After Width: | Height: | Size: 10 KiB |
|
After Width: | Height: | Size: 16 KiB |
|
After Width: | Height: | Size: 37 KiB |
|
After Width: | Height: | Size: 85 KiB |
|
After Width: | Height: | Size: 95 KiB |
|
After Width: | Height: | Size: 55 KiB |
|
After Width: | Height: | Size: 87 KiB |
|
After Width: | Height: | Size: 104 KiB |
|
After Width: | Height: | Size: 103 KiB |
|
After Width: | Height: | Size: 198 KiB |
@ -0,0 +1,95 @@ |
||||
--- |
||||
sidebar_navigation: |
||||
title: Team planner |
||||
priority: 890 |
||||
description: Using the team planner in OpenProject. |
||||
robots: index, follow |
||||
keywords: team planner,planning calendar, resource management |
||||
--- |
||||
|
||||
# Team planner |
||||
|
||||
The team planner is a module that can assist getting a better overview of which team member is working on what work package at what time. It is also a useful tool to schedule those team members for different tasks on various times. |
||||
|
||||
A few notes: |
||||
|
||||
1. The work package module has to be enabled as a prerequisite for the team planner |
||||
2. You can have multiple public, private, as well as favorite team planning calendars. They will all appear in the left menu bar. |
||||
|
||||
| Topic | Content | |
||||
|-------------------------------------------------------------------------------------------|:--------------------------------------------| |
||||
| [Main view](#main-view-start-a-new-or-select-an-existing-team-planner) | How to start a team planner? | |
||||
| [Planning calendar basics](#planning-calendar-basics) | How to navigate the team planner? | |
||||
| [Getting started](#getting-started) | How to get started? | |
||||
| [Adding team members](#step-1-adding-team-members) | How to add team members? | |
||||
| [Adding/working with work package strips](#step-2-addingworking-with-work-package-strips) | How to work with work package strips? | |
||||
| [Work package strip detail view](#work-package-strip-detail-view) | How to access the work package detail view? | |
||||
| [Removing a work package strip](#removing-a-work-package-strip) | How to remove a work package strip? | |
||||
|
||||
## Main view - Start a new or select an existing Team Planner |
||||
|
||||
 |
||||
|
||||
1. You can create a new team planner using either the **+ Create** button in the top right near your avatar, or by clicking the |
||||
|
||||
**+ New team planner** button at the bottom of the black menu bar. |
||||
|
||||
2. If you created a team planner before, you can select one of the planners from the list. |
||||
|
||||
3. Team planners with the visibility option **public** selected appear under the **Public Views** heading in the black menu bar. |
||||
|
||||
4. Team planners with the visibility option "public" unselected appear under the **Private Views** heading in the black menu bar. Note: If **public** is not selected, the calendar is automatically **private** and can only be seen by you, not other members. |
||||
|
||||
Both **public** and **private** calendars can be added as a **favored** planner, and would appear under the heading **Favorite Views** in the black menu bar. |
||||
|
||||
|
||||
## Planning calendar basics |
||||
|
||||
 |
||||
|
||||
How to navigate the team planner? - The numbers below correspond with the above image: |
||||
|
||||
1. The top header: Click on the top header (where it says **Team planner** in the picture above) to edit the name of your new team planning calendar. The top header is in edit mode by default, so you can just click right on the text. This is where you can give the new team planning calendar its new name. Your new name gets saved automatically by exiting the top header (by clicking somewhere else, for example). |
||||
2. Use the **+ add existing** button to add an existing work package to your view. Note: You cannot create new work packages from the team planner module. Create new work packages in the work package module, then select them in the team planner. |
||||
3. Add a new team member to you planning calendar using the **+ add assignee**. |
||||
3. **Include projects** filter: By default, this filter will only include the current project you are in. You can select additional projects as you see fit by pressing this filter button and check-marking additional projects. The number in the grey bubble inside of this button will indicate the number of projects that are currently selected inside of the filter. |
||||
4. There is a filter button by which you can focus what is displayed on your calendar (for example, only certain team members or work packages). |
||||
5. This switches you team planning calendar to full screen mode. |
||||
6. Saving, renaming and saving a copy (saving as), or deleting can also be accomplished using the **[⋮]** button. This is also where you can modify the visibility options. Select **public** to allow others in your organization that are members of your respective project to see your planning calendar. If **public** is not selected, the calendar is **private** and can only be seen by you, not other members. |
||||
7. By default the planning calendar only shows the current week. Use these buttons to toggle between the 1-week and 2-week view. |
||||
|
||||
## Getting started |
||||
|
||||
### Step 1: Adding team members |
||||
|
||||
The first step in setting up your team planning calendar is to add team members. This is done via the **+ add assignee** button in #3 above. Press the **+ add assignee** button, and then simply select the team member(s) from the drop-down list. Clicking on a given assignee's name will open a new window with a quick overview of which projects that member is assigned to. |
||||
|
||||
Repeat this step until all team members relevant for this planner are added, and then save it using the floppy disk icon (adjacent to the top header in #1 above). |
||||
|
||||
**Note: Once you are finished adding members to the planner, click the floppy disk icon in the top header to save.** |
||||
|
||||
 |
||||
|
||||
### Step 2: Adding/working with work package strips |
||||
|
||||
Next, add specific work packages to your planner. Do this by pressing the **+ add existing" button** we introduced in step 2 of the main view overview. Once you press the **+ add existing** button, start typing the name of the work package you are looking to add. Once found, drag & drop the work package strip. Should the work package have a duration exceeding the current 1 or 2 week view, a horizontal scroll bar will display, with which it is possible to scroll to the end date of the longest running work package. |
||||
|
||||
Additional features: You can change the status of a work package, and enter the work package strip detailed view by pressing the info button **(i)** on each respective strip |
||||
|
||||
**Note: You can only add existing work packages here. If you need to create some first, create them in the work package module as new work packages cannot be created from the team planner module.** |
||||
|
||||
 |
||||
|
||||
## Work package strip detail view |
||||
|
||||
Click on any given work package strip to open up a split screen showing the work package detail view. |
||||
|
||||
 |
||||
|
||||
## Removing a work package strip |
||||
|
||||
Work package strips are never fully removable, since the planning calendar is simply a view of the information pertaining to a given work package. There are, however, a few options to make the strip disappear from your view: |
||||
|
||||
1. Adding a filter that would exclude that work package. |
||||
2. Removing the assignee or changing the assignee to one that has not been added to the planner (and is thus not visible). |
||||
3. Changing the start/end dates so the currently visible date range does not fall in between them. |
||||
|
After Width: | Height: | Size: 34 KiB |
|
After Width: | Height: | Size: 31 KiB |
|
After Width: | Height: | Size: 22 KiB |
|
After Width: | Height: | Size: 52 KiB |
|
After Width: | Height: | Size: 57 KiB |
Loading…
Reference in new issue