‘Over’-artikelen dienen als basislaag van SUMO. Ze beogen ‘Wat is…’-vragen te beantwoorden, waardoor gebruikers worden geholpen essentiële informatie te begrijpen over onze producten, functies of services. Deze artikelen bieden een algemeen overzicht of introduceren concepten zonder in procedurele of probleemoplossingsdetails te treden.
Inhoudsopgave
Wanneer een ‘Over’-artikel moet worden geschreven
Overweeg een ‘Over’-artikel te schrijven als:
- Een nieuw product, nieuwe functie of service wordt geïntroduceerd.
- Het nodig is een concept of functie uit te leggen die essentieel is voor het begrip van hoe een product effectief kan worden gebruikt.
- Er een significante update of wijziging is van een bestaand product, bestaande functie of service die een nieuwe uitleg vergt.
Beste praktijken voor het schrijven van ‘Over’-artikelen
- Ken uw publiek: begrijp dat ‘Over’-artikelen vaak worden gelezen door mensen die niet bekend zijn met technisch jargon of de bijzonderheden van Mozilla-producten. Probeer te schrijven in heldere, eenvoudige taal die voor iedereen toegankelijk is.
- Begin met een duidelijke definitie: begin uw artikel met een heldere, beknopte definitie van het product, de functie of het concept dat u uitlegt. Vermijd het gebruik van technische termen zonder uitleg.
- Leg het belang uit: leg na het definiëren van het onderwerp uit waarom het belangrijk is. Hoe biedt het voordelen voor de gebruiker? Welk probleem lost het op? Waarom is het ontwikkeld?
- Bied context: help de lezer te begrijpen waar dit product, deze functie of service past binnen het Mozilla-ecosysteem.
- Gebruik voorbeelden: voorbeelden kunnen helpen complexe concepten te verduidelijken. Gebruik indien mogelijk praktische voorbeelden die het gebruik of de impact van het onderwerp illustreren.
Artikelstructuur
- Titel: de titel moet beschrijven waar het artikel over gaat en waar de gebruiker naar zoekt. Gebruik zinsconstructies met hoofdletters voor artikeltitels. Beperk uw titel tot rond 60 tekens, aangezien Google typisch de eerste 50–60 tekens van een titellabel toont. Wees beknopt, maar gefocust op de gebruiker.
- Samenvatting: de samenvatting licht een tipje van de sluier op over waar het artikel over gaat, om de gebruiker te helpen beslissen of ze op de juiste plek zijn. Deze dient een tekstueel overzicht of definitie van het concept te zijn en te focussen op waarom de gebruiker meer zou willen weten over het concept. Beperk de samenvatting tot 140 tekens, aangezien zoekmachines alles wat langer is kunnen afkappen.
- Hoofdtekst: vermijd het schrijven van lange paragrafen en veel tekst. Gebruik H2 voor sectieheadings. Verdeel de hoofdtekst in de volgende secties om de inhoud in logische groepen te verdelen:
- Paragrafen
- Ongeordende lijsten (behoud het gebruik van geordende lijsten voor aan ‘Taak’-artikelen)
- Tabellen
- Afbeeldingen (schermafdrukken/GIF’s)
- Koppelingen voor meer info: gebruik H3 voor de sectiekoptekst Meer info. Deze dient niet te worden opgenomen in de inhoudsopgave. Voeg ongeordende lijsten toe voor de ‘Meer info’-koppelingen en voeg niet meer dan vier koppelingen toe aan deze sectie.
