Zum Hauptinhalt springen

Blog-Richtlinien

Blogs Banner

Um sicherzustellen, dass alle ZAP-Hosting Blog-Beiträge in Qualität und Stil einheitlich sind, haben wir eine Reihe von Richtlinien erstellt, die du beachten solltest, wenn du Inhalte für unser Blog-Beitragsprogramm erstellst. Du musst dich genau an unsere Richtlinien halten, um sicherzustellen, dass deine Vorschläge und nachfolgenden Entwürfe zügig bearbeitet werden. Noch wichtiger ist aber, dass du dafür sorgst, dass unsere Leserinnen und Leser beim Lesen unserer Blogs eine bessere und gleichbleibend hochwertige Erfahrung machen.

Unsere Richtlinien für Blog-Beiträge lassen sich in die folgenden Abschnitte unterteilen:

  • Struktur
  • Stil
  • Formatierung
  • Terminologie

Struktur​

Die Blogbeiträge in unserem Beitragsprogramm sollten einer relativ einheitlichen Struktur folgen, die das Interesse des Lesers weckt und ihn mit Informationen und Neuigkeiten versorgt. Das ZAP-Beitragsteam wird mit dir zusammenarbeiten, um sicherzustellen, dass deine Struktur beim Erstellen eines Blogvorschlags angemessen ist.

  • Blog-Titel (H1-Überschrift)
  • Einführungstext
  • Optional: Voraussetzungen (H2 Überschrift)
  • Hauptthema 1 (H2 Überschrift)
  • Hauptthema 2 (H2 Überschrift)
  • Fakultativ: Unterthema 2.1 (H3 Überschrift)
  • Fakultativ: Unterthema 2.2 (H3 Überschrift)
  • ...
  • Hauptthema x (H2 Überschrift)
  • Schlussfolgerung (H2 Überschrift)
info

Denke daran, dass die obigen Angaben nur ein grober Anhaltspunkt sind. Der Hauptteil deines Blogbeitrags kann andere Überschriften haben, je nachdem, was für deinen Inhalt angemessen ist, aber alle Blogbeiträge sollten einheitlich einen Titel, eine Einführung und eine Schlussfolgerung haben, die den Hauptteil umgeben.

Überschriften​

Der Titel deines Blogbeitrags sollte kurz, klar und prägnant sein, um die Aufmerksamkeit der Leser/innen zu wecken. Er sollte genau aussagen, worum es in deinem Blogbeitrag geht, z. B. ob es um Neuigkeiten oder Tipps und Ratschläge geht. Ein Beispiel für einen guten Titel wäre: Top 10 FiveM Police Scripts.

Einführung​

Die Einführung deines Blogbeitrags sollte relativ kurz sein und einen Einblick in das Thema deines Blogbeitrags geben. Bei typischen Blogbeiträgen sollte sie nicht länger als 2 Sätze sein, um eine grobe Vorstellung zu vermitteln.

Versuche, ein paar der folgenden Fragen zu beantworten:

  • Worum geht es in deinem Blogbeitrag?
  • Was ist der Zweck dieses Beitrags?
  • Welche Informationen wird der Leser erhalten?

Die Antworten auf diese Fragen sollten dir helfen, eine kurze und prägnante Einführung für deinen Blogbeitrag zu verfassen, die die wichtigsten Punkte deines Blogbeitrags enthält.

Voraussetzungen​

Dieser Abschnitt ist nur dann notwendig, wenn dein Blog-Beitrag eine Schritt-für-Schritt-Anleitung oder ein Tutorial enthält, z. B. für Skripte oder etwas Kreatives. Der Zweck dieses Abschnitts ist es, dem Leser mitzuteilen, was er wissen muss, bevor er deinen Blog-Beitrag lesen kann, ähnlich wie eine Checkliste vor der Fertigstellung.

