Technisches Schreiben für Anfänger - Ein AZ-Leitfaden zu den Grundlagen des technischen Bloggens

Wenn Sie Schreiben und Technologie lieben, könnte technisches Schreiben eine geeignete Karriere für Sie sein. Es ist auch etwas anderes, was Sie tun können, wenn Sie Technik lieben, aber nicht den ganzen Tag Lust auf Codierung haben.

Technisches Schreiben ist möglicherweise auch für Sie geeignet, wenn Sie gerne lernen, indem Sie andere unterrichten, zu Open Source-Projekten beitragen und anderen beibringen, wie dies auch funktioniert, oder wenn Sie im Grunde genommen gerne komplexe Konzepte auf einfache Weise durch Ihr Schreiben erklären.

Lassen Sie uns in die Grundlagen eintauchen und lernen, was Sie wissen und beachten sollten, wenn Sie mit dem technischen Schreiben beginnen.

Inhaltsverzeichnis

In diesem Artikel sehen wir uns an:

  • Was ist technisches Schreiben?
  • Vorteile des technischen Schreibens
  • Notwendige Fähigkeiten als technischer Redakteur
  • Der technische Schreibprozess
  • Plattformen zum Veröffentlichen Ihrer Artikel
  • Kurse für technisches Schreiben
  • Foren und Communities für technisches Schreiben
  • Einige erstaunliche technische Redakteure werden folgen
  • Letzte Worte und Referenzen

Was ist technisches Schreiben?

Technisches Schreiben ist die Kunst, detailorientierte Anweisungen bereitzustellen, um Benutzern das Verständnis einer bestimmten Fähigkeit oder eines bestimmten Produkts zu erleichtern.

Und ein technischer Redakteur ist jemand, der diese Anweisungen schreibt, die auch als technische Dokumentation oder Tutorials bezeichnet werden. Dies kann Benutzerhandbücher, Online-Support-Artikel oder interne Dokumente für Codierer / API-Entwickler umfassen.

Ein technischer Redakteur kommuniziert auf eine Weise, die technische Informationen darstellt, so dass der Leser diese Informationen für einen bestimmten Zweck verwenden kann.

Vorteile des technischen Schreibens

Technische Redakteure sind lebenslange Lernende. Da die Aufgabe darin besteht, komplexe Konzepte in einfachen und unkomplizierten Begriffen zu kommunizieren, müssen Sie mit dem Bereich, über den Sie schreiben, vertraut sein. Oder sei bereit, etwas darüber zu lernen.

Das ist großartig, denn mit jedem neuen technischen Dokument, das Sie recherchieren und schreiben, werden Sie zu einem Experten auf diesem Gebiet.

Technisches Schreiben vermittelt Ihnen auch ein besseres Gefühl für das Einfühlungsvermögen der Benutzer. Es hilft Ihnen, mehr auf das zu achten, was die Leser oder Benutzer eines Produkts fühlen, als auf das, was Sie denken.

Sie können auch als technischer Redakteur Geld verdienen, indem Sie Beiträge für Organisationen leisten. Hier sind einige Organisationen, die Sie dafür bezahlen, dass Sie für sie schreiben, wie Smashing Magazine, AuthO, Twilio und Stack Overflow.

Darüber hinaus können Sie einen Beitrag zu Open Source-Communitys leisten und an kostenpflichtigen Open Source-Programmen wie Google Season of Docs und Outreachy teilnehmen.

Sie können das technische Schreiben auch als Vollzeitberuf aufnehmen - viele Unternehmen benötigen jemanden mit diesen Fähigkeiten.

Notwendige Fähigkeiten als technischer Redakteur

Verstehen Sie die Verwendung von richtigem Englisch

Bevor Sie über das Schreiben nachdenken, müssen Sie über gute Kenntnisse der englischen Sprache, ihrer Zeitformen, Schreibweisen und der grundlegenden Grammatik verfügen. Ihre Leser möchten keinen Artikel lesen, der von falscher Grammatik und schlechter Wortwahl geprägt ist.

Wissen, wie man Dinge klar und einfach erklärt

Wenn Sie wissen, wie eine Funktion implementiert wird, müssen Sie den Prozess nicht unbedingt anderen mitteilen.

Um ein guter Lehrer zu sein, muss man einfühlsam sein und in der Lage sein, Begriffe auf eine Weise zu unterrichten oder zu beschreiben, die für das beabsichtigte Publikum geeignet ist.

