Softwareentwickler, warum haben Sie noch nicht mit dem technischen Schreiben begonnen?

Ein Blog ist aus vielen Gründen nicht nur für Sie, sondern auch für andere Softwareentwickler im technischen Bereich ein nützlicher Beitrag.

Technisches Schreiben hilft einem Softwareentwickler, sein technisches Wissen/Erfahrungen mit anderen Softwareentwicklern im Software-Engineering zu teilen.

Technisches Schreiben ist eine Schreibdisziplin, bei der es darum geht, komplexe Informationen an diejenigen weiterzugeben, die sie zur Ausführung einer bestimmten Aufgabe oder zum Erreichen eines bestimmten Ziels benötigen. Aus diesem Grund wird technisches Schreiben oft als „ Vereinfachung des Komplexen “ definiert.

Es steigert auch Ihr Verständnis für das Thema, über das Sie schreiben, und zeigt deutlich Ihr technisches Fachwissen.

Das Einzigartigste am technischen Schreiben ist nicht nur, dass Sie hervorragende Zukunftschancen generieren konnten (einen Remote-Job in der Technikbranche, einen Vertrag als freiberuflicher Autor oder die Möglichkeit, einen Gastbeitrag auf der Website eines großen Technologieunternehmens zu verfassen usw.), sondern es kann Ihnen auch beim Aufbau helfen eine Online-Präsenz, die Ihnen letztendlich bei Ihrer Karriere als Softwareentwickler hilft.

Manchmal gehe ich zurück und lese meine Blog-Beiträge, wenn ich Informationen zu einem bestimmten Thema suche.

Wenn Sie in Ihrer Karriere als Softwareentwickler etwas Interessantes gemacht haben, es aber für sich behalten, verpassen Sie eine große Chance.

Beginnen Sie mit dem Schreiben und es ist eine effektive Möglichkeit, Ihre Ideen im Internet bekannt zu machen.

„Schreiben Sie den Blog, den Sie gerne gefunden hätten, wenn… https://t.co/PcXR0fL9QF

– Ankur💻🎧💪 (@TheAnkurTyagi) 3. Oktober 2023

Wenn Sie gerne anderen beim Lernen helfen, Freude daran haben, Teil von Open-Source-Projekten zu sein und anderen zu zeigen, wie sie mitmachen können, oder Freude daran haben, komplexe Ideen auf leicht verständliche Weise durch Ihre Texte zu erklären, dann ist technisches Schreiben genau das Richtige für Sie Du.

In diesem Artikel möchte ich erklären, wie Programmieren und Schreiben zusammengeführt werden können, um unsere Entwicklerfähigkeiten zu verbessern. Ja, Schreiben! Ich glaube wirklich, dass wir alle über ein gewisses Maß an Schreibfähigkeiten verfügen. Ich bin hier, um Ihnen Schreibtipps, Ratschläge und Beispiele zu geben, die Ihnen dabei helfen, ein kompetenterer Entwickler und Kommunikator zu werden.

Was ist Technisches Schreiben?

Beim technischen Schreiben geht es darum, klare und detaillierte Anweisungen zu geben, um Benutzern, anderen Entwicklern oder Managern zu helfen, ein technisches Produkt oder eine technische Fähigkeit oder Idee zu verstehen.

Ein technischer Redakteur ist jemand, der diese Tutorials und technischen Dokumentationen erstellt.

Technisches Schreiben könnte sein:

• Anleitungen zu Benutzerhandbüchern oder zur Integration zwischen zwei technischen SaaS
• Online-Supportartikel
• Technische Berichte , die Informationen zu einem bestimmten Thema präsentieren, oft nach der Durchführung von Recherchen oder Experimenten. Sie kommen häufig in wissenschaftlichen und technischen Bereichen vor.
• Technische Vorschläge : Diese Dokumente beschreiben einen Plan, eine Idee oder ein Projekt klar und überzeugend. Sie werden verwendet, um Genehmigung, Finanzierung oder Zusammenarbeit einzuholen.
• Interne Metamaterialien für Programmierer und API-Dokumentation für Entwickler.

