Schreibanleitung

Damit sich Nutzer effektiv mit Ihrem Projekt vertraut machen können, finden Sie hier einige Richtlinien, mit denen Sie Ihre Inhalte am besten in Form einer Schritt-für-Schritt-Anleitung präsentieren können.

Cloud Shell-Funktionen

  • Einzigartiges Layout: Walkthroughs werden in einer Seitenleiste (310 Pixel breit) auf der rechten Seite der Google Cloud Console angezeigt.
  • Navigation: Nutzer können sich mithilfe der Schaltflächen "Weiter" und "Zurück" durch die Schritt-für-Schritt-Anleitung bewegen. Nutzen Sie die Schaltfläche "Vorwärts" (anstelle von "Weiter"), um einen bereits besuchten Schritt erneut zu durchlaufen. Nutzer können die Schritt-für-Schritt-Anleitung auch mit "Anleitung schließen" beenden und später an der Stelle fortfahren, an der sie aufgehört haben.
  • Code to-go: Sie können Code-Snippets in Ihre Schritt-für-Schritt-Anleitung aufnehmen. Sie werden mit dem Inline-Symbol (Kopiersymbol) als Code formatiert, damit Nutzer diese Snippets direkt in Cloud Shell einfügen können.

Konsolensitzung mit Schritt-für-Schritt-Anleitung gestartet

Konsolensitzung mit geöffnetem Schritt-für-Schritt-Anleitungsbereich auf der rechten Seite. Nutzer können Code mithilfe des Inline-Symbols direkt in Cloud Shell kopieren und mit "Zurück" und "Fortfahren" zwischen den Seiten wechseln.

Schreibstil

  • Lockerer Umgangston: Schritt-für-Schritt-Anleitungen sollten informativ und hilfreich sein, aber nicht übermäßig formell.
  • Anrede des Nutzers in der zweiten Person: Verwenden Sie Pronomen der zweiten Person (Verwenden Sie: Sie, Ihre; Verwenden Sie nicht: Wir, ich, unser usw.)
  • Ursache und Wirkung erläutern: Wenn Sie die Nutzer dazu auffordern, einen Schritt auszuführen, erklären Sie die Gründe für die Aktion und das erwartete Ergebnis.
  • Klare Ziele: Bevor Sie den Inhalt für Ihre Schritt-für-Schritt-Anleitung schreiben, legen Sie ein klar definiertes Ziel fest, das Ihre Nutzer erreichen sollen. Gestalten Sie Ihre Schritt-für-Schritt-Anleitung unter Berücksichtigung dieses Ziels.
Original Überarbeitet Verbesserung
Auf der nächsten Seite erfahren Sie, wie Sie eine neue Schritt-für-Schritt-Anleitung erstellen. Fahren Sie fort mit dem nächsten Schritt, um mit der Einrichtung für Ihre Schritt-für-Schritt-Anleitung zu beginnen. Auf den Nutzer konzentrieren; aktive Verbform verwenden

Informelle Sprache verwenden

Führen Sie folgenden Befehl aus:

``` gcloud projects list --format="table[box,title=Projects](name, projectId)" ```

Führen Sie den folgenden Befehl aus, um eine tabellarische Liste aller Ihrer Projekte und ihrer ID-Nummern mit dem Titel "Projects" anzuzeigen: ``` gcloud projects list --format="table[box,title=Projects](name, projectId)" ``` Herangehensweise im Voraus begründen, um die Erwartungen an das Ergebnis festzulegen
Let's get started! Let's get started!

Diese Anleitung zeigt Ihnen, wie Sie Ihre eigene interaktive exemplarische Schritt-für-Schritt-Anleitung erstellen. Außerdem sind Verweise auf das Generieren einer Schaltfläche enthalten, mit der Nutzer Ihre fertige Schritt-für-Schritt-Anleitung starten können.

Fassen Sie die in der Schritt-für-Schritt-Anleitung behandelten Lektionen klar und deutlich zusammen.

Achten Sie beim Schreiben von Inhalten darauf, diesen Fokus beizubehalten!