Einige Voraussetzungen für Blogpost-Tutorials können zum Beispiel sein:

  • Erforderliche Software (z. B. Git, Node.js, Python, Docker)
  • Tutorials, die dem Leser helfen, Grundkenntnisse zu erwerben (z. B. eine andere ZAP Docs-Seite)
  • Benutzerkonten wie z. B. APIs
  • Erforderliche Einstellungen (z. B. DNS/SSL)

Du solltest eine Aufzählung dieser Voraussetzungen unter der Überschrift des Abschnitts anführen. Bedenke auch hier, dass dies in der Regel nicht erforderlich ist.

Hauptthemen​

Innerhalb dieser Themen schreibst du den Hauptteil deines Blogbeitrags. Wir empfehlen, den Blogbeitrag in mehrere Abschnitte aufzuteilen, damit sich der Leser mit dem Inhalt beschäftigen kann. Es gibt keine strikten Vorgaben, wie diese aufgeteilt werden sollten, aber als Faustregel solltest du versuchen, deinen Inhalt in ein paar Überschriften aufzuteilen. Das ZAP-Beitragsteam wird dir dabei helfen.

Wenn dein Blogbeitrag Schritt-für-Schritt-Informationen oder Anleitungen enthält, ist es sinnvoll, die Nummer des Schritts und eine kurze Beschreibung des Schritts in die Hauptüberschrift aufzunehmen, z. B. Schritt 1 - Erstellen des Ordners. Du solltest kurz beschreiben, was der Leser in dem Schritt macht, um im ersten Satz ein Gesamtziel zu nennen. Zwischen den einzelnen Schritten solltest du eine kurze Einführung und eine abschließende Überleitung einfügen, damit der Leser weiß, was er bisher getan hat und was in den folgenden Schritten passieren wird. Diese Übergänge bieten dem Leser einen wichtigen Kontext. Versuche, Wiederholungen zu vermeiden und verwende eine Reihe von Begriffen, damit sich die Schritte nicht wiederholen.

Schlussfolgerung​

In der Schlussfolgerung solltest du die Informationen zusammenfassen, die du in deinem Blogbeitrag erforscht hast. Das kann in Form von ein oder zwei kurzen Sätzen geschehen oder in Form von Aufzählungspunkten, wenn du es für sinnvoll hältst. Du könntest auch zusätzliche Informationen verlinken, die du zum Lesen empfiehlst, z. B. eine ZAP Docs Anleitung zu deinem Thema.

Stil​

Der Schreibstil für die ZAP-Hosting Docs folgt unserer Überzeugung, qualitativ hochwertige, praktische und leicht zugängliche Blogbeiträge zu verfassen, die ein breites Spektrum an Themen abdecken und Leser/innen mit unterschiedlichem Erfahrungsstand unterstützen.

Technisch & korrekt​

Unsere Blogbeiträge sollen technisch so korrekt wie möglich und auf dem neuesten Stand der Branche sein. In jedem Blogbeitrag erwarten wir, dass die Leser/innen gut geschriebene und qualitativ hochwertige Informationen zu neuen Themen und Technologien sowie Anleitungen erhalten, die sich darauf konzentrieren, dass die Leser/innen neue Informationen lernen. Wenn dein Blog-Beitrag eine Schritt-für-Schritt-Anleitung oder ein Tutorial enthält, sollte jeder Schritt einen klaren Zweck und eine Erklärung haben und gegebenenfalls zusätzliche Optionen und/oder Hinweise enthalten.

Autor/innen sollten ihre Blogbeiträge immer Korrektur lesen und testen, um sicherzustellen, dass alles technisch korrekt ist und wie beabsichtigt funktioniert, bevor sie Entwürfe einreichen. Das ZAP-Beitragsteam wird deinen Blogbeitrag gegebenenfalls durchlesen und testen, um sicherzustellen, dass er konsistent und sachlich korrekt ist, oder um Verbesserungen zu besprechen, wenn ein Fehler festgestellt wird.

tip

