Documentatie Stijlgids voor Bijdragers

Hieronder staan de basisvereisten voor het opmaken van uw documentatie-artikel.

Referenties

Richtlijnen voor Bijdragers

Verklarende Woordenlijst

Overzichtspagina's

Een artikel dat een sectie introduceert met inleidingen en links naar subsecties.

Inleidende paragraaf

Links naar secties met korte beschrijvingen

Gebruik een inspringing om elke link op te maken
Link is identiek aan hoe deze in het menu verschijnt.
Link wordt gevolgd door een gedachtestreepje (spatie-streepje-spatie) en vervolgens een inleiding van één of twee zinnen over de subsectie, die beschrijft hoe deze het algehele onderwerp verder uitwerkt.

De samenvattende paragraaf koppelt de sectie terug aan de categorie, d.w.z. koppelt een onderwerp over contentbeheer terug aan Contentbeheer.

Linken naar een Subsectie

Subsectie links

Koppen

Titelhoofdletters

Hoofdletter gebruiken

Het eerste en laatste woord (altijd)
Zelfstandige naamwoorden, werkwoorden, bijvoeglijke naamwoorden, bijwoorden
Woorden van 4+ letters (algemene vuistregel)

Kleine letter gebruiken

Korte voorzetsels: in, op, bij, door, voor, van, naar, tot
Lidwoorden: een, de, het
Korte voegwoorden: en, maar, of, noch, dus, toch

Voorbeeld

Een Gids voor de Regels van Titelhoofdletters en Hoe ze te Gebruiken

Ampersand &

Alleen gebruiken in menu's als vervanging voor het woord "en", maar nooit in artikeltitels.

Menu-item

6 Paginering & Lees Meer

Artikeltitel

6 Paginering en Lees Meer

Nummering

Wanneer inhoud een genummerde opsomming of indexstructuur volgt, voeg dan geen punt toe na het nummer.

Ja

6 Paginering en Lees Meer

Nee

6. Paginering en Lees Meer

Schermafbeeldingen

Zie Tips voor Betere Schermafbeeldingen voor gedetailleerde richtlijnen.

Opmerkingen: 1500–2500px breedte; lichte (niet donkere) browserachtergrond; passend bijsnijden om de gebruiker te oriënteren en relevante details te tonen; browserzoom om tekst te verbeteren; PNG-bestandsformaat.

Bijschriften

Wanneer geconfigureerd met een bijschrift (rechtsklikken en het bijschrift-vakje aanvinken) wordt de afbeelding verpakt in een <figure>-blok met correct bijschrift; anders wordt de afbeelding getoond in een standaard inline situatie.

Plaatsing

Grootte

Standaardbreedtes: 960px voor volledige breedte, en 320px of 640px voor gedeeltelijke breedtes.

Grote breedtes (groter dan 1000px) worden automatisch aangepast in de browser aan de artikelbreedte. Kleinere afbeeldingen worden links uitgelijnd.

Bronvermelding

Als de schermafbeelding afbeeldingen bevat, moeten we dan de bron vermelden? En hoe?