📋 [ZU LESEN] Tutorial erstellen: Die besten Praktiken

Anleitungen
1

Ein Tutorial erstellen

Hallo zusammen!

Viele von euch möchten Tutorials auf dem Forum erstellen, um die Gladys-Community zu unterstĂŒtzen, und wir sind euch dafĂŒr mehr als dankbar. :raised_hands:
Dieser Beitrag soll euch die besten Praktiken fĂŒr die Erstellung eines klaren und effektiven Tutorials aufzeigen!

Fangen wir von vorne an

Bevor ihr etwas tut, beginnt mit einem „Hallo“, „Hallo zusammen“, „Hallo allerseits“ – kurz gesagt, einer Form der Höflichkeit (das hat noch nie jemandem geschadet :laughing:).

Dann macht eine kleine EinfĂŒhrung, beschreibt das Ziel eures Tutorials, seine Vor- und Nachteile im Vergleich zu einem anderen Tutorial oder einer anderen Lösung, die bereits auf dem Forum vorhanden ist oder nicht.

Und dann?

Schreibt die Voraussetzungen auf!

Wenn ihr ein Tutorial ohne Voraussetzungen startet, riskiert ihr, den Nutzer (oder euch selbst) von Anfang an zu verlieren, und er wird weitergehen oder Fehler machen und entmutigt sein
 was wir natĂŒrlich nicht wollen.

Es ist wichtig, den Kontext zu verstehen, um zu wissen, woher man kommt und wohin man geht.

Gut, dann fĂŒhrt Appollo in Gladys aus, um Saturne zu starten, und dann gebt den Befehl truc-muche ein, um das Modul machin zu installieren.

Habt ihr mich verloren, oder?
Aber wenn ich stattdessen gemacht hÀtte =>

Voraussetzungen

Das Modul machin erfordert die Installation der Saturne-Bibliothek, die fĂŒr die Verbindung zwischen dem Gladys-Modul und Ihrem Sensor truc zustĂ€ndig ist. Die Saturne-Bibliothek erfordert die Installation von Appollo, einem Plugin fĂŒr Raspberry Pi, das etwas ausfĂŒhrt.
Sie mĂŒssen also zuerst Appollo in Gladys installieren:
Geben Sie dazu den Befehl ein

dann


Ihr werdet verstanden haben, wovon ich spreche.

Ihr werdet mir sagen: „Ja, aber das, was du geschrieben hast, ergibt keinen Sinn!“, ja, das stimmt, aber es veranschaulicht gut die Bedeutung der Voraussetzungen!

Schreibt euer Tutorial

Sobald ihr diese Schritte abgeschlossen habt, könnt ihr endlich mit dem Schreiben eures Tutorials beginnen!

Damit euer Tutorial so lesbar wie möglich ist, nutzt alle verfĂŒgbaren Mittel.
Das Forum unterstĂŒtzt Markdown nutzt es!

FĂŒr diejenigen, die es nicht kennen => Markdown

Versucht, euer Tutorial so gut wie möglich zu formatieren

  • Macht AbsĂ€tze und trennt sie
  • Erstellt Überschriften in verschiedenen GrĂ¶ĂŸen, um die Aufmerksamkeit des Nutzers zu erregen

Schau

Schau

Schau

Schau

Es ist wichtig, den Nutzer nicht in riesige Textblöcke zu ertrÀnken.

  • Markiert eventuelle Codezeilen (das könnt ihr auf zwei verschiedene Arten tun!)

Hallo, ich bin die markierte Codezeile! Man verwendet mich normalerweise fĂŒr große Befehle oder wichtige Textabschnitte, weil ich immer die ganze Zeile einnehme, egal wie groß mein Befehl ist