Im Wesentlichen vermittelt ein technischer Redakteur technische Details auf eine Weise, die es dem Leser ermöglicht, diese Informationen effektiv für einen bestimmten Zweck anzuwenden.

Wenn Sie mit dem technischen Schreiben beginnen und versuchen, über Softwareentwicklung/-programmierung oder das, was Sie in der Technik gelernt haben, zu schreiben, aber noch nicht Ihren ersten Blog geschrieben haben, werden Sie in den ersten beiden Abschnitten von den größten Wert finden In diesem Blogbeitrag spreche ich darüber, wie man als technischer Redakteur oder Blogger anfängt und wie man sein Blog skaliert.

Der Rest des Blogs wird Ihnen nützlich sein, um etwaige Wissenslücken zu schließen, die Sie benötigen, um als Softwareentwickler-Autor erfolgreich zu sein, am Arbeitsplatz erfolgreich zu sein und Ihre Karriere voranzutreiben.

„Wenn Sie einen Traum haben, können Sie ein Leben lang damit verbringen, ihn zu studieren, zu planen und sich darauf vorzubereiten. Was Sie tun sollten, ist anzufangen.“

– Zeichnete Houston

Schreiben ist überall?

Die beiden wichtigsten Online-Ressourcen, die Menschen zum Erlernen des Programmierens nutzen, sind technische Dokumentation und Stack Overflow, wobei Blogs die Top drei abrunden.

Das Dreifache, Menschen zu befähigen, sich selbst etwas über Technologie beizubringen, umfasst eine klare Dokumentation, eine lebendige Community, die Lösungen anbietet, und häufige Beiträge.

Entwickler schätzen eine breite Palette zusätzlicher Quellen, darunter Anleitungsvideos, schriftliche Tutorials, Bücher und Foren – sie stellen die Quellen und Formate zusammen, die am besten zu ihrem Lernstil passen.

Die Fähigkeit, Ihre Ideen im Team und online klar zum Ausdruck zu bringen, ist eine wertvolle Fähigkeit, die für viele Entwickler eine Herausforderung darstellt. Denken Sie nur daran, wie viel Sie jeden Tag schreiben, ohne Code zu schreiben. Diese Fähigkeit ist eine Superkraft.

Sie beschäftigen sich mit verschiedenen Formen des Schreibens wie Slack-Chats, E-Mails, internen Entwicklerdokumenten, RCA-Entwürfen, Readme-Dateien, Codekommentaren, Git-Commit-Nachrichten, Pull-Requests, Kommentaren zur Codeüberprüfung, jährlichem Leistungsfeedback, Besprechungsnotizen und mehr.

Das Beherrschen des Schreibens ist für Softwareentwickler von entscheidender Bedeutung. Unzureichende Schreibfähigkeiten können ihren beruflichen Aufstieg über einen bestimmten Punkt hinaus behindern. Viele Ingenieure stellen später in ihrer Karriere fest, dass „Soft Skills genauso wichtig sind wie Programmieren“.

Jugendliche: Ihre Karriere als Softwareentwickler wird sich erheblich verbessern und Sie erhalten bessere Zukunftschancen im technischen Bereich, wenn Sie anfangen, jeden Tag 30 Minuten zu schreiben und jeden Monat 2-3 Blogs online zu veröffentlichen, aber nur sehr wenige Entwickler sind tatsächlich dazu in der Lage, dies im Laufe der Zeit zu tun langfristig. https://t.co/damIJ5gXys

– Ankur💻🎧💪 (@TheAnkurTyagi) 4. Oktober 2023

Warum Schreiben für Entwickler von entscheidender Bedeutung ist

JavaScript, TypeScript, PHP, Go, Java – es gibt so viele verschiedene Programmiersprachen und vielleicht beherrschen Sie viele davon sogar fließend.