Wir empfehlen unseren Autorinnen und Autoren immer, deinen Inhalt durch ein Rechtschreibprüfungsprogramm zu schicken, um sicherzustellen, dass SPAG korrekt ist, bevor sie einen Entwurf einreichen. Eine nützliche Website dafür ist: https://languagetool.org/

Praktisch & nützlich​

Wenn ein Leser einen Blogbeitrag zu Ende gelesen hat, sollte er von Anfang bis Ende etwas gelernt, gebaut oder eingerichtet haben. Deshalb sollte der Inhalt deines Blogbeitrags das jeweilige Thema umfassend behandeln, um sicherzustellen, dass der Leser oder die Leserin etwas gelernt und/oder etwas erreicht hat. Das bedeutet, dass du als Autor dein Thema gründlich abdecken und alle notwendigen Details und ggf. Voraussetzungen angeben musst. Du solltest die Leser nur dann auf externe Websites weiterleiten, wenn es in den ZAP Docs keine Dokumentation zu diesem Thema gibt oder wenn du dem Leser die Möglichkeit gibst, zusätzliche Details zu erfahren, die für deinen Artikel nicht erforderlich sind, aber für die Erweiterung seines Fachwissens nützlich sein können. Externe Links sollten nicht auf Dokumentationen von Wettbewerbern weiterleiten.

Freundlich, formell und umfassend​

Wir erwarten, dass unsere Dokumentation zukunftsorientiert und freundlich ist, damit sie für jeden Leser zugänglich ist, aber gleichzeitig formell bleibt. In deinem Blogbeitrag solltest du darauf achten, dass dein Tonfall für alle Leserinnen und Leser akzeptabel ist, unabhängig von ihrer Erfahrung oder bestehenden Sprachgrenzen.

Da es sich um Blogbeiträge handelt, die in erster Linie darauf abzielen, den Leser zu unterstützen, sich zu bilden und ihn zu einem Ergebnis zu führen, erwarten wir, dass du in der zweiten Person schreibst (z. B. "Du musst...") und nicht in der ersten Person (z. B. "Ich denke..."), um den Leser bei der Stange zu halten und den Fokus auf ihn zu richten.

Schließlich müssen alle Autorinnen und Autoren unseren Verhaltenskodex befolgen, um sicherzustellen, dass unsere Blogbeiträge für jeden akzeptabel sind, unabhängig von Alter, ethnischer Zugehörigkeit, Geschlechtsidentität, Erfahrungsgrad, Nationalität, Religion, politischer Zugehörigkeit, sexueller Orientierung, sozioökonomischem Status oder technologischer Wahl. Du musst jede potenziell beleidigende Sprache und jeden anderen Inhalt vermeiden, der sich auf die oben genannten Themen bezieht.

Formatierung​

Unser Blog ist mit der weit verbreiteten Auszeichnungssprache Markdown formatiert. In den folgenden Abschnitten erfährst du, welche Elemente wir verwenden und wie sie in deinen Blogbeiträgen eingesetzt werden können.

Wir erlauben es den Nutzern, jedes beliebige Schreibprogramm für die Erstellung ihrer Inhalte zu verwenden. Wir empfehlen jedoch, das Tool StackEdit zu verwenden, um deine Inhalte zu schreiben und gleichzeitig die fantastischen Funktionen von Markdown zu nutzen. Du kannst sie dann direkt in dein Google Drive oder eine andere Anwendung zur Dateifreigabe exportieren und erhältst einen Link, den du mit uns teilen kannst.

tip

Weitere Beispiele und ausführliche Erklärungen zu den Funktionen von Markdown findest du in der Markdown Anleitung, die weitere Informationen enthält.

Kopfzeilen​

Überschriften sind eine der wichtigsten Formatierungsoptionen, um Blogbeiträge umfassend und logisch zu trennen. Der Haupttitel besteht aus der H1-Überschrift.

