GNU/Linux >> LINUX-Kenntnisse >  >> Linux

Formatleitfaden für Atlantic.Net What-Is-Artikel

Einführung

Wenn Sie denken, dass Sie für Atlantic.Net schreiben möchten, sollten Sie damit beginnen, unser Anmeldeformular auszufüllen falls noch nicht geschehen.

Artikel für Atlantic.Net sollten den in den folgenden Abschnitten angegebenen Standards entsprechen:

Abschnitte (einschließlich Einführung, Zielgruppe und das Tutorial selbst)
Format (Markdown oder einfaches HTML)
Bilder/Screenshots
Originalarbeit

Weitere Hinweise finden Sie auch in unserem Styleguide.

Abschnitte

Jeder What-Is-Artikel sollte mit dem Abschnitt Zielgruppe beginnen, der durch H5-Überschriften gekennzeichnet ist. Die Zielgruppe sollte angeben, welches Maß an Erfahrung oder Wissen der Leser Ihrer Meinung nach besitzen sollte, um das Thema zu verstehen, über das Sie schreiben werden. Das Mindesterfahrungsniveau für die Zielgruppe eines What-Is-Artikels sollten IT-Experten auf Einstiegsniveau sein. Alle Themen, bei denen davon ausgegangen wird, dass ein Leser mit dem in einem anderen Atlantic.Net-Artikel behandelten Material vertraut ist, können hier verlinkt werden.

Beispiel:

Zielgruppe

In diesem Artikel wird davon ausgegangen, dass Sie mit den grundlegenden Konzepten hinter der Public Key Infrastructure (PKI) vertraut sind. Als Auffrischer lesen Sie diese Einführung zu den Grundlagen der Public-Key-Kryptografie.

Nach der Zielgruppe sollte der Einführungsabschnitt kommen, der kurz den Umfang des Artikels beschreibt. Das Wort „Einführung“ sollte in H3-Überschriften enthalten sein.

Der Großteil des Artikels folgt der Einführung.

Formatieren

What-Is-Artikel für Atlantic.Net können in Markdown oder einfachem HTML eingereicht werden.

Unterstützte Textformatierung:Kopfzeilentext, Codeblöcke, Inline-Code (für Befehle und Tastenanschläge), kursiv (für Variablen) und fett (zur Hervorhebung).

Überschriften

H1 sollte für den Titel des Artikels verwendet werden. Der Titel sollte immer der erste Teil eines Artikels sein.

H2 sollte für wesentliche Abschnitte des Artikels verwendet werden.

H3 sollte für „Einführung“, „Zielgruppe“ und Unterabschnitte verwendet werden.

Codeblöcke

What-Is-Artikel sollten die Verwendung von Code oder Codeblöcken vermeiden (diese Verwendung ist in einem How-To-Artikel häufiger anzutreffen). Wenn Sie jedoch hervorheben, wie Code zu Ihrem Thema aussieht, sollte er in einen Codeblock eingeschlossen werden.

Wenn Sie inline auf Code verweisen, können Sie den code verwenden Schild. Diese Verwendung sollte sich darauf beschränken, sich auf einen Teil des Codes zu beziehen, dessen Form oder Funktion für das Thema relevant ist. Denken Sie daran, dass das Ziel der meisten What-Is-Artikel nicht darin besteht, jemandem beizubringen, wie man eine Aufgabe bewältigt, sondern in einem allgemeineren Sinne ein technologiebezogenes Konzept zu erklären.

Beispiel:

Das gemeinsame Erbe von UNIX, das viele nachfolgende Betriebssysteme teilen, zeigt sich in einigen der Befehle, die sie alle gemeinsam haben, wie z. B. cp zum kopieren.

Variables/benutzerdefiniertes Informationsformat

Variablen oder hostspezifische Informationen sollten in einem What-Is-Artikel selten vorkommen. Variablen oder benutzerdefinierte Konfigurationseinträge (z. B. Hostnamen) sollten jedoch bei Bedarf kursiv dargestellt werden. Unser Parser färbt außerdem alle kursiv gedruckten Einträge grün .