Da wir in unseren technischen Karrieren danach streben, qualitativ hochwertigeren Code zu produzieren, wird die Fähigkeit, in der Alltagssprache effektiv zu schreiben und zu kommunizieren, zu einer entscheidenden Fähigkeit, die im Bereich der Softwareentwicklung möglicherweise unterschätzt wird.

Beim Software-Engineering geht es nicht nur um Code. Es geht um Menschen + Code.

Wie ich als Softwareentwickler ein besserer Autor werde

Die Art und Weise, wie Ingenieure ihre Gedanken über den Code artikulieren, kann ebenso entscheidend sein wie der Code selbst. Unabhängig von Ihrer Haltung zu diesem Thema können wir einstimmig anerkennen, dass unsere Worte die Wirksamkeit des Kodex entweder verbessern oder behindern können.

Schreiben kann Ihnen helfen, Ihre Glücksoberfläche zu vergrößern.

L = D * T, wobei L Glück ist, D etwas tut und T etwas sagt.

– Jason C. Roberts

6 Hauptvorteile des technischen Schreibens

Es hilft Ihnen, Konzepte auf einer tieferen Ebene zu verstehen.

• Sie müssen die Konzepte, die Sie erklären, recherchieren, wodurch Sie mit verschiedenen Ideen, Anwendungen und Fallstricken konfrontiert werden.

• Die Konzepte bleiben besser in Ihrem Gehirn hängen, wenn Sie sie anderen erklären.

• Durch die Strukturierung und Präsentation von Informationen für andere decken Sie häufig Wissenslücken auf. Dadurch können Sie in Ihrer Entwicklerkarriere schneller vorankommen.

• Technische Redakteure sind lebenslange Lernende, denn mit jedem neuen technischen Blog, in dem Sie recherchieren und schreiben, werden Sie zum Experten für dieses Thema.

• Das Schreiben fördert auch ein tieferes Verständnis der Empathie der Benutzer. Es fordert Sie dazu auf, sich mehr auf die Perspektiven und Gefühle der Leser oder Produktbenutzer zu konzentrieren, anstatt sich nur auf Ihren Standpunkt zu verlassen.

  
  

• Hier sind einige zusätzliche Vorteile:

Darüber hinaus können Sie als technischer Redakteur Einnahmen erzielen, indem Sie Beiträge für verschiedene Organisationen leisten. Schauen Sie sich diese großartigen Firmen an, die technische Autoren bezahlen .

Im College habe ich gelernt, indem ich anderen in einem Wohnheim Nachhilfe gegeben habe

Etwas zu erklären oder auch nur so zu tun, zwingt Sie dazu, Ihr Wissen kohärent zu organisieren, Lücken in Ihrem Wissen aufzudecken und die Teile, die Sie bereits wissen, zu verstärken.

Der beste Weg zu lernen ist das Lehren und Schreiben ist für jeden Entwickler ein großer Gewinn.

Anstatt nur Aufmerksamkeit zu schenken, erwidern Menschen und Unternehmen es Ihnen gegenüber. Wenn Sie einen technischen Blogbeitrag schreiben, erhalten Sie sofortiges Feedback. Ihr technisches Schreiben trägt auch dazu bei, die Nachricht zu verbreiten und Türen zu noch interessanteren Möglichkeiten zu öffnen.

Es gibt auch eine lukrative Karriere als technischer Redakteur, wenn Ihnen das gefällt, und so gut wie alles, was ich heutzutage auf meinem Blog schreibe, sind Konzepte, die ich versuche, besser zu verstehen. Wenn ich es nicht schriftlich erklären kann, habe ich es nicht richtig verstanden.

Was sind die Beispiele für technisches Schreiben?

Als technischer Redakteur besteht Ihre Aufgabe darin, komplexe technische Informationen in eine leicht verständliche und benutzerfreundliche Sprache zu übersetzen. Technisches Schreiben umfasst verschiedene Formen, einschließlich der Erstellung von Schritt-für-Schritt-Anleitungen und umfassenden Leitfäden.