Hallo, ich bin's nochmal! Man verwendet mich normalerweise fĂŒr kleine Befehle, die in ErklĂ€rungen eingebettet sind, weil ich begrenzt bin

  • Verwende Fettdruck, um die Wichtigkeit eines Schrittes in eurem Tutorial zu kennzeichnen.
  • Im Gegenteil, verwende Kursiv, um eine nĂŒtzliche, aber nicht unbedingt notwendige Information (oder einen kleinen Witz :wink: ) zu kennzeichnen
  • FĂŒgt Fotos/Bildschirmfotos hinzu, um eure Anweisungen zu verdeutlichen
  • Ein ausgezeichnetes Modul, um bestimmte kritische Schritte hervorzuheben, ist Asciinema

Vermeidet Bildschirmfotos von eurem gesamten Bildschirm mit einer Montage, die an die eines 5-jÀhrigen Kindes erinnert! :joy:

image.png1366×768 71.8 KB

Es gibt eine ganze Reihe von kostenlosen kleinen Programmen, um ein Bild zu bearbeiten, wie Paint.net, das sehr einfach zu bedienen ist.

Ihr könnt auch Tools wie GreenShot verwenden, um Bildschirmbereiche zu erfassen und zu bearbeiten/teilen/hosten usw.

Bevorzugt ein kleineres Bild, aber mit einer Àsthetischeren Montage.

image.jpg1145×360 70.2 KB


Ihr könnt auch nummerierte Listen erstellen, um die Reihenfolge der Schritte mit Unterpunkten fĂŒr Unterschritte anzugeben
  1. Schritt 1.1
  2. Schritt 1.2
    • Schritt 1.2.1
    • Schritt 1.2.1.2
  3. Und so weiter


Verwendet eine Dropdown-Liste, wenn euer Tutorial verschiedene Konfigurationen aufweist

Konfiguration 1

Saturne installieren

Konfiguration 2

Apollo installieren

Konfiguration 3

Okay, das reicht, du wirst nicht alle Listen des Forums öffnen! :joy:

Und all diese kleinen Dinge sind hier verfĂŒgbar, wenn ihr euer Tutorial (oder eine beliebige Nachricht) im Forum schreibt

image.jpg862×360 33.1 KB

Ich habe das grĂŒne Icon (nummeriert 1) eingerahmt, auf das ihr klicken mĂŒsst, um auf das Pop-up-MenĂŒ zuzugreifen und somit die Dropdown-Listen (nummeriert 2) verwenden zu können.

Seht ihr, wie einfach es ist, mit einem schönen Screenshot, der die Schritte veranschaulicht, zu verstehen! :wink:

Tutorial beendet?

Schreibt einen kleinen Satz, um euer Tutorial abzuschließen, oder, wenn möglich, macht direkt ein Anwendungsbeispiel, um dem Nutzer den Einstieg zu erleichtern!

Wichtige Punkte!

  • Lest euch selbst! Mehrmals!
  • Nehmt euch Zeit!
  • Achten Sie auf Ihre Rechtschreibung!
  • Versetzt euch in die Lage des Nutzers, wenn ihr schreibt (nicht jeder hat euer Wissen!)
  • Verwende euer Tutorial zu Hause, um zu sehen, ob ihr nichts vergessen habt oder ob etwas vielleicht nicht klar genug ist!
  • Ihr könnt externe Editoren außerhalb des Forums verwenden, um euer Tutorial besser zu visualisieren, bevor ihr es veröffentlicht (ich habe Stackedit verwendet, einen Online-Editor, um diesen Beitrag zu verfassen)
  • Schickt uns nicht euer Tutorial an @C4rlit0 und mich selbst (@LepetitGeek) vor der Veröffentlichung, um euch bei der Formatierung oder Korrektur zu helfen ;)!

Das war’s, ich denke, ich habe alle guten Praktiken abgedeckt, die fĂŒr die Erstellung eines Tutorials im Forum (und ĂŒberall sonst) notwendig sind

Also, viel Spaß beim Tutoren! :grin:

Spoiler

Ich habe euch erwischt! jim carrey GIF - Find & Share on GIPHY

4 „GefĂ€llt mir“