Wenn Sie es einem Sechsjährigen nicht erklären können, verstehen Sie es selbst nicht. Albert Einstein

Besitzen Sie einige Schreibfähigkeiten‌‌

Ich glaube, dass Schriftsteller gemacht und nicht geboren werden. Und Sie können nur lernen, wie man schreibt, indem Sie tatsächlich schreiben.

Sie werden vielleicht nie wissen, dass Sie es in sich haben, zu schreiben, bis Sie Stift auf Papier gebracht haben. Und es gibt nur einen Weg, um festzustellen, ob Sie über Schreibfähigkeiten verfügen, und zwar durch Schreiben.

Deshalb ermutige ich Sie, heute mit dem Schreiben zu beginnen. Sie können mit einer der Plattformen beginnen, die ich in diesem Abschnitt aufgeführt habe, um Ihre Schreibmuskeln zu dehnen.

Und natürlich ist es auch ein großer Vorteil, Erfahrung in einem technischen Bereich zu haben.

Der technische Schreibprozess

Analysieren und verstehen Sie, wer Ihre Leser sind

Der größte Faktor, der beim Schreiben eines technischen Artikels berücksichtigt werden muss, ist Ihre beabsichtigte / erwartete Zielgruppe. Es sollte immer im Vordergrund Ihres Geistes stehen.

Ein guter technischer Redakteur schreibt basierend auf dem Kontext des Lesers. Als ein Beispiel , sagen sie , Sie einen Artikel schreiben an Anfänger ausgerichtet. Es ist wichtig nicht anzunehmen, dass sie bestimmte Konzepte bereits kennen.

Sie können Ihren Artikel beginnen, indem Sie alle erforderlichen Voraussetzungen erläutern. Dadurch wird sichergestellt, dass Ihre Leser über das erforderliche Wissen verfügen (oder es erwerben können), bevor Sie direkt in Ihren Artikel eintauchen.

Sie können auch Links zu nützlichen Ressourcen einfügen, damit Ihre Leser mit nur einem Klick die benötigten Informationen erhalten.

Um zu wissen, für wen Sie schreiben, müssen Sie so viele Informationen wie möglich darüber sammeln, wer das Dokument verwenden wird.

Es ist wichtig zu wissen, ob Ihr Publikum über Fachkenntnisse auf diesem Gebiet verfügt, ob das Thema für es völlig neu ist oder ob es irgendwo dazwischen liegt.

Ihre Leser werden auch ihre eigenen Erwartungen und Bedürfnisse haben. Sie müssen bestimmen, wonach der Leser sucht, wenn er mit dem Lesen des Dokuments beginnt, und was er daraus herausholt.

Um Ihren Leser zu verstehen, stellen Sie sich die folgenden Fragen, bevor Sie mit dem Schreiben beginnen:

  • Wer sind meine Leser?
  • Was brauchen Sie?
  • Wo werden sie lesen?
  • Wann werden sie lesen?
  • Warum werden sie lesen?
  • Wie werden sie lesen?

Diese Fragen helfen Ihnen auch dabei, über die Erfahrungen Ihres Lesers beim Lesen Ihres Schreibens nachzudenken, worüber wir jetzt mehr sprechen werden.

Denken Sie an die Benutzererfahrung

Die Benutzererfahrung ist in einem technischen Dokument genauso wichtig wie überall im Web.

Nachdem Sie Ihre Zielgruppe und ihre Bedürfnisse kennen, denken Sie daran, wie das Dokument selbst ihre Bedürfnisse erfüllt. Es ist so einfach zu ignorieren, wie der Leser das Dokument tatsächlich verwendet.

Treten Sie beim Schreiben kontinuierlich zurück und betrachten Sie das Dokument so, als wären Sie der Leser. Fragen Sie sich: Ist es zugänglich? Wie werden Ihre Leser es nutzen? Wann werden sie es benutzen? Ist es einfach zu navigieren?

Ziel ist es, ein Dokument zu schreiben, das für Ihre Leser sowohl nützlich als auch verwendbar ist.

Planen Sie Ihr Dokument

Wenn Sie berücksichtigen, wer Ihre Benutzer sind, können Sie Ihr Dokument konzipieren und planen.

Dieser Prozess umfasst eine Reihe von Schritten, die wir jetzt durchgehen werden.

Führen Sie gründliche Recherchen zu diesem Thema durch

