Artikelen voor de kennisbank schrijven

Meiwurkers Meiwurkers Lêst bywurke:
Dizze side bestiet net yn it Frysk. Yn stee dêrfan binne jo nei de Nederlandse ferzje trochferwizen. As jo de side nei it Frysk oersette wolle, klik dan hjir. Jo kinne ek de Ingelske ferzje fan dizze side besjen.

Als een bijdrager aan de kennisbank gebruikt u woorden om een half miljard gebruikers te helpen. Dat is een grote taak. Gebruikers komen van over de hele wereld naar de kennisbank en verwachten eenvoudige oplossingen, maar we willen hen ook verrassen met onze stem. Hoe doet u dat? Hier zijn enkele dingen die we in ons onderzoek hebben bedacht.

We houden van suggesties! Als u aanvullende suggesties hebt, plaats deze dan in het discussieforum van dit artikel.

Toon

Schrijf met het merk in gedachten. Mozilla gaat over de keuze van de gebruiker. We geloven in vrijheid en flexibiliteit. We hechten waarde aan privacy en veiligheid. We zijn een door de gemeenschap gedreven non-profitorganisatie met bijdragers over de hele wereld die gemeenschappelijke waarden delen.

U hoeft dit verhaal niet elke keer dat u een artikel schrijft te benadrukken. Het is gewoon iets om in gedachten te houden wanneer u functies beschrijft.

Schrijfstijl

Schrijf voor een algemeen, niet-technisch publiek.

We willen dat onze artikelen voor iedereen bruikbaar zijn, niet alleen voor gevorderde gebruikers. Dit betekent dat we schrijven voor een algemeen publiek in plaats van een publiek dat zeer bekend is met computertechnieken en -terminologie. Ga ervan uit dat de persoon voor wie u schrijft niet weet hoe voorkeuren te wijzigen of een werkbalkknop toe te voegen zonder stapsgewijze instructies. We moeten er ook van uitgaan dat ze geen van de standaardinstellingen van de toepassing of het besturingssysteem hebben gewijzigd.

