Einstieg ins Technische Schreiben – Wo anfangen (mit Programmierhintergrund)

Ich bin derzeit dabei, mein Unternehmen von Programmieren und Webentwicklung zu mehr technischem Schreiben und freiberuflichem Tech-Journalismus zu erweitern. Obwohl mein Hintergrund hauptsächlich in der Technologie liegt, habe ich während der High School und des Colleges ein paar AP- und fortgeschrittene Schreibkurse absolviert und mich mit Geschäftskorrespondenz ziemlich vertraut gemacht, und während ich einige grundlegende Anweisungen für Kunden erstellt habe, habe ich Ich hatte noch nie eine Teilzeit- oder Vollzeitstelle nur zum Schreiben.

Im Moment suche ich nach Karriereseiten und greife auf mein Netzwerk von Kontakten zurück, aber abgesehen von diesen Maßnahmen, gibt es noch etwas, was ich tun sollte? Obwohl ich zum Beispiel einen Blog mit Artikeln habe, die ich geschrieben habe, sollte ich auch ein Portfolio mit Scheinvorschlägen und Korrespondenz zusammenstellen, um mein Wissen zu zeigen?

Vielen Dank im Voraus für alle Vorschläge,

Es klingt für mich so, als ob Sie eher zum freiberuflichen Tech-Journalismus tendieren als zum Tech-Writing. Ich betrachte sie als ziemlich unterschiedliche Bereiche, und der Weg hinein wird nicht derselbe sein.
@Lynn, ich habe dich mit +1 bewertet, weil du meine Gedanken gelesen hast, da ich auch ein bisschen Technikjournalismus machen möchte, aber ich habe mich entschieden, diese Frage auf technisches Schreiben zu belassen, weil mich die journalistische Seite der Dinge zwar interessiert, aber mehr davon tue Das Schreiben der Dokumentation ist auf mein Unternehmen und die Dienstleistungen abgestimmt, die ich bereits Kunden anbiete.
"... Ich habe ein paar AP- und fortgeschrittene Schreibkurse auf meinem Buckel ..." Was ist AP?
Advanced Placement - Grundsätzlich Kurse auf College-Niveau, die für High-School-Studenten angeboten werden

Antworten (4)

Es gibt verschiedene Arten von Technischer Redaktion, die sich im „technischen“ Teil unterscheiden. Der logische Ausgangspunkt für Sie, der wie ich einen Programmierhintergrund hat, wäre die Dokumentation für Programmierer: APIs, SDKs und die dazugehörigen Tutorials und Leitfäden.

Wenn eine Ihrer aktuellen (Programmier-)Arbeiten von externer (Schnittstelle) oder interner (Design, Architektur) Dokumentation profitieren könnte, könnten Sie dort beginnen, um Ihre Fähigkeiten und Ihr Portfolio (und vielleicht Ihren ersten Auftritt) aufzubauen. Wenn dies nicht möglich ist, warum nicht echte Arbeit für das Open-Source-Projekt Ihrer Wahl leisten, anstatt Scheinarbeit zu leisten, um zu zeigen, was Sie können? Das kann Ihnen auch beim Networking helfen; Wenn Sie wertvolle Dokumentation zu Project Whatever beitragen, dann (1) werden Ihre Sachen gesehen und (2) die anderen Leute, die an Project Whatever arbeiten, könnten Ihnen dabei helfen, bezahlte Auftritte zu finden.

Sie können auch den Berufsverbandsweg gehen. STC (Society for Technical Communicators) ist die übliche, aber sie ist breit aufgestellt – dort finden Sie einige Programmierer, aber auch eine Menge Leute, die UIs, Hardware und – Überraschung :-) – nicht- Softwareprodukte wie medizinische und technische Geräte. Es ist also eine breite Gruppe, und wie tief sie ist, hängt von den Leuten in Ihrer Ortsgruppe ab. Ich habe vor einiger Zeit auf einer regionalen STC-Konferenz einen Vortrag über API-Dokumentation gehalten, und es war das einzige programmierungsbezogene Thema auf der Agenda; Einige Jahre später gab es bei der nationalen Konferenz jedoch mehr Optionen. Es variiert. Ich bin derzeit kein Mitglied von STC, also habe ich nicht das aktuelle Gefühl dafür. Ich fand mehr Wert in der Dokumentation SIGs von ACM und IEEE, obwohl ich diese Mitgliedschaften auch verfallen ließ. (Es tut uns leid, nur faul, denke ich. :-) )

