Skip to content

[IMP] Appraisals: Update main doc #13141

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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
185 changes: 100 additions & 85 deletions content/applications/hr/appraisals.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@
Appraisals
==========

In Odoo, the *Appraisals* application can be used to evaluate employee performance on a recurring
In Odoo, the **Appraisals** application is used to evaluate employee performance on a recurring
basis. Managers can evaluate the performance of their employees, and also allow employees to do a
self-assessment of their own. Appraisals are customizable, and can be set for any kind of schedule
desired.
self-assessment of their own. Appraisals are customizable, and can be set for any desired schedule.

Appraisals give employees valuable feedback, including actionable goals to work toward, and
measurable skills to improve upon. Additionally, appraisals may form the basis for raises,
Expand All @@ -16,121 +15,119 @@ promotions, and other benefits.
Regular appraisals are good for both the employees and the company, since they can accurately
measure performance based on company goals, and show employees where they need to improve.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd like to take some time to provide a totally optional rewrite to the introduction. The original has all the key features and delivers the value proposition of the Appraisal app. It's already strong!

I've drafted a more concise version and walk you through what changed and why I'm changing it, so you understand my reasoning, and hopefully this guides you to be consistently concise in your documentation 😊

Proposed rewrite

The Appraisals app provides a structured, repeatable way to review performance and set goals. Managers schedule reviews, employees complete self-assessments, and both sides record feedback in one place. Custom templates, rating scales, and 360° feedback keep each review aligned with company objectives and highlight concrete next steps—information managers can later use for raises, promotions, or training plans.

Why this version works better

Goal Original Rewrite Rationale
Lead with value Opens by stating the app “is used to evaluate employee performance.” Opens with the outcome: “a structured, repeatable way to review performance and set goals.” Hooks readers with what they gain first, not the mechanics.
Keep it concise Several sentences repeat why appraisals are useful. Consolidates benefits into two focused sentences. Reduces reading time while preserving meaning.
Avoid generic phrasing “Good for both the employees and the company.” Lists specific results: feedback, goals, raises, promotions, training plans. Concrete examples feel more actionable than generic praise.

Your draft contained all the right ingredients—I just repackaged them so readers can grasp the value faster. Feel free to use or adapt this rewrite, and let me know if any part of the reasoning isn’t clear. Happy to chat or pair on edits.

Great work getting the substance down; these small tweaks push it over the finish line. 🚀


Configuration
=============
The :guilabel:`Configuration` menu in the **Appraisals** application is where various settings are
configured, frequencies are set, appraisal templates are edited, evaluation scales are managed, data
for 360 feedback is stored, skills are managed, and goal tags are created.

The :guilabel:`Configuration` menu in the *Appraisals* application is where the settings can be
configured, feedback templates can be edited, frequencies can be set, evaluation scales can be
managed, data for 360 feedback can be stored, and goal tags can be viewed/created.
.. important::
When the **Appraisals** app is installed, the **Employees** app is also installed, as appraisals
are dependant on employees, and the app cannot work without the **Employees** app.

Settings
--------

To access the *Settings* menu, navigate to :menuselection:`Appraisals application --> Configuration
--> Settings`.

Feedback templates
~~~~~~~~~~~~~~~~~~

Feedback templates are form outlines used during an employee appraisal. Any edits made to a template
are, ultimately, reflected in the appraisals sent to employees.

There are two default templates pre-configured in Odoo *Appraisals*: one for employee feedback, and
one for manager feedback. Each contains several sections, along with questions, and brief
explanations for how to respond to the questions.

The :guilabel:`Employee Feedback Template` has the following sections: :guilabel:`My work`,
:guilabel:`My future`, and :guilabel:`My feelings`.

The :guilabel:`Manager Feedback Template` has the following sections: :guilabel:`Feedback`,
:guilabel:`Evaluation`, and :guilabel:`Improvements`.

Any desired changes to the default feedback templates can be made by making changes directly in each
template.
========

Appraisals
~~~~~~~~~~

The :guilabel:`Appraisals` section of the settings menu determines the frequency that appraisals are
performed, and if it is possible to request additional feedback.
To access the *Settings* menu, navigate to :menuselection:`Appraisals app --> Configuration
--> Settings`. First, using the drop-down menu, select the :guilabel:`Default Template` used for all
employee appraisals.

