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/user-guide/README.md

53 lines
3.7 KiB

---
sidebar_navigation:
title: OpenProject User Guide
priority: 999
description: OpenProject user guide for Community, Cloud Edition and Enterprise Edition.
robots: index, follow
keywords: user guide
---
# User guide
Welcome to the OpenProject User guide.
5 years ago
Here you will learn about all functionalities in OpenProject.
## Overview of projects in OpenProject
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
Your work in OpenProject can be organized in multiple projects with a distinct set of members and their respective roles in that project. Each project can be individually configured with regards to the enabled features, which are 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 collaborate 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>
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
Both the community edition and enterprise edition allows 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/).
5 years ago
## 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? |
| [Roadmap](roadmap) | How to create a product roadmap with OpenProject? |
| [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? |
| [Boards](agile-boards) | How to work with Agile boards for agile project management, e.g. Kanban? |
| [Backlogs (Scrum)](backlogs-scrum) | How to manage a Scrum team in OpenProject with a product backlog and taskboard? |
| [Calendar](calendar) | How to display your work in a calendar in OpenProject? |
| [News](news) | How to create and manage News for your projects? |
| [Forums](forums) | How to manage forums to discuss and comment on topics? |
| [Wiki](wiki) | How to create and manage a wiki to collaboratively document and share information? |
| [Time and costs](time-and-costs) | How to track time and costs in OpenProject and report spent time and costs? |
| [Budgets](budgets) | How to create and manage a project budget? |
| [Members](members/) | How to manage Members in a project? |
| [Documents](documents) | How to upload and share documents in OpenProject? |
| [Meetings](meetings) | How to manage meetings to create and share meeting agenda and meeting minutes? |
| [Manage projects](projects) | Edit, create, copy, delete projects and change project settings. |