Braucht ein Technischer Redakteur einen technischen Hintergrund?

Braucht ein Technischer Redakteur einen technischen Hintergrund?

Antworten (17)

Kurze Antwort: nein.

Trotzdem ist es ein Plus. Es ist gut, über fundierte Kenntnisse in dem Bereich zu verfügen, über den Sie schreiben, damit Ihre Dokumente mehr Gewicht und Einsicht haben.

Wenn ich nach technischen Dokumenten suche, würde ich bei gleicher Schreibkompetenz eine Person mit technischem Hintergrund einer Person ohne technischen Hintergrund vorziehen.

Warum nicht den Vorteil haben, wenn Sie können? Stellen Sie sicher, dass Sie ein großartiger Autor sind, oder arbeiten Sie mit dem Thema, über das Sie schreiben werden, aber landen Sie die Gigs.

Ich bin ein erfahrener technischer Redakteur, der sich auf API-Dokumentation spezialisiert hat. Meiner Erfahrung nach muss ein technischer Redakteur, um erfolgreich zu sein, über ausreichende technische Fähigkeiten verfügen, um (1) die Bedürfnisse der Benutzer zu verstehen und (2) die Fachexperten (KMU) zu untersuchen. Wenn Sie nur nachplappern, was Ihnen die KMU sagen, werden Sie wichtige Details übersehen. KMU (in allen Bereichen) haben blinde Flecken; Sie haben so lange in den Tiefen ihres Codes gelebt, dass sie vergessen können, dass die „offensichtlichen“ Annahmen nicht offensichtlich sind. Sie neigen auch dazu, ein bestimmtes Modell dafür zu haben, wie Benutzer ihr Produkt verwenden werden, das möglicherweise eher spekulativ als realitätsbasiert ist. (Ich kritisiere sie nicht; sie haben oft nicht genug Informationen.) Es ist die Aufgabe des Technischen Redakteurs, all dem auf den Grund zu gehen. (Auch die des Testers, falls vorhanden.)

Wenn ich technische Redakteure einstelle, achte ich auf eine bestimmte Schwelle an Schreibfähigkeiten, aber dann achte ich auf technische Begabung. Ich hätte lieber einen kompetenten Autor, der die Technologie versteht, als einen Autor, der exzellente Prosa produziert, aber viel Hilfe braucht, um herauszufinden, was er schreiben soll. Es ist einfacher, einem kompetenten Autor zu helfen, das Schreiben zu verbessern, als jemandem zu helfen, die relevante Technologie tiefgehend zu verstehen.

Aus meiner Erfahrung nicht explizit. Aber ein technischer Redakteur muss verstehen, worüber er schreibt, um es effektiv zu kommunizieren. Wenn Sie ein Buch zu diesem Thema möchten, ist Technical Communication von Mike Markel eine ausgezeichnete Ressource für alle Aspekte des technischen Schreibens und der Kommunikation.

Ich habe selbst einen technischen Hintergrund, aber ich habe mit einigen erstklassigen Tech-Autoren zusammengearbeitet, die aus den Geistes- oder Sozialwissenschaften in das Fachgebiet gewandert sind. Meiner Meinung nach haben die besten technischen Redaktionsteams eine Mischung aus Technikern (um technische Einblicke zu geben) und Nicht-Technikern (um nützliche "dumme" Fragen zu stellen).

Gutes Technisches Schreiben basiert jedoch auf einer soliden Neugier auf die Materie. Ihr Ziel sollte es sein, die Technologie Ihren Lesern zugänglich zu machen. Tech-Autoren, die nicht neugierig oder von Technologie eingeschüchtert sind (und es gibt viele von ihnen!), schreiben auf oberflächliche, irreführende Weise über Dinge, die sie kaum verstehen, was die Leser in den Wahnsinn treibt.

Ich mache technisches Schreiben und Veröffentlichen im Computerbereich, und bis zu einem gewissen Grad sage ich ja. Sie müssen eine Vorstellung von der Technologie haben, wenn Sie Originalmaterial über eine Technologie schreiben. Wenn Sie technische Details über die Arbeit schreiben, die jemand anderes geleistet hat, können Sie meiner Meinung nach mit guten Kommunikationsfähigkeiten mit einer Person auskommen, die die Details des Themas versteht.

Ich denke schon, dass man etwas technisches Geschick oder Interesse braucht, um den Fachjargon und die allgemeine Anwendung des Themas aufzugreifen.