Während Sie Ihr Dokument planen, müssen Sie das Thema recherchieren, über das Sie schreiben. Es gibt Unmengen von Ressourcen, die nur eine Google-Suche entfernt sind, damit Sie sie nutzen und tiefere Einblicke erhalten können.

Seien Sie nicht versucht, die Werke oder Artikel anderer Leute abzuheben und als Ihre eigenen weiterzugeben, da dies ein Plagiat ist. Verwenden Sie diese Ressourcen vielmehr als Referenzen und Ideen für Ihre Arbeit.

Google so viel wie möglich, holt Fakten und Zahlen aus Forschungszeitschriften, Büchern oder Nachrichten und sammelt so viele Informationen wie möglich über dein Thema. Dann können Sie eine Gliederung erstellen.

Machen Sie einen Umriss

Wenn Sie den Inhalt Ihres Dokuments skizzieren, bevor Sie es erweitern, können Sie gezielter schreiben. Außerdem können Sie Ihre Gedanken organisieren und Ihre Ziele für Ihr Schreiben erreichen.

Mithilfe einer Gliederung können Sie auch ermitteln, was Ihre Leser aus dem Dokument herausholen sollen. Und schließlich wird ein Zeitplan für die Fertigstellung Ihres Schreibens erstellt.

Holen Sie sich relevante Grafiken / Bilder

Eine Gliederung ist sehr hilfreich, um die verschiedenen virtuellen Hilfsmittel (Infografiken, Gifs, Videos, Tweets) zu identifizieren, die Sie in verschiedene Abschnitte Ihres Dokuments einbetten müssen.

Und es wird Ihren Schreibprozess viel einfacher machen, wenn Sie diese relevanten Grafiken griffbereit halten.

Schreiben Sie im richtigen Stil

Endlich können Sie anfangen zu schreiben! Wenn Sie alle diese Schritte ausgeführt haben, sollte das Schreiben viel einfacher werden. Sie müssen jedoch sicherstellen, dass Ihr Schreibstil für ein technisches Dokument geeignet ist.

Das Schreiben muss zugänglich, direkt und professionell sein. Blumiger oder emotionaler Text ist in einem technischen Dokument nicht erwünscht. Um diesen Stil beizubehalten, sind hier einige Schlüsselmerkmale aufgeführt, die Sie pflegen sollten.

Verwenden Sie Active Voice

Es ist eine gute Idee, aktive Stimmen in Ihren Artikeln zu verwenden, da diese leichter zu lesen und zu verstehen sind als die passive Stimme.

Aktive Stimme bedeutet, dass das Subjekt des Satzes dasjenige ist, das die Aktion des Verbs aktiv ausführt . Passive Stimme bedeutet, dass ein Subjekt der Empfänger der Aktion eines Verbs ist .

Hier ein Beispiel für Passivsprache : Die Dokumentation sollte sechsmal im Jahr von jedem Webentwickler gelesen werden.

Und hier ein Beispiel für aktive Stimme : Jeder Webentwickler sollte diese Dokumentation sechsmal im Jahr lesen.

Wählen Sie Ihre Wörter sorgfältig aus

Wortwahl ist wichtig. Stellen Sie sicher, dass Sie das beste Wort für den Kontext verwenden. Vermeiden Sie übermäßige Verwendung von Pronomen wie "es" und "dies", da der Leser möglicherweise Schwierigkeiten hat, zu identifizieren, auf welche Substantive er sich bezieht.

Vermeiden Sie auch Slang und vulgäre Sprache - denken Sie daran, dass Sie für ein breiteres Publikum schreiben, dessen Disposition und kulturelle Neigungen von Ihrer abweichen können.

Vermeiden Sie übermäßigen Jargon

Wenn Sie ein Experte auf Ihrem Gebiet sind, kann es einfach sein, den Ihnen vertrauten Jargon zu verwenden, ohne zu bemerken, dass er für andere Leser verwirrend sein kann.

Sie sollten auch die Verwendung von Akronymen vermeiden, die Sie zuvor nicht erklärt haben.

Hier ist ein Beispiel :

Weniger klar: PWAs gelten als die Zukunft der plattformübergreifenden Entwicklung. Ihre Verfügbarkeit auf Android und iOS macht sie zur App der Zukunft.

Verbessert: Progressive Web Applications (PWAs) sind wirklich die Zukunft der plattformübergreifenden Entwicklung. Ihre Verfügbarkeit auf Android und iOS macht PWAs zur App der Zukunft.

