Beratung zum technischen Schreiben

Dieser Leitfaden erstellt Ratschläge und Einblicke in das technische Schreiben, insbesondere für Webtechnologie und Bloggen, das Zeichnen von erfahrenen Fachleuten und persönliche Erfahrung.

Wählen Sie Ihr Thema aus:

Das ideale Thema ist eines, das Sie leidenschaftlich und persönlich investiert haben. Ihre Begeisterung wird durchscheinen. Wie Chris Coyier mit Bedacht berät: "Schreiben Sie den Artikel, den Sie sich wünschen, wenn Sie etwas gegoogelt haben." Während auf Zuordnungsbasis produktiv sein kann, erhöht die persönliche Verbindung die Qualität.

Schreiben Sie, während das Wissen frisch ist:

Die beste Zeit zum Schreiben ist sofort, nachdem er etwas Neues gelernt hat. Die Erfahrung ist immer noch lebendig und ermöglicht es Ihnen, das "vor" und "Nach" des Verständnisses zu vermitteln. Selbst wenn Sie schnelle Notizen über Ihren Lernprozess aufschreiben, können später wertvoll sein. Betrachten Sie den Ansatz "heute gelernt" (TIL), wie von Manuel Matuzovic veranschaulicht.

Hebelvergleiche:

Eine leistungsstarke, nicht genutzte Technik ist es, neue Technologien mit bekannten zu vergleichen. Rachel Andrew schlägt vor, moderne JavaScript -Techniken jemandem zu erklären, der mit JQuery vertraut ist und die Lücke zwischen dem Neuen und dem Bekannten überbrückt. Dieser Ansatz verbindet das Unbekannte mit einer gut verstandenen Stiftung.

Erstellen einer überzeugenden Einführung:

Eine häufige Gefahr besteht darin, den Zweck des Artikels nicht klar zu sagen und die Zielgruppe frühzeitig abzielt. Rachel Andrew betont die Bedeutung einer kurzen Einführung, die das Thema und die beabsichtigte Leserschaft sofort verdeutlicht. Brian Rinaldi fügt hinzu, dass ein gut geschriebener Einführungsabsatz bestimmen kann, ob ein Leser fortgesetzt wird.

Klare und prägnante Titel:

Erin Kissane setzt sich für klare, beschreibende Titel ein und Priorität der Klarheit über Clickbait. Ein klarer Titel wie "Erste Schritte mit GraphQL, Phoenix und React" ist einem vage, ClickBaity One weit überlegen. Klarheit kommt sowohl zu dem Leserverständnis als auch von SEO zugute.

Die Kunst des Outro:

Ben Halpern unterstreicht die Bedeutung des abschließenden Absatzes, oft nach der Einführung des zweithäufigsten Abschnitts. Während eine einfache Zusammenfassung ("EHE, was Sie ihnen gesagt haben") effektiv ist, verstärkt eine gut gestaltete Schlussfolgerung die Botschaft und liefert Schließung.

Verbesserung der Skannierbarkeit:

Brian Rinaldi betont, wie wichtig es ist, große Textblöcke aufzubrechen, um die Lesbarkeit zu verbessern. Zu den Techniken gehört die Verwendung von Unterhose, Listen, relevanten Bildern und Screenshots, veranschaulichenden Grafiken, präzisen Videos, gut formatierten Codeblöcken, Tabellen und Collapsible-Abschnitten mit <details>/<summary></summary></details> . Die strategische Verwendung von Designelementen wie Abstand, Farbe und Ausrichtung verbessert die Skannbarkeit weiter.

Aktive Stimme und Wortwahl:

Katy Decorah und Neal Whitman betonen die Bedeutung der Verwendung von Active Voice ("Der Server verarbeitet die Anforderung") anstelle von passiven Voice ("Die Anforderung wird vom Server verarbeitet"). Vermeiden Sie Wörter wie "gerecht", die herablassend und oft unnötig sein können.

Ton und Stimme aufrechterhalten:

Ton (wie Sie etwas sagen) sollte mit dem Kontext übereinstimmen. Ein freundlicher, maßgeblicher, einladender und dankbarer Ton ist im Allgemeinen für technisches Schreiben geeignet. Die Stimme (Ihre Persönlichkeit) sollte konsistent bleiben, auch wenn der Ton für verschiedene Situationen angepasst wird.

Verwaltungslänge:

Das technische Schreiben leidet oft unter übermäßiger Länge. Wade Christensen empfiehlt einen rücksichtslosen Bearbeitungsansatz. Während übermäßig kurze Beiträge auch problematisch sind, sollten Klarheit und Nützlichkeit der Hauptaugenmerk sein und nicht die Wortzahl. Ein langer Beitrag in eine Serie zu zerlegen, sollte nur dann erfolgen, wenn die Teile thematisch unterschiedlich und in sich geschlossen sind.

Schreibblock überwinden:

Angst und Selbstzweifel sind häufige Hindernisse für technisches Bloggen. Max Böck schlägt vor, die wesentlichen Punkte zu veröffentlichen, sobald die wesentlichen Punkte abgedeckt sind, und ignoriert die Stimme "Es ist nicht bereit". Jeremy Keith raten davon ab, Entwürfe zu behalten, da sie oft unvollendet bleiben. Denken Sie daran, selbst ein kleiner Beitrag kann hilfreich sein (Matthias OTT). Ali Spittel weist darauf hin, dass selbst Anfänger wertvolle Perspektiven haben.

Stil und Kreativität:

Sara Soueidan betont, dass es keinen einzigen perfekten Schreibstil gibt. Sei du selbst und lass deine Persönlichkeit durchscheinen und gleichzeitig Klarheit aufrechterhalten. Experimentieren Sie mit kreativen Formaten wie kommentierten Gesprächen oder Videoreihen.

Anfänger ausgerichtet Inhalt:

Während das Web mit Inhalten auf Anfängern gefüllt ist, kann sich ein gut geschriebener Einführungsbeitrag auffallen. Klarheit ist für alle Fähigkeiten wertvoll.

Beispiele in der Praxis gegen Abstraktion:

Christine betont die Bedeutung realer Beispiele, um komplexe Konzepte zu veranschaulichen. Vermeiden Sie jedoch Beispiele, die die Klarheit beeinträchtigen. Die Abstraktion kann bei effektivem Einsatz stark sein.

Die Vorteile des Bloggens:

Blogging verbessert die Karriereaussichten, zeigt Fachwissen und verbessert das Verständnis. Khoi Vinh beschreibt das Bloggen als "Verstärker".

Übung und Verbesserung:

Konsequentes Schreiben und Verlagswesen sind für Verbesserungen von entscheidender Bedeutung. "Schreiben mit Einsätzen" (öffentlich Ihre Arbeit teilen) ist die effektivste Lernmethode.

Finden Sie Ihre Stimme:

Beginnen Sie damit, Ihr Wissen einfach zu teilen. Verbessern Sie Ihr Schreiben, indem Sie persönliche Erfahrungen einbeziehen, andere zitieren und Forschungen durchführen.

Gastbeitrag:

Wenn Sie sich auf eine Website stellen, überprüfen Sie ihre Richtlinien sorgfältig.

Nützliche Werkzeuge:

Dropbox -Papier zur Zusammenarbeit und Grammatik zum Korrekturlesen sind vorgeschlagene Werkzeuge.

Das obige ist der detaillierte Inhalt vonBeratung zum technischen Schreiben. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!