Die Untersuchung der Welt des Technical Writer

Leute, die technischen Unterlagen schreiben kommen aus allen Bereichen des Lebens - und die meisten sind nicht technische Redakteure per se. Hier sind einige der aktuellen Situation von Menschen, die aufgefordert wurden, im Laufe ihrer Berufe technischen Unterlagen zu schreiben:

  • Computerprogrammierer: Pat hat einen Abschluss in Informatik und wurde als Software-Entwickler für ein Unternehmen in der Überholspur eingestellt. Einige Monate später, fühlte sich das Unternehmen eine finanzielle Not und die technischen Redakteure entlassen. Pat hatte einen großen lieferbaren wegen in ein paar Monaten, und ihr Vorgesetzter sagte ihr, dass sie eine Bedienungsanleitung zu schreiben hatte. Sophomore Englisch (das Patent durch gerungen und verabscheute) hielt sie nicht für diese Art der Zuweisung vorbereiten. Schließlich war Shakespeare kein technischer Art von Kerl. Schlechte Pat hatte durchzuwursteln Handbuch zu schreiben und bekam vorzeitig graue Haare.
  • Fertigungsspezialist: Bill arbeitete für ein produzierendes Unternehmen seit vielen Jahren und entwickelte ein Stück Ausrüstung, die erwartet wurde, um die Branche zu revolutionieren. Die Ausrüstung machte sein Debüt in Deutschland auf der größten Konferenz der Industrie. Bill Vorgesetzter bat ihn, ein Papier (der Fachbegriff für eine Herstellung von technischen Präsentation) liefern auf der Konferenz. Das Publikum würde bestehen aus mehr als 200 Top-Industrie-Profis. Nicht nur, dass Bill das Podium mehr als den Zahnarztbohrer fürchten, er ist nicht ein technisches Papier herzustellen oder zu liefern wusste - vor allem in einem fremden Land für ein Publikum von diesem Kaliber.
  • Verrückter Wissenschaftler: Während bei einem Pharmaunternehmen arbeitete, hatte Nathaniel einen wichtigen Durchbruch auf eine Behandlung, die Kahlheit zu verhindern, versprochen. Der Präsident des Unternehmens bat ihn, einen Artikel für einen großen medizinischen Zeitschrift zu schreiben. Obwohl Nathaniel nach Wunsch des Präsidenten geschmeichelt wurde, wusste er nicht, das erste, was über das Schreiben oder einen technischen Artikel einreichen.
  • Außendienstmitarbeiter: Lynette war ein Vertriebsmitarbeiter für einen weltweiten Computer-Händler. Sie hatte oft weg für Wochen zu einer Zeit von zu Hause sein. Nach 15 Jahren als Straßenkämpfer, erlitt Lynette von Burnout. (Früher hat sie ihr Bild auf dem Kamin Mantel lassen, so dass ihre Familie sie nicht vergessen würde.) Lynette über dem aufstrebenden Gebiet hatte der Tech-Schreiben zu lesen. Sie rief eine lokale College, bekam die ganze Literatur, und beschlossen, einen Master-Abschluss in technischen Schreibens zu verfolgen.

Obwohl die Namen, die Unschuldigen zu schützen geändert wurden (Lynette, zum Beispiel hat in ihrem Rücktritt noch nicht eingeschaltet), Szenarien wie diese typisch sind. Technische Menschen, die nicht trainiert Autoren sind ständig zu schreiben technischen Unterlagen gebeten. Ihre Ausbildung und Berufserfahrung selten bereiten sie für diese Art von Herausforderung.

Dokumente der technischen Art

Die Menschen in spezialisierten Bereichen schreiben Dokumente, die technische oder komplexe Themen beziehen. Im Gegensatz zu Geschäftsunterlagen, die von einer Person in der Regel geschrieben werden, sind technische Dokumente oft eine gemeinsame Anstrengung zwischen Autor, Fachexperten (KMU), Herausgeber und andere. Technische Dokumente sind für viele Leser im Allgemeinen bestimmt. Hier sind einige häufig geschrieben technische Dokumente - Papier und elektronisch:

  • Abstracts
  • Artikel für Veröffentlichung
  • Computer Based Training (CBT)
  • Bewertungsformulare
  • Zusammenfassungen
  • Funktionale und Detailspezifikationen
  • Onlinehilfe
  • Präsentationen
  • Fragebögen
  • Berichte
  • Schulungsmaterial (Papier oder elektronisch)
  • Bedienungsanleitungen
  • Web Based Training (WBT)

Zuweisung der Verantwortung für technische Dokumente

Die Verantwortung für das Schreiben von technischen Unterlagen, hängt von einer Struktur des Unternehmens und Ressourcen. Hier sind drei Möglichkeiten, die Unternehmen in der Regel technische Dokumente zu erzeugen:

1. Technische Gurus (Ingenieure, Software-Entwickler und andere) schreiben ihre eigenen Dokumente. Einige dieser Leute haben Schreibkurse genommen, aber die meisten haben keine Ausbildung in einer zusammenhängenden Dokument zu schreiben. Diese "technischen Autoren" oft Schritte übersehen mit ihren Lesern zu teilen, weil diese Schritte offensichtlich zu ihnen sind. Und sie haben wahrscheinlich nicht auf die Bedürfnisse ihrer Leser identifiziert. Sie schreiben, was ihnen wichtig ist.

2. Die gleichen Gurus können Dokumente entwerfen und dann drehen Sie die Entwürfe über den technischen Autoren zu bearbeiten, formatieren und zu polieren. Es sei denn, der Technische Redakteur die Möglichkeit hat, den Gegenstand eng zu lernen, viele der Schritte, die von dem Guru übersehen wurden nicht durch den Autor oder Herausgeber identifiziert. Dieser Prozess wird, erzeugen jedoch ein Dokument, das für das Auge gefälliger sein kann - für das, was das wert ist.