Der Einstieg in ein neues Feld besteht aus zwei wesentlichen Teilen: dem Nachweis guter Fähigkeiten und der Suche nach den richtigen Leuten, denen sie diese demonstrieren können. Wenn Sie sich in Ihrer aktuellen Position darauf einlassen können, haben Sie ein Bein nach oben; Du kennst die Leute schon. Wenn nicht, müssen Sie eine Reihe von Arbeiten aufbauen und sich vernetzen.

Vielen Dank für die Antwort! Die Konzentration auf APIs ist etwas, von dem ich nicht glauben kann, dass ich vorher nicht daran gedacht habe, denn bei all der Open-Source-Software, die ich für Kundenprojekte verwende, kann ich nicht einmal zählen, wie oft ich mich mit Projekten mit unvollständiger/begrenzter Dokumentation befasst habe Also werde ich Open-Source-Projekten als Dokumentationsschreiber definitiv mehr Aufmerksamkeit schenken, denn wenn es um Code geht, ist mein Teller bereits voll.
Ich mag die ACM nicht und habe meine Mitgliedschaft erlöschen lassen, sobald ich nicht mehr an den großen ACM-Konferenzen teilnehmen musste. Das IEEE ist etwas besser. Ich mag das Aussehen des STC, obwohl ich kein Tech-Autor bin, habe ich bisher nur ihren Blog Intercom abonniert .

Basierend auf Ihrem Hintergrund und Ihren Sprachkenntnissen empfehle ich Ihnen, diese beiden Bücher zu studieren:

Lernen Sie dann, wie Sie Git und Github verwenden. Suchen Sie auf Github nach einem Open-Source-Projekt, das Ihrem Interessengebiet am nächsten kommt. Schreiben Sie freiwillig. Sie lernen wichtige Fähigkeiten für die Arbeit mit Softwareentwicklungsteams. Sie wenden das Wissen an, das Sie durch das Lesen dieser beiden Bücher erworben haben, und beginnen mit dem Aufbau eines Portfolios von Beispielen für technisches Schreiben. (Geben Sie Ihre Ziele offen an. Irgendwann in Ihrer Karriere könnte Sie jemand aus dem Team einstellen.)

Je nachdem, wo Sie leben, sollten Sie dem STC beitreten und zu den Write the Docs-Treffen gehen . Nutzen Sie diese Gelegenheit, um mehr Kontakte zu knüpfen, mehr Fähigkeiten zu erwerben und mehr über lokale Arbeitgeber zu erfahren.

Wenn Sie die Inhalte dieser beiden Bücher verinnerlichen, sich ein Portfolio relevanter Beispiele aufbauen und sich vernetzen, sind Sie in jedem Fall bestens aufgestellt, um als Technischer Redakteur zu arbeiten. Viel Glück!

Möglicherweise stellen Sie fest, dass für das Technische Schreiben ein eingeschränkteres Regelwerk gilt als für die meisten anderen Bereiche des Schreibens. Schreiben muss extrem minimalistisch und einfach sein. Es gibt weniger Raum für jede Art von verbaler Kreativität als im Journalismus. Beim technischen Schreiben geht es nicht um persönlichen Ausdruck, sondern um Klarheit und Einfachheit.

Sie könnten damit beginnen, einen Stilleitfaden für technisches Schreiben wie „Bitte zuerst lesen!“ zu lesen. Ein Styleguide für die Computerindustrie . Dann schreiben Sie eine kleine Anleitung, die den im Styleguide beschriebenen Regeln folgt. Die Fähigkeit, sich einen Styleguide zu merken, ist wahrscheinlich die wichtigste Fähigkeit für einen Technischen Redakteur.

Diese Antwort scheint vorauszusetzen, dass der Autor der Frage nur mit kreativem Schreiben oder Belletristik vertraut ist, dies in der ursprünglichen Frage jedoch überhaupt nicht. Oder übersehe ich deinen Punkt?

Sie können mit dem Schreiben und Erstellen von Videos zu grundlegenden Programmiertipps und Anleitungen beginnen. Es gibt viele frischgebackene Programmierer, die nach solchen Themen suchen.

Willkommen bei Writer's, können Sie sich auf Ihre Antwort verlassen.