.. image:: appraisals/appraisals-setting.png
:align: center
:alt: The appraisals sections with the timeline filled in and 360 feedback enabled.
Feedback templates are form outlines used during an employee appraisal. One template comes
preconfigured with the **Appraisals** app, named :guilabel:`Default Template`.

.. _appraisals/appraisal-plan:

Appraisals plans
****************
----------------

By default, appraisals are pre-configured to be automatically created six months after an employee
is hired, with a second appraisal exactly six months after that.
The :guilabel:`Appraisals Plans` section of the settings menu determines the frequency appraisals
are performed, whether appraisals are scheduled automatically, and if it is possible to request
additional feedback.

By default, appraisals are preconfigured to be automatically created six months after an employee is
hired, with a second appraisal exactly six months after that.

Once those two initial appraisals have been completed in the employee's first year, following
appraisals are only created once a year (every twelve months).

To modify this schedule, change the number of months in the blank fields under the
:guilabel:`Appraisals Plans` section.

To have appraisals automatically scheduled *and* confirmed according to the schedule, tick the
checkbox next to :guilabel:`Appraisals Automation`.

.. important::
If the :guilabel:`Appraisals Plans` section is modified, **all** empty :guilabel:`Next Appraisal
Dates` are modified for **all** employees.

360 feedback
************

The :guilabel:`360 Feedback` option can be enabled to allow managers to request feedback from other
Enable the :guilabel:`360 Feedback` option to allow managers to request feedback from other
employees using a different survey form, at any time, independent of the appraisal schedule.

Typically, managers ask for feedback from other people who work with an employee they manage. This
includes the employee's various managers, peers, and direct reports.
includes the employee's various managers, coworkers, and direct reports.

By default, the preconfigured :guilabel:`360 Feedback` populates the :guilabel:`Default Template`
field.

To view the :guilabel:`360 Feedback` survey, click the :guilabel:`→ Internal link` icon at the end
of the :guilabel:`Default Template` field. The :guilabel:`360 Feedback` survey loads, and any
desired changes to the survey can be made.
To view the :guilabel:`360 Feedback` survey, click the :icon:`oi-arrow-right` :guilabel:`(Internal
link)` icon at the end of the :guilabel:`Default Template` field. The :guilabel:`360 Feedback`
survey loads, and any desired changes to the survey are then made.

For more information on how to edit a survey, refer to the :doc:`../marketing/surveys/create`
document.

.. image:: appraisals/appraisal-settings.png
:alt: The various configured settings for the Appraisals app.

.. important::
The :guilabel:`360 Feedback` form is a pre-configured survey within the *Surveys* application. In
order to use the :guilabel:`360 Feedback` option, including the ability to edit the survey, the
*Surveys* application **must** be installed.
The :guilabel:`360 Feedback` form is a preconfigured survey within the **Surveys** application.
In order to use the :guilabel:`360 Feedback` option, including the ability to edit the survey,
the **Surveys** application **must** be installed.

Evaluation scale
----------------
Appraisal templates
===================

On each employee appraisal form, final rating options appear by default. To view and edit these
options, navigate to :menuselection:`Appraisals application --> Configuration --> Evaluation Scale`.
This presents the ratings in a list view.
To view available appraisal templates and make any desired modifications, navigate to
:menuselection:`Appraisals app --> Configuration --> Appraisal Templates`. Only one appraisal
template comes preconfigured in Odoo's **Appraisals** app, the :guilabel:`Default Template`.

Click on the template to view the template details. The :guilabel:`Default Template` contains
several sections, along with questions, and brief explanations for how to respond to the questions.

The :guilabel:`Employee Feedback` section has the following sections: :guilabel:`My work`,
:guilabel:`My future`, and :guilabel:`My feelings`.

The pre-configured ratings are :guilabel:`Needs Improvement`, :guilabel:`Meets Expectations`,
:guilabel:`Exceeds Expectations`, and :guilabel:`Strongly Exceeds Expectations`. To add another
rating, click the :guilabel:`New` button.
The :guilabel:`Manager Feedback` side has the following sections: :guilabel:`Feedback`,
:guilabel:`Evaluation`, and :guilabel:`Improvements`.

Make any desired modifications directly in the template. Any edits made to the template are,
ultimately, reflected in the appraisals sent to employees.

When the :guilabel:`New` button is clicked on the :guilabel:`Evaluation Scale` page, a blank line
appears at the bottom of the list. Enter the name of the rating in the field.
Evaluation scale
================

On each employee appraisal form, final rating options appear by default. To view and edit these
options, navigate to :menuselection:`Appraisals app --> Configuration --> Evaluation Scale`. This
presents the ratings in a list view.

