technical writing resources

Gliederung

• Gliederung
• Ressourcen
• Was ist technisches Schreiben?
• Artikel
• Bücher
• Kurse
• YouTube
• Gemeinschaften
• Schreibwerkzeuge
• Dokumentationstools
• Wer bezahlt technische Schriftsteller
• Open Source -Projekte
  • Open -Source -Projekte/-Programme technische Autoren können dazu beitragen
• Blogs, die für großartige Schreibinhalte folgen sollen
• Vorbereitung auf technische Schreibinterviews
• Websites zur Veröffentlichung von Artikeln
• Jobbörsen für technische Schreibrollen

Ressourcen

Dieses Repository enthält unterschiedliche Ressourcen für technische Schreiben, die aus dem gesamten Internet gesammelt wurden

Was ist technisches Schreiben?

Das technische Schreiben ist eine Form der Kommunikation, mit der Benutzer Probleme mit der Technologie lösen können. Es ist der Prozess, klare, prägnante und informative Inhalte zu erstellen, die komplexe Informationen auf eine Weise vermitteln sollen, die vom beabsichtigten Publikum leicht zu verstehen ist.

Es umfasst häufig das Schreiben von Handbüchern, Leitfäden, Berichten und Dokumentation, die technische Konzepte, Prozesse oder Produkte erklären.

Artikel

• Technisches Schreiben jenseits von Blogposts
• Wie man mit technischem Schreiben beginnt
• Wie man technischer Schriftsteller wird
• Technisches Schreiben für Anfänger - Ein AZ -Leitfaden für Tech -Blogging -Grundlagen
• Technisches Schreiben: Was und wie?
• So lernen Sie kostenlos technisches Schreiben
• Erste Schritte mit technischem Schreiben
• Beratung zum technischen Schreiben
• So schreiben Sie Inhalte, die die Leser basierend auf Erkenntnissen aus der Benutzerpsychologie lesen werden
• So erstellen Sie ein technisches Schreibportfolio
• Schreiben von Tipps für Softwareentwickler - wie man ein besserer Tech -Autor wird
• 11 Best Practices zum Schreiben von API -Dokumentation
• Technisches Schreiben gegen technisches Bloggen

Bücher

• Gut schreiben ~ Julian Shapiro

• Technisches Schreiben, vereinfacht ~ Nell Johnson

• Schreiben für SOTWARE -Entwickler ~ Philip Kiely

• Technisches Schreiben für Dummies ~ Sheryl Lindsell-Roberts

• Dokumente für Entwickler: Ein Ingenieur -Feldhandbuch zum technischen Schreiben ~ Jared Bhatti

• Modernes technisches Schreiben: Eine Einführung in die Software -Dokumentation ~ Andrew Etter

• Jeder schreibt: Ihr Anleitungen zum Erstellen lächerlich guter Inhalt ~ Ann Handley

• Auf gut schreiben ~ William Zinsser

• Technische Kommunikation ~ Mike Markel

Kurse

• Technische Schreibkurse für Ingenieure
• Technisches Schreiben: So schreiben Sie Softwaredokumentation
• Lernen Sie das technische Schreiben von API: JSON und XML für Schriftsteller
• Die Kunst der API -Dokumentation
• Dokumentieren von APIs: Ein Leitfaden für technische Schriftsteller und Ingenieure
• Technischer Autor -Zertifizierungskurs ~ Der technische Autor -Zertifizierungskurs wurde für angehende technische Autoren oder Personen erstellt, die ihre technischen Schreibfähigkeiten auffrischen möchten.
• SEO für Devs ~ SEO für Devs ist ein kostenloser 2 -Wochen
• API-Dokumentation für Entwickler ~ Ein praktischer Leitfaden zum Erstellen und Aufrechterhaltung der API-Dokumentation.

YouTube

• Doctohelptv
• Technischer Schriftsteller HQ
• Amruta Ranade
• William Smith
• Wie man technischer Schriftsteller wird | Fähigkeiten und Karrierewachstum

