Skip to content
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

Chore/process docs #680

Merged
merged 4 commits into from
Feb 6, 2025
Merged
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
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."
"``{{ reviewer }}``", "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."
82 changes: 78 additions & 4 deletions backend/docs/manual/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,87 @@
Gebruikershandleiding
=====================

Deze handleiding is bedoeld voor de gebruikers van het systeem. Hierin wordt uitgelegd hoe per rol de verschillende
taken kunnen worden uitgevoerd.
Deze handleiding is bedoeld voor de gebruikers van het systeem, en beschrijft het overkoepelende proces voor het
beoordelen, goedkeuren, en vernietigen van vernietigingslijsten binnen de applicatie. Het proces omvat verschillende
rollen en hun bijbehorende verantwoordelijkheden.

.. toctree::
:maxdepth: 2
:caption: Inhoudsopgave

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

Overkoepelend proces vernietiging
---------------------------------

Deze handleiding beschrijft het overkoepelende proces voor het beoordelen, goedkeuren, en vernietigen van
vernietigingslijsten binnen de applicatie. Het proces omvat verschillende rollen en hun bijbehorende
verantwoordelijkheden.

Rollen en verantwoordelijkheden
-------------------------------

Het proces wordt uitgevoerd door verschillende rollen, waarbij elke rol specifieke verantwoordelijkheden heeft:

- **Record manager**:
- De **record manager** is verantwoordelijk voor het aanmaken, beheren en voorbereiden van de vernietigingslijst.
- De **record manager** is ook verantwoordelijk voor het doorsturen van de lijst naar de archivaris na goedkeuring
door de beoordelaar.
- De **record manager** kan niet tegelijk de auteur en de **beoordelaar** van een vernietigingslijst zijn, maar kan zowel de rol van
record manager als beoordelaar in het systeem vervullen, mits deze rollen betrekking hebben op verschillende
lijsten.

- **Beoordelaar**:
- De **beoordelaar** beoordeelt de vernietigingslijst op basis van vooraf gedefinieerde criteria.
- De **beoordelaar** kan de lijst goedkeuren of afwijzen.
- Indien er meerdere beoordelaars zijn, kunnen zij gezamenlijk de lijst beoordelen, maar de **hoofdbeoordelaar**
heeft de uiteindelijke verantwoordelijkheid voor goedkeuring of afwijzing van de lijst.
- De **beoordelaar** is verantwoordelijk voor het markeren van zaken als **geaccordeerd** of **uitgezonderd**.

- **Mede-beoordelaar**:
- De **mede-beoordelaar** is een extra beoordelaar die kan worden toegevoegd om samen met de hoofdbeoordelaar de
lijst te beoordelen.
- De **mede-beoordelaar** heeft dezelfde beoordelingsverantwoordelijkheden als de hoofdbeoordelaar, zoals het
goedkeuren of afwijzen van zaken in de lijst.
- De beoordelingen van alle **mede-beoordelaars** worden zichtbaar voor alle beoordelaars.
- De **mede-beoordelaar** kan zaken als **geaccordeerd** of **uitgezonderd** markeren, maar heeft geen bevoegdheid
om de lijst als geheel goed te keuren of af te wijzen. Dit kan alleen de **hoofdbeoordelaar** doen.

- **Archivaris**:
- De **archivaris** heeft de laatste beoordeling van de vernietigingslijst en geeft de goedkeuring voor de
vernietiging.
- Als de lijst door de beoordelaar is goedgekeurd, stuurt de **record manager** deze door naar de **archivaris**
voor de laatste goedkeuring.

Processtappen
-------------

1. **Voorbereiden van de lijst (door de record manager)**:
- De **record manager** creëert de vernietigingslijst en past deze eventueel later nog aan.
- Zodra de lijst klaar is, kan de **record manager** de lijst naar de beoordelaar sturen en kan daarbij optioneel
ook medebeoordelaars toewijzen.

2. **Beoordelen van de lijst (door de beoordelaar en mede-beoordelaars)**:
- De **beoordelaar** opent de lijst en beoordeelt de zaken.
svenvandescheur marked this conversation as resolved.
Show resolved Hide resolved
- De **beoordelaar** kan extra medebeoordelaars toewijzen om samen aan de beoordeling te werken.
- De **mede-beoordelaar** heeft dezelfde beoordelingsverantwoordelijkheden als de **beoordelaar** en kan zaken
goedkeuren, afwijzen of uitzonderen.
- Alle beoordelaars (hoofdbeoordelaar en mede-beoordelaars) kunnen hun opmerkingen en beoordelingen zien, maar
alleen de **hoofdbeoordelaar** kan de lijst goedkeuren of afwijzen.

svenvandescheur marked this conversation as resolved.
Show resolved Hide resolved
3. **Verwerken van een beoordeling (door de record manager)**:
- Indien een lijst is afgewezen kan de beoordeling door de **record manager** verwerkt worden door voor elke
uitgezonderde zaak de selectielijstklasse (en optioneel archiefactiedatum) aan te passen, of het voorstel tot
uitzonderen af te wijzen.

4. **Doorsturen naar de archivaris (door de record manager)**:
- Nadat de lijst is goedgekeurd door de beoordelaar, stuurt de **record manager** de lijst door naar de
**archivaris**.
- De **archivaris** heeft de laatste goedkeuring om de vernietiging in gang te zetten.

5. **Vernietigen van de lijst (door de archivaris)**:
- Na goedkeuring door de archivaris, worden de geselecteerde zaken definitief vernietigd.
- Een vernietigingsrapport wordt gegenereerd door het systeem na afloop van de vernietiging, welke kan worden
gedownload door de record manager.