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

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

Wir bei Atlantic.Net freuen uns sehr, dass Sie daran interessiert sind, Artikel für uns zu schreiben. Wir freuen uns auf die Partnerschaft zwischen uns, um dazu beizutragen, die Informationen bereitzustellen, die Menschen dazu befähigen, rauszugehen und coole und aufregende Dinge mit Technologie zu machen und zu tun.

Bevor Sie also loslegen, nehmen Sie sich bitte einen Moment Zeit, um diesen Styleguide zu lesen. Es sollte Ihnen eine Vorstellung von dem Ton und der Richtung geben, nach der wir in den Einsendungen suchen, die wir erhalten.

Wenn Sie wissen möchten, wie Sie Ihre Einreichung formatieren, konsultieren Sie bitte unsere Formatleitfäden für How-To- und What-Is-Artikel.

Zielgruppe

Wenn Sie daran interessiert sind, technische Artikel zu schreiben, sind Sie wahrscheinlich die Sorte, die sich über das Lernen und das Teilen dieses Lernens freut. Diese Einstellung ist die Art, die wir bei Atlantic.Net teilen, und die Art, von der wir erwarten, dass sie auch von vielen unserer Leser geteilt wird.

Als Lernende merken wir oft, je mehr wir lernen, desto mehr erkennen wir, wie viel mehr es zu lernen gibt (und wie wenig wir vorher wussten). Kombinieren Sie diese Erfahrung mit unserer Notwendigkeit, mit kontinuierlichen Upgrades, Innovationen und der Einführung neuer Strukturen, Sprachen und Anwendungen Schritt zu halten, und es ist nicht verwunderlich, dass alle Arten von Referenzdokumenten benötigt werden.

Aus dieser Perspektive gehen wir davon aus, dass sich unsere Leser uns nähern und die Ansicht, an die wir unsere Autoren erinnern möchten, zu schreiben. Stellen Sie sich vor, der Leser Ihres Artikels hat Erfahrung in einem anderen Technologie- oder Computerbereich als dem, über das Sie schreiben. Es kann auch hilfreich sein, sich daran zu erinnern, wie es war, als Sie zum ersten Mal davon erfuhren, worüber Sie schreiben. Was war schwierig, oder welche Fehler hast du gemacht? Setzen Sie diese Erfahrung ein!

Wie und warum

Natürlich besteht der Großteil eines Anleitungsartikels aus einer Reihe von Schritten, die befolgt werden müssen, um die Aufgabe zu erfüllen, die Gegenstand des Artikels ist.

Zusätzlich zum Wie möchten wir jedoch, dass ein Atlantic.Net-Artikel auch einige Erklärungen zum Warum enthält. Ein aussagekräftiger Anleitungsartikel enthält zusätzliche Informationen zu optionalen oder empfohlenen Vorgehensweisen.

Beispielsweise könnte man in einem Artikel, der zeigt, wie man einen Ubuntu-Server verwaltet, vorschlagen, Updates auf folgende Weise auszuführen:

sudo apt-get update && sudo apt-get upgrade

Diese Zeile ist eine Verkettung von zwei Befehlen, die separat ausgeführt werden könnten. Der && gibt an, dass der folgende Befehl ausgeführt werden soll, nachdem der vorangehende Befehl erfolgreich abgeschlossen wurde. Diese Befehlsfolge kann mit ; um einen Tastendruck verkürzt werden (Semikolon) statt && , aber ; gibt an, dass der folgende Befehl ausgeführt werden soll, unabhängig davon, ob der vorhergehende Befehl erfolgreich abgeschlossen wurde. In diesem Fall ist diese Verwendung keine bewährte Methode, da Sie sicher sein möchten, dass Sie erfolgreich mit Ihren Paket-Repositories aktualisieren, bevor Sie versuchen, Upgrades zu installieren.

Wenn Sie als root eingeloggt sind, würden Sie natürlich das sudo weglassen , obwohl es oft bequem ist, ist es auch keine bewährte Methode, als root angemeldet zu bleiben.

Stil

Ein Atlantic.Net-Artikel sollte in erster Linie informativ sein, aber das bedeutet nicht, dass er trocken sein muss. Wir ermutigen unsere Autoren, einen freundlichen, persönlichen Stil zu pflegen und sich dennoch auf die Übermittlung von Informationen zu konzentrieren.

Am besten vermeiden Sie Umgangssprache und Umgangssprache. Und da ein beträchtlicher Teil unserer Leserschaft wahrscheinlich international ist und für die Englisch möglicherweise nicht die erste Sprache ist, raten wir auch von der Verwendung von Redewendungen ab.

Ebenso würde es helfen, Ihre Meinung nicht in Artikel einzufügen. Wo es Raum für Interpretationen oder Präferenzen gibt, sollten Sie anerkennen, welcher Teil einen subjektiven Standpunkt darstellt. Die Bereitstellung eines Links oder von Referenzen, die den Standpunkt unterstützen, sofern seriös, ist akzeptabel. Im Zweifelsfall sollten Sie jedoch die subjektiven Teile eines Artikels kürzen.

Grammatik

Ein informativer Artikel ist nur so effektiv wie die Sprache, durch die er seine Informationen vermittelt. Wenn ein Leser nicht verstehen kann, was Sie sagen, wird dieser Leser woanders hingehen. Daher sollten sich alle eingereichten Artikel so genau wie möglich an die englischen Grammatik- und Rechtschreibstandards halten.

Einreichungen mit erheblichen Problemen mit Grammatik oder Rechtschreibung werden zum Umschreiben zurückgeschickt. Wir behalten uns das Recht vor, bei kleineren Problemen Änderungen vorzunehmen.

Ein schlecht geschriebenes Programm kann fehlschlagen oder nicht optimal laufen. Gleiches gilt für Texte, die mit wenig Sorgfalt auf Grammatik- und Rechtschreibregeln und -syntax geschrieben wurden. Bemühen Sie sich, einfach und prägnant zu schreiben, um die meisten sprachlichen Fallstricke zu vermeiden.

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


Linux
  1. So installieren Sie MongoDB unter Ubuntu 18.04 – Leitfaden für Anfänger

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

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

  4. Schreiben Sie für Atlantic.Net FAQ

  5. Wie schreibe ich Regeln für persistente Netznamen?

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

Atlantic.Net Cloud – So fügen Sie eine private IP auf Windows Server 2012 R2 hinzu

Atlantic.Net Cloud – So fügen Sie eine private IP auf Fedora hinzu

Atlantic.Net – Leitfaden für VPN-Verbindungen

So richten Sie Atlantic.Net E-Mail ein

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