In unseren Blogs sollten H2-Überschriften verwendet werden, um den Blogbeitrag in seine Hauptabschnitte zu unterteilen. Danach sollten H3-Überschriften verwendet werden, um die Hauptabschnitte in Unterabschnitte zu unterteilen. Ein Beispiel dafür, wo dies sinnvoll ist, ist die Aufteilung eines Hauptabschnitts in mehrere Schritte, um das Verfolgen des Blogbeitrags zu erleichtern. Schließlich gibt es noch ein H4-Tag, das seltener verwendet wird, aber demselben Zweck dient, nämlich der Aufteilung in Unterabschnitte.

info

Wenn du Unterüberschriften verwendest (z. B. H3-Überschriften unter den H2-Hauptüberschriften), achte bitte darauf, dass es innerhalb des Abschnitts zwei oder mehr Überschriften der gleichen Ebene gibt, sonst wäre das eine falsche Verwendung.

Hier ist ein kurzes Beispiel für die Verwendung von Überschriften:

## Einrichten von Mods
H2 Hauptabschnitt Überschrift
### Herunterladen der Mods
H3 Unterüberschrift
#### Über Steam Workshop
H4 Zwischenüberschrift
#### Manuell über SteamCMD
H4 subheader
### Die richtige Struktur vorbereiten
H3 subheader
### Installieren der Mods auf deinem Server
H3 subheader

Inline-Markdown​

Wir verwenden eine Reihe von Inline-Formatierungen, um die Lesbarkeit unserer Blog-Beiträge zu verbessern und Leser mit unterschiedlichen technischen Kenntnissen anzusprechen. Lies dir den folgenden Abschnitt durch, um zu verstehen, wie die einzelnen Formatierungen verwendet werden.

Fettgedruckter Text​

Fett gedruckter Text wird hauptsächlich verwendet, um Informationen hervorzuheben. Beispiele dafür sind:

  • Wechsel des Kontexts zwischen den Schritten
  • Hostnamen, Anmeldedaten und Benutzernamen
  • Wichtige Terminologie

Du kannst einfach ein doppeltes Sternchen außerhalb des Zieltextes verwenden, um den Text fett zu machen, z. B. **Hallo dort** ergibt Hallo dort.

Kursivschrift​

Kursivschrift wird in erster Linie verwendet, um neue technische Schlüsselwörter in deinem Artikel einzuführen. Zum Beispiel werden wir heute einen Reverse Proxy einrichten.

Um Kursivschrift zu verwenden, musst du einfach ein einzelnes Sternchen außerhalb des Zieltextes setzen, z.B. *ZAP-Hosting - More POWER!* ergibt ZAP-Hosting - More Power!.

In-line Code​

