Ga naar hoofdinhoud

Blog Richtlijnen

Blogs Banner

Om ervoor te zorgen dat alle ZAP-Hosting Blogposts consistent zijn in kwaliteit en stijl, hebben we een reeks richtlijnen opgesteld die je moet volgen bij het creëren van content voor ons Blogs Contribution Program. Je moet onze richtlijnen nauwkeurig volgen om ervoor te zorgen dat je suggesties en daaropvolgende concepten snel verwerkt worden. Belangrijker nog, dit zorgt ervoor dat onze lezers een betere en consistent hoogwaardige ervaring hebben tijdens het lezen van onze blogs.

Onze blogbijdrageregels zijn op te splitsen in een paar hoofdsecties, namelijk:

  • Structuur
  • Stijl
  • Opmaak
  • Terminologie

Structuur​

Onze blogposts binnen het bijdrageprogramma moeten een relatief consistente structuur volgen, die de interesse van de lezer wekt en informatie en nieuws biedt. Het ZAP Contribution Team werkt met je samen om te zorgen dat je structuur passend is bij het maken van een blogsuggestie.

  • Paginatitel (H1)
  • Introductie (H2)
  • Voorbereiding (H2)
  • Hoofdonderwerp (H2)
  • Optioneel: Subonderwerp 1 (H3)
  • Optioneel: Subonderwerp 2 (H3)
  • ...
  • Optioneel: Nog een Onderwerp (H2)
  • Conclusie (H2)
Gebruik van Subkoppen (H3 & H4)

Je wordt aangemoedigd om H3-koppen te gebruiken om subsecties binnen hoofdsecties (H2) te maken, zodat grotere stukken content beter georganiseerd worden. Een voorbeeld hiervan zie je bij de Hoofdonderwerp sectie hierboven.

Als je subkoppen gebruikt, is het meestal logisch om minstens twee of meer subkoppen binnen de bovenliggende kop te hebben, anders heeft het meestal geen zin om slechts één subkop binnen een hoofdkop te hebben.

info

Houd er rekening mee dat bovenstaande een ruwe richtlijn is. De hoofdtekst van je blogpost kan andere koppen bevatten, afhankelijk van wat passend is voor jouw content, maar alle blogposts moeten consistent een titel, introductie en conclusie hebben rondom de hoofdinhoud.

Titels​

De titel van je blogpost moet kort, duidelijk en pakkend zijn om de aandacht van de lezer te trekken. Het moet precies aangeven waar je blogpost over gaat, bijvoorbeeld of het nieuws is of tips en advies. Een goed voorbeeld van een titel is: Top 10 FiveM Politie Scripts.

Introductie​

Introducties voor je blogpost moeten relatief kort en to the point zijn, meestal 1-2 zinnen. In de inhoud moet je kort het onderwerp beschrijven en vooral uitleggen wat de blogpost de lezer zal bieden, zodat ze weten wat het einddoel is.

Een voorbeeld van een ideale introductie voor een blogpost over SteamCMD zou zijn:

  • 1e zin: SteamCMD is een essentieel hulpmiddel dat nodig is voor het installeren van dedicated servers voor een breed scala aan games, waaronder Palworld, Enshrouded en meer.
  • 2e zin: In deze blogpost verkennen we het installatieproces van SteamCMD op je Linux-server. We gebruiken Ubuntu in de voorbeelden, maar het proces is vergelijkbaar voor andere distributies.

Zoals je ziet, vat het voorbeeld kort de relevante onderwerpen samen en presenteert het het doel voor de lezer.

Voorbereiding​

De voorbereidingssectie is handig om eventuele noodzakelijke vereisten te verduidelijken die de lezer moet hebben voordat ze de blogpost kunnen volgen. Dit kan software- of hardwarevereisten zijn, instructies voor het voorbereiden van software zoals een firewall, of simpelweg de gebruiker begeleiden om in te loggen op hun server via SSH of RDP.