3. Ein technischer Redakteur ist von Beginn eines Projekts hinzugezogen. Der Schriftsteller arbeitet mit dem Entwickler, der Gegenstand Experte (SME) ist. Sie arbeiten als kollaborative Team, die jeweils für das Projekt ihr Know-how Zugabe. Dieser Ansatz ist in der Regel die beste aller möglichen Welten.

Strategie, keine Software

Wer technische Dokumente schreibt müssen verstehen, wie wichtig es ist, einen strategischen Ansatz. Zum Beispiel, wenn Sie ein eigenes Haus entwerfen, rufen Sie zuerst jemand einen Hammer zu schwingen? Natürlich nicht. Ein Hammer ist nur ein Werkzeug. Um ein eigenes Haus entwerfen, Sie können einen Architekten nennen - eine ausgebildete Fachkraft, die Layout- Designs macht Pläne für die Sanitär-, Elektro- und Heizungs Systeme- und stellt die Struktur. Dann rufen Sie jemanden, der Hammer kennt.

Das gleiche gilt in technischen Schreibens wahr. Wirksame technische Dokumente benötigen einen Informationsarchitekten - ein technischer Redakteur. Ob diese Person ein professioneller technischer Redakteur oder Ingenieur oder Software-Entwickler ist, die technischen Unterlagen schreibt, sie müssen bei Planung, Entwurf und logische Struktur bereitzustellen. Jeder kann lernen, die Software zu verwenden, das Dokument zu erstellen. Ähnlich wie der Hammer, Software ist nur ein Werkzeug. Der Schlüssel zu einem großen Dokument zu schreiben, ist Strategie, keine Software.

Nur sehr wenige Menschen haben, dass eine breite Wissensbasis. Technisches Schreiben ist über die Verwendung von Strategie und Ressourcen klare, genaue und logische Dokumente zu schreiben. Wenn Sie eine logische Strategie anwenden und sich von Ressourcen in Anspruch nehmen, können Sie einfach über alles schreiben - vom Drehen auf Ihrem Computer ein Jet-Flugzeug zu montieren.

Was Sie brauchen, um erfolgreich zu sein

Hier ist ein Überblick, was es braucht klare und verständliche technische Unterlagen zu schreiben:

  • Zeigen Sie Respekt für Ihre Leser. Sie müssen immer mit Respekt für Ihre Leser zu schreiben. Schreiben Sie mit einer positiven Einstellung, nicht mit Arroganz. Technische Redakteure sprechen oft von ihren Lesern hochmütig mit Bemerkungen wie: "Wir schreiben diese Dokumente nicht für Idioten. Wenn sie so dumm sind, sollten sie dieses Produkt nicht verwenden." (Na ja, excuuuuse mich!) Auch die hellste humanoiden kann Verwirrung erleben, wenn sie mit etwas völlig Neues präsentiert.
  • Achten Sie viel Liebe zum Detail. Sie zeigen Ihr scharfes Auge für Details in der Art und Weise Sie darüber nachdenken, was Sie schreiben. Hier sind ein paar Aufzählungselemente aus einem Lebenslauf von jemandem extrahiert, die für eine Position als technischer Redakteur wurde die Anwendung:

# 8226; "Co-Autor wöchentliche Stadtzeitung." (Welche Zeitung? Was er schreibt? Die Zeitung wöchentlich ist, sondern seinen Beitrag wöchentlich? Alle zwei Monate? Monats?)

# 8226; "Generiert technische Berichte." (Was bedeutet er "erzeugt"? Hat er den Bericht schreiben oder nur die Drucktaste klicken und spucken sie aus?)

# 8226; Der Autor dieser Zeilen war nicht in der Lage, die Details zu erkennen, dass ein potenzieller Arbeitgeber beantwortet will. Daher war es offensichtlich, dass er nicht die Details erkennen konnte, dass sein Publikum braucht. Sie müssen die Fragen, die Ihre Leser fragen zu antizipieren können, und Sie müssen sie beantworten.

  • Kennen Sie Ihre Leser und deren Anforderungen. Im Gegensatz zu einem Brief, den Sie für einen bestimmten Leser schreiben kann, schreiben Sie oft ein technisches Dokument für eine vielfältige Gruppe von Lesern. Sie müssen ihre Bedürfnisse, um zu bestimmen, zu verstehen, wie Sie das Dokument schreiben und ob Print- oder elektronischen Medien geeignet ist.
  • Gemeinsame Anstrengungen. John Donne berühmtes Zitat zu zwicken: Keine Tech-Schriftsteller ist eine Insel. Auch wenn Sie der einzige Tech-Schriftsteller an Ihrem Projekt sind, werden Sie mit Menschen innerhalb und außerhalb der Organisation arbeiten: KMU, Redakteure, Publikation / Elektronik-Spezialisten und Endanwender.
  • Demonstrieren Sie die Fähigkeit, Bein-o Ihr Ego. Last but not least, müssen Sie in der Lage sein, Ihr Ego an der Tür zu verlassen. Der fertige Dokument wird oft sehr unterschiedlich sein von Ihrem ursprünglichen Entwurf. Jeder, der das Dokument Bewertungen fühlt sich gezwungen, einen Stift zu holen und markieren es. Es ist alles Teil des Prozesses - die Notwendigkeit, einen Beitrag zu leisten. Also, werden Sie bereit, Ihre Arbeit bearbeitet zu haben, neu bearbeitet, und vielleicht in Fetzen gerissen.

Ähnliche

Menü