FO-schermindex
Doel
Deze index verbindt het Functioneel Ontwerp met de beschikbare tekstuele schermdocumentatie van OefenHub.
De index is bedoeld voor traceerbaarheid:
- welk schermdocument bestaat er;
- bij welke rol- of contextlaag hoort het scherm;
- welk FO-hoofdstuk gebruikt het scherm primair als schermbron;
- welke FO-hoofdstukken raken het scherm secundair;
- welke schermdocumenten zijn bron voor zichtbare UI, acties, lege toestanden en waardelagen;
- welke schermdocumentatiepunten nog bronhygiëne of afstemming nodig hebben.
De index vervangt geen schermdocumentatie. De schermdocumentatie blijft leidend voor schermspecifieke zichtbare onderdelen, acties, lege toestanden, waardelagen, mockupverwijzingen, element-ID's en schermtrace naar SRS en acceptatiecriteria.
Bronpositie
| Bronlaag | Betekenis binnen deze index |
|---|---|
| FO | Beschrijft functionele samenhang, domeingrenzen, rollen, autorisatie, lifecycle en bron-van-waarheidregels. |
| Schermdocumentatie | Beschrijft per view zichtbare UI, schermcontext, acties, velden, waardelagen, lege toestanden en schermrequirements. |
| Mockups HTML | Ondersteunen schermopbouw, interactiepatroon, layoutvarianten en voorbeeldwaarden. |
| PNG-screenshots | Ondersteunen visuele interpretatie, maar zijn geen zelfstandige functionele bron. |
| Usecases | Beschrijven procesflow en toegestane acties. |
| Database-informatie | Beschrijft brondata, readmodels, history, audit en persistente grenzen. |
| Ontwerpbronnen | Beschrijven domeinbrede regels, statusmodellen, autorisatiematrix, popupregister, command-register en event-register. |
Deze index bevat alleen tekstuele schermdocumentatiebestanden die als afzonderlijke views of schermhoofdstukken beschikbaar zijn.
Niet opgenomen als gewone schermrij
De volgende bronnen worden niet als gewone schermrij opgenomen:
- mapintroducties zonder eigen viewfunctie;
- algemene schermsjablonen;
- PNG-bestanden;
- HTML-mockups zonder bijbehorende tekstuele schermdocumentatie;
- FO-hoofdstukken;
- usecases;
- technische architectuurdocumentatie;
- tijdelijke werkbestanden of extractienotities.
De rolgebonden 01_schermen-*-bestanden worden in deze index wel benoemd in de onderhoudssectie, maar niet als gewone viewrij, omdat zij vooral overkoepelende werkafspraken en menu-/layoutcontext vastleggen.
Interpretatieregels
Voor deze index gelden de volgende regels.
- Een schermrij betekent dat er een tekstueel schermdocument bestaat, niet dat het scherm volledig of definitief geïmplementeerd is.
- Het schermdocument beschrijft de zichtbare view; FO-hoofdstukken blijven leidend voor functionele domeinregels.
- Een mockupversie is een bronverwijzing, geen applicatieversie.
- Voorbeeldwaarden in schermdocumentatie en mockups zijn dynamische voorbeelddata, tenzij een bron expliciet anders bepaalt.
- Zichtbare knoppen, menu-items, filters of routevoorbeelden zijn geen autorisatiebewijs.
- Iedere mutatie, detailweergave, export, liveactie of routeactie moet server-side opnieuw worden gecontroleerd.
- Wanneer schermdocumentatie en FO inhoudelijk verschillen, moet de bronhiërarchie uit Bronnen en afbakening worden toegepast.
- Deze index mag afwijkingen signaleren, maar verzint geen nieuwe scherm-ID's wanneer de onderliggende schermdocumentatie inconsistent is.
- Scherm-ID's volgen de vorm
SCH-<context>-<schermvolgnummer>-<variantvolgnummer>, bijvoorbeeldSCH-OVG-04-01.
Kolommen
| Kolom | Betekenis |
|---|---|
| Scherm-ID | Schermreferentie zoals vastgelegd in de schermdocumentatie. |
| Doelgroep / context | Primaire gebruikers- of beheercontext. |
| Schermnaam | Functionele naam van het scherm of de view. |
| Bronbestand | Relatieve link naar het tekstuele schermdocument. |
| Primair FO-hoofdstuk | Hoofdstuk dat het scherm primair functioneel gebruikt. |
| Secundaire FO-hoofdstukken | Andere FO-hoofdstukken die het scherm raken. |
| Indexnotitie | Korte traceerbaarheids- of bronhygiënenotitie. |
Samenvatting per schermcontext
| Context | Aantal geïndexeerde schermdocumenten | Primaire FO-focus |
|---|---|---|
| Beheerder | 12 | Beheerderfunctionaliteit, meldingen, contentbeheer, popups/templates/features, catalogus en modules. |
| Docent | 12 | Docentfunctionaliteit, oefencatalogus, leerlingautorisatie, resultaten, live meekijken en samenwerking. |
| Generiek | 13 | Berichten, meldingen, relaties, profiel/voorkeuren, contentbeheer en vaste publieke pagina's. |
| Leerling | 8 | Frontpage, oefenen, voortgang, resultaten, geschiedenis en gedeelde oefeningen. |
| Ouder/voogd | 4 | Ouder-/voogdfunctionaliteit, gecombineerde frontpage en online/live meekijken. |
| Totaal | 49 | Traceerbaarheid tussen FO en schermdocumentatie. |
Beheerder-schermen
Docent-schermen
Generieke schermen
Leerling-schermen
Ouder-/voogd-schermen
| Scherm-ID | Doelgroep / context | Schermnaam | Bronbestand | Primair FO-hoofdstuk | Secundaire FO-hoofdstukken | Indexnotitie |
|---|---|---|---|---|---|---|
| SCH-OVG-01-01 | Ouder/voogd | Frontpage — Ouder/voogd | schermdocumentatie/ouders/02_frontpage.md | 11 — Ouder-/voogdfunctionaliteit | 04 — Frontpages en overzichtsschermen | Read-only samenvatting van gekoppelde kinderen en resultaten. |
| SCH-OVG-02-01 | Gebruiker met actieve docentrol en actieve ouder-/voogdrol | Frontpage — Ouder/voogd en docent | schermdocumentatie/ouders/03_frontpage_ook_docent.md | 04 — Frontpages en overzichtsschermen | 10 — Docentfunctionaliteit, 11 — Ouder-/voogdfunctionaliteit | Gecombineerde frontpage; contexten blijven functioneel gescheiden. |
| SCH-OVG-04-01 | Ouder/voogd | Kinderen | schermdocumentatie/ouders/04_kinderen.md | 11 — Ouder-/voogdfunctionaliteit | 06 — Relatiebeheer, 18 — PDF-export en resultaatpresentatie | Kindselectie is tijdelijke UI-context; relatiecontrole blijft per vervolgactie vereist; onderliggende schermdocumentatie moet dit genormaliseerde scherm-ID gebruiken. |
| SCH-OVG-05-01 | Ouder/voogd | Online overzicht | schermdocumentatie/ouders/05_online.md | 15 — Live meekijken | 11 — Ouder-/voogdfunctionaliteit | Online/livebeschikbaarheid op basis van actieve ouder-/voogdrelatie en actuele runcontext. |
Overkoepelende schermdocumentatiebestanden
De onderstaande bestanden bevatten schermdocumentatie-afspraken, menucontext of mapcontext. Zij zijn belangrijk voor interpretatie, maar worden niet als afzonderlijke viewrij in de schermindex behandeld.
| Context | Bronbestand | Betekenis | Notitie |
|---|---|---|---|
| Algemeen | schermdocumentatie/intro.md | Sjabloon, legenda en algemene structuur voor schermdocumentatie. | Geen afzonderlijke viewrij. |
| Beheerder | schermdocumentatie/beheerder/01_schermen-beheerder.md | Overkoepelende beheerderafspraken. | Geen afzonderlijke beheerderview. |
| Docent | schermdocumentatie/docent/01_schermen-docent.md | Overkoepelende docentafspraken, menu-items en layoutcontext. | Geen afzonderlijke docentview. |
| Leerling | schermdocumentatie/leerling/intro.md | Leerlingmapintro en overzicht van leerlingdocumenten. | Geen afzonderlijke viewrij. |
| Ouder/voogd | schermdocumentatie/ouders/01_schermen-ouders_voogd.md | Overkoepelende ouder-/voogdafspraken. | Geen afzonderlijke viewrij. |
| Generiek | schermdocumentatie/generiek/01_schermen-generiek.md | Overkoepelende generieke schermafspraken, menu-items en footercontext. | Geen afzonderlijke viewrij. |
Onderhoudsregels
Bij wijziging van schermdocumentatie gelden de volgende onderhoudsregels.
- Nieuwe tekstuele schermdocumentatie krijgt alleen een indexrij wanneer het een concrete view of schermvariant is.
- Wijzigingen in zichtbare schermnaam, scherm-ID of bronbestand worden in deze index bijgewerkt.
- FO-hoofdstukkoppelingen worden bijgewerkt wanneer een scherm primair onder een ander functioneel domein gaat vallen.
- PNG- en HTML-bronnen worden niet los als schermrij opgenomen zonder tekstueel schermdocument.
- Duplicaten of afwijkende scherm-ID-vormen worden niet stilzwijgend opgelost in het register; zij worden alleen aangepast wanneer de onderliggende schermdocumentatie of een expliciete correctie de canonieke ID bevestigt.
- Verwijderde schermdocumenten worden uit de index verwijderd of als historisch/uitgefaseerd gemarkeerd wanneer behoud nodig is.
- Deze index blijft DRY: details over velden, knoppen, requirements, waardelagen en validaties blijven in het schermdocument zelf.
Relatie tot andere FO-registers
| Register | Relatie |
|---|---|
| FO-usecase-index | Verbindt usecases met FO-hoofdstukken; schermindex verbindt schermdocumentatie met FO-hoofdstukken. |
| FO-broninventaris overige markdown | Inventariseert overige markdownbronnen buiten usecases en schermdocumentatie. |
| Bronnenoverzicht | Beschrijft bronsets en bronpositie; moet later nog tijdelijke bronverwijzingen opschonen. |
| Extractie-notities | Beschrijft hoe bronnen duurzaam worden geëxtraheerd en verwerkt. |
Gerelateerde bronverwijzingen
| Bron | Link |
|---|---|
| Schermdocumentatie — intro | Schermdocumentatie |
| Schermdocumentatie — beheerder | Beheerder |
| Schermdocumentatie — docent | Docent |
| Schermdocumentatie — leerling | Leerling |
| Schermdocumentatie — ouder/voogd | Ouder/voogd |
| Schermdocumentatie — generiek | Generiek |
| FO — bronnen en afbakening | Bronnen en afbakening |
| FO — schermlaag en UX-specificaties | Schermlaag en UX-specificaties |
| FO — open punten en buiten scope | Open punten en buiten scope |