Broninventaris overige markdownbestanden
Doel
Deze inventaris beschrijft de duurzame markdown- en MDX-bronnen die naast de usecases en schermdocumentatie relevant zijn voor het Functioneel Ontwerp.
Het register is bedoeld voor traceerbaarheid. Het vervangt geen broninhoud en dupliceert geen volledige database-, ontwerp-, architectuur-, mockup- of modulebeschrijvingen.
Dit register gebruikt duurzame broncategorieën. Tijdelijke zipnamen, ruwe consolidatiedocumenten, conversiebestanden of overdrachtsbestanden worden niet als blijvende FO-bron opgenomen.
Scope van dit register
| Categorie | In dit register? | Toelichting |
|---|---|---|
| Database-informatie | Ja | Brondata, persistente grenzen, history en readmodels. |
| Ontwerpbronnen | Ja | Autorisatiematrix, business rules, statusmodellen, popupregisters, commands en events. |
| Architectuur | Ja | Functionele interpretatie van systeemgrens, containers en componenten. |
| Oefenmodule-documentatie | Ja | Modulecontract, modulepayloads en modulespecifieke presentatie-/exportregels. |
| Mockups HTML | Ja | Visuele referentie en layoutinterpretatie; geen definitieve datawaarden. |
| Style-documenten | Ja, beperkt | Documentatiestijl; niet functioneel normatief. |
| FO-bronnen en registers | Ja, beperkt | Ondersteunende FO-bronnen en traceerbaarheidsregisters. |
| Usecases | Nee | Worden beheerd in FO-usecase-index. |
| Schermdocumentatie | Nee | Wordt beheerd in FO-schermindex. |
| FO-hoofdstukken | Nee | Zijn doeldocumentatie binnen het FO, geen overige broninventaris. |
Bronpositie en interpretatie
| Bronsoort | Bronpositie |
|---|---|
| Usecases | Leidend voor procesflows, actoren, triggers, precondities, mutaties en acceptatiegedrag. |
| Database-informatie | Leidend voor brondata, persistente records, relaties, history, audit, readmodels en technische datagrenzen. |
| Ontwerpbronnen | Leidend voor autorisatie, business rules, popupkeys, statusmodellen, commands, events en domeinobjectterminologie. |
| Schermdocumentatie | Leidend voor zichtbare schermonderdelen, velden, acties, lege toestanden en waardelagen. |
| Mockups HTML | Ondersteunen visuele interpretatie, responsiviteit en layoutcontrole, maar zijn geen bron van definitieve datawaarden. |
| Oefenmodule-documentatie | Leidend voor modulespecifieke configuratie, vraagpresentatie, antwoordcontrole en payloadschema’s. |
| Architectuurdocumentatie | Ondersteunt de functionele systeemgrens, containergrens en componentverantwoordelijkheden. |
| Style-documenten | Ondersteunen documentatieconsistentie en zijn niet inhoudelijk normatief voor applicatiegedrag. |
Onderhoudsregels
- Voeg alleen duurzame documenten toe die onderdeel blijven van de documentatieset.
- Verwijs naar bronnen met relatieve Docusaurus-routelinks zonder bestandsextensie, zodat
.md/.mdx-verschillen geen buildfouten veroorzaken. - Neem usecases en schermdocumentatie niet opnieuw als rij op wanneer zij al in hun eigen register staan.
- Gebruik mockups als visuele referentie, niet als definitieve bron voor tellingen, waardelijsten, autorisatie of databasevelden.
- Gebruik database-informatie niet om technische DDL in het FO te dupliceren; beschrijf alleen functionele consequenties.
- Wanneer een bron tijdelijk, verouderd of vervangen is, neem die niet op als blijvende bronverwijzing.
- Wanneer een bron een open punt of nog uit te werken domein bevat, markeer dit als bronstatus en behandel het niet als afgeronde functionele waarheid.
Samenvatting per broncategorie
| Categorie | Aantal | Betekenis |
|---|---|---|
| Database-informatie | 10 | Brondata, history, audit, readmodels en persistente grenzen. |
| Ontwerpbronnen | 10 | Autorisatie, business rules, statusmodellen, popups, commands, events en domeinobjecten. |
| Architectuur | 7 | Systeemcontext, containergrens, componenten en bouwblokken. |
| Oefenmodule-documentatie | 3 | Modulecontract en modulespecifieke payload-/presentatieregels. |
| Mockups HTML | 60 | Visuele interpretatie per rol/context, inclusief modulemockups. |
| Style-documenten | 4 | Documentatiestijl en schrijfconventies. |
| FO-ondersteunende documenten/registers | 6 | Intro, bronnen en traceerbaarheidsregisters. |
Database-informatie
| Bron | Betekenis | Primaire FO-koppeling | Notitie |
|---|---|---|---|
| Database-informatie intro | Overzicht van database-informatie. | FO-00, FO-23 | Bronpositie voor datalagen. |
| 01 — Identiteit en autorisatie | Users, rollen, accountstatus, profiel- en autorisatiebasis. | FO-02, FO-05, FO-12 | Leidend voor brondata; FO blijft functioneel. |
| 02 — Relatiebeheer | Relaties, uitnodigingen, events en relatie-afhankelijke toegang. | FO-06, FO-09, FO-11 | Leidend voor relatiebrondata. |
| 03 — Docentstructuur en leerlingtoegang | Niveaus, categorieën, oefeningen, collaborators en leerlingautorisaties. | FO-07, FO-10 | Leidend voor catalogus- en docentstructuur. |
| 04 — Communicatie en notificaties | Systeemberichten, privéberichten, threaddeelnemers, notificaties. | FO-13, FO-17 | Leidend voor communicatiedata. |
| 05 — Configuratie en contentbeheer | Contentblokken, footer, popups, templates, features en instellingen. | FO-16, FO-17 | Leidend voor beheerbare configuratie. |
| 06 — Ticket- en meldingsbeheer | Tickets, assignments, discussion, closures, reopen requests. | FO-14, FO-12 | Leidend voor meldingendata. |
| 07 — Oefenruns, delen en voortgang | ExerciseRuns, voortgang, gedeelde oefeningen, live-view en payloads. | FO-08, FO-09, FO-15, FO-18, FO-22 | Leidend voor oefenrunbrondata. |
| 08 — Audit, historie en technische uitgangspunten | Audit, history en technische gegevensgrenzen. | FO-12, FO-23 | Ondersteunt history- en auditregels. |
| 09 — Nog uit te werken tabellen en domeinen | Nog niet definitief uitgewerkte datadomeinen. | FO-20 | Niet als afgeronde bron behandelen. |
Ontwerpbronnen
| Bron | Betekenis | Primaire FO-koppeling | Notitie |
|---|---|---|---|
| Ontwerpbronnen intro | Overzicht van ontwerpbronnen. | FO-00 | Bronpositie. |
| Autorisatiematrix | Rollen, contexten en toegestane acties. | FO-02 en alle domeinen | Leidend voor autorisatievragen. |
| Business rules | Overkoepelende functionele regels. | FO-19 en betrokken domeinen | Leidend bij business-ruleconflicten. |
| Command-register | Commandonamen en mutatie-ingangen. | FO-12, FO-14, FO-23 | Niet als UI-flow dupliceren. |
| Event-register | Gebeurtenissen en audit-/eventbegrippen. | FO-06, FO-13, FO-14, FO-23 | Leidend voor eventterminologie. |
| Domeinobjecten | Domeinobjecten en samenhang. | FO-23 en domeinhoofdstukken | Ondersteunt bron-van-waarheidregels. |
| Header, footer en navigatie | Applicatieschil, header, footer, badges en navigatie. | FO-03, FO-16 | Leidend voor shellgedrag. |
| Popup-register | Popupkeys, varianten en context. | FO-17 | Leidend voor popupteksten/keys. |
| Popup-themes | Herbruikbare popup-themes en presentatiegedrag. | FO-17 | Leidend voor popup-presentatiegrenzen. |
| Statusmodellen | Statuswaarden en statusovergangen. | FO-14 en betrokken domeinen | Leidend voor statusmodelconflicten. |
Architectuur
| Bron | Betekenis | Primaire FO-koppeling | Notitie |
|---|---|---|---|
| Architectuurintro | Overzicht van architectuurdocumentatie. | FO-23 | Oriëntatie; geen detail-TO. |
| C4 niveau 1 — System Context | Systeemgrens, actoren en externe systemen. | FO-01, FO-23 | Functioneel leidend voor systeemafbakening. |
| C4 niveau 2 — Container Diagram | Containergrens: webapp, database en externe systemen. | FO-23 | Functionele interpretatie, geen implementatiedetail. |
| C4 niveau 3 — Component Diagram | Logische componenten binnen de webapp. | FO-23 | Ondersteunt domein- en componentgrenzen. |
| C4 niveau 4 — Interne bouwblokken | Interne bouwblokken en samenhang. | FO-23 | Alleen gebruiken waar functionele consequenties bestaan. |
| C4-model intro | Introductie van C4-bronnen. | FO-23 | Ondersteunend. |
| Structurizr smoke test | Technische smoke-test/documentatiecontrole. | Geen primaire FO | Niet functioneel normatief. |
Oefenmodule-documentatie
| Bron | Betekenis | Primaire FO-koppeling | Notitie |
|---|---|---|---|
| Oefenmodules intro | Overzicht van oefenmodule-documentatie. | FO-22 | Modulebronpositie. |
| Moduleplatform en contract | Generieke platform- en contractcontext voor technische oefenmodules. | FO-21, FO-22 | Ondersteunend. |
| Optellen & Aftrekken (simpel) | Voorbeeldmodule met configuratie, payload, vraagtypes en schema. | FO-07, FO-08, FO-22 | Leidend voorbeeld voor modulecontract en payloadvelden. |
Mockups HTML
Mockups ondersteunen visuele interpretatie. Zij zijn niet leidend voor definitieve datawaarden, autorisatie, statusmodellen, brondata, tellingen of procesflows.
Wanneer mockups afwijken van usecases, database-informatie, ontwerpbronnen of schermdocumentatie, geldt de duurzame bronhiërarchie uit Bronnen en afbakening.
Beheerder
| Mockupbron | Primaire FO-koppeling | Bronpositie |
|---|---|---|
| Intro | FO-12 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_beheerder_01_frontpage_V1_6.html | FO-04, FO-12 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_beheerder_02_meldingen_overzicht_v1_6.html | FO-12, FO-14 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_beheerder_03_accounts_V1_2.html | FO-05, FO-12 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_beheerder_04_systeeminstellingen_v2_3.html | FO-12, FO-17 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_beheerder_05_sys_01_frontpage_V1_9.html | FO-04, FO-16 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_beheerder_06_sys_02_popups_V1_2.html | FO-17 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_beheerder_07_sys_03_systeemberichten_V1_4.html | FO-13, FO-17 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_beheerder_08_sys_04_handige_links_paginas_V1_13.html | FO-16 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_beheerder_09_sys_05_features_V1_3.html | FO-17 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_beheerder_11_categorieen_V1_10.html | FO-07, FO-12 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_beheerder_12_modules_V1_4.html | FO-12, FO-22 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_beheerder_13_docent_ondersteuning_V1_9.html | FO-10, FO-12 | Visuele referentie; geen zelfstandige functionele bron. |
Docent
| Mockupbron | Primaire FO-koppeling | Bronpositie |
|---|---|---|
| Intro | FO-10 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_docent_01_frontpage_v1_10.html | FO-04, FO-10 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_docent_02_niveaus_en_categorieen_v1_10.html | FO-07, FO-10 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_docent_02B_niveau_categorie_modals_v1_11.html | FO-07, FO-10 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_docent_03_nieuwe_oefening_v1_22.html | FO-07, FO-10, FO-22 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_docent_04_leerlingen_v1_9.html | FO-10 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_docent_05_bekijk_geschiedenis_v1_13.html | FO-10, FO-18 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_docent_06_online_overzicht_v2_16.html | FO-10, FO-15 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_docent_07_meekijken_v1_14.html | FO-15 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_docent_08_autoriseer_leerling_v1_7.html | FO-10 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_docent_09_autoriseer_niveau_v1_14.html | FO-10 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_docent_10_collaborator_v1_8.html | FO-10 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_docent_11_eigenaarschap_overdragen_v1_13.html | FO-10 | Visuele referentie; geen zelfstandige functionele bron. |
Generiek
| Mockupbron | Primaire FO-koppeling | Bronpositie |
|---|---|---|
| Intro | FO-05, FO-06, FO-13, FO-14, FO-16 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_generiek_01_berichten_overzicht_v3_3.html | FO-13 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_generiek_02_nieuw_privebericht_v2_4.html | FO-13 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_generiek_03_open_bericht_v3_5.html | FO-13 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_generiek_04_beantwoord_bericht_v2_6.html | FO-13 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_generiek_05_meldingen_v1_12.html | FO-14 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_generiek_05b_melding_details_v1_7.html | FO-14 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_generiek_06_relaties_v1_8.html | FO-06 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_generiek_07_toegankelijk_v1_4.html | FO-05 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_generiek_08_voorkeuren_v1_3.html | FO-05 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_generiek_09_profiel_v1_3.html | FO-05 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_generiek_10_over_oefenhub_V1_8.html | FO-16 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_generiek_11_privacybeleid_V1_6.html | FO-16 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_generiek_12_contact_V1_5.html | FO-16 | Visuele referentie; geen zelfstandige functionele bron. |
Leerling
| Mockupbron | Primaire FO-koppeling | Bronpositie |
|---|---|---|
| Intro | FO-04, FO-08 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_leerling_01_frontpage_v6_3.html | FO-04, FO-08 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_leerling_02_frontpage_geen_docent_v7_5.html | FO-04, FO-08 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_leerling_03_oefening_v3_2.html | FO-08 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_leerling_04_start_nieuwe_v4_3.html | FO-08 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_leerling_05_geschiedenis_overzicht_v1_3.html | FO-08, FO-18 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_leerling_06_geschiedenis_details_v2_1.html | FO-08, FO-18 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_leerling_07_geschiedenis_alles_v1_5.html | FO-08 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_leerling_08_gedeelde_oefening_overzicht_v1_4.html | FO-09 | Visuele referentie; geen zelfstandige functionele bron. |
Modules
| Mockupbron | Primaire FO-koppeling | Bronpositie |
|---|---|---|
| Intro | FO-22 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_docent_module_optellen_en_aftrekken_simpel_v1_23.html | FO-22 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_leerling_module_optellen_en_aftrekken_simpel_v4_1.html | FO-08, FO-22 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_leerling_module_optellen_en_aftrekken_simpel_goed_v1_1.html | FO-08, FO-22 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_leerling_module_optellen_en_aftrekken_simpel_fout_v1_4.html | FO-08, FO-22 | Visuele referentie; geen zelfstandige functionele bron. |
Ouder/voogd
| Mockupbron | Primaire FO-koppeling | Bronpositie |
|---|---|---|
| Intro | FO-11 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_ouders_01_frontpage_V1_3.html | FO-04, FO-11 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_ouders_02_kinderen_V1_4.html | FO-11 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_ouders_03_online_overzicht_V1_4.html | FO-11, FO-15 | Visuele referentie; geen zelfstandige functionele bron. |
| oefenhub_ouders&docent_04_frontpage_V1_9.html | FO-04, FO-11 | Visuele referentie; geen zelfstandige functionele bron. |
Style-documenten
| Bron | Betekenis | Primaire FO-koppeling | Notitie |
|---|---|---|---|
| Style — generiek | Algemene documentatiestijl. | Geen primaire FO | Vormgevings-/documentatiestijl, niet functioneel normatief. |
| Style — architectuur | Architectuurdocumentatiestijl. | Geen primaire FO | Ondersteunend. |
| Style — database-informatie | Database-informatie stijl. | Geen primaire FO | Ondersteunend. |
| Style — schermdocumentatie beheerder | Schermdocumentatiestijl voor beheerder. | Geen primaire FO | Ondersteunend. |
FO-ondersteunende documenten en registers
| Document | Betekenis | Primaire koppeling | Notitie |
|---|---|---|---|
| Functioneel ontwerp intro | FO-status, versiepositie en hoofdstukoverzicht. | FO-overkoepelend | Versie-informatie staat alleen hier. |
| Bronnenoverzicht | Overzicht van FO-bronnen. | FO-00 | Duurzaam bronnenoverzicht zonder tijdelijke bronverwijzingen. |
| Extractie-notities | Duurzame extractieregels en reviewaanpak. | FO-00 | Gebruik als werkwijze, niet als inhoudelijke bron. |
| FO-usecase-index | Traceerbaarheid van usecases naar FO-hoofdstukken. | Registers | Geen broninhoud dupliceren. |
| FO-schermindex | Traceerbaarheid van schermdocumentatie naar FO-hoofdstukken. | Registers | Geen schermdetails dupliceren. |
| FO-broninventaris overige markdown | Deze inventaris. | Registers | Inventaris, geen bron van nieuw functioneel gedrag. |
Bronnen die bewust niet als overige markdownrij zijn opgenomen
| Bronsoort | Reden |
|---|---|
| Usecasebestanden | Worden apart beheerd in FO-usecase-index. |
| Schermdocumentatiebestanden | Worden apart beheerd in FO-schermindex. |
| FO-hoofdstukken | Zijn doeldocumentatie binnen het FO en worden niet als externe bron geïnventariseerd. |
| Tijdelijke ruwe documenten | Verdwenen of vervangbare werkinput heeft geen duurzame bronwaarde. |
| Conversie- of extractiebestanden | Alleen hulpmiddel tijdens documentgeneratie; geen blijvende functionele bron. |
| Zipnamen of exportpaden | Geen inhoudelijke bron; hoogstens historische werkinformatie. |
Kwaliteitscontrole
Bij onderhoud van deze inventaris moet minimaal worden gecontroleerd dat:
- alle links relatief, klikbaar en buildbaar zijn;
- tijdelijke bronnamen niet terugkeren als duurzame bron;
- usecases niet dubbel naast de usecase-index worden geïnventariseerd;
- schermdocumentatie niet dubbel naast de schermindex wordt geïnventariseerd;
- mockups duidelijk als visuele referentie zijn gemarkeerd;
- open of nog uit te werken bronnen niet als afgeronde functionele waarheid worden behandeld;
- nieuwe modulebronnen expliciet aan FO-22 en relevante oefenhoofdstukken worden gekoppeld;
- nieuwe database- of ontwerpbronnen aan de juiste FO-hoofdstukken worden gekoppeld.
Relatie tot andere FO-hoofdstukken
| Hoofdstuk/register | Relatie |
|---|---|
| Bronnen en afbakening | Bepaalt bronhiërarchie, DRY-principes, linkbeleid en conflictregels. |
| Productvisie en scope | Bepaalt productscope en niet-doelen. |
| Schermlaag en UX-specificaties | Verwijst naar schermdocumentatie als bron voor zichtbare schermdetails. |
| Functionele architectuurcontext | Interpreteert architectuurbronnen functioneel. |
| Open punten en buiten scope | Centraliseert nog open bron- en documentatiepunten. |
| FO-usecase-index | Beheert usecase-traceerbaarheid. |
| FO-schermindex | Beheert schermdocumentatie-traceerbaarheid. |
| Extractie-notities | Beschrijft de praktische extractie- en reviewregels. |