Skip to content

Commit

Permalink
📝 #675 - docs: rename reviewer to beoordelaar in user manual
Browse files Browse the repository at this point in the history
  • Loading branch information
svenvandescheur committed Feb 6, 2025
1 parent cf30dec commit e4c6e44
Show file tree
Hide file tree
Showing 10 changed files with 22 additions and 22 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Voorwaarden
------------
- De record manager moet beschikken over een actieve gebruikersaccount met de juiste toegangsrechten.
- Er moeten zaken aanwezig zijn in de applicatie.
- Een reviewer (beoordelaar) moet bestaan om toegewezen te worden aan de vernietigingslijst.
- Een beoordelaar moet bestaan om toegewezen te worden aan de vernietigingslijst.

Stappen
-------
Expand All @@ -42,14 +42,14 @@ Stappen
- Op het formulier dat verschijnt, vul je de volgende velden in:
- **Naam**: Geef een duidelijke en unieke naam voor de vernietigingslijst, bijvoorbeeld:
**“Mijn eerste vernietigingslijst”**.
- **Reviewer**: Kies een beoordelaar uit de lijst die je wilt toewijzen aan de vernietigingslijst.
- **Beoordelaar**: Kies een beoordelaar uit de lijst die je wilt toewijzen aan de vernietigingslijst.

.. figure:: ../_assets/vernietigingslijst-opstellen-formulier.png
:align: center
:alt: Vernietigingslijst opstellen formulier
:height: 346px

Formulier voor het opstellen van een nieuwe vernietigingslijst met velden voor **"Naam"**, **"Reviewer"** en
Formulier voor het opstellen van een nieuwe vernietigingslijst met velden voor **"Naam"**, **"Beoordelaar"** en
**"Opmerking"**.

6. **Bevestig de aanmaak van de lijst**
Expand All @@ -64,7 +64,7 @@ Let op
- Controleer altijd of alle velden correct zijn ingevuld voordat je de lijst aanmaakt.
- Indien je een fout hebt gemaakt, kun je de lijst later bewerken of verwijderen.

Met deze stappen kun je een vernietigingslijst opstellen en een reviewer toewijzen. De lijst kan nog worden
Met deze stappen kun je een vernietigingslijst opstellen en een beoordelaar toewijzen. De lijst kan nog worden
:ref:`aangepast<manual_1-record-manager_1.2-vernietigingslijst-bewerken>` voordat deze definitief wordt gemaakt en ter
controle wordt :ref:`aangeboden aan de beoordelaar<manual_1-record-manager_1.3-vernietigingslijst-klaarzetten-voor-beoordeling>`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Stappen
- Een formulier wordt geopend om de nieuwe beoordelaar of toe te wijzen.

4. **Selecteer een nieuwe beoordelaar**
- Vul het veld **"Beoordelaar"** in door een naam te selecteren uit de lijst, bijvoorbeeld **"John Doe (reviewer)"**.
- Vul het veld **"Beoordelaar"** in door een naam te selecteren uit de lijst, bijvoorbeeld **"John Doe (beoordelaar)"**.
- Vul het veld **"Reden"** in met een korte toelichting, bijvoorbeeld **"Originele beoordelaar is op vakantie."**.

5. **Bevestig de wijziging**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Let op
:ref:`afgebroken<manual_1-record-manager_1.4-beoordelingsproces-afbreken>`.

Zodra de lijst is klaargezet voor beoordeling, kan de beoordelaar de lijst inzien en
:ref:`beoordelen<manual_2-reviewer-archivaris_2.1-vernietigingslijst-beoordelen>` op basis van de geselecteerde zaken en
:ref:`beoordelen<manual_2-beoordelaar-archivaris_2.1-vernietigingslijst-beoordelen>` op basis van de geselecteerde zaken en
informatie. De beoordelaar kan de lijst goedkeuren of afwijzen. Indien de lijst wordt goedgekeurd zal de status worden
bijgewerkt naar **"Intern beoordeeld"** en kan de lijst worden aangeboden aan de archivaris. Indien de lijst wordt
afgekeurd, zal de status worden bijgewerkt naar **"Wijzigingen aangevraagd"** waarna de eventueel afgekeurde zaken
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Let op
- Nadat de lijst opnieuw is ingediend, zal deze opnieuw beoordeeld moeten worden door een beoordelaar.

Na het indienen kan de lijst door de beoordelaar opnieuw worden
:ref:`bekeken<manual_2-reviewer-archivaris_2.1-vernietigingslijst-beoordelen>`. De beoordelaar kan de lijst goedkeuren
:ref:`bekeken<manual_2-beoordelaar-archivaris_2.1-vernietigingslijst-beoordelen>`. De beoordelaar kan de lijst goedkeuren
of verdere wijzigingen aanvragen.