Ein guter Draht zu einem Fachexperten ist in jedem Fall erforderlich, damit Sie eine zweite Meinung zu dem Geschriebenen einholen und prüfen können, ob es zum Thema passt.

Die Technische Redaktion ist ein dreibeiniger Hocker. Um es gut und effizient zu machen, brauchen Sie drei Dinge:

  • Ausreichendes Wissen über die Aufgabe des Benutzers, um herauszufinden, was er wissen muss und wie er es ihm mitteilen kann.

  • Ausreichende Kenntnisse der Technologie, um herauszufinden, wie sie funktioniert und was Sie dazu sagen müssen, und um den Entwicklern die richtigen Fragen zu stellen.

  • Ausreichende Kenntnisse im Schreiben und Publizieren, um tatsächlich ein verständliches und nutzbares Werk zu erstellen.

Können Organisationen technische Redakteure mit allen drei dieser Fähigkeiten finden? Oft können sie es nicht, deshalb müssen sie sich oft mit nur einem oder zwei zufrieden geben.

Verstehen alle Organisationen, dass die technische Redaktion ein Hocker auf drei Beinen ist? Nein, manchmal wollen sie nur, dass jemand die Wörter schreibt oder jemanden, der das Dokument hübsch aussehen lässt.

Organisationen, die nicht wissen, dass sie alle drei Beine des Hockers brauchen, werden von einer Kommunikationskatastrophe zur nächsten eilen, bis sie feststellen, dass sie alle drei Beine brauchen. Dann stehen sie vor dem Problem, dass es sehr schwierig ist, eine Person mit allen drei zu finden, insbesondere für das Gehalt, das sie zu zahlen bereit sind.

An diesem Punkt müssen sie sich entscheiden, auf welche der drei sie verzichten können. Dies hängt vom Produkt und vom Markt ab. Wenn sie ein Verbraucherprodukt liefern, ist die erste Etappe eigentlich ziemlich einfach, also können sie sich auf die anderen beiden konzentrieren.

Wenn der Markt sehr technisch ist, konzentrieren sie sich möglicherweise mehr auf das Hinspiel.

Wenn sie dringend auf Entwicklerzyklen in ihrem Produktionsprozess gedrängt werden, können sie sich auf die zweite Etappe konzentrieren, um die Zeit zu minimieren, die Tech-Comm von ihrem Entwicklungsplan wegnimmt.

Aufgrund dieser unterschiedlichen Reaktionen auf den Mangel an Menschen mit allen drei Fähigkeiten, die bereit sind, für den angebotenen Lohn zu arbeiten, können Sie einen Job mit nur zwei oder manchmal nur einem der drei Beine bekommen, aber je nachdem stehen unterschiedliche Möglichkeiten offen welche beine hast du.

Und natürlich sind sowohl die erste als auch die zweite Etappe mehr oder weniger branchenspezifisch. Sie können beispielsweise über beispielhafte Aufgabenkenntnisse in Buchhaltungssoftware verfügen, aber für das technische Schreiben von Medizinprodukten völlig ungeeignet sein.

Kurz gesagt, es kommt darauf an. Technische Redaktion ist keine allgemeine Ware, und Sie können für einen Job hervorragend qualifiziert und für einen anderen hoffnungslos unqualifiziert sein.

Gute, gründliche Antwort; vielen Dank, dass Sie auf eine alte Frage zurückgekommen sind, um sie hinzuzufügen. Vielen Unternehmen ist nicht bewusst, was ein guter Technischer Redakteur mit allen dreien leisten kann (und warum er ein gutes Gehalt wert ist), aber sie sind da draußen, wenn Sie weiter suchen.

Ja, ein effektiver Technischer Redakteur verfügt über genügend technisches Hintergrundwissen und Erfahrung, um nützliche Inhalte aus dem (oft spärlichen) Quellenmaterial zu erstellen.

Noch wichtigere Eigenschaften effektiver technischer Redakteure sind jedoch starke Schreib-/Kommunikationsfähigkeiten und eine tiefe Neugier auf das Thema und das Publikum. Diese werden einen nicht sehr technischen Redakteur im Job weit bringen.

Der Titel „Technischer Redakteur“ umfasst ein breites Spektrum an Berufsbildern. Infolgedessen haben berufstätige Technische Redakteure in diesem Bereich ein breites Spektrum an technischen Fähigkeiten und Wissensanforderungen. Je weniger technisch das Thema ist, desto weniger streng gilt der technische Scharfsinn.