Hervorhebung

Wenn Sie eine Hervorhebung angeben möchten, verwenden Sie fett .

Tastenanschläge

Wenn es darum geht, Tastenanschläge innerhalb des Textes zu referenzieren, schließen Sie sie in einen code span ein . Auch diese Art der Einbeziehung sollte in einem What-Is-Artikel selten vorkommen.

Beispiel:

Die Enter Taste kann immer noch als Return bezeichnet werden Taste auf einigen Tastaturen, was auf die Verwendung auf Schreibmaschinen zurückgeht, um einen Wagenrücklauf anzuzeigen.

Verwenden Sie für Tastenanschläge, bei denen mehrere Tasten gleichzeitig gedrückt werden müssen, ein Pluszeichen (+) zwischen den Tasten.

Beispiel:

Die Tastenkombination von Ctrl+Alt+Del erhielt in manchen Kreisen den Beinamen „Drei-Finger-Gruß“.

Bilder

Wir empfehlen die Verwendung von Bildern und Screenshots, um viele der Punkte zu veranschaulichen, die in einem Was-Ist-Thema angesprochen werden können. Bilder sollten eine maximale Breite von 730 Pixel haben. Sie können das Bild selbst erstellen oder ein Bild verwenden, das unter einer Lizenz wie beispielsweise Creative Commons zur Wiederverwendung lizenziert ist.

Bitte fügen Sie einen Link zum Bild mit der URL hinzu, unter der es derzeit gehostet wird. Bei zur Veröffentlichung angenommenen Artikeln werden alle zugehörigen Bilder heruntergeladen und auf unseren Servern gehostet. Zusammen mit Bildern benötigen wir Folgendes:

Bildname :Format anet-articlename-## (wobei der ## wird durch eine Zahl ersetzt, z. B. anet-what_is_a_vpn-01 ).
Alt-Text :eine kurze Beschreibung des Bildes, falls es nicht geladen wird.
Bildunterschrift :eine kurze Beschreibung, die unter dem Bild erscheint.
Namensnennung :bei Verwendung eines zur Wiederverwendung lizenzierten Bildes, einschließlich der entsprechenden Zuordnungsinformationen (Titel, Autor, Quelle, Lizenz usw.)

Alle eindeutig identifizierbaren Informationen sollten unkenntlich gemacht werden, vorzugsweise durch die Verwendung von auffälligen Platzhalternamen (wie „example.com“ oder „192.168.0.2“).

Originalarbeit

Alle für Atlantic.Net geschriebenen Artikel müssen Originalarbeiten sein. Atlantic.Net toleriert kein Plagiat oder die Wiederverwendung bereits vorhandener Arbeiten.

Ebenso sollten alle Bilder und Screenshots einzigartig sein, mit Ausnahme der Bilder, deren ordnungsgemäße Verwendung einer entsprechend zugewiesenen Lizenz entspricht.

Erfahren Sie mehr über unsere VPS-Hosting-Services und den VPS-Hosting-Preis.


Linux
  1. 10 Containerleitfäden für Systemadministratoren

  2. Linux – Welches Dateisystem sollte ich bei der Installation von Linux auf einem USB-Laufwerk verwenden, um die beste Leistung zu erzielen?

  3. Gewusst wie:Style Guide für Atlantic.Net-Artikel

  4. Formatleitfaden für Atlantic.Net How-To-Artikel

  5. Schreiben Sie für Atlantic.Net FAQ

Atlantic.Net Cloud – Wie kann ich meine Kundeninformationen für mein Cloud-Konto aktualisieren?

Atlantic.Net Cloud – Kann ich meinen Cloud-Server vergrößern?

Atlantic.Net Cloud – So stellen Sie einen Cloud-Server neu bereit

Atlantic.Net – Leitfaden für VPN-Verbindungen

So richten Sie Atlantic.Net E-Mail ein

Atlantic.Net Trusted Access – Leitfaden zur Multi-Faktor-Authentifizierung