Verwenden Sie die einfache Sprache

Verwenden Sie weniger Wörter und schreiben Sie so, dass jeder Leser den Text verstehen kann. Vermeiden Sie lange Wörter. Versuchen Sie immer, Konzepte und Begriffe so klar wie möglich zu erklären.

Visuelle Formatierung

Eine Textwand ist schwer zu lesen. Selbst die klarsten Anweisungen können in einem Dokument mit schlechter visueller Darstellung verloren gehen.

Man sagt, ein Bild sagt mehr als tausend Worte. Dies gilt auch für das technische Schreiben.

Aber nicht jedes Bild verdient ein technisches Dokument. Technische Informationen können nur schwer im Text zu vermitteln sein. Ein gut platziertes Bild oder Diagramm kann Ihre Erklärung verdeutlichen.

Die Leute lieben auch Visuals, deshalb hilft es, sie an den richtigen Stellen einzufügen. Betrachten Sie die folgenden Bilder:

Hier ist zunächst ein Blog-Snippet ohne Bildmaterial:

Hier ist ein Ausschnitt aus demselben Blog, aber mit Bildmaterial:

Durch das Hinzufügen von Bildern zu Ihren Artikeln wird der Inhalt verständlicher und verständlicher. Neben Bildern können Sie bei Bedarf auch Gifs, Emoji, Einbettungen (soziale Medien, Code) und Codefragmente verwenden.

Durchdachte Formatierungen, Vorlagen und Bilder oder Diagramme machen Ihren Text auch für Ihre Leser hilfreicher. In den folgenden Referenzen finden Sie eine Vorlage für technisches Schreiben von @Bolajiayodeji.

Machen Sie eine sorgfältige Überprüfung

Gutes Schreiben jeglicher Art muss frei von Rechtschreib- und Grammatikfehlern sein. Diese Fehler mögen offensichtlich erscheinen, aber es ist nicht immer leicht, sie zu erkennen (insbesondere in langen Dokumenten).

Überprüfen Sie immer Ihre Rechtschreibung (Sie wissen, punktieren Sie Ihre Is und kreuzen Sie Ihre Ts), bevor Sie auf "Veröffentlichen" klicken.

Es gibt eine Reihe kostenloser Tools wie Grammatik und die Hemingway-App, mit denen Sie nach Grammatik- und Rechtschreibfehlern suchen können. Sie können einen Entwurf Ihres Artikels auch an jemanden weitergeben, der vor der Veröffentlichung Korrektur gelesen werden soll.

Wo Sie Ihre Artikel veröffentlichen können

Nachdem Sie sich für das technische Schreiben entschieden haben, finden Sie hier einige gute Plattformen, auf denen Sie kostenlos technische Inhalte erstellen können. Sie können Ihnen auch dabei helfen, ein ansprechendes Portfolio für zukünftige Arbeitgeber aufzubauen.

Dev.to ist eine Community von Tausenden von Technikfreaks, in denen sowohl Schriftsteller als auch Leser Ideen und Ressourcen sinnvoll einbeziehen und austauschen können.

Hashnode ist meine Blogging-Plattform mit fantastischen Vorteilen wie benutzerdefiniertem Domain-Mapping und einer interaktiven Community. Das Einrichten eines Blogs auf dieser Plattform ist ebenfalls einfach und schnell.

freeCodeCamp hat eine sehr große Community- und Publikumsreichweite und ist ein großartiger Ort, um Ihre Artikel zu veröffentlichen. Sie müssen sich jedoch bewerben, um für die Veröffentlichung einige frühere Schreibmuster zu schreiben.

Ihre Bewerbung kann entweder angenommen oder abgelehnt werden, aber lassen Sie sich nicht entmutigen. Sie können sich später jederzeit erneut bewerben, wenn Sie besser werden, und wer weiß? Sie könnten akzeptiert werden.

Wenn Sie für sie schreiben, überprüfen und bearbeiten sie Ihre Artikel vor der Veröffentlichung, um sicherzustellen, dass Sie den bestmöglichen Artikel veröffentlichen. Sie werden Ihre Artikel auch auf ihren Social-Media-Plattformen teilen, damit mehr Menschen sie lesen können.

Hackernoon hat über 7.000 Autoren und könnte eine großartige Plattform für Sie sein, um Ihre Artikel für die über 200.000 täglichen Leser in der Community zu veröffentlichen.