Autoren, die mit Endbenutzerdokumentation und -hilfe arbeiten, benötigen beispielsweise häufig weniger tiefgreifende Programmierkenntnisse, obwohl häufig Kenntnisse in dem Bereich erwartet werden, in dem das Produkt verwendet werden soll. Ein Hintergrund in User Experience Design (kognitive Psychologie) ist oft von Vorteil. Und es gibt typischerweise Anforderungen an die vom Team verwendeten Produktionstools (Office, HTML, XML usw.).

Daher kann die Definition von „technisch“ je nach Thema, Publikum und Team variieren.

Auf der anderen Seite erfordern tiefergehende technische Inhalte ein tiefes Verständnis der Materie. Ich glaube nicht, dass ein Autor ohne Programmiererfahrung nützliche API-Dokumente schreiben könnte, und die Nützlichkeit der Dokumente steigt wahrscheinlich mit der Erfahrung und dem Wissen des Autors.

Ich habe mit Technischen Redakteuren gearbeitet, die keinen besonders technischen Hintergrund hatten. Zum größten Teil konnten sie es fälschen, indem sie Formen und Stilen folgten und Teile aus anderen Quellen wiederverwendeten. Das ist wirklich nur eine verherrlichte Bearbeitung.

Um fair zu sein, habe ich jedoch auch mit Autoren mit tief technischem Hintergrund gearbeitet, die ebenfalls keine nützlichen Dokumente schreiben konnten, weil sie keine effektiven Kommunikatoren waren. Sie haben das Thema sehr gut verstanden, konnten aber nicht klar und prägnant vermitteln, wie es funktioniert oder was damit zu tun ist.

Technisches Wissen ist also eine Voraussetzung, aber nicht die einzige.

Es gibt zwei Szenarien, in denen man argumentieren könnte

Ich habe ziemlich viel technisches Schreiben für Informationssysteme im Gesundheitswesen geschrieben. Es gibt zwei Hauptkategorien, die ich identifizieren kann, und jede hat unterschiedliche Anforderungen. Zwischen diesen beiden Kategorien gibt es jede Menge Projekte mit unterschiedlichen Anforderungen.

  1. Allgemeine Endbenutzerdokumentation:
    • Dokumente, die nicht-technische Personen verwenden müssen, um ein minimal komplexes technisches System zu verstehen. Ein Beispiel hierfür könnte das Benutzerhandbuch für ein medizinisches Abrechnungssystem sein. Beim Schreiben dieser Art von Material ist nur sehr wenig technisches Wissen erforderlich.
  2. API-Dokumente
    • Dokumente, die Programmierer verwenden, um eine Programmierschnittstelle für eine Software zu verstehen. Schlecht geschriebene API-Dokumente können für Integrationsbemühungen fatal sein. Dies erfordert einige technische Kenntnisse, insbesondere ein Verständnis für Programmierung. Sie müssen kein Vollzeit-Programmierer sein, aber Sie sollten zumindest die Grundlagen der Programmierung und alles verstehen, was für die API, die Sie dokumentieren, besonders wichtig ist. Ihnen sollte ein Programmierer oder jemand, der die API sehr gut versteht, als Ressource für diese Art von Projekt zur Verfügung gestellt werden.

Mein Unternehmen stellt eine personelle technische Ressource zur Verfügung, wenn wir einen Autor ohne technischen Hintergrund im erforderlichen Bereich einstellen. Wenn Sie gut mit einer menschlichen technischen Ressource oder sogar einer nichtmenschlichen technischen Ressource zusammenarbeiten können, kann dies Ihren Bedarf an technischem Hintergrund drastisch reduzieren.

Zusammenfassend hängt es also davon ab, wie technisch das ist, was Sie schreiben, und von den Ressourcen, die von der einstellenden Stelle bereitgestellt werden.

Ich bin dabei, eine ziemlich gute Vertragsrolle als technischer Autor (TA) abzulehnen, der API für ein Unternehmen mit Sitz in Gibraltar schreibt - Sonne, Sand und Senoritas! Wieso den? Weil ich das Vorstellungsgespräch allein aufgrund meiner Persönlichkeit und nicht aufgrund meiner Eignung für das Thema bestanden habe. Ich bin ein TA, der gut genug ist, um meine Grenzen zu kennen, und ich habe bereits Erfahrung mit dem Schreiben von APIs. Warum sage ich also nein zu einem Vertrag, den ich wirklich brauche? Die Antwort ist, dass ich nicht glaube, dass ich dem gerecht werden könnte.

