🚧 - docs

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,

backend/docs/index.rst

@@ -15,3 +15,4 @@ Documentation
 
     configure/index
     developers/index
+    manual/index

backend/docs/manual/1-record-manager/1.1-vernietigingslijst-opstellen.rst

@@ -0,0 +1,79 @@
+.. _manual_1-record-manager_1.1-vernietigingslijst-opstellen:
+
+============================
+Vernietigingslijst opstellen
+============================
+
+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.
+
+|vernietigingslijst_opstellen_formulier|
+
+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<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>`.
+
+
+.. |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

backend/docs/manual/1-record-manager/1.2-vernietigingslijst-bewerken.rst

@@ -0,0 +1,79 @@
+.. _manual_1-record-manager_1.2-vernietigingslijst-bewerken:
+
+===========================
+Vernietigingslijst bewerken
+===========================
+
+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<manual_1-record-manager_1.3-vernietigingslijst-klaarzetten-voor-beoordeling>`.
+
+.. |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