To rearrange the order of the ratings, click the :guilabel:`(six small gray boxes)` icon to the left
of a rating, and drag the rating to the desired position on the list.
The preconfigured ratings are :guilabel:`Needs Improvement`, :guilabel:`Meets Expectations`,
:guilabel:`Exceeds Expectations`, :guilabel:`Strongly Exceeds Expectations`, and :guilabel:`Good`.
To add another rating, click the :guilabel:`New` button, and a blank line appears at the bottom of
the list. Enter the name of the rating in the field.

.. image:: appraisals/evaluation-scale.png
:align: center
:alt: The evaluation scale, with the new button and click and drag icons highlighted.
.. note::
If in a multi-company environment, a :guilabel:`Company` column also appears.

360 feedback
------------
============

The :guilabel:`360 Feedback` section displays information for all the surveys currently configured
in the *Appraisals* application. To view the surveys, and their statistics, navigate to
:menuselection:`Appraisals application --> Configuration --> 360 Feedback`.
in the **Appraisals** application. To view the surveys, and their statistics, navigate to
:menuselection:`Appraisals app --> Configuration --> 360 Feedback`.

.. image:: appraisals/survey-list.png
:align: center
:alt: A list view of all available surveys in the Appraisals application.

Each appraisal (or survey) is presented in its own line on the :guilabel:`360 Feedback` page, along
with various information related to that particular appraisal.
Each appraisal (or survey) is presented in its own line on the :guilabel:`360 Feedback` dashboard,
along with various information related to each particular appraisal.

Each appraisal includes the following information:

Expand All @@ -143,33 +140,51 @@ Each appraisal includes the following information:
- :guilabel:`Completed`: the number of people who have completed the survey.

Each appraisal also has two buttons at the end of each line: a :guilabel:`Test` button and a
:guilabel:`See Results` button.
:guilabel:`See results` button.

To see what an appraisal looks like for the end user (i.e. an employee), click the :guilabel:`Test`
button, and the appraisal loads in a new browser tab. The entire appraisal loads, and can be clicked
through without having to enter any answers.

To exit, close the tab. Or, click :guilabel:`This is a Test Survey. → Edit Survey` at the top of the
page to be taken to the detail form for that particular survey.
through without having to enter any answers. To exit, close the tab.

To view the results from everyone who completed an appraisal, click the :guilabel:`See Results`
button. This presents all the answers for the survey in a new tab. Each question provides
information on how many people responded to a question, and how many people skipped it. All answers
for each question are visible.

To exit, close the tab. Or, click :guilabel:`→ Edit Survey` at the top of the page to be taken to
the detail form for that particular survey.
for each question are visible. To exit, close the tab.

In addition to viewing the responses from past appraisals and surveys, new surveys can also be
created from the :guilabel:`360 Feedback` page. Simply click the :guilabel:`New` button in the
top-left of the page to create a new survey.
created from the :guilabel:`360 Feedback` page. Click the :guilabel:`New` button in the top-left
corner of the page to create a new survey.

For more information on how to create a survey, refer to the :doc:`../marketing/surveys/create`
document.

.. note::
In previous versions of Odoo, this section was referred to as :guilabel:`Surveys`.

Skills type
===========

An employee's progress is reflected not only in their appraisals, but through specific :doc:`goals
<appraisals/goals>`. These goals can be reviewed independently, or concurrent with an appraisal.

Goals can be based on specific skills, or independently. To view the currently configured skills,
navigate to :menuselection:`Appraisals app --> Configuration --> Skills Type`. This list is
identical to the skills in the *8Employees** app, and can be modified either here in the
**Appraisals** app, or in the :ref:`Employees app <employees/skill-types>`.

Tags
====

Tags are used when creating an employee :doc:`goals <appraisals/goals>`, to classify goals for
reporting purposes. To view the preconfigured tags, navigate to :menuselection:`Appraisals app -->
Configuration --> Tags`.

The default tags are: :guilabel:`External`, :guilabel:`Hard Skills`, :guilabel:`Internal`,
:guilabel:`Programming`, :guilabel:`Soft Skills`, and :guilabel:`Training`.

To add a new tag, click the :guilabel:`New` button in the upper-left corner. Enter the new tag in
the blank field that appears at the bottom of the list.

.. seealso::
- :doc:`appraisals/new_appraisals`
- :doc:`appraisals/goals`
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.