Gemeinschaften

Gemeinschaften können wertvolle Lernmöglichkeiten, Wachstum, Mentoring und berufliche Fortschritt bieten. Die Verbindung mit Menschen mit ähnlichem Interesse ist einer der Gründe, warum Menschen sich Gemeinschaften anschließen. Hier sind einige der Gemeinschaften, denen technische Autoren beitreten können:

• Schreiben Sie die Dokumente
• Dokument
• Hackmamba
• LinkedIn Technical Writing Community
• Globale Autorengemeinschaft
• API -Dokumentationsgruppe
• Technisches Schriftsteller Forum
• Hashhnode
• Die Good Docs Project Community
• Techwriters.dev
• R/technisches Writing

Schreibwerkzeuge

• Canva ~ Canva ist eine Grafikdesign -Plattform, mit der Social -Media -Grafiken, Präsentationen, Poster, Dokumente und andere visuelle Inhalte erstellt werden.
• EntfernenBg ~ A -Werkzeuge, mit denen Bildhintergründe entfernen wird.
• Markdown ~ Markdown ist ein Text-zu-HTML-Conversion-Tool für Webautoren.
• Asciidoc ~ asciidoc ist eine leichte und semantische Markup -Sprache, die hauptsächlich für das Schreiben technischer Dokumentation entwickelt wurde.
• Denigma ~ Denigma ist ein Tool, das Code in verständlichem Englisch erklärt.
• Grammatary ~ Grammatary ist ein Schreibassistent, der Rechtschreibung, Grammatik, Interpunktion, Klarheit, Engagement und Lieferfehler überprüft.
• Hemingway -App ~ Die Hemingway -App ist eine Web- und Desktop -App, mit der Ihren Schreibstil verbessern und Ihre Inhalte verbessert werden können.
• Quillbot AI ~ Quillbot AI ist ein Mehrzweck-Schreibwerkzeug, mit dem Sie Ihren Schreibstil verbessern können. Einige seiner Produkte sind Paraphraser, Grammatikprüfer, Plagiatsprüfer, Co-Autor, Zusammenfassungszitat, Zitiergenerator und Wortzähler.
• Begriff ~ Begriff ist ein All-in-One-Arbeitsbereich für Ihre Notizen, Aufgaben, Wikis und Datenbanken. Es ist ein Tool, mit dem Sie Ihre Gedanken, Projekte und Informationen organisieren können.
• Dropbox -Papier ~ Dropbox -Papier ist ein Online -Dokument -Arbeitsbereich, in dem Sie Text, Medien und Dateien an einem Ort organisieren und anzeigen können.
• GofullPage - Vollständige Bildschirmaufnahme ~ Eine Chrome -Erweiterung TAHT ermöglicht es Ihnen, Ihr aktuelles Browser -Fenster zu übernehmen.
• Carbon ~ Carbon ist der einfachste Weg, um schöne Bilder Ihres Quellcode zu erstellen und zu teilen.
• ISITWP ~ ISITWP -Headlinie -Analysator -Tool hilft Ihnen, Schlagzeilen zu schreiben, die den Datenverkehr und die Aktien vorantreiben und in den Suchergebnissen besser eingestuft werden.
• Kapitalisieren Sie meinen Titel ~ Die Titelkapitalisierung für Ihr Schreiben erleichtert Ihr Schreiben
• WordTune ~ WordTune verwandelt Text in präzise, ​​ansprechende, gut geschriebene Nachrichten.
• Headline -Analysator ~ Schreiben Sie Schlagzeilen, die den Verkehr, die Aktien und die Suchergebnisse vorantreiben.
• Titelgenerator ~ Erstellen Sie großartige Titel für Artikel und Blog -Beiträge.
• SEO -Schreiben Assistent ~ Ein intelligenter Schreibeditor, der Ihnen hilft, Ihre Kopie für Engagement und SEO zu optimieren.
• Hackmd ~ Ein kollaborativer Markdown -Editor zum Teilen Ihrer Artikel und zum Einholen von Feedback von anderen.
• Copyscape ~ Plagiatprüfung
• Markdoc ~ Ein Superset von Markdown zum Erstellen benutzerdefinierter Dokumentationswebsites. Es wurde durch Stripe erstellt und im Mai 2022 Open Source gemacht.
• WordTune ~ WordTune ist ein Ai-Antriebsschreibbegleiter, der Ihre Sätze neu formuliert, um genau das zu sagen, was Sie durch klare, überzeugende und authentische Schrift meinen.