Das Hauptziel besteht darin, das Verständnis aller technischen Aspekte eines Produkts oder einer Dienstleistung zu erleichtern, sei es bei internen Teammitgliedern oder Endbenutzern.

Vor diesem Hintergrund sollen Ihnen die folgenden Beispiele für technisches Schreiben ein klares Verständnis vermitteln.

1. SuperTokens Review – eine Open-Source-Alternative zu Auth0, Firebase Auth und AWS Cognito.

Dies ist ein sehr einfaches Beispiel für die Überprüfung von Supertokens und dafür, warum „Supertokens“ eine gute Benutzerauthentifizierung darstellen.

2. So erstellen Sie mit Medusa einen Next.js-E-Commerce-Shop

Dies ist ein sehr gutes Beispiel dafür, wie Sie neben der Erstellung einer App auch ein Tutorial erstellen können. In diesem Blog habe ich eine Schritt-für-Schritt-Anleitung zum Aufbau eines E-Commerce-Shops von Medusa geteilt, der eine Open-Source-Alternative zu Shopify ist.

3. So stellen Sie LLMs mit MindsDB und OpenAI bereit

In diesem Leitfaden habe ich erklärt, wie Sie LLMs mit MindDB und OpenAI bereitstellen können

4. So migrieren Sie Ihre Datenbank von Supabase nach HarperDB

Ein vollständiges Tutorial, wie Sie Ihre Datenbank von Supabase nach HarperDB migrieren können

5- Produktdokumentation

Die Produktdokumentation enthält Anweisungen zur effektiven Verwendung und Integration mit anderen Entwicklertools.

Das Verfassen von Produktdokumenten erfordert gute technische Schreibfähigkeiten und Organisationskenntnisse. Dies sind nur einige Beispiele, die unter den Bereich Technisches Schreiben fallen und ein hohes Maß an Recherche- und Visualisierungsfähigkeiten sowie die Fähigkeit erfordern, mit einem breiten Spektrum an Zielgruppen in Kontakt zu treten.

Tipp: „Stellen Sie sich die Frage: Weckt der Titel das Interesse des Lesers?“ Wenn ja, vertiefen sie sich wahrscheinlich in die Einleitung und entscheiden dann: „Lohnt es sich, meine Zeit in dieses ganze Stück zu investieren?“ Ein häufiger Fehler, den ich in technischen Beiträgen oft beobachte, ist zu viel Einleitung oder umgekehrt zu wenig.

Ein präzise formulierter Absatz kann effektiv die Bühne für einen technischen Blogbeitrag bereiten.

Wie fange ich als Technischer Redakteur an?

Die mit Abstand häufigste Frage, die ich zum Thema „Technisches Schreiben oder Bloggen“ bekomme, ist, wie man am besten anfängt.

Im Leben scheint das größte Hindernis, etwas zu tun und das zu werden, was man werden möchte, der Anfang zu sein.

Der schlimmste Feind ist „Selbstzweifel“. pic.twitter.com/fw1691QRSY

– Ankur💻🎧💪 (@TheAnkurTyagi) 10. August 2023

Ob es darum geht, ein neues Trainingsprogramm zu beginnen, für einen Marathon zu trainieren, ein Unternehmen zu gründen, ein Buch zu schreiben oder – in diesem Fall genauer gesagt – das Schreiben – der schwierigste Teil ist immer der Anfang.

Es ist leicht – und verlockend – unzählige Stunden damit zu verschwenden, darüber zu diskutieren, was man tun soll.

Es ist viel einfacher zu „lesen“, „lesen“ und „lernen“, als mit dem „Schreiben“ zu beginnen.

Aber das Geheimnis ist, dass Sie immer nur einen Schritt nach dem anderen machen müssen.

Bauen Sie in Ihrer Karriere als Software-Ingenieur mindestens einen Mehrwert auf

– Starten Sie einen Blog – Starten Sie einen Newsletter – Beginnen Sie mit der Aufnahme von YT-Videos – Starten Sie einen Podcast – Beginnen Sie mit dem Aufbau von Netzwerken