Die Formatierung von Inline-Code wird vor allem verwendet, um technischere Informationen wie URLs anzuzeigen. Eine umfangreichere Liste von Beispielen umfasst:

  • Dateinamen und Pfade (z. B. C:/Benutzer/[IhrName]/AppData....test.png)
  • URLs (z.B. https://zap-hosting.com)
  • Ports (z.B. :30120)
  • Befehle (z.B. ipconfig)
  • SQL-Abfragen (z. B. SELECT * FROM servers)
  • Tastenkombinationen und Tastendrücke (z.B. ENTER oder CTRL + C)

Tabellen​

Eine weitere nützliche Funktion von Markdown sind Tabellen. Diese können besonders nützlich sein, wenn du eine große Menge an sich wiederholenden Informationen anzeigen musst, z. B. die Befehle, Beschreibungen und Verwendungen, die in einem Spiel verfügbar sind. Im Folgenden findest du ein Beispiel für die Verwendung von Tabellen:

| Befehl | Beschreibung | Verwendung |
| ----------- | ------------------------ | --------------------- |
| /help | Sendet einen Hilfebefehl | /help [Kategorie] |
| /stop | Stoppt den Server | /stop [true/false] |

Codeblöcke​

Ein weiteres sehr nützliches Markdown-Formatierungstool sind Codeblöcke. Sie eignen sich besonders für Blogbeiträge, in denen Befehle, Skripte, Terminalausgaben und mehr verwendet werden.

Um einen Codeblock zu verwenden, setzt du einfach ``` außerhalb des Textblocks ein, den du in einen Block einfügen möchtest. Du kannst auch die Sprache neben dem ersten Satz von dreifachen Anführungszeichen angeben, um die Programmiersprache richtig zu formatieren. Nachfolgend ein Beispiel für die Verwendung von Codeblöcken unter Verwendung von ```js für die Sprache JavaScript.

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

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

Screenshots​

Screenshots sind eine äußerst nützliche Methode, um die Leser visuell durch die Schritte zu leiten, und wir empfehlen, sie zu verwenden, wo es angebracht ist.

Du kannst die folgende Syntax verwenden, um einen Screenshot zu deinem Inhalt hinzuzufügen, indem du deine_url durch die URL des Bildes ersetzt:

![bild](deine_url)

Am besten verwendest du eine Online-Bilder-Hosting-Seite wie Imgur, um das Bild hochzuladen und in deinem Markdown zu verwenden.

Terminologie​

In unseren Blogbeiträgen wird eine Vielzahl von Fachbegriffen verwendet. Wir erwarten von dir, dass du in deinem Blogbeitrag die US-amerikanische Rechtschreibung verwendest, um eine einheitliche Schreibweise in allen unseren Blogbeiträgen zu gewährleisten. In diesem Abschnitt wollen wir einige der Begriffe standardisieren, die wahrscheinlich häufig verwendet werden.

ZAP-Hosting Produkte​

Wenn du dich auf ein ZAP-Hosting-Produkt beziehst, solltest du immer sicherstellen, dass der richtige Name, die richtige Schreibweise und die richtige Großschreibung verwendet werden. Du kannst dies überprüfen, indem du auf die ZAP-Hosting-Website gehst und nachschaust, wie das Produkt auf der jeweiligen Produktseite referenziert wird.

Benutzerdefinierte Attribute​

In einigen Blogbeiträgen werden Konfigurationsoptionen für Elemente wie Benutzer, Hostnamen, Domänen, IP-Adressen und URLs benötigt, bei denen der Leser seine eigenen Angaben anstelle unserer Platzhalter verwenden muss.

Standardmäßig solltest du immer [dein_Attribut] verwenden, um zwischen statischen Elementen und eindeutigen Elementen zu unterscheiden, wobei [Attribut] durch den Typ des Attributs ersetzt werden sollte. Wenn du zum Beispiel eine IP-Adresse nennst, solltest du in deinem Blogbeitrag [your_server_ip] angeben, oder wenn du eine URL nennst, solltest du http://[your_server_ip]:30120 angeben. Dadurch werden die Attribute, die der Leser aufgrund seiner eigenen Konfiguration ändern muss, klar unterschieden. Um sicherzustellen, dass alles verstanden wird, solltest du auch eine Erklärung oder einen Hinweis geben, die/der die Leser/innen darüber informiert, welche Attribute sie/er ändern muss, wenn sie/er zum ersten Mal im Blogpost erwähnt wird.

Du solltest zaphosting als Standard-Hostname, -Benutzername oder -Datenbankname verwenden.

Software​

Wenn du in deinem Blogbeitrag Software erwähnst, solltest du sicherstellen, dass du die korrekte Schreibweise und Großschreibung für den Namen der Software beachtest. Wenn die Software-Website die Groß- und Kleinschreibung nicht beibehält, solltest du die gleiche Groß- und Kleinschreibung in einem Artikel verwenden, um die Konsistenz zu wahren.

Wenn du die Software zum ersten Mal erwähnst, solltest du einen Hyperlink auf die Website der Software setzen, sofern eine offizielle Website vorhanden ist.