Dokumentationstools

• Gitbook ~ Eine moderne Dokumentationsplattform, auf der Teams alles von Produkten bis hin zu internen Wissensbasis und APIs dokumentieren können.
• Lesen Sie die Dokumente ~ Eine Open-Source-Plattform zum Hosting, Erstellen und Versioning-Dokumentation.
• Docusaurus ~ Ein statischer Site-Generator, der es einfach macht, Open-Source-Projektwebsites zu erstellen.
• Sphinx ~ Ein Dokumentationsgenerator, der umstrukturierte Dateien in HTML -Websites und andere Formate umwandelt.
• Mkdocs ~ ein schneller, einfacher und statischer Site -Generator, der sich auf die Bauprojektdokumentation auszeichnet.
• Swagger ~ Eine Reihe von Tools für die API -Dokumentation, einschließlich Prahlereditor, Swagger UI und Swagger Codegen.
• Postman ~ Eine Kollaborationsplattform für die API -Entwicklung, die es einfach macht, APIs zu erstellen, zu teilen, zu testen und zu dokumentieren.
• Slate ~ Ein statischer Site -Generator, der speziell für die API -Dokumentation entwickelt wurde.
• Redoc ~ Ein Open-Source-Tool zur Generierung von API-Dokumentation aus OpenAPI-Definitionen (ehemals Swagger).
• Docz ~ Ein Werkzeug zum Schreiben von Dokumentationen für Ihre React-Komponenten mit MDX und Live-Reload-Unterstützung.
• Jekyll ~ Ein statischer Site -Generator, der einfache Text in statische Websites und Blogs verwandelt.
• Hugo ~ Ein schneller und flexibler statischer Site -Generator, der in Go geschrieben wurde.
• Antora ~ Ein Dokumentations -Site -Generator zum Erstellen von Dokumentationsportalen und technischen Dokumentationswebsites.
• VuePress ~ Ein statischer Stättengenerator von Vue.js.
• ASCIIDOCTOR ~ Ein schneller Textprozessor und Veröffentlichungs -Toolchain zum Konvertieren von Asciidoc -Inhalten in HTML5, Docbook, PDF und andere Formate.
• Confluence ~ Ein Tool für die Zusammenarbeit, mit dem Teams zusammenarbeiten und Wissen effizient ausgetauscht werden können.
• MADCAP FLARE ~ Ein umfassendes technisches Authoring- und Veröffentlichungsinstrument zum Erstellen von Inhalten für verschiedene Ausgaben.

Wer bezahlt technische Schriftsteller

Das Schreiben technischer Inhalte für Organisationen und Veröffentlichungen ist eine hervorragende Möglichkeit, zusätzliches Einkommen zu erzielen. Auf diese Weise lernen Sie viel, teilen dann Ihr Wissen und werden bezahlt. Schauen Sie sich diese kompilierte Liste für Organisationen an, die technische Schriftsteller bezahlt.

• Community Writer -Programm
• Lassen Sie sich bezahlt, um für diese über 45 Websites zu schreiben
• Veröffentlichungen, die Sie dafür bezahlen, technische Artikel zu schreiben

Open Source -Projekte

Der Beitrag zu Open Source kann eine lohnende Art sein, Erfahrungen in nahezu allen Fähigkeiten zu lernen, zu lehren und zu bauen, die Sie sich vorstellen können. Ein Großteil Peole trägt aus verschiedenen Gründen und die wichtige, die die Fähigkeiten verbessert.