Ich habe kein "angemessen" tiefes Verständnis der Programmierung ( JSON / Java / RESTful ) und müsste mich stark auf die Entwickler stützen, um jede Nuss und Schraube des Codes zu erklären - wodurch ich enthüllen würde, was für ein Wally ich war, und Entwickler schließlich entmutigen oder technische Experten daran hindern, den technischen Kram zu liefern, den ich als Autor dem Publikum erklären sollte.

Ich bin fest davon überzeugt, dass ein guter Autor aus Erfahrung, aus einer soliden Wissensbasis zum Thema und aus einer Position der Stärke heraus schreibt. Das Verständnis Ihres Themas lässt Ihre Prosa fließen, und zwar mit Klarheit und Prägnanz. Also ja, ein technischer Autor braucht einen technischen Hintergrund zu dem Thema, über das er schreibt; und sei es nur, damit er die Zusammenarbeit der Fachexperten erhalten kann, von denen er die Informationen erhält.

Es versteht sich von selbst, dass der Autor, wenn er die Informationen, über die er schreibt, nicht versteht, keine Ahnung hat, wie er die Daten sichten und das Thema klar erklären soll.

Nein, Sie müssen nur so viel wissen wie der Endbenutzer.

In meinem Fall habe ich einen Marketing- und Übersetzungshintergrund und wurde später leitender technischer Redakteur für Texte für mobile Benutzeroberflächen von Samsung. Ich musste nie Richtlinien oder Texte für hochrangige Programmierer schreiben. Ich habe nur für UX-Designer und für die Endbenutzer der Geräte geschrieben.

Die Fähigkeiten, die es mir ermöglichten, in dieser Rolle erfolgreich zu sein, waren der Drang, so viel wie möglich zu verstehen und zu vereinfachen und immer logische Gründe zu finden, um meine Entscheidungen zu stützen. Denken Sie außerdem daran, dass Sie normalerweise mit einem Team oder Fachexperten zusammenarbeiten, die die Details für Sie ausfüllen. Zwingen Sie diese klugen Leute mit vielen dummen Fragen zum Nachdenken und Sie werden äußerst nützliche Inhalte produzieren.

Und in einigen Fällen kann es sogar nützlich sein, weniger zu wissen als ein typischer Endbenutzer, solange Sie alles lernen und erzählen, was er wissen möchte.

Nein. Ich war dort und habe das von beiden Seiten gemacht.

Ein technischer Redakteur muss genug wissen, um zu verstehen, was ihm gegeben/gesagt wird, und es in etwas Nützliches umzuwandeln. Ihre Aufgabe ist es, Fachsprache in etwas Nützliches für Laien zu verwandeln und sie in einem Stil zu formatieren, den das Unternehmen für seine Dokumente verwendet.

Der Inhalt muss vom Ingenieur/Programmierer stammen, der möglicherweise Hilfe benötigt, um die nützlichen Informationen zum Bearbeiten und Umschreiben auf eine Seite zu bringen. Der schlimmste Fall wäre, sie zu interviewen und den ersten Entwurf für sie zu erstellen. Häufiger geht es darum, zurückzuschauen, um zu sehen, was sie wirklich gemeint haben, oder um Lücken mit Dingen zu füllen, die sie ausgelassen haben, weil „das jeder weiß“.

Wie die Lehre lässt sich auch das Technische Schreiben als „die Kunst, Informationen ohne Wissen zu vermitteln“ beschreiben.

Sie sind der Fürsprecher des Endverbrauchers. Ihre technischen Fähigkeiten bestehen in diesem Fall einfach darin, die notwendigen Informationen von den Experten zu erhalten und diese Informationen dann Ihren Lesern so zu präsentieren, dass sowohl die Experten als auch die Leser mit den Ergebnissen zufrieden sind. Ich scherze, ich scherze.

Im Ernst, angesichts der notwendigen Interview-, Recherche- und Schreibfähigkeiten (ohne die Sie einer der Experten wären, nicht einer der Autoren), ist ein echtes Interesse an dem Themengebiet hilfreich. Experten sprechen im Allgemeinen gerne über ihre Lieblingsthemen und freuen sich über ein sympathisches Publikum.

Ich denke, es kommt darauf an. Um endbenutzerorientierte Dokumente wie SAP, JDE Schritt-für-Schritt-Arbeitsanweisungen zu schreiben, wie etwas zu tun ist, benötigen Sie nicht wirklich technischen Hintergrund. Sie müssen schnell lernen.

