openproject/docs/user-guide/README.md

---
sidebar_navigation:
  title: User guide
  priority: 990
description: OpenProject user guide for Community, Cloud Edition and Enterprise Edition.
keywords: user guide
---
# User guide

Welcome to the OpenProject User guide.

This guide covers all features and functionalities found in OpenProject. 


## 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.

<div class="glossary">
**Module** is defined as an independent unit of functionality that can be used to extend and improve the existing core functions. Modules can be activated and deactivated in the project settings (information tab).
</div>


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

A module in OpenProject encapsulates a specific set of collaboration functionality. Modules can be individually enabled or disabled within the settings of a project.

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

| Topic                                                        | Content                                                      |
| ------------------------------------------------------------ | :----------------------------------------------------------- |
| [Project overview page](project-overview)                    | How to create a project overview dashboard with important project information. |
| [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. |
| [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.       |
| [GitHub](../system-admin-guide/integrations/github-integration/) | How to manage GitHub integration.                            |
| [Meetings](meetings)                                         | How to manage meetings to create and share meeting agenda and meeting minutes. |
| [News](news)                                                 | How to create and manage News for your projects.             |
| [Using the Nextcloud integration](nextcloud-integration)     | How to link and use Nextcloud files and folders in 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. |
| [Roadmap](roadmap)                                           | How to create a product roadmap with OpenProject.            |
| [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.                        |
| [Gantt chart](gantt-chart)                                   | How to create and manage a project plan in a Gantt chart.    |
| [Members](members/)                                          | How to manage Members in a project.                          |
| [Manage projects](projects)                                  | Edit, create, copy, delete projects and change project settings. |
Adding installation checklist to Enterprise Edition guide 5 years ago			`---`
			`sidebar_navigation:`
Docs cherry picks from release-12.0 (#10527) * Chore/doc pngs (#10422) * feat(docs): remove uppercase duplicate pngs * feat(docs): reduce png file sizes * Make the menu item for dev FAQ conistent * Remove section it does not add any value * Initial draft * Make the capitalization consistent for Release notes * Make the menu entry for installation & operations guide consistent with heading * Make the capitalization consistent for Enterprise guide * Make capitalization consistent for System admin guide * Make the capitalization consistent for API documentation * Added missing elements, udpated status for each Added links to some components and patterns that were missing and updated the status to accurately reflect the documentation status for each. No doc status for foundation library yet (some elements like Illustrations and Spacing don't need documentation, the rest is in progress) * Example for implementation of Action bar * Fixed markdown table, added implementation examples * Adding link to Calendar module as example for an implemented component * Added some examples, but they're mostly Include projects * Correct capitalization of User guid in docs Co-authored-by: Niels Lindenthal <lindenthal@users.noreply.github.com> Co-authored-by: Parimal Satyal <88370597+psatyal@users.noreply.github.com> 3 years ago			`title: User guide`
fix(docs): add missing & adjust frontmatter (#9405) 3 years ago			`priority: 990`
Adding installation checklist to Enterprise Edition guide 5 years ago			`description: OpenProject user guide for Community, Cloud Edition and Enterprise Edition.`
			`keywords: user guide`
			`---`
Upload structure for user guide Upload initial structure for the user guide 5 years ago			`# User guide`

			`Welcome to the OpenProject User guide.`

Task/37591 review docs user guide (#9378) * Spelling and Grammar - User Guide Review Spelling and grammar review of the User Guide. Revisions and edits are benchmarked to US-English. [ci skip] * Spelling and Grammar - Project Overview Review [#37591] Review Docs - User Guide https://community.openproject.org/work_packages/37591 Spelling and grammar review of the Project Overview doc. Revisions and edits are benchmarked to US-English. [ci skip] * Update docs/user-guide/project-overview/README.md Co-authored-by: Phil Davis <phil@jankaritech.com> Co-authored-by: Phil Davis <phil@jankaritech.com> 3 years ago			`This guide covers all features and functionalities found in OpenProject.`
Upload structure for user guide Upload initial structure for the user guide 5 years ago
Move project admin guide into user-guide 5 years ago

			`## Overview of projects in OpenProject`

Task/37591 review docs user guide (#9378) * Spelling and Grammar - User Guide Review Spelling and grammar review of the User Guide. Revisions and edits are benchmarked to US-English. [ci skip] * Spelling and Grammar - Project Overview Review [#37591] Review Docs - User Guide https://community.openproject.org/work_packages/37591 Spelling and grammar review of the Project Overview doc. Revisions and edits are benchmarked to US-English. [ci skip] * Update docs/user-guide/project-overview/README.md Co-authored-by: Phil Davis <phil@jankaritech.com> Co-authored-by: Phil Davis <phil@jankaritech.com> 3 years ago			`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.`
Move project admin guide into user-guide 5 years ago
review and glossary limked 5 years ago			`<div class="glossary">`
			`Module is defined as an independent unit of functionality that can be used to extend and improve the existing core functions. Modules can be activated and deactivated in the project settings (information tab).`
			`</div>`

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
Task/37591 review docs user guide (#9378) * Spelling and Grammar - User Guide Review Spelling and grammar review of the User Guide. Revisions and edits are benchmarked to US-English. [ci skip] * Spelling and Grammar - Project Overview Review [#37591] Review Docs - User Guide https://community.openproject.org/work_packages/37591 Spelling and grammar review of the Project Overview doc. Revisions and edits are benchmarked to US-English. [ci skip] * Update docs/user-guide/project-overview/README.md Co-authored-by: Phil Davis <phil@jankaritech.com> Co-authored-by: Phil Davis <phil@jankaritech.com> 3 years ago			`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/).`
Commit changes 5 years ago
			`## Overview of modules in OpenProject`
Upload structure for user guide Upload initial structure for the user guide 5 years ago
Move project admin guide into user-guide 5 years ago			`A module in OpenProject encapsulates a specific set of collaboration functionality. Modules can be individually enabled or disabled within the settings of a project.`

small additional changes for time and costs module [ci skip] 4 years ago			`Please choose the module or topic you want to learn more about.`
Move project admin guide into user-guide 5 years ago
Updates to NC docs (#11211) Updated titles of Nextcloud user guide and admin guide, added section on file permissions to user guide, updated formatting of the troubleshooting section (h3 instead of bullet points) 2 years ago			`\| Topic \| Content \|`
			`\| ------------------------------------------------------------ \| :----------------------------------------------------------- \|`
			`\| [Project overview page](project-overview) \| How to create a project overview dashboard with important project information. \|`
			`\| [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. \|`
			`\| [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. \|`
			`\| [GitHub](../system-admin-guide/integrations/github-integration/) \| How to manage GitHub integration. \|`
			`\| [Meetings](meetings) \| How to manage meetings to create and share meeting agenda and meeting minutes. \|`
			`\| [News](news) \| How to create and manage News for your projects. \|`
			`\| [Using the Nextcloud integration](nextcloud-integration) \| How to link and use Nextcloud files and folders in 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. \|`
			`\| [Roadmap](roadmap) \| How to create a product roadmap with OpenProject. \|`
			`\| [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. \|`
			`\| [Gantt chart](gantt-chart) \| How to create and manage a project plan in a Gantt chart. \|`
			`\| [Members](members/) \| How to manage Members in a project. \|`
			`\| [Manage projects](projects) \| Edit, create, copy, delete projects and change project settings. \|`