Notitieblok: Wanneer en hoe het te gebruiken
Gebruik een notitieblok om nabijgelegen inhoud te verduidelijken zonder de actie, uitkomst, het risico of de prioriteiten van de lezer te wijzigen—en houd tips en waarschuwingen elke keer duidelijk gescheiden.
Een notitieblok isoleert context die een lezer helpt nabijgelegen inhoud te interpreteren, maar niet verandert wat de lezer moet doen, welk resultaat te verwachten of hoe ernstig de situatie is.
Dit weergegeven voorbeeld beantwoordt een mogelijke vraag zonder een stap toe te voegen. Een lezer die het overslaat, kan het rapport nog steeds correct gebruiken. Een lezer die een tijdverschil opmerkt, krijgt de ontbrekende context en kan doorgaan zonder de workflow te wijzigen.
Waarom dit element ertoe doet
Lezers scannen een pagina op visuele prioriteit. Een begrensd notitieblok zegt: “Deze context kan een vraag beantwoorden, maar het is geen nieuwe instructie.” Dat signaal vermindert de moeite die nodig is om een terzijde te classificeren. De lezer kan kort het hoofdargument verlaten, de verduidelijking opnemen en op hetzelfde punt terugkeren zonder zich af te vragen of het proces is veranderd.
Het element werkt alleen wanneer die belofte betrouwbaar blijft. Als verplichte stappen, verkoopboodschappen, definities, waarschuwingen en achtergrondfeiten allemaal dezelfde notitiestyling krijgen, stopt het label met helpen. Lezers moeten elk blok inspecteren om te ontdekken wat het betekent, wat meer cognitieve belasting toevoegt—de mentale inspanning die nodig is om informatie te verwerken—dan gewoon proza zou hebben gecreëerd.
Ernstlabels leren ook gedrag aan door herhaling. Wanneer onschadelijke context waarschuwingskleuren krijgt, komen lezers herhaaldelijk een dringend signaal tegen zonder betekenisvolle consequentie. Ze leren eroverheen te kijken. De volgende echte waarschuwing concurreert dan met een geschiedenis van valse alarmen. Het verkeerd gebruiken van waarschuwingsstyling voor notities maakt niet alleen één pagina melodramatisch; het verzwakt de hele risicotaal van de site.
Voor machines biedt een getypeerde notitie een expliciete grens en doel. Een migratietool voor inhoud kan het blok behouden als aanvullende context in plaats van het samen te voegen in een procedurele stap. Een zoeksysteem of AI-agent kan de notitie met het label en de inhoud extraheren en deze ondergeschikt houden aan de bewering die het uitlegt. Die relatie is moeilijker te herstellen uit een alinea die blauw is gemaakt met paginaspecifieke styling.
Extraheerbaarheid hangt nog steeds af van het schrijfwerk. “Dit kan er anders uitzien” is niet nuttig buiten zijn alinea omdat het onderwerp ontbreekt. “Rapporttijdstempels gebruiken UTC, niet de lokale tijd van de kijker” is zelfstandig. De schrijfregels voor elementen hebben voorrang: classificeer de passage eerst op doel, pas daarna het geregistreerde element toe. Visuele nadruk creëert nooit het semantische type.
Wanneer te gebruiken
Gebruik een notitie alleen wanneer alle vier voorwaarden waar zijn:
- De passage verduidelijkt één nabijgelegen bewering, waarde, instructie, voorbeeld of reeks.
- Het overslaan ervan verandert niet de vereiste handeling, het verwachte resultaat, de juiste interpretatie van de hoofdbewering of het risiconiveau.
- De context beantwoordt een plausibele lezersvraag die anders het begrip zou onderbreken.
- De passage is zelfstandig genoeg om betekenisvol te blijven wanneer deze met het label wordt geëxtraheerd.
Goed notitiemateriaal omvat een tijdzoneconventie, een naamgevingsalias, een reikwijdtegrens die al wordt geïmpliceerd door de hoofdtekst, een onschadelijk interfaceverschil tussen versies, of een uitleg voor een verwachte weergavestatus. Bijvoorbeeld: “De knop heet Opslaan op maandelijkse accounts en Toepassen op jaarlijkse accounts; beide verzenden dezelfde instellingen.” De actie en het resultaat van de lezer veranderen niet.
Bijna-raakgevallen zijn belangrijk omdat “nuttige extra informatie” een te brede definitie is:
- Een feit dat nodig is om de volgende alinea te begrijpen, hoort in de hoofdtekst. Het verbergen in een notitie laat essentiële informatie er optioneel uitzien.
- Een vereiste hoort vóór de procedure. Als werk niet kan beginnen zonder beheerdertoegang, is toegang geen aanvullende context.
- Een optionele techniek die het werk sneller of beter maakt, hoort in een tipblok . Een tip verandert de kwaliteit of efficiëntie van de uitkomst; een notitie doet dat niet.
- Een voorwaarde die verwijdering, kosten, blootstelling, letsel of ongeldig werk voorkomt, hoort in een waarschuwingsblok . Het doel is om gedrag te veranderen vóór schade.
- Een formele definitie die vaststelt wat een term betekent, hoort in het definitieslement of de hoofdtekst, niet in een notitie.
- Een citatie hoort naast de bewering die het ondersteunt. Bewijs is geen terzijde wanneer de bewering ervan afhankelijk is.
- Een promotie, aanmeldingsprompt of productaanbeveling is een call-to-action, geen informatie.
Gebruik de geen-veranderingstest bij onzekerheid over de classificatie: “Moet de lezer een handeling, verwachting, beslissing of veiligheidsreactie veranderen als hij dit feit leert?” Zo ja, dan is het geen notitie. Zo nee, vraag dan of het feit een echte dubbelzinnigheid oplost. Zo niet, verwijder het dan of behoud het als gewoon proza in plaats van nadruk te creëren.
Waar te plaatsen
Plaats een notitie direct na het volledige inhoudsblok dat het verduidelijkt. Het doelwit kan een alinea, lijstitem, stap, tabel, codevoorbeeld of korte reeks zijn, maar het doelwit moet logisch zijn voordat de notitie verschijnt. De notitie levert dan aanvullende context zonder het doelwit uit elkaar te halen.
Wanneer een notitie van toepassing is op een hele sectie, plaats deze dan na de openingsalinea die de reikwijdte van de sectie definieert. Noem die reikwijdte in de eerste zin van de notitie. Wanneer het van toepassing is op een procedure, plaats deze dan na de inleidende alinea en vóór de eerste stap alleen als er geen actie verandert; anders is de inhoud een vereiste of waarschuwing. Een notitie over een uitvoer hoort nadat de uitvoer is geïntroduceerd, niet enkele alinea’s later.
Gebruik maximaal drie notities per pagina en één per sectie. Drie is een maximum. Als meerdere notities zich rond één passage verzamelen, mist de hoofdtekst waarschijnlijk een uitleg of verdient het materiaal een eigen subsectie.
Een notitie mag niet staan:
- Tussen een kop en de openingsalinea.
- Tussen een bewering en het bewijs dat deze ondersteunt.
- Tussen een instructie en de vereiste succescoördinator.
- Direct naast een tip, waarschuwing, CTA, promotionele banner of een andere notitie.
- Binnenin een tabelcel, FAQ-antwoord, citaat, codeblok, accordeonpaneel of een andere uitlichting.
- In een held alleen om visuele interesse te creëren, tenzij een elementspecificatie het vereiste live voorbeeld weergeeft.
- Aan het einde van een pagina wanneer het doelwit veel eerder verscheen.
Als nabijheid een stapel blokken zou creëren, verplaats de notitie dan naar proza of herstructureer de sectie. Los de botsing niet op door een notitie waarschuwingskleuren te geven; presentatie kan geen onduidelijke inhoudsrelatie herstellen.
Anatomie
De weergegeven notitie heeft vier zichtbare of structurele regio’s:
- Type label: Het zichtbare woord “Notitie”, dat het blok identificeert zonder te vertrouwen op kleur of een pictogram.
- Optionele titel: Een korte, feitelijke zin die de context benoemt, zoals “Tijdzone” of “Interfacelabels.”
- Inhoud: Eén zelfstandige verduidelijking en, wanneer nuttig, een zin die deze verbindt met de nabijgelegen inhoud.
- Aangrenzend doelwit: Het volledige blok of de benoemde reeks die wordt verduidelijkt. Plaatsing draagt deze relatie over, ook al is het geen geschreven tekstveld.
Randen, achtergronden, pictogrammen, witruimte en lettertypestijlen behoren tot de renderer. Auteurs leveren betekenis, geen kleurinstructies of decoratieve symbolen.
Ontwerpvoorbeelden
De ondersteunde varianten testen inhoud en responsief gedrag. Ze creëren geen verschillende niveaus van belangrijkheid.
Standaard: De renderer levert “Notitie” en de inhoud bevat één verduidelijking. Gebruik deze vorm het vaakst.
Aangepaste titel: Een feitelijke titel identificeert het onderwerp. Het verhoogt de ernst niet en vervangt de notitiesemantiek van het component niet.
Maximaal twee alinea’s: De eerste alinea vermeldt de context; de tweede lost een grens of onschadelijke uitzondering op. Langere uitleg wordt normale inhoud.
Inline referentie: Eén inline codewaarde of beschrijvende link kan het doelwit verduidelijken. Geen van beide mag de notitie veranderen in documentatie binnen documentatie.
Smalle viewport: Label, titel en inhoud behouden hun leesvolgorde, worden normaal ombroken en blijven begrijpelijk zonder rand of pictogram.
Parameters
Het inhoudsmodel scheidt het vaste semantische type, optionele benaming, inhoud en relatie tot nabijgelegen inhoud. “Bron” geeft aan waar een auteur of renderer de waarde vandaan haalt.
| Naam | Type | Verplicht | Min/max | Standaard | Bron | |
|---|---|---|---|---|---|---|
type | Enum | Ja | Exact note | note | Directivenaam of shortcode-attribuut | |
title | Platte string | Nee | 1–6 woorden; maximaal 50 tekens | Note | Attribuut; rendererstandaard bij weglating | |
body | Beperkte Markdown | Ja | 15–90 woorden; 1–2 korte alinea’s | Geen | Directive of shortcode-inhoud | |
inlineLink | URL plus anker | Nee | 0–1 link | Weggelaten | Inhoud | |
inlineCode | Inline code-span | Nee | 0–2 korte waarden | Weggelaten | Inhoud | |
target | Documentrelatie | Ja | Exact één nabijgelegen blok of één benoemde reeks | Vorig volledig inhoudsblok | Plaatsing in documentvolgorde | |
label | Afgeleide platte string | Ja | Eén zichtbaar semantisch label | Note | Renderer op basis van type |
De titel is optioneel omdat “Notitie” meestal voldoende is. De eerste kop van de draagbare directive kan worden toegewezen aan title onder de standaard inhoudsregels, maar de beknopte attribuutvorm heeft de voorkeur voor dit element. Al het andere wordt toegewezen aan body. De huidige Hugo-implementatie accepteert een positioneel type of een genoemd type, plus een optionele genoemde title; meng nooit positionele en genoemde parameters.
Syntax en codevoorbeelden
Deze vormen hebben hetzelfde type, titel en inhoud. Platformweergave kan verschillen, maar de verduidelijking moet een notitie blijven.
Draagbare Markdown-directive
:::note{title="Tijdzone"}
Rapporttijdstempels gebruiken UTC. Filters en berekeningen veranderen niet wanneer de lokale tijdzone van een kijker verschilt.
:::
De directivenaam levert het type, het attribuut levert de optionele titel en de omsloten Markdown levert de inhoud.
Hugo shortcode
{{< callout type="note" title="Tijdzone" >}}Rapporttijdstempels gebruiken UTC. Filters en berekeningen veranderen niet wanneer de lokale tijdzone van een kijker verschilt.{{< /callout >}}
Dit voorbeeld gebruikt alleen genoemde parameters. Zonder aangepaste titel is de positionele vorm callout note geldig en levert de renderer het label “Notitie”.
WordPress-blok of shortcode
<!-- wp:amicited/note {"title":"Tijdzone"} -->
<p>Rapporttijdstempels gebruiken UTC. Filters en berekeningen veranderen niet wanneer de lokale tijdzone van een kijker verschilt.</p>
<!-- /wp:amicited/note -->
[note title="Tijdzone"]Rapporttijdstempels gebruiken UTC. Filters en berekeningen veranderen niet wanneer de lokale tijdzone van een kijker verschilt.[/note]
Het geregistreerde blok is de voorkeursimplementatie voor WordPress. Een shortcode is acceptabel waar die installatie dit expliciet ondersteunt; importerende systemen mogen de notitie niet platmaken tot een waarschuwing of een ander type afleiden uit de kleuren.
Voorbeelden
Goed: onschadelijke interfacevariatie
Dit is goed omdat het een plausibele interfacevraag beantwoordt terwijl dezelfde actie en uitkomst behouden blijven. Het noemt beide labels, zegt waar elk verschijnt en bevestigt hun gelijkwaardige gedrag. De notitie is logisch, zelfs als deze uit de omringende procedure wordt geëxtraheerd.
Slecht: een waarschuwing vermomd als informatie
Notitie — Werkruimte verwijderen: Het verwijderen van de werkruimte verwijdert permanent de rapporten. Exporteer vereiste gegevens voordat u doorgaat.
Dit is slecht omdat de consequentie een gedragsverandering vereist vóór een onomkeerbare actie. Kalme formulering en een neutraal label maken het niet aanvullend. Het moet een waarschuwing zijn die vóór het verwijderbesturingselement wordt geplaatst, met het doelwit, de consequentie en de preventieve actie expliciet vermeld.
Een andere slechte notitie zegt: “De export moet alle vereiste kolommen bevatten.” Dat is een acceptatiecriterium. Zet de vereiste kolommen in de instructie of specificatietabel. Een derde zegt: “U kunt tijd besparen door de export eerst te filteren.” Dat is optioneel, uitkomstverbeterend advies en dus een tip. Correcte classificatie is belangrijker dan visuele variatie.
Schema-opmaak en toegankelijkheid
Een notitieblok heeft geen toegewezen Schema.org-type of -eigenschap. Het blijft zichtbare inhoud binnen het omsluitende Article, TechArticle, product of andere waarheidsgetrouwe paginaschema. Maak er geen zelfstandig JSON-LD-object voor. Wanneer een notitie een stap verduidelijkt, houd deze dan gescheiden van HowToStep.text, tenzij de verduidelijking nodig is om de stap uit te voeren; als dat nodig is, was het vanaf het begin geen optionele notitie-inhoud.
Een statische notitie heeft geen role="alert", een ARIA live-regio of geforceerde aankondiging nodig. Die mechanismen communiceren urgentie of dynamische verandering, terwijl een notitie aanwezig is in de normale documentvolgorde en niet-dringende context bevat. Agressieve aankondiging zou het belang verkeerd voorstellen en de uitvoer van ondersteunende technologie luidruchtiger maken.
Geef het zichtbare label weer als tekst in het Document Object Model, niet als achtergrondafbeelding, pictogram-only tooltip of CSS-gegenereerde decoratie. Als een region-rol wordt gebruikt, koppel dan de toegankelijke naam aan het zichtbare label of de aangepaste titel. De leesvolgorde is label, optionele titel, dan inhoud. Kleur en pictogrammen kunnen het type versterken, maar mogen niet het enige onderscheid zijn van tips en waarschuwingen.
Bij 200% tekstzoom en op een smalle viewport moet de inhoud ombreken zonder horizontaal scrollen. Links hebben beschrijvende ankertekst nodig en moeten toetsenbordtoegankelijk zijn. Inline code moet leesbaar blijven bij hoog contrast. Essentiële informatie mag niet alleen bestaan in de anatomiescreenshot of de alternatieve tekst van een pictogram.
Schrijfregels
Streef naar 15–60 woorden. Het harde maximum is 90 woorden over maximaal twee korte alinea’s. Een langere passage verdient meestal integratie in de hoofdtekst; een extreem korte notitie is vaak een label zonder nuttige context.
Schrijf één verduidelijking per blok in een kalme, feitelijke toon. Vermeld het onderwerp in de eerste zin en leg vervolgens het onschadelijke verschil of de grens uit. Gebruik liever precieze formuleringen zoals “Tijdstempels gebruiken UTC” dan conversationele opvulling zoals “Even ter informatie.” Geef de reden vóór een interpretatieregel: “Gearchiveerde projecten blijven zichtbaar in historische rapporten, dus hun totalen kunnen nog steeds verschijnen in eerdere datumbereiken.”
Een notitie mag gewone nadruk bevatten, maximaal twee korte inline codewaarden en hoogstens één beschrijvende link. Het mag nooit bevatten:
- Een verplichte stap, vereiste, validatieregel, succescriterium of herstelinstructie.
- Een materieel risico, onomkeerbare consequentie, veiligheidsvoorwaarde, juridische instructie of kostenopenbaring.
- Optioneel advies met als doel snelheid, kwaliteit, nauwkeurigheid of gemak te verbeteren.
- Een volledige definitie, bewijs dat nodig is om een bewering te ondersteunen, of een bronnenlijst.
- Meer dan één onafhankelijke verduidelijking.
- Een tabel, codeblok, formulier, knop, CTA, getuigenis, promotie of genest element.
- Grapjes, alarmistische taal, decoratieve emoji’s of woorden zoals “kritiek” en “gevaar.”
Geef niet elke notitie de titel “Belangrijk.” Belangrijkheid is niet het doel van het element en het woord benadert ten onrechte de ernst van een waarschuwing. Gebruik “Notitie” of een feitelijke onderwerptitel. Gebruik nooit een notitie om onduidelijk proza te redden: repareer eerst de hoofdtekst en behoud een notitie alleen als er een werkelijk aanvullende dubbelzinnigheid overblijft.
Berichttypen die het gebruiken
De postTypes-frontmatter vermeldt indelingen waar aanvullende context terugkeert. Opname blijft optioneel; de tabel definieert de toegestane functie en positie in plaats van een verplichte plek.
| Berichttype | Typisch gebruik | Positie | Niet in de notitie plaatsen | |
|---|---|---|---|---|
| How-to-gids | Onschadelijke interface-label-, versie-, tijdzone- of weergavestatusverschillen | Na de volledige stap of uitvoer die het verduidelijkt | Vereisten, verplichte acties, succescoördinaten of foutherstel | |
| Ultieme gids | Reikwijdtegrenzen, terminologie-aliasen of contextuele uitzonderingen die het argument niet wijzigen | Na de alinea die de algemene regel vaststelt | Bewijs, definities nodig voor begrip, of grote uitzonderingen | |
| Wat-is-pagina | Een naamgevingsvariatie of grens die een voorspelbaar misverstand voorkomt | Na de kerndefinitie en eerste uitleggende alinea | De canonieke definitie of een kwalificatie die de nauwkeurigheid ervan verandert | |
| Productpagina | Goedaardige beschikbaarheid, label-, eenheids- of weergavecontext | Naast de relevante feitelijke sectie en weg van aankoopbesturingselementen | Prijsvoorwaarden, terugkerende kosten, compatibiliteitsvereisten of aankooprisico’s |
Andere berichttypen mogen een notitie gebruiken wanneer dezelfde geen-veranderingstest slaagt. Vermeld staan rechtvaardigt geen toevoeging voor visueel ritme, en niet vermeld staan verandert een waarschuwing niet in een notitie.
QA-checklist
Controleer vóór publicatie elk item:
- Het blok verduidelijkt één nabijgelegen passage en verandert geen actie, uitkomst, prioriteit, interpretatie of risico.
- De context beantwoordt een plausibele lezersvraag in plaats van het doelwit te herhalen.
- Vereiste informatie blijft in de hoofdinhoud.
- De notitie staat direct na het volledige doelwit of na de reikwijdte-alinea voor een benoemde reeks.
- Het scheidt geen kop van de inleiding, een bewering van bewijs, of een instructie van de succescoördinator.
- Geen waarschuwing, tip, CTA, banner of tweede notitie staat er direct naast.
- De pagina heeft niet meer dan drie notities en de sectie heeft niet meer dan één.
- De inhoud streeft naar 15–60 woorden, blijft onder 90 woorden en bevat één verduidelijking.
- Het zichtbare tekstlabel overleeft zonder kleur, rand, pictogram of afbeelding.
- De tekst blijft betekenisvol wanneer geëxtraheerd met het label maar zonder omringende opmaak.
- Het blok gebruikt geen alert-rol of live-regio wanneer aanwezig bij het laden van de pagina.
- Markdown-, Hugo- en WordPress-toewijzingen behouden type, titel, inhoud en plaatsing.
- Hugo-parameters zijn volledig positioneel of volledig genoemd; ze worden nooit gemengd.
- Er verschijnt geen niet-ondersteund genest component, codeblok, tabel, formulier of promotionele actie binnenin.
- Screenshot-markeringen vragen om toekomstige vastleggingen zonder niet-bestaande assets weer te geven.
FAQ
Wat is het verschil tussen een notitie, een tip en een waarschuwing? Een notitie verduidelijkt zonder iets te veranderen. Een tip biedt een optionele verbetering. Een waarschuwing verandert gedrag om schade, verlies, kosten, blootstelling of ongeldig werk te voorkomen. Classificeer op basis van de consequentie van het overslaan van het blok, niet op basis van de kleur.
Kan een notitieblok verplichte informatie bevatten? Nee. Verplichte informatie hoort in de hoofdinhoud waar elke lezer het in volgorde tegenkomt. Een notitie mag een onschadelijke variatie uitleggen, maar het overslaan ervan mag de taak of interpretatie niet onjuist maken.
Hoeveel notitieblokken mag een pagina bevatten? Gebruik maximaal drie per pagina en één per sectie. De meeste pagina’s hebben er minder nodig. Herhaalde notities geven aan dat de hoofdtekst geherstructureerd moet worden.
Moet een notitieblok waarschuwingskleuren of een alert-rol gebruiken? Nee. Waarschuwingspresentatie signaleert een materiële consequentie en role="alert" signaleert urgente dynamische informatie. Het toepassen van beide op routinematige context leert mensen het echte signaal te negeren en misleidt gebruikers van ondersteunende technologie.
Kan een notitieblok links of code bevatten? Het mag één beschrijvende link of maximaal twee korte inline codewaarden bevatten wanneer deze het doelwit direct verduidelijken. Gebruik de hoofdinhoud voor codeblokken, tabellen, formulieren of meerstapsdocumentatie.
Een notitie verdient zijn grens door een echte dubbelzinnigheid op te lossen terwijl de koers van de lezer onveranderd blijft. Houd het kalm, aangrenzend, zelfstandig en visueel te onderscheiden van advies en risico.
Meer tutorials in deze sectie
Klaar om het in de praktijk te brengen?
Gratis check · 7 dagen proefperiode · geen creditcard nodig