Samengevat dient u deze richtlijnen te volgen:

  1. Houd het kort. Mensen komen naar de kennisbank op zoek naar snelle oplossingen. Ze geven misschien niet om de innerlijke werking van de tool – ze willen gewoon weten wat zij moeten doen om het te repareren. Schrap gerust wat woorden. Kijk hoeveel u met minder woorden kunt overbrengen. Het is net poëzie!
  2. Houd het duidelijk. Vermijd jargon. Wees specifiek. Gebruik woorden in de titel en in het artikel die de lezer zou gebruiken. Als uw 13-jarige neefje het niet zou begrijpen, schrijf het dan zo dat hij het wel zou begrijpen. Zie de volgende sectie voor een uitgebreidere gids.
  3. Wees vriendelijk, leuk en empathisch. (Kortom: wees menselijk.) Oké, gebruikers komen niet naar ondersteuning en verwachten plezier. Dat is wat dit krachtig maakt. Fleur de dag van de gebruiker op met een beetje humor. Maar wees voorzichtig dat u de duidelijkheid niet opoffert door leuke metaforen of uitdrukkingen te gebruiken. Als u niet zeker weet hoe u dit in evenwicht kunt brengen, schrijf dan gewoon duidelijke instructies en gebruik de toon in de inleiding of conclusie.
  4. Vertel een verhaal. Zorg voor een begin, een midden en een eind. Maar schrijf geen roman (zie richtlijn #1).
    • Begin: dit geeft de lezer wat context. Waar gaat dit artikel over en waarom zou ik erom geven? Houd het kort.
    • Midden: de instructies komen hier. Dit zou de vraag “Hoe doe ik dit?” moeten beantwoorden.
    • Eind: zijn er vervolgstappen voor het artikel of de functie? Vertel de lezer waar hij of zij naartoe moet als ze meer willen leren.

Lees de volgende sectie voor uitgebreidere richtlijnen.

Schrijfstijl (uitgebreid)

  • Conversatiestijl – Gebruik een informele, actieve stijl die vergelijkbaar is met de manier waarop u met iemand persoonlijk zou spreken.
  • Humor en emotie – Humor gebruiken is geweldig, maar het is soms moeilijk of onmogelijk te lokaliseren. Emoties zoals verrassing en “Dat wist ik niet/Eureka!” zijn misschien gemakkelijker op te nemen.
  • Meerdere leerstijlen – Net als op school leren mensen op verschillende manieren. Ook profiteert iedereen ervan als dezelfde inhoud op meerdere manieren wordt uitgedrukt.
  • Herhaling – Wanneer u iets op een andere manier met verschillende media uitlegt, herhaalt u het uiteraard ook, wat een andere goede manier is om mensen te helpen onthouden wat belangrijk is.
  • Afbeeldingen en video – Het gebruik van afbeeldingen en video naast tekst is niet alleen het op één na beste alternatief voor persoonlijke hulp, het is ook een gemakkelijke manier om meerdere leerstijlen en herhaling op te nemen. Te veel afbeeldingen kunnen het lokaliseren van een artikel echter moeilijker maken, dus probeer alleen afbeeldingen toe te voegen als dit nuttig is voor een stap of concept. Voor een stap waarbij op een knop wordt geklikt, kunt u bijvoorbeeld “Klik op OK” zeggen in plaats van een schermafbeelding van het dialoogvenster van die knop toe te voegen.
  • Activiteiten – Vooral in een handleiding is het goed om mensen iets nuttigs te laten bereiken. Het is één ding om instructies te lezen en het proces te begrijpen, maar het is vaak nuttig om mensen eraan te herinneren en in staat te stellen dingen uit te proberen.

Artikeltypen

Het gebruik van consistente inhoudstypen voor onze kennisbankartikelen heeft vele voordelen, waaronder gemakkelijker navigeren en verbeterde duidelijkheid en organisatie, naast dat het ons helpt om effectiever inhoud te creëren. We gaan over op het categoriseren van externe kennisbankartikelen in vier typen, elk met een specifiek doel:

  • Over: deze artikelen behandelen “Wat is…”-vragen en bieden essentiële informatie om lezers te helpen een onderwerp te begrijpen.
  • Instructie: deze artikelen richten zich op het beantwoorden van “Hoe…?”-vragen en leiden lezers door de stappen die nodig zijn om een specifiek doel of een specifieke procedure te bereiken.
  • Probleemoplossing: deze artikelen helpen gebruikers bij het identificeren, diagnosticeren en oplossen van veelvoorkomende problemen die ze kunnen tegenkomen met een product, dienst of functie door “Hoe…?”-vragen met betrekking tot probleemoplossing te beantwoorden.
  • FAQ: deze artikelen bevatten beknopte antwoorden op veelgestelde vragen over één onderwerp, die mogelijk niet in andere individuele KB-artikelen passen, en bieden een snelle referentie voor veelvoorkomende vragen.

Begin met een effectieve en beschrijvende titel

Een goed opgestelde titel is meer dan alleen een label; het is het eerste contactpunt van een gebruiker met uw KB-artikel. Een goede titel moet niet alleen de aandacht van de lezer trekken, maar ook dienen als een beknopte en informatieve voorvertoning van de inhoud van het artikel. Houd bij het maken van titels voor SUMO rekening met het volgende:

  • Duidelijkheid en beschrijvend vermogen: stem af op waar het artikel over gaat en waar de gebruiker naar zoekt. Wees beknopt, maar gebruikersgericht.
  • Trefwoorden opnemen: neem relevante trefwoorden op om de zichtbaarheid in zoekmachines te verbeteren en gebruikers te helpen uw artikel te vinden.
  • Beknoptheid: houd titels kort en geef toch voldoende informatie. Kortere titels zijn vaak gebruiksvriendelijker. Probeer titels rond de 60 tekens te houden.
  • Actiegericht: gebruik actiewerkwoorden waar van toepassing om aan te geven wat gebruikers kunnen doen om een probleem op te lossen of een doel te bereiken. Vermijd het gebruik van gerundia (woorden die eindigen op “ing”) in titels om ervoor te zorgen dat ze actiegericht blijven. Vermijd het gebruik van titels die “Hoe…” bevatten.

Schrijf een goede inleiding

Samen met de titel en de inhoudsopgave is de inleiding wat mensen zal helpen bepalen of ze op de juiste plek zijn.

  • Voor een “Over”-artikel: geef een tekstueel overzicht of definitie van het concept en focus op waarom de gebruiker erom zou moeten geven.
  • Voor een “Instructie”-artikel: geef een tekstueel overzicht of definitie van de taak en focus op het belang of de voordelen van de taak.
  • Voor een “Probleemoplossing”-artikel: beschrijf het specifieke probleem of de symptomen die gebruikers kunnen tegenkomen. Schrijf in duidelijke en beknopte taal en vermijd waar mogelijk technisch jargon.

Houd er rekening mee dat een goede inleiding meestal kan dienen als een goede zoekopdrachtsamenvatting. Vaak kunt u deze gewoon kopiëren naar het veld “Samenvatting zoekresultaat” en bent u klaar.

Organiseer het artikel effectief

Het algemene idee hier is om te proberen vaardigheden op te bouwen van eenvoudig naar complex, terwijl u probeert de informatie die de meeste mensen nodig hebben bovenaan te houden. Een eenvoudige, veelvoorkomende oplossing komt dus meestal voor een complexe of uitzonderlijke oplossing.

Maak stapsgewijze instructies gemakkelijk te volgen

Het belangrijkste om in gedachten te houden bij het schrijven van stapsgewijze instructies is om zorgvuldig alle acties op te nemen die nodig zijn om de taak te voltooien. Als u bijvoorbeeld op OK moet klikken na het selecteren van een voorkeur om naar de volgende stap te gaan, zorg er dan voor dat u het klikken op “OK” als onderdeel van die stap opneemt. Enkele aanvullende zaken om te overwegen:

  • Er zijn altijd meerdere manieren om een resultaat te bereiken. We moeten altijd de meest gebruiksvriendelijke manier kiezen door waar mogelijk de grafische gebruikersinterface en menu’s te gebruiken.
  • Gebruik volledige zinnen bij het beschrijven van de toegang tot de gebruikersinterface.
  • Neem verwachte resultaten op bij het geven van instructies (bijvoorbeeld Klik op “OK” en het venster wordt gesloten.).

Leesbaarheid

De tekst moet leesbaar zijn. Om dit te doen, moet u:

  • Een artikel opdelen in kleine logische/semantische blokken met subkoppen.
  • Genummerde of opsommingslijsten gebruiken.
  • Korte of relatief korte zinnen schrijven.
  • Vermijden om grote alinea’s te schrijven.

Er is geen limiet aan de hoeveelheid tekst. Hoe meer materiaal, hoe beter; u moet het echter niet kunstmatig uitbreiden. Geef alleen nuttige, waardevolle en noodzakelijke informatie.

Hoe te linken naar externe documentatie voor software van derden

Bij het maken of bijwerken van artikelen die acties binnen software van derden omvatten, zoals besturingssystemen of externe toepassingen, is het cruciaal om gebruikers te voorzien van nauwkeurige en betrouwbare informatie. Het opnemen van directe stappen voor deze software in onze artikelen kan echter uitdagingen met zich meebrengen:

  • Snel verouderde informatie: updates van software van derden kunnen onze instructies verouderd maken, wat onze gebruikers mogelijk kan verwarren of misleiden.
  • Resource-intensief: het continu monitoren en bijwerken van stappen voor meerdere externe platforms zou aanzienlijke inspanningen en middelen vergen, wat mogelijk niet haalbaar is.

Beste praktijken

Om ervoor te zorgen dat onze gebruikers de meest betrouwbare en actuele informatie ontvangen zonder onze middelen te overweldigen, volgt u deze beste praktijken:

  • Link naar officiële bronnen: wanneer instructies software van derden betreffen, zoek dan de officiële documentatie of helpartikelen die door de softwaremaker worden verstrekt. Link naar deze bronnen in plaats van de stappen rechtstreeks in onze artikelen uit te schrijven.
  • Geef context: leg kort uit waarom u de gebruiker naar een externe pagina verwijst (bijvoorbeeld: “Voor de nieuwste en meest nauwkeurige stappen om uw systeeminstellingen aan te passen, raadpleegt u de officiële <software name>-ondersteuningspagina”).
  • Controleer links periodiek: hoewel we streven naar het verminderen van het onderhoud van instructies van derden, is het periodiek controleren of externe links nog steeds geldig zijn nog steeds belangrijk. Als u merkt dat een link verouderd of verbroken is, zoek dan naar een bijgewerkte link naar de officiële documentatie en dien een revisie in.
  • Disclaimer over externe inhoud: wanneer u gebruikers naar een externe link verwijst, maak dan duidelijk dat ze SUMO verlaten en dat we niet verantwoordelijk zijn voor de inhoud van externe sites. Een eenvoudige disclaimer of opmerking kan volstaan (bijvoorbeeld: “Het volgen van deze link leidt u naar een externe website die niet door Mozilla wordt beheerd.”).

Voorbeeld

Stel u voor dat u een artikel schrijft over het configureren van een Firefox-functie die afhankelijk is van het wijzigen van systeeminstellingen op een Mac. In plaats van de stappen rechtstreeks in het artikel te schetsen, zou u kunnen schrijven:

Voor de nieuwste stappen voor het aanpassen van uw systeemvoorkeuren op macOS, raadpleegt u de officiële Apple-ondersteuningsdocumentatie door deze gids te bezoeken. Houd er rekening mee dat het volgen van die link u naar een externe website leidt die niet door Mozilla wordt beheerd.

Dit zorgt ervoor dat u de meest actuele instructies rechtstreeks van de bron volgt.

Technische richtlijnen

Titel

  • Titellengte: de zoekresultatenpagina van Google toont maximaal 60 tekens. Uw titel kan indien nodig langer zijn, maar zorg ervoor dat uw belangrijke trefwoorden in de eerste 60 tekens zijn opgenomen.
  • Hoofdlettergebruik: het eerste woord in de titel moet een hoofdletter hebben, evenals eigennamen en namen, niet elk belangrijk woord. Gebruik ‘sentence’-stijl, geen ‘headline’-stijl. (Hetzelfde geldt voor koptitels. Zie de sectie Stijlgids en schrijfregels hieronder voor andere regels over hoofdlettergebruik.) Bewerk de titel van een bestaand artikel echter niet om het hoofdlettergebruik te wijzigen, tenzij u andere titelwijzigingen aanbrengt, omdat er dan geen omleiding wordt gemaakt en er verbroken wikilinks in artikelen die ernaar linken ontstaan (bug 1969540).
  • Gebruik geen dubbele punt in de artikeltitel, omdat dit het maken van een wikilink naar dat artikel verhindert (bug 749835). Zorg er ook voor dat u geen extra spaties in de artikeltitel hebt, wat ook voorkomt dat wikilinks werken.
  • Probeer de manier waarop u artikelen benoemt te variëren. Gebruik niet dezelfde woorden of zinsdelen in elke titel. Begin artikelen bijvoorbeeld niet altijd met “Hoe” en vermijd het gebruik van taaknamen die eindigen op “-en”, zoals “De startpagina instellen”.
  • Onthoud dat de hele uitleg niet in de titel hoeft te staan. U kunt de samenvatting gebruiken om de gebruiker aanvullende informatie te geven over wat er in het artikel staat.

Slug

Wanneer u een nieuw artikel maakt en een titel invoert, maakt SUMO automatisch een slug (het deel na kb/ aan het einde van de URL voor het artikel). Een beoordelaar kan de titel van een bestaand artikel bewerken, maar de slug blijft hetzelfde, tenzij handmatig gewijzigd (dit is zo ontworpen). De slug heeft een limiet van 50 tekens. Spaties worden weergegeven als streepjes. De slug moet consistent zijn met de titel, maar hoeft, gezien de krappere ruimtebeperking, niet hetzelfde te zijn.

De slug repareren

Controleer het einde van de automatisch gegenereerde slug. Soms wordt een woord afgekapt of eindigt het op een streepje. Repareer dit soort dingen.

Slug van een bestaand artikel bijwerken

Wanneer u een titel van een bestaand artikel bijwerkt, laat u de huidige slug ongewijzigd, tenzij de nieuwe titel een significante verandering vertegenwoordigt die niet langer overeenkomt met de bestaande slug. Het consistent houden van de slug helpt gebroken links te voorkomen en behoudt de SEO-waarde.

Categorieën, producten en onderwerpen

Voor het grootste deel hoort een artikel in de categorie Instructie of Probleemoplossing. Af en toe schrijven we artikelen in een van de andere categorieën, zoals “Hoe bij te dragen”-artikelen (zoals deze). De geschiedenispagina van het artikel toont de categorie.

Artikelen zijn ook “relevant voor” ten minste één product. Ze horen ook in één hoofd-“Onderwerp” en optioneel een “subonderwerp”.

N.B.: houd er rekening mee dat de categorie Administratie artikelen verbergt voor openbare zoekopdrachten, terwijl toegang via URL nog steeds mogelijk is. Gebruik deze categorie bij het configureren van inhoud die tijdelijk verborgen moet blijven. Dit kan bijvoorbeeld handig zijn voor artikelen met betrekking tot een aanstaande Firefox-uitgave, die lokalisatie vereisen maar op dit moment niet vindbaar mogen zijn in openbare zoekopdrachten. Artikelen kunnen indien nodig naar een andere categorie worden overgeschakeld door de metagegevens van het artikel te bewerken, zoals in dit artikel wordt uitgelegd.

Trefwoorden

Het trefwoordenveld in een artikel kan worden gebruikt om de zoekresultaten op SUMO te verbeteren. Het moet echter alleen onder specifieke omstandigheden worden gebruikt, omdat misbruik de zoekresultaten juist kan schaden. We hoeven zelden trefwoorden te gebruiken. Zie Trefwoorden gebruiken om de zoekresultaatvolgorde van een artikel te verbeteren voor details.

Schrijf een goede zoekopdrachtsamenvatting

De artikelsamenvatting, samen met de titel, helpt gebruikers te beoordelen of een artikel hun vraag zal beantwoorden. We noemen dit “Gebruikersvertrouwen” en het heeft een directe invloed op de doorklikratio’s. Zelfs als we het juiste artikel bovenaan de lijst met zoekresultaten tonen, moet de gebruiker de mentale verbinding maken tussen de zoekopdracht en de resultaten die we weergeven om door te klikken naar het artikel.

Een samenvatting voor een instructieartikel moet de onderwerpen bevatten die in het artikel worden behandeld. Een probleemoplossingsartikel moet proberen symptomen op te nemen. Daarnaast moet een samenvatting de volgende richtlijnen volgen:

  • Kort en bondig. Herinnert u zich rubrieksadvertenties? Schrijf het zo. Zoekmachines kunnen alles wat langer is dan 140 tekens afkappen. Als u een langere samenvatting gebruikt, houd dan de belangrijke informatie aan het begin. N.B.: de KB-software toont 20 resterende tekens wanneer de samenvatting 140 tekens bereikt, omdat de interne zoeklimiet 160 is.
  • Gebruik geen wiki-opmaak.
  • Gebruik niet “Dit artikel legt uit” in elke samenvatting. Varieer waar mogelijk. Enkele andere zinsdelen om te overwegen:
    • We laten u zien
    • We leggen uit
    • Deze pagina legt uit
    • Dit artikel beschrijft
    • Leer hoe

Aantal stappen

Overweeg bij het begeleiden van gebruikers door een proces geordende lijsten (genummerde lijsten). Het is over het algemeen een goede gewoonte om te proberen het totale aantal stappen in het bereik van zes tot zeven te houden.

Parallelle structuur

Gebruik dezelfde formulering of hetzelfde woordpatroon voor elke stap die u schrijft. Parallelle structuur is belangrijk in KB-artikelen omdat het de zaken duidelijk en gemakkelijk te volgen maakt. Wanneer vergelijkbare elementen een consistent formaat hebben, kunnen gebruikers taken soepeler begrijpen en voltooien. Deze structuur vereenvoudigt instructies, vermindert fouten en zorgt ervoor dat informatie effectief wordt overgebracht.

Bijvoorbeeld:

  1. Zoek Geschiedenis wissen zodra Firefox sluit. Als dit is geselecteerd:
    1. Klik op de knop Settings….
    2. Zorg ervoor dat Formulier- & zoekgeschiedenis niet is geselecteerd.
    3. Klik op OK.

Richtinggevende aanwijzingen

Richtinggevende aanwijzingen zijn verwijzingen of indicatoren die gebruikers naar de specifieke locatie of positie binnen een gebruikersinterface leiden waar ze een bepaalde actie moeten ondernemen. Deze aanwijzingen helpen gebruikers effectiever te navigeren en te interageren met software, toepassingen of websites. Ze omvatten doorgaans zinnen als “In de rechterbovenhoek”, “In het linkermenu” of “Onder de zoekbalk”, die gebruikers een duidelijk gevoel geven van waar ze acties kunnen vinden en uitvoeren.

Zorg ervoor dat u in uw KB-artikelinstructies richtinggevende aanwijzingen geeft voor de actie. In plaats van te zeggen Klik op de knop, gebruikt u bijvoorbeeld Klik in de rechterbovenhoek op de knop. Dit formaat helpt gebruikers gemakkelijk acties binnen de interface te lokaliseren en uit te voeren.

Stijlgids en schrijfregels

Zoals we eerder zeiden, dient u een actieve, conversationele stijl te gebruiken wanneer u schrijft. Vermijd dingen te zeggen als “Als de bladwijzers van een gebruiker verloren zijn gegaan” en zeg in plaats daarvan “Als u uw bladwijzers bent kwijtgeraakt”. Hier zijn andere veelvoorkomende stijl- en schrijfproblemen die u kunt tegenkomen bij het schrijven van ondersteuningsartikelen: Gebruik termen altijd zoals ze in de Mozilla-interface verschijnen. Bijvoorbeeld:

  • Plugins does not have a hyphen.
  • Add-ons does have a hyphen.
  • Home page is two words.

Algemene computertermen:

  • Website is één woord. Webpagina is twee woorden.
  • Log in en log out zijn werkwoorden. Voorbeeld: “Log in to the website.” Hetzelfde geldt voor sign in en sign out. Gebruik niet “log into” of “sign into”.
  • Login en logout zijn zelfstandige naamwoorden (meestal gebruikt als bijvoeglijke naamwoorden). Voorbeeld: “Click the login button.”
  • Gebruik email in plaats van e-mail.
  • Het meervoud van CD-ROM is CD-ROMs.

Links naar mozilla.org en firefox.com mogen de landinstelling niet bevatten:

Bij het opnemen van links in zinnen:

  • Vermijd het gebruik van “klik hier” of “hier” als linktekst.
    • Wel doen: ga naar uw accountinstellingen om uw abonnement op te zeggen.
    • Niet doen: klik hier om uw abonnement op te zeggen.

Gebruik een hoofdletter voor de volgende items:

  • Eigennamen en namen, inclusief merknamen, productnamen en functienamen
  • Het eerste woord van een volledige zin
  • De letters van afkortingen en acroniemen, tenzij ze normaal gesproken in kleine letters zijn
  • Het eerste woord in genummerde of opsommingslijsten
  • De naam van een toets op het toetsenbord
  • Het eerste woord van een volledige zin na een dubbele punt
  • Het eerste woord in een kop of titel

Mozilla accounts:

  • De “a” in Mozilla accounts is altijd een kleine letter, behalve in navigatie-items waar het is opgenomen met andere navigatie-items die hoofdletters gebruiken.
  • Gebruik altijd “sign in” en “sign out”.
  • Gebruik in werkwoordsvorm “sign in to your account” (niet “sign into”) om grammaticaal correct te zijn.
  • U kunt ook “Sign in with Mozilla” gebruiken.
  • “Sign” moet altijd als werkwoord worden gebruikt. Als u het als zelfstandig naamwoord gebruikt, gebruik dan “login”.
  • Gebruik “sign up” als de oproep tot actie om een nieuw account aan te maken.

Zie Editorial guidelines for Mozilla accounts voor details over hoe u naar Mozilla accounts kunt verwijzen in KB-artikelen.

Gebruik geen ‘i.e.’ en ‘e.g.’. Deze Latijnse afkortingen kunnen mensen verwarren. Gebruik voor de duidelijkheid “met andere woorden” of “anders gezegd” in plaats van i.e. wanneer u iets op een andere manier wilt uitleggen. Gebruik “bijvoorbeeld” of “zoals” in plaats van e.g. wanneer u voorbeelden wilt geven.

Gebruik geen seriële komma’s in een lijst met items. Gebruik bijvoorbeeld “Extensies, thema’s en plug-ins” (zonder de seriële komma), niet “Extensies, thema’s, en plug-ins”.

Gebruik initialismen die als algemeen bekend worden beschouwd. Bijvoorbeeld:

  • HTTP
  • USB
  • URL

Getallen die voorkomen in de versie van een product, foutcodes, toetsen en knoppen worden niet uitgeschreven.

Schrijf instructies in de actieve vorm. Schrijf instructies in de actieve vorm. De actieve vorm en de tegenwoordige tijd vereenvoudigen instructies, waardoor ze gemakkelijker te volgen zijn en snelle actie wordt aangemoedigd. Voorbeeld:

“Herstart Firefox om bij te werken” not “Firefox moet worden herstart”.

Schrijf backslashes(\) en forward slashes(/) uit voor paden en zoekopdrachten om verwarring te voorkomen.

Voorbeeld: “Sommige padnamen naar afbeeldingen bevatten backslashes (\\)”.

Toetsenbordcombinaties Gebruik een hoofdletter voor de eerste letter van een toetsenbordcombinatie of een combinatie van sneltoetsen: Ctrl + Shift + C of Command + Shift + C.

Gebruik geen jargon en idioom. Al onze artikelen worden in veel verschillende talen vertaald, dus ze worden gelezen en vertaald door niet-moedertaalsprekers van het Engels. Jargon en idioom kunnen dubbelzinnig zijn, wat lezers kan verwarren en de vertaling moeilijker kan maken.

We hebben speciale visuele stijlen voor een aantal items die kunnen worden bereikt door de juiste wiki-opmaak rond het item toe te voegen. Zie de Spiekbriefje voor opmaak voor de meest voorkomende stijlen.

We hebben een speciale wiki-opmaak – {for} – waarmee u informatie kunt richten op specifieke versies van Firefox of specifieke besturingssystemen. U kunt bijvoorbeeld één set instructies weergeven aan mensen die Windows gebruiken en een andere aan mensen die macOS gebruiken (zie ‘For’-labels gebruiken voor details).

Dizze aardige minsken hawwe holpen by it skriuwen fan dit artikel:

Illustration of hands

Frijwilliger wurde

Lit jo ekspertize groeie en diel dizze mei oaren. Beäntwurdzje fragen en ferbetterje ús kennisbank.

Mear ynfo