Nein , Sie müssen keine Kurse oder einen Abschluss in Ihrer Nähe besucht haben. Was Sie wirklich brauchen, ist eine unersättliche Neugier . Eines der besten mir bekannten Beispiele dafür ist Martin Gardner , der über 20 Jahre lang eine Kolumne für Scientific American mit dem Titel Mathematical Games geschrieben hat . Ihm wird viel Anerkennung für die Popularisierung der Freizeitmathematik im 20. Jahrhundert zuteil.

Laut Wikipedia: "Ironischerweise hatte Gardner Probleme, Kalkül zu lernen, und belegte nach der High School nie einen Mathematikkurs." Soweit ich mich erinnere, schrieb Gardner einen Teil des Erfolgs seiner Kolumne seiner mangelnden Ausbildung in Mathematik zu. Jeden Monat musste er für seine Kolumne etwas über das Thema lernen, bevor er es seinem Publikum beibringen konnte.

Sie müssen verstehen (hoffentlich etwas ausführlicher als das, was Sie schreiben), was der Leser wissen muss und was er bereits versteht, damit Sie wissen, welche Analogien, Beispiele, Detaillierungsgrad und andere Dinge Sie verwenden müssen, um die Lücke dazwischen zu schließen und das neue Material. Sie müssen also kein Experte sein, aber Sie müssen wissen, wohin Sie wollen, wenn Sie jemand anderen dorthin führen wollen.

Wenn Sie mit Experten zusammenarbeiten, müssen Sie auch wissen, was der Leser nicht wissen muss, damit Sie unnötige Details und Randthemen herausfiltern können.

Sie können immer etwas davon lernen, aber es hilft wirklich, mit einem allgemeinen Gefühl für das Material und den Hintergrund zu beginnen.

Ein etwas anderer Blickwinkel ist, dass technisches (oder jede andere Art von) Schreiben genauso viel mit Kultur zu tun haben kann wie mit explizitem Inhalt.

Um für eine bestimmte technische Community am effektivsten zu schreiben, müssen Sie das behandelte Thema verstehen, aber auch in einem Stil kommunizieren, der bei dieser Community Anklang findet. Wenn Sie beispielsweise über die zeitgenössische Musikszene in einer bestimmten Stadt schreiben, würden Sie bei den Lesern an Glaubwürdigkeit verlieren, wenn Sie den lokalen Slang missbrauchen oder veraltete Referenzen verwenden, selbst wenn Ihre Fakten über die lokalen Bands völlig korrekt sind.

Auf die gleiche Weise neigen technische Gemeinschaften dazu, subtile, aber unterschiedliche Arten der Verwendung und Wahrnehmung von Sprache zu haben, die Sie als Außenseiter, sympathischen Besucher oder "einen von uns" kennzeichnen können. Lesen Sie einige angesehene Texte für den Bereich, in dem Sie arbeiten möchten, und suchen Sie nach Beispielen für den Stil der Community.

Ja! Das bedeutet aber noch lange kein Ingenieurstudium, und der Stand der technischen Kenntnisse hängt von der Art der Dokumentation ab. Sie benötigen mehr ingenieurwissenschaftlichen und naturwissenschaftlichen Hintergrund, um für ein Ingenieur- oder Wissenschaftsunternehmen zu arbeiten. Möglicherweise benötigen Sie mehr Statistiken und finanziellen Hintergrund, um für eine Bank zu arbeiten oder Förderanträge zu schreiben. Hier sind einige der technischen Bereiche, die die meisten Verfasser von Dokumentationen und Angeboten verwenden müssen: Mathematik: Prozentsätze, Brüche, Maße, Zeit, Einheitenumrechnungen. Wissenschaft: Physik (Grundlagen wie Beschleunigung, Kraft). Technik: ISO-Normen, wissenschaftliche Notation, technische Zeichnungen und Symbole. Software: Code-Repositories, Betriebssysteme, Datenbanken, Webtechnologien, Publishing-Software und -Methoden.

Persönlich habe ich Abschlüsse in Englisch und Journalismus, aber ich wäre ziemlich verloren, wenn ich nicht Physik, Trig, Mikrobiologie, Chemie, Astronomie und andere naturwissenschaftliche und ingenieurwissenschaftliche Kurse in der High School und am College belegt hätte. Diese Grundlage brauchte ich besonders für technisches Schreiben (mein aktueller Job), aber der technische Hintergrund war auch in journalistischen Jobs wichtig, wenn ich über Umweltthemen, Staatshaushalte und Steuern, Wettergeschichten und viele andere Bereiche schrieb.