.. |muteren_knop| image:: ../_assets/muteren-knop.png
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Let op
- Nadat de lijst is gemarkeerd als definitief, zal de archivaris de lijst verder verwerken.

Na het markeren van de lijst als definitief, wordt de lijst doorgestuurd naar de archivaris voor verdere verwerking. De
archivaris voert een laatste :ref:`beoordeling<manual_2-reviewer-archivaris_2.1-vernietigingslijst-beoordelen>` uit en
archivaris voert een laatste :ref:`beoordeling<manual_2-beoordelaar-archivaris_2.1-vernietigingslijst-beoordelen>` uit en
kan de lijst goedkeuren of afwijzen. Indien de lijst wordt goedgekeurd zal de status worden bijgewerkt naar
**"Klaar om te vernietigen"** en kan de vernietiging van de geselecteerde zaken worden
:ref:`gestart<manual_1-record-manager_1.7-vernietigingslijst-vernietigen>`. Indien de lijst wordt afgekeurd, zal de status
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _manual_2-reviewer-archivaris_2.1-vernietigingslijst-beoordelen:
.. _manual_2-beoordelaar-archivaris_2.1-vernietigingslijst-beoordelen:

=============================
Vernietigingslijst beoordelen
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _manual_2-reviewer-archivaris_2.2-medebeoordelaars-toewijzen:
.. _manual_2-beoordelaar-archivaris_2.2-medebeoordelaars-toewijzen:


==========================
Expand Down Expand Up @@ -40,7 +40,7 @@ Stappen
- Nadat je de medebeoordelaars hebt toegewezen, worden de medebeoordelaars weergegeven in de lijst met beoordelaars.

Na het toewijzen kunnen de medebeoordelaars de lijst bekijken en
:ref:`beoordelen<manual_2-reviewer-archivaris_2.1-vernietigingslijst-beoordelen>`. Beoordelingen van alle
:ref:`beoordelen<manual_2-beoordelaar-archivaris_2.1-vernietigingslijst-beoordelen>`. Beoordelingen van alle
(mede)beoordelaars zijn zichtbaar voor alle andere beoordelaars. Alleen de hoofdbeoordelaar kan de lijst goedkeuren of
afwijzen.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _manual_2-reviewer-archivaris_index:
.. _manual_2-beoordelaar-archivaris_index:

===================
Reviewer/Archivaris
===================
======================
Beoordelaar/Archivaris
======================

.. toctree::
:maxdepth: 1
Expand Down
12 changes: 6 additions & 6 deletions backend/docs/manual/3-administrator/3.1-email-templates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ Locatie van de Email Configuratie

Hier kun je de onderwerpen en de emailteksten voor de emails die worden gestuurd naar:

- De reviewer als een review wordt aangevraagd.
- De reviewer als een herinnering voor een review nodig is.
- De record manager als een reviewer een lijst heeft goedgekeurd.
- De record manager als een reviewer aanpassingen heeft aangevraagd op een lijst.
- De record manager en de reviewers als een lijst succesvol is vernietigd.
- De beoordelaar als een review wordt aangevraagd.
- De beoordelaar als een herinnering voor een review nodig is.
- De record manager als een beoordelaar een lijst heeft goedgekeurd.
- De record manager als een beoordelaar aanpassingen heeft aangevraagd op een lijst.
- De record manager en de beoordelaars als een lijst succesvol is vernietigd.

Tekst en HTML sjablonen moeten geconfigureerd worden voor elke email. Een voorbeeld voor de email
die wordt gestuurd naar een beoordelaar als een lijst goedgekeurd moet worden zou kunnen is:
Expand Down Expand Up @@ -62,4 +62,4 @@ Voor elke emailtekst sjabloon, deze variabelen zijn beschikbaar:

"``{{ list_name }}``", "Geeft de naam van de vernietigingslijst."
"``{{ user_name }}``", "Geeft de voornaam en de achternaam van de persoon die de email ontvangt."
"``{{ reviewer }}``", "Geeft de voornaam, de achternaam en de gebruikersnaam (tussen haakjes) van de reviewer van de vernietigingslijst. Deze variabele is alleen beschikbaar in de sjabloon voor de email naar de record manager na een goedkeuring van de reviewer."
"``{{ beoordelaar }}``", "Geeft de voornaam, de achternaam en de gebruikersnaam (tussen haakjes) van de beoordelaar van de vernietigingslijst. Deze variabele is alleen beschikbaar in de sjabloon voor de email naar de record manager na een goedkeuring van de beoordelaar."
2 changes: 1 addition & 1 deletion backend/docs/manual/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ rollen en hun bijbehorende verantwoordelijkheden.
:caption: Inhoudsopgave

1-record-manager/index
2-reviewer-archivaris/index
2-beoordelaar-archivaris/index
3-administrator/index

Overkoepelend proces vernietiging
Expand Down

0 comments on commit e4c6e44

Please sign in to comment.