Erstellen, veröffentlichen und wiederholen

Im Internet warten Zukunftsmöglichkeiten auf Sie

Cc @TheAnkurTyagi

– Kap.ts (@Kaperskyguru) 17. Februar 2023

Und schau dich um; Die meisten Entwickler in der Softwareentwicklung schreiben nicht rund um die Uhr Code. Die meisten von uns verbringen jeden Tag viel Zeit mit anderen Dingen.

Dazu gehört:

• Demo einer neuen Funktionalität im gesamten Team eines Unternehmens oder bei Kunden.
• Dokumentieren Sie eine neue oder alte Funktion in Ihrem Produkt.
• Aktualisieren eines JIRA-Tickets im Zusammenhang.
• Erstellen von Rückstandsarbeiten zur Unterstützung dieser neuen Funktion.

Natürlich gibt es auch immer Zeit für Toiletten-/Mittagspausen und zum Scrollen auf Twitter 😉

Denken Sie also nicht zu viel nach – fangen Sie einfach an

„Schreiben ist wie Basketball spielen lernen.“

– David Perell

Um ein erfolgreicher Autor zu sein und Chancen zu finden, müssen Sie über drei Fähigkeiten verfügen.

• Codierung
• Schreiben
• Englisch

Ja, bevor Sie überhaupt mit dem Schreiben beginnen, müssen Sie zunächst die englische Sprache verstehen, einschließlich der Zeitformen, der Schreibweise und der grundlegenden Grammatik.

Ihre Leser möchten keinen Artikel lesen, der voller Grammatikfehler und schlechter Wortwahl ist.

In der Technologiebranche ist Englisch de facto zur Kommunikationssprache zwischen Softwareentwicklern, Ingenieuren und anderen Technologiefachleuten weltweit geworden. Es ist die Sprache, die für Dokumentation, Programmiersprachen und Entwicklungswerkzeuge verwendet wird.

Lernen Sie, Ideen einfach und klar zu kommunizieren

Zu wissen, wie eine technische Funktion implementiert wird, bedeutet nicht unbedingt, dass Sie den Prozess auch anderen erklären können.

Ein guter Lehrer erfordert Einfühlungsvermögen und die Fähigkeit, Informationen zielgruppengerecht zu vermitteln

Man versteht etwas nicht, wenn man es einem Sechsjährigen nicht erklären kann.

Einstein, Albert

Es gibt keine perfekte Strategie, um ein außergewöhnlicher Schriftsteller zu werden. Sie fragen sich vielleicht, warum ich dieses Thema diskutiere. Denn es ist von entscheidender Bedeutung, dies von Anfang an anzugehen.

„Suchen Sie nicht nach einer Strategie; Suchen Sie beim Schreiben nach Ihrer einzigartigen Stimme und entwickeln Sie Ihren Stil.“

Der einzige Schreib-Hack, den Sie kennen sollten.

• Weniger Technik ist mehr, ich arbeite 90 % der Zeit mit React.

• Wenn Sie zum ersten Mal schreiben, geben Sie sich mehr Zeit, es herauszufinden.

• Erlaube dir, schlecht zu schreiben.

• Hören Sie auf, sich vorzubereiten, und beginnen Sie mit der Schauspielerei.

  
  

So werden Sie im KI-Zeitalter ein herausragender Autor:

Bevor Sie Ihren nächsten Blogbeitrag schreiben, bitten Sie ChatGPT, einen zu diesem Thema zu verfassen und Ihnen zu zeigen, welche generischen Dinge bereits im Internet verfügbar sind, damit Sie das vermeiden und schreiben können, was für das Publikum wichtig und einzigartig ist.

– Ankur💻🎧💪 (@TheAnkurTyagi) 16. Februar 2023

Um Ihr Publikum zu verstehen, stellen Sie diese Fragen, bevor Sie mit dem Schreiben beginnen.

