Open Telekom Cloud für Geschäftskunden

Themenideen und Best Practices für Tutorials

Gesuchte Themen

Mögliche Themen für Workshops und Tutorials umfassen alles, was den Alltag von Anwendern, Entwicklern, Administratoren und DevOps einfacher macht. Dazu zählen beispielsweise:

  • Automatisierung und Infrastructure as Code: Wie konzipiere ich ein Setup nach dem Cattle- und nicht nach dem Pet-Prinzip? Wie setze ich Deployment-Frameworks wie Ansible, Terraform, oder Heat ein?
  • Entwicklung und Testen: Welche Best Practices vereinfachen das Arbeiten mit einer CI/CD-Pipeline? Wie lassen sich diese Abläufe mit Monitoring überwachen? Wie gelingt das Testen in einer Cloud-Umgebung?
  • Data-Science, Machine Learning und Künstliche Intelligenz: Wie lassen sich Frameworks wie Pandas, Tensor Flow oder Keras schnell aufbauen und verwalten? Welche Ausstattung mit CPUs, Speicher und vor allem GPUs und FPGAs funktionieren am besten?
  • IoT und Edge: Wie gelingt das Zusammenspiel von dezentralen Edge-Devices wie dem Raspberry Pi und zentralen Queues wie Kafka und Time Series Datenbanken? Wie lassen sich aufgezeichnete Sensordaten auswerten und visualisieren?
  • Orchestrierung und Container: Welche Tipps und Tricks helfen beim Einstieg in eine Microservice-Architektur? Wie verwaltet man am besten APIs? Welche Schritte ermöglichen eine sanfte Migration von Mode 1 zu Mode 2?

Tipps zum Aufbau

Ideal für Euer Tutorial ist eine Länge zwischen 5.000 und 15.000 Zeichen. Die Texte könnt Ihr sowohl auf Deutsch als auch auf Englisch schreiben. Unsere Redaktion akzeptiert jedes Text- und Dateiformat, doch Markdown oder Restructured Text erleichtern ihr die Arbeit besonders. Euren Lesern vereinfacht ein gut aufgebauter Text das Verständnis. Wenn Ihr Euch vor dem Schreiben über folgende Punkte im Klaren seid, fällt es Euch leichter, dem Text eine gelunge Struktur zu geben.

  • Über welchen Kontext sprechen wir?
    Ein guter Einstieg ist eine allgemeine Aussage zum Thema des Tutorials. Eure Leser sollten dieser von ganzem Herzen zustimmen können. Ein Beispiel: "Die Bereitstellung einer öffentlichen Cloud-Plattform ist eine komplexe Aufgabe, da es viele unterschiedliche Komponenten und Prozesse zu betreuen gibt.“
  • Was ist die Herausforderung, die Ihr lösen wollt?
    Benennt genau das Problem, welches Euer Tutorial lösen soll. Beispiel: "Beim Betrieb der X-Lösung haben Nutzer häufig mit dem Ausfall der Y-Komponenten zu kämpfen und verbringen zu viel Zeit mit Fehlerbehebung. Mit diesem Tutorial wollen an die Ursache des Problems gehen und eine langfristige Lösung schaffen.“
  • Was ist Euer Ansatz?
    Eine kurze Zusammenfassung der Lösung gibt dem Leser einen ersten Überblick und macht das Vorgehen einfacher verständliche. Ein Beispiel: "Wir haben uns eine clevere Überwachungslösung ausgedacht, die zunächst Daten sammelt, sie speichert, die Trends visualisiert und die verantwortlichen Teams informiert, wenn Probleme auftreten. Diese vier Schritte werden wir nun im Detail erläutern."
  • Wie werdet Ihr das Problem technisch lösen?
    Dies ist der Hauptteil des Dokuments. Er wird den weitaus größten Teil des Dokuments abdecken. Erklärt Euren Lesern, wie sie Schritt für Schritt vorgehen müssen.
  • Was ist Euer Fazit?
    Was sind die wichtigsten Punkte Eures Tutorials? Habt Ihr einen Aufruf zum Handeln? Selbst wenn die Leser fast alle Details Ihrer Präsentation vergessen – was wäre die Schlüsselbotschaft, an die sie sich erinnern und die sie an andere weitergeben sollen?

Empfehlungen zur Sprache und Gestaltung

Hier ein paar Tipps zur Umsetzung Eures Tutorials, die vielleicht nicht in alle Situationen zutreffen – es kann Ausnahmen geben.

  • Strukturiert den Text – aber nicht zu sehr
    Eine Struktur mit Absätzen und Zwischenüberschriften machen Euren Text übersichtlicher. Übertreibt es aber nicht mit zu vielen unterschiedlichen Ebenen von Zwischenüberschriften, die Euer Tutorial zu komplex machen. Versucht, Euch an eine Überschrift für das gesamte Dokument und eine Ebene von Zwischenüberschriften zu halten.
  • Bildet kurze Sätze
    Lange Sätze sind immer schwer zu lesen. Wenn Eure Leser zudem im Internet veröffentlichte Dokumente auf schmalen Mobilgeräten lesen, fällt ihnen das Verständnis besonders schwer. Macht daher einfach mal einen Punkt.
  • Schreibt aktiv
    Wenn Ihr den passiven Modus verwendet, bleibt Eurem Lesen unklar, wer oder was der Handelnde im Satz ist und das Verständnis fällt ihm schwerer. Beispiel: "Nachdem die Nutzerrechte in /etc/passwd aktualisiert wurden, kann sich der Admin im System anmelden". Besser: "Nachdem das XY-Skript die Nutzerrechte in /etc/passwd aktualisiert hat, kann sich der Admin beim System anmelden".
  • Verwendet Tabellen, Diagramme und Bilder
    Bilder wie zum Beispiel Screenshots machen ein Tutorial viel anschaulicher und verständlicher. Fügt bitte Bildunterschriften hinzu, die erklären, was auf dem Bild zu sehen ist. Stellt Euch dabei vor, Ihr würdet es einer blinden Person beschreiben. Diese Beschreibung kann ruhig drei bis vier Zeilen lang sein. Es macht dabei nichts, wenn sie Informationen enthält, die redundant zum Text sind.

Best Practices


Jetzt Ideen einsenden

Bitte geben Sie eine gültige Telefonnummer an, damit wir Sie kontaktieren können.

* Pflichtfelder

  • Communities

    Die Open Telekom Cloud Community

    Hier treffen sich Nutzer, Entwickler und Product Owner um sich zu helfen, auszutauschen und zu diskutieren.

    Jetzt entdecken 

  • Telefon

    Kostenfreie Experten-Hotline

    Unsere zertifizierten Cloud-Experten stehen Ihnen mit persönlichem Service zur Seite.

     0800 3304477 (aus Deutschland)

     
    +800 33044770 (aus dem Ausland)

     
    24 Stunden am Tag, 7 Tage die Woche

  • E-Mail

    Unser Kunden-Service steht Ihnen per E-Mail-Support kostenlos zur Verfügung.

    E-Mail schreiben