We raden sterk aan om onze ZAP-Docs website te doorzoeken voor handleidingen die mogelijk gerelateerd zijn aan de voorbereidingsstappen die je wilt opnemen. Als er een handleiding is over een onderwerp, bijvoorbeeld SSH Initial Access, moet je die linken en de lezer adviseren deze te volgen voordat ze verder gaan.

Veelvoorkomende vereisten voor blogposts zijn:

  • Vereiste software (bijv. Git, Node.js, Python, Docker)
  • Tutorials die de lezer basiskennis kunnen geven (bijv. een andere ZAP-Docs pagina)
  • Gebruikersaccounts zoals API’s
  • Vereiste instellingen (bijv. DNS/SSL)

Een voorbeeld voor een Reverse Proxy blogpost zou zijn:

Om een reverse proxy op te zetten heb je een Linux-server nodig om je proxyserver te hosten en moet je verbinding maken. Gebruik onze [SSH Initial Access](vserver-linux-ssh.md) gids als je hulp nodig hebt. Je hebt ook toegang nodig tot een domein dat je bezit. Voor elk subdomein dat je wilt gebruiken, moet je een `A` DNS-record aanmaken dat verwijst naar het IP-adres van je Linux-server.

Hoofdonderwerp​

Nu is het tijd om het grootste deel van je blogpost te schrijven. We raden aan om de blogpost in een paar secties te splitsen om de lezer betrokken te houden. Er zijn geen strikte regels voor hoe dit moet, maar als vuistregel kun je grote stukken content opdelen in meerdere koppen. Het ZAP Contributions Team helpt je hiermee tijdens het proces.

Als je blogpost stapsgewijze instructies of tutorials bevat, is het handig om het stapnummer en een korte omschrijving in de hoofdonderwerpkop te zetten, bijvoorbeeld Stap 1 - Map aanmaken. Je beschrijft kort wat de lezer in die stap doet om een doel te geven in de eerste zin. Tussen de stappen door kun je een korte introductie en afsluitende overgangs-zinnen maken om de lezer te laten weten wat ze tot nu toe hebben gedaan en wat er in de volgende stappen komt. Deze overgangen geven belangrijke context. Probeer herhaling te vermijden en gebruik verschillende termen om stappen niet steeds te herhalen.

Conclusie​

Tot slot is er de conclusie van de blogpost. Deze sectie sluit de gids af in 1-3 zinnen waarin je uitlegt wat de lezer succesvol heeft bereikt, geleerd of een conclusie geeft van een informatieve gids.

Het is ook handig om verwijzingen te geven naar verdere leesstof of andere blogposts of handleidingen die de gebruiker kan volgen om hun kennis over het onderwerp uit te breiden. Link hier naar bestaande ZAP-Docs handleidingen of blogposts, vooral als ze natuurlijk aansluiten op jouw gids.

Stijl​

De schrijfstijl voor de ZAP-Hosting docs volgt onze overtuiging om hoogwaardige, praktische en makkelijk toegankelijke blogposts te maken die een breed scala aan onderwerpen ondersteunen en lezers van elk ervaringsniveau helpen.

Technisch & correct​

Onze blogposts streven ernaar zo technisch accuraat mogelijk en up-to-date te zijn met de nieuwste info uit de industrie. We verwachten dat elke blogpost goed geschreven en kwalitatief hoogstaande informatie biedt over nieuwe onderwerpen en technologieën, evenals tutorials die gericht zijn op het leren van nieuwe dingen. Als je blogpost stapsgewijze instructies bevat, moet elke stap een duidelijk doel en uitleg hebben, met extra opties en/of flags waar relevant.

Schrijvers moeten altijd proeflezen en hun blogposts testen om te zorgen dat alles technisch klopt en werkt zoals bedoeld voordat ze concepten indienen. Het ZAP Contributions Team leest en test je blogpost waar nodig om te zorgen dat het consistent en feitelijk correct is, of bespreekt verbeteringen als er fouten zijn.

tip

We raden altijd aan om je content door een spellingscontrole te halen voordat je een concept indient. Een handige site hiervoor is: https://languagetool.org/

Praktisch & nuttig​