• Wer sind Ihre Leser?
• Wonach suchen sie bei Google oder vor welchem Problem stehen sie?
• Welche Blogs lesen sie gerade?
• Wie werden sie lesen?

Wie man Ideen für Blogbeiträge entwickelt

• Schreiben Sie den Artikel, der Sie davon abgehalten hätte, stundenlang zu googeln und sich am Kopf zu kratzen.

• Wenn Sie etwas Neues lernen, schreiben Sie darüber, wie Sie es gelernt haben und was Sie gelernt haben.

• Schreiben Sie eine Geschichte über Ihr Fachgebiet, Ihr Interesse oder Ihren Beruf.

• Wählen Sie einen Blogbeitrag Ihres Lieblingsbloggers aus, der Ihnen Spaß gemacht hat, und erkunden Sie dasselbe Thema aus einer neuen Perspektive oder befassen Sie sich mit einem anderen Thema aus einem ähnlichen Blickwinkel.

  
  

Schreiben Sie den Blog-Beitrag, den Sie beim Googeln gerne gefunden hätten.

– Ankur💻🎧💪 (@TheAnkurTyagi) 20. März 2023

Hinweis: Wenn Sie in Ihrer Karriere als Softwareentwickler etwas Interessantes gemacht haben, es aber für sich behalten, verpassen Sie einen großen Chancengenerator.

Wenn es darum geht, Ihre Ideen effektiv zu bewerben, lässt sich das Internet am besten durch Schreiben navigieren.

Es gibt einen Sweet Spot zum Schreiben technischer Beiträge und Tutorials. Schreiben Sie für den Fachmann, der noch keine Zeit hatte, das Ding zu lernen, und verknüpfen Sie es mit Dingen, die er bereits weiß. Zum Beispiel jemandem, der sich mit jQuery auskennt, eine moderne JS-Technik erklären.

– Rachel Andrew (@rachelandrew) 20. Februar 2019

Abschluss

Schreiben ist für die meisten erfahrenen Entwickler eine leicht zu bewältigende Aufgabe.

Wenn Sie der Meinung sind, dass Sie durch das Lesen eines Blog-Beitrags viel über Technik lernen können; Versuchen Sie diese Woche, eines zu schreiben.

– Ankur💻🎧💪 (@TheAnkurTyagi) 2. Oktober 2023

Der Grund, warum jeder Entwickler einen Blog-Beitrag darüber schreiben sollte, was er in der Softwareentwicklung lernt, liegt darin, dass er beim Schreiben entdeckt, dass er etwas möglicherweise nicht so gut versteht, wie er dachte.

Über alles zu lehren und zu schreiben ist der beste Weg, etwas darüber zu lernen, und es ist eine einfache Möglichkeit, einen neuen Lebensstil zu beginnen, da Sie bereits Erfahrungen aus erster Hand haben. Sie müssen also nur vorbeikommen und einen 12-Blog-Beitrag schreiben Schauen Sie sich dieses Jahr um, werten Sie die Ergebnisse aus und planen Sie Ihren nächsten Schritt!

„Lesen Sie, um die Punkte zu sammeln, schreiben Sie, um sie zu verbinden.“ – David Perell

Das Fazit ist, dass die Verbesserung Ihrer Schreibfähigkeiten und ein wenig mehr Aufwand beim Schreiben Ihre Fähigkeiten als Entwickler wirklich verbessern können. Diese Tipps können unter anderem für die Zusammenarbeit mit anderen Entwicklern, die Pflege Ihrer Arbeit, die Erstellung Ihrer Inhalte bei Bedarf oder sogar für die Ausarbeitung von Projektvorschlägen hilfreich sein.

Ressourcen für technisches Schreiben

• Ratschläge für technisches Schreiben (Ein gut geschriebener Blogbeitrag von Chris von CSS Tricks)
• Technische Schreibressourcen (Ein GitHub-Repo von Cynthia Peter )
• Googles Leitfaden zum technischen Schreiben
• Grundlagen des Technischen Schreibens
• Schreiben Sie die Dokumente