diff --git a/content/applications/services/project.rst b/content/applications/services/project.rst index 15d3ba4c77..f504238186 100644 --- a/content/applications/services/project.rst +++ b/content/applications/services/project.rst @@ -17,4 +17,5 @@ coworkers, and keep track of each project's profitability. :titlesonly: project/project_management + project/project_dashboard project/tasks diff --git a/content/applications/services/project/project_dashboard.rst b/content/applications/services/project/project_dashboard.rst new file mode 100644 index 0000000000..b7024dc1e1 --- /dev/null +++ b/content/applications/services/project/project_dashboard.rst @@ -0,0 +1,113 @@ +================= +Project dashboard +================= + +The project dashboard allows you to get a comprehensive overview of your project's status. It +displays information such as the total number of tasks, timesheets, and planned hours linked to the +project, as well as detailed information about project milestones and its costs and revenues. Within +the project dashboard, you can create :guilabel:`Project updates`, which allow you to take a +snapshot of the project's status at a certain point in time. As such, it is a crucial tool for +effective project management and ensuring that your project stays on track. + +Using the project dashboard +=========================== + +To access the project dashboard, open the **Project** app and hover over the desired project’s +card. Then, click the :icon:`fa-vertical-ellipsis` (:guilabel:`vertical ellipsis`) icon and +select :guilabel:`Dashboard`. + +The left side of the dashboard displays a list of existing :ref:`project updates `, +and the right side provides :ref:`detailed information about records linked to the project +`, as well as :ref:`milestones `, +:ref:`profitability `, and :ref:`budgets +`. + +.. note:: + The information displayed on the project dashboard varies depending on the applications installed + on your database. For example, you will not see information about **Timesheets**, **Planning**, + or **Purchase Orders** if the corresponding applications are not installed. + +.. _project/project-dashboard/smart-buttons: + +Totals smart buttons +-------------------- + +The following smart buttons are displayed on the top left of the project dashboard: + + - :guilabel:`Tasks`: the number of completed (i.e., :guilabel:`Done` or :guilabel:`Canceled` + :ref:`tasks `) and all tasks, in format + completed/all, as well as the entire project's completion percentage estimation. + - :guilabel:`Timesheets`: the number of hours or days (depending on the **Timesheets** app + configuration) linked to the project. This includes all :doc:`timesheets <../timesheets>`, + whether or not they have been validated. + - :guilabel:`Planned`: the number of hours that have been planned for shifts in the **Planning** + app. This includes all :doc:`planned shifts <../planning>`, including past shifts and shifts that + have not yet been published. + - :guilabel:`Documents`: number of :doc:`documents <../../productivity/documents>` in the + project’s workspace. + - :guilabel:`Burndown Chart`: click the smart button to access a :doc:`report ` + on the status of the project’s tasks over time. + - :guilabel:`Timesheets and Planning`: click the smart button to access a :doc:`report ` + on the project’s timesheets and shifts. + - **Additional fields**, such as :guilabel:`Sales Orders`, :guilabel:`Sales Order Items`, + :guilabel:`Purchase Orders`, and more, represent the number of records linked to the project. + +.. tip:: + Use the project dashboard smart buttons to update the project records easily. Click + :guilabel:`Timesheets` to validate timesheets, :guilabel:`Planned` to create project planning, + :guilabel:`Documents` to view and validate documents, etc. + +.. _project/project-dashboard/milestones: + +Milestones +---------- + +This section is only visible if :doc:`milestones ` +have been created for this project. Click :guilabel:`Add Milestone` to create a new milestone. +Click a milestone in the checklist to edit it, enable its checkbox to mark it as completed, or +click the :icon:`fa-trash` (:guilabel:`trash`) icon to remove it. + +.. _project/project-dashboard/profitability: + +Profitability +------------- + +This section only applies to billable projects and provides a breakdown of project costs and +revenues. + +.. _project/project-dashboard/budgets: + +Budgets +------- + +If a budget has been set for the project, its status and related details are displayed in this +section. Click :guilabel:`Add Budget` to create a new budget for the project. + +.. note:: + :doc:`Analytic accounting ` must + be enabled in your database’s **Accounting** application in order for this section to be + displayed. + +.. _project/project-dashboard/updates: + +Project updates +=============== + +Project updates allow you to take a snapshot of the project’s overall status at a given point in +time, for example, during a periodic (weekly, bi-weekly, or monthly) review. This allows you to +compare specific data points, note any aspects of the project that need improvement, and estimate +if the project is on or off track. + +To create a new project update, go to the project dashboard, click :guilabel:`New`, and fill in the +following fields: + + - :guilabel:`Status`: Choose between :guilabel:`On Track`, :guilabel:`At Risk`, :guilabel:`Off + Track`, :guilabel:`On Hold`, and :guilabel:`Done`. Once the status is set, a color-coded dot is + displayed on the project’s Kanban card, allowing the project manager to easily identify which + projects need attention. + - :guilabel:`Progress`: Manually input the completion percentage based on the project's progress. + - :guilabel:`Date` and :guilabel:`Author`: These fields are automatically filled in with + appropriate information based on the user who created the update and the current date. + - :guilabel:`Description`: Use this rich-text field to gather notes. Depending on the project + configuration (e.g., if the project is billable), this field may be pre-filled with current + information on aspects such as profitability, budget, milestones, etc. diff --git a/content/applications/services/project/tasks/task_stages_statuses.rst b/content/applications/services/project/tasks/task_stages_statuses.rst index b0fb95bf5b..6971abae8f 100644 --- a/content/applications/services/project/tasks/task_stages_statuses.rst +++ b/content/applications/services/project/tasks/task_stages_statuses.rst @@ -47,6 +47,8 @@ there, click one of the following: - :guilabel:`Delete`: to delete this stage. - :guilabel:`Archive/Unarchive all`: to archive or unarchive all of the tasks in this stage. +.. _project/tasks/task_stages_statuses/statuses: + Task statuses =============