Tegen de tijd dat een lezer klaar is met het lezen van een blogpost, moet hij iets geleerd, gebouwd of opgezet hebben van begin tot eind. Onze blogposts zijn bedoeld om lezers van elk niveau te ondersteunen, dus je blogpost moet het onderwerp volledig behandelen zodat de lezer kennis opdoet en/of iets bereikt. Als schrijver betekent dit dat je je onderwerp grondig moet behandelen, inclusief alle benodigde details en vereisten waar nodig. Verwijs alleen naar externe websites als er geen bestaande documentatie op ZAP Docs is of als het de lezer helpt extra info te verzamelen die niet noodzakelijk is voor je artikel, maar wel nuttig kan zijn om hun technische kennis uit te breiden. Externe links mogen niet verwijzen naar documentatie van concurrenten.

Vriendelijk, formeel & uitgebreid​

We verwachten dat onze documentatie vooruitstrevend en vriendelijk is, zodat het voor elke lezer toegankelijk is, maar tegelijkertijd formeel blijft. In je blogpost moet je een toon hanteren die voor iedereen acceptabel is, ongeacht ervaring of taalbarrières.

Omdat deze blogposts vooral gericht zijn op het ondersteunen van de lezer om iets te leren en een resultaat te bereiken, verwachten we dat schrijvers de tweede persoon gebruiken (bijv. "Je moet...") in plaats van de eerste persoon (bijv. "Ik denk...") om de lezer betrokken te houden en de focus op hen te houden.

Tot slot moeten alle schrijvers zich houden aan onze gedragscode om te zorgen dat onze blogposts acceptabel zijn voor iedereen, ongeacht leeftijd, etniciteit, genderidentiteit, ervaringsniveau, nationaliteit, religie, politieke voorkeur, seksuele geaardheid, sociaaleconomische status of technologische keuzes. Vermijd elke potentieel aanstootgevende taal en content die verwijst naar bovengenoemde onderwerpen.

Opmaak​

Onze Blog is opgemaakt met Markdown, een veelgebruikte opmaaktaal. Gebruik onderstaande secties om te begrijpen welke elementen we gebruiken en hoe je ze in je blogposts kunt toepassen.

Je mag elke schrijftool gebruiken voor je content, maar we raden sterk aan om StackEdit te gebruiken om je content te schrijven en tegelijkertijd alle handige Markdown-functionaliteiten te behouden. Je kunt het dan direct exporteren naar Google Drive of een andere file-sharing app en een link delen met ons.

tip

Voor meer voorbeelden en uitgebreide uitleg over Markdown, check Markdown Guide voor extra info.

Koppen​

Koppen zijn een van de belangrijkste opmaakopties om blogposts overzichtelijk en logisch te scheiden. De hoofdtitel is een H1-kop.

In onze blogs gebruik je H2-koppen om de blogpost in hoofdsecties te splitsen. Daarna gebruik je H3-koppen om hoofdsecties verder op te delen in subsecties. Een voorbeeld is het opdelen van een hoofdsectie in meerdere stappen om het volgen makkelijker te maken. Er is ook een H4-kop die minder vaak gebruikt wordt, maar hetzelfde doel dient om subsecties te maken.

info

Als je subkoppen gebruikt (bijv. H3 onder H2), zorg dan dat er twee of meer koppen van hetzelfde niveau binnen die sectie zijn, anders is het verkeerd gebruik.

Hier een snel voorbeeld van koppen:

## Installatie
H2 - Hoofdsectie

### Gamebestanden downloaden
H3 - Subsectie van H2

#### Via SteamCMD
H4 - Subsectie van H3

#### Handmatig via GitHub
H4 - Subsectie van H3

### Configuratie voorbereiden
H3 - Subsectie van H2

### Server starten
H3 - Subsectie van H2

Inline markdown​

We gebruiken verschillende inline opmaak om de leesbaarheid van onze blogposts te verbeteren en aan te sluiten bij lezers met uiteenlopende technische skills. Hieronder lees je hoe je ze gebruikt.

Vetgedrukte tekst​