Hier sind einige Artikel, die Ihnen helfen, zu verstehen, wie Sie zu Open -Source -Projekten beitragen können.

• Open Source für technische Schriftsteller
• Der Leitfaden für technische Autoren, um zu Open -Source -Projekten beizutragen
• Wie man als technischer Schriftsteller zu Open-Source beiträgt
• 4 Tipps zum technischen Schriftsteller mit Open -Source -Beiträgen
• Erste Schritte mit Open Source als technischer Schriftsteller

Open -Source -Projekte/-Programme technische Autoren können dazu beitragen

• Codecademy Docs ~ docs ist eine Community-gesteuerte Sammlung von Code-Dokumentation für beliebte Programmiersprachen und Frameworks.
• Das Good Docs -Projekt ~ Das gute DOCS -Projekt ist eine Community, die zusammenarbeitet, um die Vorlagen, Tools und Ressourcen zu erstellen, um die Gesamtqualität der Dokumentation in OSS und darüber hinaus zu verbessern.
• Google Season of Docs ~ Staffel of Docs bietet Unterstützung für Open -Source -Projekte zur Verbesserung ihrer Dokumentation und bietet professionellen technischen Autoren die Möglichkeit, Erfahrungen in Open Source zu sammeln.
• HACKBOBERFEST ~ HACKBOBERFEST ist eine jährliche Veranstaltung, die die Menschen dazu ermutigt, im Oktober zur Open Source beizutragen.
• Das Gnome -Dokumentationsprojekt

Blogs, die für großartige Schreibinhalte folgen sollen

• Techwriters Hub
• Kesi Parker
• Idratherbewriting
• Alles technische Schreiben
• WriteTech Hub
• Hackmamba

Vorbereitung auf technische Schreibinterviews

Es gibt mehrere Tipps, die Ihnen helfen können, ein Interview zu führen, aber einige der wichtigsten haben einen gut zugeschnittenen Lebenslauf und Anschreiben. Schauen Sie sich die folgenden Anschreiben und Tipps an, die Ihnen helfen, Ihr nächstes Interview zu landen:

• Anschreibenvorlage für Ihren nächsten Job
• So schreiben Sie ein verlockendes Anschreiben
• So schreiben Sie einen technischen Schriftsteller Lebenslauf [+Beispiele]
• Bester technischer Schriftsteller Anschreiben Beispiel und Format

Hier sind einige Ressourcen für Fragen des technischen Schreibens, die Ihnen helfen, sich auf Ihr nächstes Interview vorzubereiten.

• 12 Fragen und Antworten des technischen Schriftstellers Interviews
• Google Technical Writer Interviewfragen
• Vorstellungsgespräch für technisches Schreiben

Websites zur Veröffentlichung von Artikeln

• Hashhnode ~ Hashhnode ist eine kostenlose Entwickler -Blogging -Plattform, auf der Sie Ihre Ideen mit Menschen in Technik, Entwicklern und Ingenieuren teilen können.
• Medium ~ Medium ist eine Social Publishing -Plattform mit vielen Benutzern und Sie können verschiedene Inhalte und Ideen veröffentlichen.
• Dev.to ~ dev.to ist, wo Programmierer Ideen teilen und sich gegenseitig wachsen lassen. Es ist eine Online -Community, um großartige Ideen zu teilen und zu entdecken.
• Mirror.xyz ~ Mirror.xyz ist eine Verlagsplattform für Schriftsteller, die Kryptowährung und Blockchain -Technologie nutzt.
• Freecodecamp ~ freecodecamp ist eine gemeinnützige Organisation, die aus einer interaktiven Webplattform, einem Online-Community-Forum, Chatrooms, Online-Publikationen und lokalen Organisationen besteht, die beabsichtigen, Lernwebentwicklung für jeden zugänglich zu machen.

Jobbörsen für technische Schreibrollen

• Top -Jobbörsen für technische Autoren

• Startup.jobs

• Witzig

• Beste Schreibjobs

Hergestellt mit ❤️ von Damilola Ezekiel