Skip to content

[NEW] timesheets: billing rate leaderboad #13921

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 18.0
Choose a base branch
from
Open

[NEW] timesheets: billing rate leaderboad #13921

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions content/applications/services/timesheets/overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ Overview
:titlesonly:

overview/time_off
overview/billing_rates
91 changes: 91 additions & 0 deletions content/applications/services/timesheets/overview/billing_rates.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
:show-content:

=======================================
Timesheet billing rates and leaderboard
=======================================

Odoo’s **Timesheets** app allows you to set personalized :ref:`billing rate targets <billing_rates/targets>`
for employees. In addition to billing rate targets, a :ref:`leaderboard <billing_rates/leaderboard>`
can be enabled to motivate employees and gamify their experience. The leaderboard displays billable
and total time logged by employees, and can be enhanced with :ref:`motivational tips <billing_rates/tips>`.

.. _billing_rates/targets:

Billing rate indicators
=======================

Configuration
-------------

To enable billing rate indicators, navigate to :menuselection:`Timesheets --> Configuration --> Settings`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this line goes over the 100th character-limit?

then enable :guilabel:`Billing Rate Indicators`, and press :guilabel:`Save`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
then enable :guilabel:`Billing Rate Indicators`, and press :guilabel:`Save`.
then enable :guilabel:`Billing Rate Indicators`, and click :guilabel:`Save`.

(not wrong but you used "click" elsewhere in the doc and we usually assume people are doing this from a computer so for consistency 😉 )


A new item, :guilabel:`Billing Time Targets` is then added in the :guilabel:`Configuration` menu. To
set up the targets, click :guilabel:`Billing Time Targets`, then encode the :guilabel:`Monthly
Comment on lines +23 to +24
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • We don't usually mention that menu items are "added" and instead focus on actionable steps (e.g., To configure xxx, go to yy --> zz --> aa, enable blabla, etc.)
  • This is only true from 18.2; in 18.0, you need to click the internal link under the setting
Suggested change
A new item, :guilabel:`Billing Time Targets` is then added in the :guilabel:`Configuration` menu. To
set up the targets, click :guilabel:`Billing Time Targets`, then encode the :guilabel:`Monthly
To set up the targets, click :guilabel:`Set employee billing time targets`, then encode the :guilabel:`Monthly

in 18.2, I'd add the menu as an alternative:

Suggested change
A new item, :guilabel:`Billing Time Targets` is then added in the :guilabel:`Configuration` menu. To
set up the targets, click :guilabel:`Billing Time Targets`, then encode the :guilabel:`Monthly
To set up the targets, click :guilabel:`Set employee billing time targets` or go to :menuselection:`Timesheets --> Configuration --> Billing Time Targets`, then encode the :guilabel:`Monthly

Billing Time Target` in hours or days, depending on the **Encoding Method** selected in the
**Timesheets** app configuration.
Comment on lines +25 to +26
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Billing Time Target` in hours or days, depending on the **Encoding Method** selected in the
**Timesheets** app configuration.
Billing Time Target` in hours or days, depending on the :guilabel:`Encoding Method` selected in the
**Timesheets** :guilabel:`Settings`.
  • since we are referring to that field
  • I feel like settings is more precise and makes it clear what we are referring to exactly


.. note::
Once the :guilabel:`billing rate indicators` have been enabled in **Timesheets** app
configuration, you can also navigate to the **Employees** app, access the employee form that you
Comment on lines +29 to +30
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Once the :guilabel:`billing rate indicators` have been enabled in **Timesheets** app
configuration, you can also navigate to the **Employees** app, access the employee form that you
Once the :guilabel:`Billing Rate Indicators` have been enabled,, you can also navigate to the **Employees** app, access the employee form that you
  • guilabel = we match the UI's capitalization (unless it's all caps); you could also remove the guilabel here if you want since we can also argue we are referring to the general concept of billing rate indicators
  • since we just explained the configuration, I feel like we don't need to repeat it here in detail

wish to edit, and navigate to the :guilabel:`Settings` tab. Scroll down to
:guilabel:`Application settings`, then encode the :guilabel:`Monthly Billing Time Target`.

Using the billing rate indicators
---------------------------------

Once enabled, the billing rate indicators are displayed in the upper right corner of the
:guilabel:`My Timesheets` in Kanban, grid, and list views for all users. The monthly amount of time
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like a word is missing after "My timesheets" but I'm not sure what would work here. Any ideas?

logged by the user is displayed in the following format: **logged billable time / billable time
target**. The percentage of completion of the billing rate target is also displayed, highlighted in
red if the user falls below the target and in green once the target is reached.

Below the billing rate indicators, the total monthly amount of time logged by the user is also
displayed.

.. image:: billing_rates/indicators.png
:alt: Billing rate indicators.

.. _billing_rates/leaderboard:

Billing rate leaderboard
========================

Configuration
-------------

After the **monthly billing time targets** have been enabled, Odoo offers the possibility of
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I'd add a ref here instead

Suggested change
After the **monthly billing time targets** have been enabled, Odoo offers the possibility of
After the :ref:`monthly billing time targets <timesheets/billing_rates/targets>` have been enabled, Odoo offers the possibility of

activating a **billing rate leaderboard** in order to motivate employees and enhance workplace
transparency.

To enable the billing rate leaderboard, navigate to :menuselection:`Timesheets --> Configuration --> Settings`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this line also goes over the 100th character-limit? 🙈

activate :guilabel:`Billing Rate Leaderboard`, then click :guilabel:`Save`.

Using the billing rate leaderboard
----------------------------------

The billing rate leaderboard is then displayed in the upper right corner of the
:guilabel:`My Timesheets` view, next to the billing rate indicators. It displays the current top
three performers who have logged the highest percentage of their allocated billing hours.

It also shows the amount of the time logged by the signed in user in the format: logged billable
time / billable time target, as well as the total time logged.
Comment on lines +71 to +72
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
It also shows the amount of the time logged by the signed in user in the format: logged billable
time / billable time target, as well as the total time logged.
It also shows the amount of time logged by the signed-in user in the format: logged billable
time / billable time target, as well as the total time logged.


Clicking on the area of the top three performers opens the leaderboard for all team members. Use the
drop-down menu in the upper left corner to switch between the :guilabel:`Billing Rate Leaderboard`
and the :guilabel:`Total Time Leaderboard`, which displays the total time logged by team members
across billable and internal projects.

.. image:: billing_rates/leaderboard.png
:alt: Billing rate leaderboard.

.. _billing_rates/tips:

Leaderboard tips
================

**Daily motivational tips**, displayed on the right side of the leaderboard, enhance the billing
rate and total time leaderboard. The tips are randomly selected and change daily.

To create or edit existing tips, navigate to :menuselection:`Timesheets --> Configuration --> Tips`.
To create a new tip, click :guilabel:`New`, and to edit the existing one, double-click on its text.
Comment on lines +90 to +91
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like maybe we could group these two sentences (it would also avoid repetitions):

Suggested change
To create or edit existing tips, navigate to :menuselection:`Timesheets --> Configuration --> Tips`.
To create a new tip, click :guilabel:`New`, and to edit the existing one, double-click on its text.
To create or edit existing tips, navigate to :menuselection:`Timesheets --> Configuration --> Tips`, then click :guilabel:`New` or double-click a tip's text.

Binary file added content/applications/services/timesheets/overview/billing_rates/indicators.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/applications/services/timesheets/overview/billing_rates/leaderboard.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.