opf/openproject

View on GitHub
docs/user-guide/README.md

Summary

Maintainability
Test Coverage
---
sidebar_navigation:
  title: User guide
  priority: 990
description: OpenProject user guide for Community edition, Enterprise cloud and Enterprise on-premises.
keywords: user guide
---
# User guide

Welcome to the OpenProject User guide.

This guide covers all of OpenProject's functionalities from a user's perspective.

## Overview of projects in OpenProject

Your work within OpenProject can be organized into multiple projects, each with a distinct set of members and their respective roles in that project.  In turn, each project can be individually configured with regards to the enabled features, called *Modules* in OpenProject. This distinction between projects provides you with a lot of flexibility to set up your work, and control what users are allowed to view and/or collaborate on in each individual project.

Both the Community edition and Enterprise edition allow you to create an unlimited number of projects to separate your work. To learn more about the creation and management of projects within OpenProject, [please visit our separate section on projects](projects/).

## Overview of modules in OpenProject

<div class="glossary">

**Module** is defined as an independent unit of functionality that can be used to extend and improve the existing core functions.

</div>

Within a project Modules can be activated and deactivated under "Modules" in the project settings menu by project members who have sufficient permissions to adjust project settings. Which modules or single functionalities will be available within projects is controlled in the global Administration settings (please see [System admin guide](../system-admin-guide/projects) to see how this is done).

Please choose the module or feature you want to learn more about.

| Topic                                                        | Content                                                      |
| ------------------------------------------------------------ | :----------------------------------------------------------- |
| [Activity](activity)                                         | How to find out about the latest activities in a project.    |
| [Backlogs (Scrum)](backlogs-scrum)                           | How to manage a Scrum team in OpenProject with a product backlog and taskboard. |
| [Baseline comparison](work-packages/baseline-comparison)     | View and compare changes in a work package table within a given period of time. |
| [Boards](agile-boards)                                       | How to work with Agile boards for agile project management, e.g. Kanban. |
| [Budgets](budgets)                                           | How to create and manage a project budget.                   |
| [Calendar](calendar)                                         | How to display your work in a calendar in OpenProject.       |
| [Documents](documents)                                       | How to upload and share documents in OpenProject.            |
| [Forums](forums)                                             | How to manage forums to discuss and comment on topics.       |
| [Gantt chart](gantt-chart)                                   | How to create and manage a project plan in a Gantt chart.    |
| [GitHub](../system-admin-guide/integrations/github-integration/) | How to manage the GitHub integration.                        |
| [GitLab](../system-admin-guide/integrations/gitlab-integration/) | How to manage the GitLab integration.                        |
| [Meetings](meetings)                                         | How to manage meetings to create and share meeting agenda and meeting minutes. |
| [Members](members)                                           | How to manage Members in a project.                          |
| [News](news)                                                 | How to create and manage News for your projects.             |
| [Nextcloud integration](./file-management/nextcloud-integration) | How to link and use Nextcloud files and folders in OpenProject. |
| [OneDrive/SharePoint integration](./file-management/one-drive-integration) | How to link and use SharePoint files and folders in OpenProject. |
| [Projects](projects)                                         | Edit, create, copy, delete projects and change project settings. |
| [Project overview page](project-overview)                    | How to create a project overview dashboard with important project information. |
| [Roadmap](roadmap)                                           | How to create a product roadmap with OpenProject.            |
| [Team planner](team-planner)                                 | How to use the team planner module.                          |
| [Time and costs](time-and-costs)                             | How to track time and costs in OpenProject and report spent time and costs. |
| [Wiki](wiki)                                                 | How to create and manage a wiki to collaboratively document and share information. |
| [Work packages](work-packages)                               | How to manage your work in a project.                        |