diff --git a/backend/docs/conf.py b/backend/docs/conf.py index 94fc7498d..6af22fde3 100644 --- a/backend/docs/conf.py +++ b/backend/docs/conf.py @@ -85,8 +85,8 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -# html_logo = "logo.svg" -# html_theme = "sphinx_rtd_theme" +html_logo = "logo.svg" +html_theme = "sphinx_rtd_theme" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/backend/docs/index.rst b/backend/docs/index.rst index 8876d144d..002b1c228 100644 --- a/backend/docs/index.rst +++ b/backend/docs/index.rst @@ -15,3 +15,4 @@ Documentation configure/index developers/index + manual/index diff --git a/backend/docs/logo.svg b/backend/docs/logo.svg new file mode 100644 index 000000000..eda5d41cb --- /dev/null +++ b/backend/docs/logo.svg @@ -0,0 +1,45 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/backend/docs/manual/1-record-manager/1.1-vernietigingslijst-opstellen.rst b/backend/docs/manual/1-record-manager/1.1-vernietigingslijst-opstellen.rst new file mode 100644 index 000000000..8d895aa62 --- /dev/null +++ b/backend/docs/manual/1-record-manager/1.1-vernietigingslijst-opstellen.rst @@ -0,0 +1,89 @@ +.. _manual_1-record-manager_1.1-vernietigingslijst-opstellen: + +============================ +Vernietigingslijst opstellen +============================ + +.. figure:: ../_assets/pages/vernietigingslijst-opstellen.png + :align: center + :alt: Vernietigingslijst opstellen schermafbeelding + +Deze handleiding beschrijft de stappen die een **record manager** kan volgen om een nieuwe vernietigingslijst aan te +maken binnen de applicatie. + +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. + +Stappen +------- + + +1. **Inloggen als record manager** + - Open de applicatie en log in met je gebruikersnaam en wachtwoord. + - Na succesvol inloggen, wordt je automatisch doorgestuurd naar het overzicht van bestaande vernietigingslijsten. + +2. **Navigeren naar de pagina voor het aanmaken van een nieuwe lijst** + - Klik op de knop **“Vernietigingslijst opstellen”**. |vernietigingslijst_opstellen_link| + - Je wordt doorgestuurd naar de pagina **`/destruction-lists/create`**. + +3. **Selecteer zaken voor de vernietigingslijst** + - Op de pagina zie je een lijst van beschikbare zaken. + - Klik op de checkbox naast een zaak om deze te selecteren. |checkbox_zaak| + - Je kunt ook de checkbox bovenaan gebruiken om alle zichtbare zaken in één keer te selecteren of deselecteren. |checkbox_zaken| + +4. **Bevestig de selectie** + - Klik op de knop **“Vernietigingslijst opstellen”** om door te gaan met de geselecteerde zaken. |vernietigingslijst_opstellen_actie| + +5. **Vul de vereiste informatie in** + - 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. + +.. 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 + **"Opmerking"**. + +6. **Bevestig de aanmaak van de lijst** + - Klik op de knop **“Vernietigingslijst opstellen”** om de lijst definitief aan te maken. + +7. **Controleer de aangemaakte lijst** + - Na bevestiging word je teruggeleid naar de pagina **`/destruction-lists`**. + - De vernietigingslijst verschijnt in het overzicht met de status *"Nieuw"*. + +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 +:ref:`aangepast` voordat deze definitief wordt gemaakt en ter +controle wordt :ref:`aangeboden aan de beoordelaar`. + + +.. |vernietigingslijst_opstellen_link| image:: ../_assets/vernietigingslijst-opstellen-link.png + :alt: Vernietigingslijst opstellen knop + :height: 32px + +.. |checkbox_zaak| image:: ../_assets/checkbox-zaak.png + :alt: Checkbox voor enkele zaak + :height: 42px + +.. |checkbox_zaken| image:: ../_assets/checkbox-zaken.png + :alt: Checkbox voor alle zaken + :height: 40 + +.. |vernietigingslijst_opstellen_actie| image:: ../_assets/vernietigingslijst-opstellen-actie.png + :alt: Vernietigingslijst opstellen actie knop + :height: 32px + +.. |vernietigingslijst_opstellen_formulier| image:: ../_assets/vernietigingslijst-opstellen-formulier.png + :alt: Vernietigingslijst opstellen formulier + :height: 346px \ No newline at end of file diff --git a/backend/docs/manual/1-record-manager/1.2-vernietigingslijst-bewerken.rst b/backend/docs/manual/1-record-manager/1.2-vernietigingslijst-bewerken.rst new file mode 100644 index 000000000..391ce926c --- /dev/null +++ b/backend/docs/manual/1-record-manager/1.2-vernietigingslijst-bewerken.rst @@ -0,0 +1,83 @@ +.. _manual_1-record-manager_1.2-vernietigingslijst-bewerken: + +=========================== +Vernietigingslijst bewerken +=========================== + +.. figure:: ../_assets/pages/vernietigingslijst-bewerken.png + :align: center + :alt: Vernietigingslijst bewerken schermafbeelding + +Deze handleiding beschrijft de stappen die een **record manager** kan volgen om een bestaande vernietigingslijst te +bewerken binnen de applicatie, inclusief het aanpassen van de naam van de lijst. + +Voorwaarden +------------ +- De record manager moet beschikken over een actieve gebruikersaccount met de juiste toegangsrechten. +- Er moet een bestaande vernietigingslijst aanwezig zijn. + +Stappen +------- + +1. **Inloggen als record manager** + - Open de applicatie en log in met je gebruikersnaam en wachtwoord. + - Na succesvol inloggen, word je automatisch doorgestuurd naar het overzicht van bestaande vernietigingslijsten. + +2. **Open de vernietigingslijst** + - Zoek in het overzicht naar de lijst die je wilt bewerken. + - Klik op de naam van de lijst, bijvoorbeeld **"Mijn eerste vernietigingslijst"**. + + |vernietigingslijst_kaart| + + - Je wordt doorgestuurd naar de pagina met details van de lijst. + +3. **Start het bewerken** + - Klik op de knop **"Bewerken"** om de lijst aan te passen. |vernietigingslijst_bewerken| + - Je wordt doorgestuurd naar de bewerkingspagina van de vernietigingslijst. + +4. **Zaken toevoegen** + - Navigeer naar de juiste pagina van de lijst indien deze meerdere pagina's bevat. + - Selecteer extra zaken door op de checkbox naast de gewenste zaken te klikken. + - Klik op de knop **"Vernietigingslijst aanpassen"** om de wijzigingen op te slaan. + +5. **Zaken verwijderen** + - Navigeer naar de juiste pagina van de lijst. + - Deselecteer zaken door op de checkbox naast de ongewenste zaken te klikken. + - Klik op de knop **"Vernietigingslijst aanpassen"** om de wijzigingen op te slaan. + +6. **Filters gebruiken** + - Klik op het filtericoon en selecteer de gewenste filters, bijvoorbeeld op **identificatie** of **zaaktype**. + - Pas filters toe om specifieke zaken te vinden en te beheren binnen de vernietigingslijst. + - Voeg zaken toe of verwijder zaken zoals eerder beschreven. + +7. **Naam van de lijst aanpassen** + - Klik op de knop **"Naam bewerken"** om de naam van de lijst te wijzigen. |naam_bewerken| + - Vul de nieuwe lijstnaam in, bijvoorbeeld **"Vernietigingslijst"** in het veld **"Naam"**. + - Klik op de knop **"Opslaan"** om de naamwijziging door te voeren. + +8. **Controleer de wijzigingen** + - Na het opslaan van de aanpassingen word je teruggeleid naar de lijstweergave. + - De zaken die je hebt toegevoegd of verwijderd, evenals de nieuwe naam van de lijst, worden voortaan weergegeven in de lijst. + +Let op +------ +- Controleer altijd of alle wijzigingen correct zijn doorgevoerd voordat je de lijst definitief maakt. +- Gebruik filters om snel specifieke zaken te vinden en aan te passen. +- Indien nodig kun je wijzigingen later opnieuw bewerken. +- De lijstnaam kan op elk moment aangepast worden, maar zorg ervoor dat je de nieuwe naam opslaat. + +Met deze stappen kun je een vernietigingslijst bewerken, zaken toevoegen of verwijderen, de naam van de lijst aanpassen, +en filters gebruiken om je selectie te verfijnen. De volgende stap is om de lijst definitief te maken en +:ref:`aan te bieden aan de beoordelaar`. + +.. |vernietigingslijst_kaart| image:: ../_assets/vernietigingslijst-kaart.png + :alt: Vernietigingslijst kaart (op landingspagina) + :height: 117px + +.. |vernietigingslijst_bewerken| image:: ../_assets/vernietigingslijst-bewerken.png + :alt: Vernietigingslijst bewerken knop + :height: 32px + +.. |naam_bewerken| image:: ../_assets/naam-bewerken.png + :alt: Naam bewerken knop + :height: 22px \ No newline at end of file diff --git a/backend/docs/manual/1-record-manager/1.3-vernietigingslijst-klaarzetten-voor-beoordeling.rst b/backend/docs/manual/1-record-manager/1.3-vernietigingslijst-klaarzetten-voor-beoordeling.rst new file mode 100644 index 000000000..e5ef27682 --- /dev/null +++ b/backend/docs/manual/1-record-manager/1.3-vernietigingslijst-klaarzetten-voor-beoordeling.rst @@ -0,0 +1,60 @@ +.. _manual_1-record-manager_1.3-vernietigingslijst-klaarzetten-voor-beoordeling: + +=============================================== +Vernietigingslijst klaarzetten voor beoordeling +=============================================== + +.. figure:: ../_assets/pages/vernietigingslijst-klaarzetten-voor-beoordeling.png + :align: center + :alt: Vernietigingslijst klaarzetten voor beoordeling schermafbeelding + +Deze handleiding beschrijft de stappen die een **record manager** kan volgen om een vernietigingslijst klaar te zetten +voor beoordeling binnen de applicatie. + +Voorwaarden +------------ +- De record manager moet beschikken over een actieve gebruikersaccount met de juiste toegangsrechten. +- Er moet een bestaande vernietigingslijst aanwezig zijn. +- Er moeten **beoordelaars** aan de lijst zijn toegewezen. + +Stappen +------- + +1. **Inloggen als record manager** + - Open de applicatie en log in met je gebruikersnaam en wachtwoord. + - Na succesvol inloggen, wordt je automatisch doorgestuurd naar het overzicht van bestaande vernietigingslijsten. + +2. **Open de vernietigingslijst** + - Zoek de vernietigingslijst die je klaar wilt zetten voor beoordeling. Bijvoorbeeld + **"Mijn eerste vernietigingslijst"**. + - Klik op de naam van de lijst om de details van de lijst te openen. + +3. **Zet de lijst klaar voor beoordeling** + - Klik op de knop **"Ter beoordeling indienen"** om de lijst als klaar voor beoordeling in te dienen. |ter_beoordeling_indienen| + - Bevestig de actie door opnieuw op de knop **"Ter beoordeling indienen"** te klikken in het vervolgscherm. + +4. **Controleer de status** + - Nadat de lijst klaar is gezet voor beoordeling, word je teruggeleid naar het overzicht van de + vernietigingslijsten. + - De status van de lijst wordt bijgewerkt naar **"Klaar voor beoordeling"**. + +Let op +------ +- Zorg ervoor dat alle noodzakelijke zaken correct zijn toegevoegd en geselecteerd voordat je de lijst voor beoordeling + indient. +- Controleer altijd of de juiste beoordelaar aan de lijst is toegewezen voordat je de lijst klaarmaakt voor beoordeling. +- De lijst kan niet meer bewerkt worden nadat deze is ingediend voor beoordeling, om een ingediende lijst toch te + bewerken moet eerst het beoordelingsproces worden + :ref:`afgebroken`. + +Zodra de lijst is klaargezet voor beoordeling, kan de beoordelaar de lijst inzien en +:ref:`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 aanboden aan de archivaris. Indien de lijst wordt +afgekeurd, zal de status worden bijgewerkt naar **"Wijzigingen aangevraagd"** waarna de eventueel afgekeurde zaken +kunnen worden :ref:`aangepast` en de lijst opnieuw kan worden +ingediend voor beoordeling. + +.. |ter_beoordeling_indienen| image:: ../_assets/ter-beoordeling-indienen.png + :alt: ter beoordeling indienen knop + :height: 26px \ No newline at end of file diff --git a/backend/docs/manual/1-record-manager/1.4-beoordelingsproces-afbreken.rst b/backend/docs/manual/1-record-manager/1.4-beoordelingsproces-afbreken.rst new file mode 100644 index 000000000..4135baf67 --- /dev/null +++ b/backend/docs/manual/1-record-manager/1.4-beoordelingsproces-afbreken.rst @@ -0,0 +1,51 @@ +.. _manual_1-record-manager_1.4-beoordelingsproces-afbreken: + +============================= +(Beoordelings)proces afbreken +============================= + +.. figure:: ../_assets/pages/beoordelingsproces-afbreken.png + :align: center + :alt: Beoordelingsproces afbreken schermafbeelding + +Deze handleiding beschrijft de stappen die een **record manager** kan volgen om een beoordelingsproces proces af te +breken binnen de applicatie, dit is noodzakelijk wanneer een ingediende lijst moet worden aangepast of verwijderd. + +Voorwaarden +------------ +- De record manager moet beschikken over een actieve gebruikersaccount met de juiste toegangsrechten. +- Er moet een bestaande vernietigingslijst aanwezig zijn zonder de status **"Nieuw"** of **"Vernietigd"**. + +Stappen +------- + +1. **Inloggen als record manager** + - Open de applicatie en log in met je gebruikersnaam en wachtwoord. + - Na succesvol inloggen, word je automatisch doorgestuurd naar het overzicht van bestaande vernietigingslijsten. + +2. **Open de vernietigingslijst** + - Zoek de vernietigingslijst die je wilt afbreken, bijvoorbeeld **"Mijn eerste vernietigingslijst"**. + - Klik op de naam van de lijst om de details van de lijst te openen. + +3. **Proces afbreken** + - Klik op de knop **"Proces afbreken"** om het proces te stoppen. |proces_afbreken| + - Vul de reden voor het afbreken van het proces in. + - Bevestig de actie door op de knop **"Proces afbreken"** te klikken in het vervolgscherm. + +4. **Controleer de status** + - Nadat je het proces hebt afgebroken, wordt je doorgestuurd naar de bewerkingspagina van de vernietigingslijst. + - De status van de lijst wordt bijgewerkt naar **"Nieuw"** en alle voortgang van het proces wordt teruggezet. + +Let op +------ +- Zorg ervoor dat je een opmerking toevoegt bij het afbreken van het proces, zodat de reden duidelijk is. +- Het afbreken van het proces zet de status van de lijst terug naar **"Nieuw"**, wat betekent dat het proces opnieuw kan + worden gestart. + +Na het afbreken van het proces kan de lijst opnieuw worden +:ref:`bewerkt` en verder worden verwerkt. Het proces kan later +opnieuw worden gestart of aangepast om verder te gaan met de beoordeling. + +.. |proces_afbreken| image:: ../_assets/proces-afbreken.png + :alt: ter beoordeling indienen knop + :height: 26px \ No newline at end of file diff --git a/backend/docs/manual/1-record-manager/1.5-beoordeling-verwerken.rst b/backend/docs/manual/1-record-manager/1.5-beoordeling-verwerken.rst new file mode 100644 index 000000000..0c51255c9 --- /dev/null +++ b/backend/docs/manual/1-record-manager/1.5-beoordeling-verwerken.rst @@ -0,0 +1,92 @@ +.. _manual_1-record-manager_1.5-beoordeling-verwerken: + +===================== +Beoordeling verwerken +===================== + +.. figure:: ../_assets/pages/beoordeling-verwerken.png + :align: center + :alt: Beoordeling verwerken schermafbeelding + +Deze handleiding beschrijft de stappen die een **record manager** kan volgen om een vernietigingslijst te verwerken na +een beoordeling door een **beoordelaar**. Het proces kan onder meer het aanpassen van de selectielijstklasse of het +verlengen van de bewaartermijn omvatten. + +Deze handleiding gaat ervan uit dat de record manager al een beoordeling heeft ontvangen en de lijst moet aanpassen +voordat deze opnieuw kan worden ingediend voor beoordeling. + +Voorwaarden +------------ +- De record manager moet beschikken over een actieve gebruikersaccount met de juiste toegangsrechten. +- Er moet een bestaande vernietigingslijst zijn met de status **"Wijzigingen aangevraagd"**. +- Een beoordelaar moet al een beoordeling hebben uitgevoerd en de lijst moet de beslissing **"Afgewezen"** bevatten. +- De lijst moet zaken bevatten die aangepast moeten worden. + +Stappen +------- + +1. **Inloggen als record manager** + - Open de applicatie en log in met je gebruikersnaam en wachtwoord. + - Na succesvol inloggen, word je automatisch doorgestuurd naar het overzicht van bestaande vernietigingslijsten. + +2. **Open de vernietigingslijst** + - Zoek de vernietigingslijst die je wilt verwerken. Bijvoorbeeld **"Mijn eerste vernietigingslijst"**. + - Klik op de naam van de lijst om de details van de lijst te openen. + +3. **Beoordeel de wijzigingen** + - Je wordt doorgestuurd naar de pagina waar je de beoordeling kunt verwerken. + - Klik op de knop **"Muteren"** om wijzigingen aan te brengen. |muteren_knop| + +4. **Selectielijstklasse aanpassen** + - Indien nodig, selecteer je de optie **"Aanpassen van selectielijstklasse"**. + - Vul het veld **"Selectielijstklasse"** in, bijvoorbeeld **"11.1 - Verleend - vernietigen - P1Y"**. + +5. **Bewaartermijn verlengen** + - Kies de optie **"Verlengen bewaartermijn"**. + - Vul de gewenste **"Dag van de maand"** in (bijvoorbeeld **09/15/2023**). + +6. **Afwijzen van het voorstel** + - Kies de optie **"Afwijzen van het voorstel"** om zaak niet te muteren en (en opnieuw aan te bieden aan de + beoordelaar). + +.. figure:: ../_assets/muteren-formulier.png + :align: center + :alt: muteren formulier + :height: 523px + + Zaak mutatie formulier met keuzes **"Aanpassen van selectielijstklasse"**, **"Verlengen bewaartermijn"** en + **"Afwijzen van het voorstel"**. + +7. **Opmerking toevoegen en opnieuw indienen** + - Vul de reden voor de wijziging in. + - Klik op de knop **"Muteren"** om de wijziging door te voeren. + - Klik daarna op **"Opnieuw indienen"** om de gewijzigde lijst in te dienen. |opnieuw_indienen_knop| + - Voeg een opmerking toe, bijvoorbeeld **"Datum aangepast"**, en klik op **"Opnieuw indienen"** in het vervolgscherm. + + |opnieuw_indienen_formulier| + +8. **Controleer de status** + - Nadat je de wijzigingen hebt ingediend, wordt je teruggeleid naar het overzicht van de vernietigingslijsten. + - De status van de lijst wordt bijgewerkt naar **"Klaar voor beoordeling"**. + +Let op +------ +- Zorg ervoor dat je de selectielijstklasse correct aanpast als dat nodig is. +- Vergeet niet een reden voor de wijziging in te vullen en de lijst opnieuw in te dienen. +- 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`. De beoordelaar kan de lijst goedkeuren +of verdere wijzigingen aanvragen. + +.. |muteren_knop| image:: ../_assets/muteren-knop.png + :alt: muteren knop + :height: 26px + +.. |opnieuw_indienen_knop| image:: ../_assets/opnieuw-indienen-knop.png + :alt: opnieuw indienen knop + :height: 26px + +.. |opnieuw_indienen_formulier| image:: ../_assets/opnieuw-indienen-formulier.png + :alt: opnieuw indienen knop + :height: 182px \ No newline at end of file diff --git a/backend/docs/manual/1-record-manager/1.6-vernietigingslijst-klaarzetten-voor-archivaris.rst b/backend/docs/manual/1-record-manager/1.6-vernietigingslijst-klaarzetten-voor-archivaris.rst new file mode 100644 index 000000000..655d8211f --- /dev/null +++ b/backend/docs/manual/1-record-manager/1.6-vernietigingslijst-klaarzetten-voor-archivaris.rst @@ -0,0 +1,67 @@ +.. _manual_1-record-manager_1.6-vernietigingslijst-klaarzetten-voor-archivaris: + +======================================================================== +Vernietigingslijst klaarzetten voor archivaris (als definitief markeren) +======================================================================== + +.. figure:: ../_assets/pages/vernietigingslijst-klaarzetten-voor-archivaris.png + :align: center + :alt: Vernietigingslijst klaarzetten voor archivaris schermafbeelding + +Deze handleiding beschrijft de stappen die een **record manager** kan volgen om een vernietigingslijst als definitief te +markeren nadat de lijst is beoordeeld door een **beoordelaar**. Het proces bevat het toevoegen van een archivaris en een +opmerking voordat de lijst als definitief wordt gemarkeerd. + +Voorwaarden +------------ +- De record manager moet beschikken over een actieve gebruikersaccount met de juiste toegangsrechten. +- Er moet een bestaande vernietigingslijst zijn met de status **"Intern beoordeeld"**. +- Een beoordelaar moet een beoordeling hebben uitgevoerd en de lijst moet de beslissing **"Geaccepteerd"** bevatten. +- De lijst moet de goedkeuring van de record manager ontvangen voordat deze naar de archivaris kan worden gestuurd. + +Stappen +------- + +1. **Inloggen als record manager** + - Open de applicatie en log in met je gebruikersnaam en wachtwoord. + - Na succesvol inloggen, word je automatisch doorgestuurd naar het overzicht van bestaande vernietigingslijsten. + +2. **Open de vernietigingslijst** + - Zoek de vernietigingslijst die je wilt markeren als definitief. Bijvoorbeeld **"Mijn eerste vernietigingslijst"**. + - Klik op de naam van de lijst om de details van de lijst te openen. + +3. **Markeer de lijst als definitief** + - Klik op de knop **"Markeren als definitief"** om de lijst als definitief te markeren. |markeren_als_definitief_knop| + - Vul het veld **"Archivaris"** in door de naam van de archivaris te selecteren. + - Vul het veld **"Opmerking"** in. + +.. figure:: ../_assets/markeren-als-definitief-formulier.png + :align: center + :alt: markeren als definitief formulier + :height: 264px + + Formulier voor het markeren van de lijst als definitief met velden voor **"Archivaris"** en **"Opmerking"**. + +4. **Definitief markeren** + - Klik op de knop **"Markeer als definitief"** om de lijst definitief te markeren. + - De lijst zal nu de status **"Klaar voor archivaris"** krijgen en is gereed voor verdere verwerking door de archivaris. + +5. **Controleer de status** + - Nadat je de lijst als definitief hebt gemarkeerd, wordt je teruggeleid naar het overzicht van de vernietigingslijsten. + - De status van de lijst wordt bijgewerkt naar **"Klaar voor archivaris"**. + +Let op +------ +- Zorg ervoor dat je het juiste **"Archivaris"** selecteert voordat je de lijst markeert als definitief. +- 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` 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`. Indien de lijst wordt afgekeurd, zal de status +worden bijgewerkt naar **"Wijzigingen aangevraagd"**. + +.. |markeren_als_definitief_knop| image:: ../_assets/markeren-als-definitief-knop.png + :alt: markeren als definitief knop + :height: 26px diff --git a/backend/docs/manual/1-record-manager/1.7-vernietigingslijst-vernietigen.rst b/backend/docs/manual/1-record-manager/1.7-vernietigingslijst-vernietigen.rst new file mode 100644 index 000000000..f263f1e4d --- /dev/null +++ b/backend/docs/manual/1-record-manager/1.7-vernietigingslijst-vernietigen.rst @@ -0,0 +1,69 @@ +.. _manual_1-record-manager_1.7-vernietigingslijst-vernietigen: + +============================== +Vernietigingslijst vernietigen +============================== + +.. figure:: ../_assets/pages/vernietigingslijst-vernietigen.png + :align: center + :alt: Vernietigingslijst opstellen schermafbeelding + +Deze handleiding beschrijft de stappen die een **record manager** kan volgen om een vernietigingslijst te vernietigen +wanneer de lijst de status **"Klaar voor vernietigen"** heeft. Het proces omvat de bevestiging van de lijst en het +starten van de vernietiging van de geselecteerde zaken. + +Voorwaarden +------------ +- De record manager moet beschikken over een actieve gebruikersaccount met de juiste toegangsrechten. +- Er moet een bestaande vernietigingslijst zijn met de status **"Klaar voor vernietigen"**. +- De archiveringsdatum van de zaken in de lijst moet zijn verstreken. + +Stappen +------- + +1. **Inloggen als record manager** + - Open de applicatie en log in met je gebruikersnaam en wachtwoord. + - Na succesvol inloggen, word je automatisch doorgestuurd naar het overzicht van bestaande vernietigingslijsten. + +2. **Open de vernietigingslijst** + - Zoek de vernietigingslijst die je wilt vernietigen, bijvoorbeeld **"Mijn eerste vernietigingslijst"**. + - Klik op de naam van de lijst om de details van de lijst te openen. + +3. **Start de vernietiging** + - Klik op de knop **"Vernietigen starten"** om het vernietigingsproces te starten. |vernietigen_starten_knop| + - Vul het veld **"Type naam van de lijst ter bevestiging"** in met de naam van de lijst om te bevestigen dat je de lijst + wilt vernietigen. + + |vernietigen_starten_formulier| + +4. **Bevestig de vernietiging** + - Klik op de knop **"Zaken vernietigen"** om de geselecteerde zaken te vernietigen. + - Er zal een **bedenktijd van 7 dagen** worden ingelast waarna de vernietiging wordt uitgevoerd. + - De lijst wordt gemarkeerd als **"Vernietigd"** en de geselecteerde zaken zullen definitief worden verwijderd uit het + gekoppelde zaaksysteem. + - Het is mogelijk de vernietiging te annuleren binnen de bedenktijd, gebruik hiervoor de knop + **"Vernietigen annuleren"**, dit zet de status van de lijst terug naar **"Nieuw"** (zie ook + :ref:`(Beoordelings)proces afbreken`). + +5. **Controleer de status** + - Nadat je de vernietiging hebt gestart, wordt je teruggeleid naar het overzicht van de vernietigingslijsten. + - De status van de lijst wordt bijgewerkt naar **"Vernietigd"** zodra de zaken succesvol zijn vernietigd. + +Let op +------ +- Zorg ervoor dat je de juiste lijst selecteert en de naam correct typt ter bevestiging voordat je de vernietiging start. +- Het proces van vernietigen kan niet ongedaan worden gemaakt, dus wees er zeker van dat je de juiste lijst kiest. +- De lijst zal worden gemarkeerd als **"Vernietigd"** zodra de zaken zijn verwijderd. + +Na het vernietigen van de lijst worden de geselecteerde zaken permanent verwijderd. Het proces kan afhankelijk van het +systeem verder geautomatiseerd zijn. Na het vernietigen van de lijst kan de record manager een samenvatting downloaden +met gegevens van de vernietigde zaken. + +.. |vernietigen_starten_knop| image:: ../_assets/vernietigen-starten-knop.png + :alt: vernietigen starten knop + :height: 26px + + +.. |vernietigen_starten_formulier| image:: ../_assets/vernietigen-starten-formulier.png + :alt: vernietigen starten formulier + :height: 214px diff --git a/backend/docs/manual/1-record-manager/index.rst b/backend/docs/manual/1-record-manager/index.rst new file mode 100644 index 000000000..d6f0a88b1 --- /dev/null +++ b/backend/docs/manual/1-record-manager/index.rst @@ -0,0 +1,17 @@ +.. _manual_1-record-manager_index: + +============== +Record manager +============== + +.. toctree:: + :maxdepth: 1 + :caption: Inhoudsopgave + + 1.1-vernietigingslijst-opstellen + 1.2-vernietigingslijst-bewerken + 1.3-vernietigingslijst-klaarzetten-voor-beoordeling + 1.4-beoordelingsproces-afbreken + 1.5-beoordeling-verwerken + 1.6-vernietigingslijst-klaarzetten-voor-archivaris + 1.7-vernietigingslijst-vernietigen diff --git a/backend/docs/manual/2-reviewer-archivaris/2.1-vernietigingslijst-beoordelen.rst b/backend/docs/manual/2-reviewer-archivaris/2.1-vernietigingslijst-beoordelen.rst new file mode 100644 index 000000000..06cf960c1 --- /dev/null +++ b/backend/docs/manual/2-reviewer-archivaris/2.1-vernietigingslijst-beoordelen.rst @@ -0,0 +1,95 @@ +.. _manual_2-reviewer-archivaris_2.1-vernietigingslijst-beoordelen: + +============================= +Vernietigingslijst beoordelen +============================= + +.. figure:: ../_assets/pages/vernietigingslijst-beoordelen.png + :align: center + :alt: Vernietigingslijst beoordelen schermafbeelding + +Deze handleiding beschrijft de stappen die een **beoordelaar** of **archivaris** kan volgen om een vernietigingslijst te +beoordelen binnen de applicatie. + +Voorwaarden +------------ +- De beoordelaar of archivaris moet beschikken over een actieve gebruikersaccount met de juiste toegangsrechten. +- De vernietigingslijst moet de status **"Klaar voor beoordeling"** hebben. + +Stappen +------- + +1. **Inloggen als beoordelaar of archivaris** + - Open de applicatie en log in met je gebruikersnaam en wachtwoord. + - Na succesvol inloggen, word je automatisch doorgestuurd naar het overzicht van bestaande vernietigingslijsten. + +2. **Open de vernietigingslijst** + - Zoek de vernietigingslijst die je wilt beoordelen. Bijvoorbeeld **"Mijn eerste vernietigingslijst"**. + - Klik op de naam van de lijst om de details van de lijst te openen. + +3. **Beoordeel de vernietigingslijst** + - Bekijk de zaken in de lijst en controleer of alles voldoet aan de beoordelingscriteria, markeer zaken optioneel + als accoord door op **"Accorderen"** te klikken. |accorderen| + - Als alles correct is, klik op de knop **"Goedkeuren"** om de lijst goed te keuren. |goedkeuren_knop| + - Vul een opmerking in indien nodig en bevestig de goedkeuring door op **"Vernietigingslijst goedkeuren"** te klikken. + + |goedkeuren_formulier| + +4. **Afwijzen van de lijst** + - Als er zaken zijn die niet voldoen, klik dan op de knop **"Uitzonderen"** voor de desbetreffende zaak(en). |uitzonderen_knop| + - Vul een reden in voor de afwijzing en klik op **"Zaak uitzonderen"**. + + |uitzonderen_formulier| + + - Klik op **"Afwijzen"** om de lijst af te wijzen. |afwijzen_knop| + - Vul een opmerking in indien nodig en bevestig de afwijzing door op **"Vernietigingslijst afwijzen"** te klikken. + + |afwijzen_formulier| + + - De status van de lijst wordt bijgewerkt naar **"Wijzigingen aangevraagd"**. + +5. **Controleer de status** + - Nadat je de lijst hebt goedgekeurd of afgewezen, wordt de status van de lijst bijgewerkt. + - **"Intern beoordeeld"** bij goedkeuring door de beoordelaar. + - **"Wijzigingen aangevraagd"** bij afwijzing door de beoordelaar. + +Let op +------ +- Ongeselecteerde zaken (niet geaccordeerd/uitgezonderd) worden automatisch goedgekeurd bij het goedkeuren van de lijst. +- Na goedkeuring door de beoordelaar moet de lijst door de archivaris worden beoordeeld. +- Als er gebruik gemaakt wordt van mede-beoordelen kunnen er accorderingen/uitzonderingen van de mede-beoordelaar(s) + zichtbaar worden. +- Alleen de hoofdbeoordelaar kan de lijst goedkeuren of afwijzen. + +Na goedkeuring kan de lijst worden doorgestuurd naar de archivaris voor de laatste goedkeuring. Als de lijst wordt +afgekeurd, moet de record manager de aangevraagde wijzigingen +:ref:`verwerken` voordat de lijst opnieuw kan worden +:ref:`ingediend`. + +.. |accorderen| image:: ../_assets/accorderen.png + :alt: accorderen knop + :height: 26px + +.. |goedkeuren_knop| image:: ../_assets/goedkeuren-knop.png + :alt: lijst goedkeuren knop + :height: 26px + +.. |goedkeuren_formulier| image:: ../_assets/goedkeuren-formulier.png + :alt: lijst goedkeuren formulier + :height: 238px + +.. |uitzonderen_knop| image:: ../_assets/uitzonderen-knop.png + :alt: uitzonderen knop + :height: 26px + +.. |uitzonderen_formulier| image:: ../_assets/uitzonderen-formulier.png + :alt: uitzonderen formulier + :height: 182px + +.. |afwijzen_knop| image:: ../_assets/afwijzen-knop.png + :alt: lijst afwijzen knop + :height: 26px + +.. |afwijzen_formulier| image:: ../_assets/afwijzen-formulier.png + :alt: lijst afwijzen formulier + :height: 182px \ No newline at end of file diff --git a/backend/docs/manual/2-reviewer-archivaris/2.2-medebeoordelaars-toewijzen.rst b/backend/docs/manual/2-reviewer-archivaris/2.2-medebeoordelaars-toewijzen.rst new file mode 100644 index 000000000..f8ee81cd4 --- /dev/null +++ b/backend/docs/manual/2-reviewer-archivaris/2.2-medebeoordelaars-toewijzen.rst @@ -0,0 +1,53 @@ +.. _manual_2-reviewer-archivaris_2.2-medebeoordelaars-toewijzen: + + +========================== +Medebeoordelaars toewijzen +========================== + +Deze handleiding beschrijft de stappen voor het toewijzen van **medebeoordelaars** en hoe zij kunnen samenwerken aan de +beoordeling van een vernietigingslijst binnen de applicatie. + +Voorwaarden +------------ +- De hoofdbeoordelaar moet beschikken over een actieve gebruikersaccount met de juiste toegangsrechten. +- De vernietigingslijst moet al klaarstaan voor beoordeling. +- Medebeoordelaars moeten bestaan om toegewezen te worden aan de vernietigingslijst. + +Stappen +------- + +1. **Inloggen als hoofdbeoordelaar** + - Open de applicatie en log in met je gebruikersnaam en wachtwoord. + - Je wordt automatisch doorgestuurd naar het overzicht van bestaande vernietigingslijsten. + +2. **Open de vernietigingslijst** + - Zoek de vernietigingslijst waarvoor je medebeoordelaars wilt toewijzen. Bijvoorbeeld **“Mijn eerste vernietigingslijst”**. + - Klik op de naam van de lijst om de details te openen. + +3. **Medebeoordelaars toewijzen** + - Klik op de knop **"Beoordelaar bewerken"**. |beoordelaars_bewerken_knop| + - Selecteer de gewenste medebeoordelaars. + - Vul de reden voor de toewijzing in. + - Klik op **"Toewijzen"** om de medebeoordelaars definitief toe te wijzen. + +.. figure:: ../_assets/beoordelaars-bewerken-formulier.png + :align: center + :alt: beoordelaars bewerken formulier + :height: 592px + +4. **Controleer de status** + - 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`. Beoordelingen van alle +(mede)beoordelaars zijn zichtbaar voor alle andere beoordelaars. Alleen de hoofdbeoordelaar kan de lijst goedkeuren of +afwijzen. + +.. |beoordelaars_bewerken_knop| image:: ../_assets/beoordelaars-bewerken-knop.png + :alt: beoordelaars bewerken knop + :height: 22px + +.. |beoordelaars_bewerken_formulier| image:: ../_assets/beoordelaars-bewerken-formulier.png + :alt: beoordelaars bewerken formulier + :height: 592px diff --git a/backend/docs/manual/2-reviewer-archivaris/index.rst b/backend/docs/manual/2-reviewer-archivaris/index.rst new file mode 100644 index 000000000..01da9466a --- /dev/null +++ b/backend/docs/manual/2-reviewer-archivaris/index.rst @@ -0,0 +1,12 @@ +.. _manual_2-reviewer-archivaris_index: + +=================== +Reviewer/Archivaris +=================== + +.. toctree:: + :maxdepth: 1 + :caption: Inhoudsopgave + + 2.1-vernietigingslijst-beoordelen + 2.2-medebeoordelaars-toewijzen diff --git a/backend/docs/manual/index.rst b/backend/docs/manual/index.rst new file mode 100644 index 000000000..252ab89e7 --- /dev/null +++ b/backend/docs/manual/index.rst @@ -0,0 +1,15 @@ +.. _manual_index: + +===================== +Gebruikershandleiding +===================== + +Deze handleiding is bedoeld voor de gebruikers van het systeem. Hierin wordt uitgelegd hoe per rol de verschillende +taken kunnen worden uitgevoerd. + +.. toctree:: + :maxdepth: 2 + :caption: Inhoudsopgave + + 1-record-manager/index + 2-reviewer-archivaris/index \ No newline at end of file