Best Practices

  • Fassen Sie sich kurz: Die Schritt-für-Schritt-Anleitung unterliegt spezifischen Platzbeschränkungen, weshalb einem Nutzer jeweils nur eine begrenzte Menge an Informationen angezeigt werden können. Vermeiden Sie große Textblöcke, die schwer zu lesen sind und vertikales Scrollen erfordern; gliedern Sie stattdessen Informationen in übersichtlichen Sinneinheiten.

    • Schreiben Sie wenn möglich nicht mehr als fünf Schritte und drei Code-Snippets pro Seite.

    • Absätze sollten im Idealfall fünf Zeilen oder weniger umfassen und sich auf ein einzelnes Konzept beziehen.

    • Wenn eine Seite länger sein muss, sollte sie maximal doppelt so lang wie das Fenster sein.

    • Code- und Terminalblöcke sollten so übersichtlich sein, dass man sie gut lesen kann:

      • Streben Sie zehn Zeilen oder weniger an.
      • Beschränken Sie sich pro Zeile möglichst auf höchstens 80 Zeichen, um den horizontalen Bildlauf zu reduzieren.
      • Vermeiden Sie Codeblöcke mit mehreren Befehlen, damit Nutzer nicht mehrere Befehle gleichzeitig kopieren und ausführen müssen.
  • Einführungsseite: Beginnen Sie Ihre Schritt-für-Schritt-Anleitung mit einer Einführung.

    • Erwartungen festlegen: Erklären Sie kurz, wie Ihre Nutzer vom Durchführen dieser Schritt-für-Schritt-Anleitung profitieren.
    • Geschätzter Zeitaufwand: Schätzen Sie ungefähr ein, wie lange Nutzer voraussichtlich für die Schritt-für-Schritt-Anleitung brauchen werden. Erstellen Sie eine Schritt-für-Schritt-Anleitung, die in weniger als 15 Minuten abgeschlossen werden kann. Wenn Ihre Schritt-für-Schritt-Anleitung länger ist (oder aus mehr als 15 eng beschriebenen Seiten besteht), sollte sie in mehrere kürzere Schritt-für-Schritt-Anleitungen aufgeteilt werden.
    • Voraussetzungen zu Beginn nennen: Geben Sie alle erforderlichen Ressourcen oder Zugriffsrechte an, die der Nutzer benötigt, um die Schritt-für-Schritt-Anleitung unterbrechungsfrei auszuführen.
    Beispiel

    ## Los gehts!

    Verschaffen Sie Ihren Nutzern mit einer interaktiven Schritt-für-Schritt-Anleitung einen schnellen Einstieg in Ihr Projekt.

    Diese Anleitung zeigt Ihnen, wie Sie Ihre eigene interaktive Schritt-für-Schritt-Anleitung (wie diese) erstellen. Außerdem sind Verweise auf das Generieren einer Schaltfläche enthalten, mit der Nutzer Ihre fertige Schritt-für-Schritt-Anleitung starten können.

    **Zeit zum Durcharbeiten**: etwa 10 Minuten

    **Voraussetzungen**: Ein GCP-Konto

    Mit einem Klick auf die Schaltfläche **Weiter** gelangen Sie zum nächsten Schritt.

  • Hintergrundseite

    • Überblick bieten: Es ist oft hilfreich, eine Set the scene: mit Kontext zu versehen. Das kann bedeuten, dass Sie einen kurzen Überblick über das Produkt geben oder die wichtigsten Funktionen einer UI schnell durchgehen.
    Beispiel

    ## Was ist Cloud Shell?

    Bevor Sie anfangen, gehen wir kurz auf die Möglichkeiten von Cloud Shell ein.

    Cloud Shell ist eine persönliche, gehostete virtuelle Maschine mit vorinstallierten Entwicklertools für Google Cloud-Produkte. Diese interaktive Shell-Umgebung enthält einen integrierten Codeeditor, nichtflüchtigen Festplattenspeicher und eine Webvorschaufunktion. Wenn Sie nur mit der Befehlszeile arbeiten möchten, verwenden Sie [console.cloud.google.com/cloudshell](https://console.cloud.google.com/cloudshell).

    Sie können Ihre Nutzer auf Cloud Shell leiten, damit sie schnell mit Ihrem Projekt beginnen, einen Anwendungsfall durchgehen und sich mit der Funktionalität Ihres Projekts vertraut machen können.

    Fahren Sie mit dem nächsten Schritt fort, um mit der Einrichtung Ihrer Schritt-für-Schritt-Anleitung zu beginnen.

  • Einfache Beispiele:

    • Hallo Welt: Das erste Beispiel, das Sie bereitstellen, sollte so einfach sein, dass Sie es ohne viel Erklärung testen können. Es sollte Ihr Äquivalent zu "Hallo Welt" sein. Verwenden Sie dieses Beispiel als Basis, auf die weitere Konzepte aufbauen, die in der Schritt-für-Schritt-Anleitung veranschaulicht werden.
    Beispiel

    ## Schritt-für-Schritt-Anleitungen im Kontext

    Was Sie jetzt sehen, ist eine Schritt-für-Schritt-Anleitung im Kontext.

    Der Inhalt wird zusammen mit der Cloud Shell-Umgebung angezeigt, in der Sie die Schritte der Schritt-für-Schritt-Anleitung ausführen können. Da single screen Schritt-für-Schritt-Anleitung und Entwicklungsumgebung an derselben Stelle erscheinen, können Nutzer mit einem normalen Einzelbildschirm das Projekt so leichter nachvollziehen.

    Versuchen Sie jetzt, einen Befehl auszuführen:

    ```bash

    echo "Hallo Cloud Shell"

    ```

    **Tipp**: Klicken Sie neben dem Codefeld auf "Kopieren", um den Befehl im Cloud Shell-Terminal einzufügen und auszuführen.

    Als Nächstes schreiben und starten Sie eine grundlegende Schritt-für-Schritt-Anleitung.

  • Schritt-für-Schritt-Anleitung – Inhalt

    • Durchdachte Formatierungen: Textformatierungen (fett, kursiv usw.) lenken ab. Verwenden Sie diese nur bei Bedarf und zu Ihrem Vorteil (für Warnungen, zentrale Fakten usw.).
    • Konsistente Grammatik: Verwenden Sie beim Beschreiben von Nutzeraktionen die Imperativform und achten Sie darauf, dass Sätze mit einem Punkt beendet werden.
    • Verweise auf Links: Fügen Sie, sofern dies für den Kontext wichtig ist, ergänzende Links ([Linktext](Link-URL)) hinzu, damit Nutzer selbst nachschlagen können.
    • Hervorhebungen statt Screenshots verwenden: Indem Sie hervorheben, wo sich UI-Elemente in der Console befinden, können Nutzer die Elemente identifizieren, ohne ein Bild absuchen zu müssen.
    • Alternative Ansicht: Falls möglich geben Sie einen Link zu Ihrem Schritt-für-Schritt-Anleitungsinhalt an, der als statischer Inhalt angeboten wird. Auf diese Weise kann der Nutzer selber wählen, wie er die bereitgestellten Informationen konsumieren möchte.
    • Tipps sind empfehlenswert: Fügen Sie gegebenenfalls Tipps hinzu ("**Tipp:**"), um den Nutzern intuitivere Lösungen und Best Practices zu bieten.
    Beispiel

    ## In Markdown schreiben

    Verwenden Sie zum Schreiben Ihrer Schritt-für-Schritt-Anleitung [Markdown](https://en.wikipedia.org/wiki/Markdown) und befolgen Sie die folgenden Richtlinien:

    ### Titel bearbeiten

    Ändern Sie den Titel dieser Schritt-für-Schritt-Anleitung ('"# Einführung in das Schreiben von Schritt-für-Schritt-Anleitungen in Cloud Shell") so:

    ```

    # So lerne ich, eine Schritt-für-Schritt-Anleitung zu schreiben

    ```

    ### Einen neuen Schritt hinzufügen

    Nun fügen Sie direkt nach dem Titel einen weiteren Schritt ein:

    ```

    ## Schritt 1

    Dies ist ein neuer Schritt, den ich gerade hinzugefügt habe.

    ```

    Jeder "Schritt" einer Schritt-für-Schritt-Anleitung wird auf einer eigenen Seite angezeigt.

    **Tipp**: Verwenden Sie die Schaltflächen 'Zurück' und 'Weiter/Vorwärts', um die einzelnen Schritte durchzugehen.

  • Zusammenfassung

    • Glückwunsch: Denken Sie daran, ein Trophäensymbol (<walkthrough-conclusion-trophy></walkthrough-conclusion-trophy>) hinzuzufügen, um den Nutzern dafür zu danken, dass sie sich die Zeit für die Schritt-für-Schritt-Anleitung genommen haben.
    • Zusammenfassung: Fassen Sie wichtige Lektionen zusammen, die Nutzer aus der Schritt-für-Schritt-Anleitung mitnehmen sollen.
    • Nächste Schritte: Helfen Sie den Nutzern auf ihrem weiteren Weg, indem Sie die nächsten Schritte nennen – das können Leseempfehlungen, zusätzliche Ressourcen oder sogar eine andere Schritt-für-Schritt-Anleitung sein.
    • Nutzer unterstützen: Bitten Sie sie, alle Testressourcen, die sie für die Zwecke der Schritt-für-Schritt-Anleitung erstellt haben, zu bereinigen, um unerwünschte Rechnungsgebühren zu vermeiden.
    Beispiel

    ## Glückwunsch!

    <walkthrough-conclusion-trophy></walkthrough-conclusion-trophy>

    Fertig!

    Sie können jetzt festlegen, dass Nutzer Ihre Schritt-für-Schritt-Anleitung in Cloud Shell starten und Ihr Projekt problemlos verwenden können.

    Eine vollständige Liste der Schreibtools für Cloud Shell-Schritt-für-Schritt-Anleitungen finden Sie in der [Markdown-Referenz für Schritt-für-Schritt-Anleitungen](https://cloud.google.com/shell/docs/walkthrough-markdown-reference).

    **Denken Sie daran, eigene Projekte zu bereinigen**: Wenn Sie Testprojekte erstellt haben, löschen Sie diese jetzt, um unnötige Kosten zu vermeiden. Verwenden Sie `gcloud projects delete <PROJECT-ID>`.