Vetgedrukte tekst gebruik je vooral om info te benadrukken. Bijvoorbeeld:

  • Contextwisselingen tussen stappen
  • Hostnamen, inloggegevens & gebruikersnamen
  • Belangrijke termen

Je maakt tekst vet door dubbele sterretjes te gebruiken, bijvoorbeeld **hallo daar** wordt hallo daar.

Cursief​

Cursief gebruik je vooral om nieuwe technische termen te introduceren. Bijvoorbeeld: we gaan vandaag een reverse proxy opzetten.

Je maakt tekst cursief door één sterretje te gebruiken, bijvoorbeeld *ZAP-Hosting - Meer POWER!* wordt ZAP-Hosting - Meer Power!.

Inline code​

Inline code gebruik je vooral voor technische info zoals URL’s. Voorbeelden:

  • Bestandsnamen en paden (bijv. C:/User/[YourName]/AppData....test.png)
  • URL’s (bijv. https://zap-hosting.com)
  • Poorten (bijv. :30120)
  • Commando’s (bijv. ipconfig)
  • SQL-queries (bijv. SELECT * FROM servers)
  • Toetscombinaties (bijv. ENTER of CTRL + C)

Tabellen​

Tabellen zijn handig om veel herhalende info overzichtelijk te tonen, bijvoorbeeld commando’s, beschrijvingen en gebruik binnen een game. Voorbeeld:

| Commando    | Beschrijving             | Gebruik               |
| ----------- | ------------------------ | --------------------- |
| /help       | Stuurt help commando     | /help [categorie]     |
| /stop       | Stopt de server          | /stop [true/false]    |

Codeblokken​

Codeblokken zijn superhandig voor blogposts met commando’s, scripts, terminal output en meer.

Je maakt een codeblok door te gebruiken vóór en na de tekst. Je kunt ook de programmeertaal aangeven na de eerste voor syntax highlighting. Bijvoorbeeld:

function hello(name) {
    console.log(name)
}

var server = "ZAP-Hosting"
hello(server)

Screenshots​

Screenshots zijn een top manier om lezers visueel door stappen te leiden en we raden ze zeker aan waar passend.

Je voegt een screenshot toe met deze syntax, waarbij je your_url vervangt door de URL van de afbeelding:

![](your_url)

Het beste is om een online image hosting site te gebruiken zoals Imgur om je afbeelding te uploaden en te gebruiken in je markdown.

Terminologie​

In onze blogposts gebruiken we veel belangrijke termen. We verwachten dat je US-Engelse spelling gebruikt voor consistentie in al onze blogs. Hieronder standaardiseren we wat termen die vaak voorkomen.

ZAP-Hosting producten​

Als je een ZAP-Hosting product noemt, zorg dan dat je de juiste naam, spelling en hoofdletters gebruikt. Check dit op de ZAP-Hosting website om te zien hoe het product genoemd wordt.

Door gebruiker gedefinieerde attributen​

In sommige blogposts heb je configuratie-opties nodig zoals gebruikersnamen, hostnamen, domeinen, IP-adressen en URL’s, waarbij de lezer zijn eigen gegevens moet invullen in plaats van onze placeholders.

Gebruik standaard altijd [your_attribute] om statische elementen te onderscheiden van unieke elementen, waarbij [attribute] vervangen wordt door het type attribuut. Bijvoorbeeld, bij een IP-adres schrijf je [your_server_ip] of bij een URL http://[your_server_ip]:30120. Dit maakt duidelijk welke gegevens de lezer moet aanpassen. Geef ook een uitleg of opmerking bij de eerste vermelding zodat alles duidelijk is.

Gebruik zaphosting als standaard hostname, gebruikersnaam of databasenaam.

Software​

Als je software noemt in je blogpost, zorg dan dat je de juiste spelling en hoofdletters gebruikt. Als de softwarewebsite inconsistent is in hoofdletters, houd dan binnen één artikel dezelfde stijl aan voor consistentie.

Link naar de officiële website van de software bij de eerste vermelding, als die beschikbaar is.

Cookie-instellingen