Hacker Noon unterstützt Autoren, indem sie ihre Artikel vor dem Veröffentlichen auf der Plattform Korrektur lesen und so häufige Fehler vermeiden.

Kurse für technisches Schreiben

Wie in jedem anderen Bereich gibt es im technischen Schreiben verschiedene Prozesse, Regeln, Best Practices usw.

Ein Kurs über technisches Schreiben führt Sie durch alles, was Sie lernen müssen, und kann Ihnen auch einen wichtigen Vertrauensschub geben, um Ihre Schreibreise zu beginnen.

Hier sind einige Kurse zum technischen Schreiben, die Sie sich ansehen können:

  • Google Technical Writing Kurs (kostenlos)
  • Udemy Technical Writing Course (bezahlt)
  • Hashnode Technical Writing Bootcamp (kostenlos)

Foren und Communities für technisches Schreiben

Alleine können wir so wenig tun, zusammen können wir so viel tun ~ Helen Keller

Es ist von Vorteil, Teil einer Community oder eines Forums zu sein, zusammen mit Menschen, die dieselbe Leidenschaft wie Sie teilen. Sie können Feedback, Korrekturen, Tipps und sogar einige Stiltipps von anderen Autoren in der Community erhalten.

Hier sind einige Communitys und Foren, denen Sie beitreten können:

  • Hashnode
  • Dev.to.
  • Technische Schreibwelt
  • Technisches Autorenforum
  • Schreiben Sie das Docs Forum

Einige erstaunliche technische Redakteure werden folgen

Auf meiner Reise zum technischen Schreiben bin ich gekommen und habe einige großartige technische Redakteure verfolgt, deren Schreibreise, Beständigkeit und Stil mich inspirieren.

Dies sind die Autoren, zu denen ich aufschaue und die ich als virtuelle Mentoren für technisches Schreiben betrachte. Manchmal lassen sie technische Schreibtipps fallen, die ich hilfreich finde und von denen ich viel gelernt habe.

Hier sind einige dieser Autoren (mit ihren Twitter-Handles verlinkt):

  • Quincy Larson
  • Edidiong Asikpo
  • Catalin Pit
  • Victoria Lo
  • Bolaji Ayodeji
  • Amruta Ranade
  • Chris Bongers
  • Colby Fayock

Letzte Worte

Sie benötigen keinen Abschluss in technischem Schreiben, um technische Inhalte zu veröffentlichen. Sie können mit dem Schreiben in Ihrem persönlichen Blog und in öffentlichen GitHub-Repositories beginnen, während Sie Ihr Portfolio aufbauen und praktische Erfahrungen sammeln.

Wirklich - fang einfach an zu schreiben.

Üben Sie, indem Sie neue Dokumente für vorhandene Programme oder Projekte erstellen. Es gibt eine Reihe von Open Source-Projekten auf GitHub, die Sie überprüfen und zu ihrer Dokumentation hinzufügen können.

Gibt es eine App, die Sie gerne verwenden, deren Dokumentation jedoch schlecht geschrieben ist? Schreiben Sie Ihre eigenen und teilen Sie sie online für Feedback. Sie können Ihr Blog auch schnell auf hashnode einrichten und mit dem Schreiben beginnen.

Sie lernen zu schreiben, indem Sie schreiben und lesen und darüber nachdenken, wie Schriftsteller ihre Charaktere geschaffen und ihre Geschichten erfunden haben. Wenn Sie kein Leser sind, denken Sie nicht einmal daran, Schriftsteller zu sein. - Jean M. Auel

Technische Redakteure lernen immer . Durch das Eintauchen in neue Themenbereiche und das Erhalten von externem Feedback hört ein guter Schriftsteller nie auf, sein Handwerk zu verbessern.

Natürlich sind gute Schriftsteller auch unersättliche Leser. Wenn Sie häufig gelesene oder häufig verwendete Dokumente überprüfen, wird sich Ihr eigenes Schreiben definitiv verbessern.

Ich kann es kaum erwarten, Ihre technischen Artikel zu sehen!

Verweise

Einführung in das technische Schreiben‌‌

So strukturieren Sie einen technischen Artikel‌‌

Verstehen Sie Ihr Publikum, das Warum und Wie

‌‌Technische Schreibvorlage

Ich hoffe das war hilfreich. Wenn ja, folge mir auf Twitter und lass es mich wissen!