Technische Dokumentation

Principles of Technical Writing in English 2

Integrierte Lehrveranstaltung, 2.00 ECTS

 

Lehrinhalte

Course Content
This course builds on the unit completed in the first semester and explores the topics covered there in more detail. We will talk further about planning and executing larger documents, the differences between writing in English and German, methods for ensuring consistency across documents, indexing, writing for different media, and text usability. We will also cover some typical problem cases for non-English natives, quality management for English texts and creating guidelines for English documentation. Once again, there will be an emphasis placed on producing sample texts (using Adobe FrameMaker), in this case larger, collaborative projects.

Teaching outcome/Skills acquired
After completing this course, students will be able to:
- get information from subject-matter experts and translate that information into useable, documentation.
- apply advanced editing skills to edit content at copyediting and comprehensive levels.
- generate indexes and other navigational aids for larger documentation projects.
- discuss the difference in language use across different media.
- apply principles of information design and content strategy for usability in documents.
- collaborate and interact with subject matter experts, colleagues, and users for the purpose of generating effective technical documents and communication products.

Recommended literature
Markel, Mike: "Technical Communication", Bedford/St. Martin's, 2014. ISBN: 978-1457673375
Alred, Gerald J, Brusaw, Charles T and Oliu, Walter E: "The Handbook of Technical Communication", Bedford/St. Martin's, 2014. ISBN: 978-1457675522
The Chicago Manual of Style, University of Chicago Press, 2003. ISBN: 978-0321115836
Strunk, William Jr. and White , E.B.: "The Elements of Style", Longman, 1999 ISBN: 978-0205309023
Tebeaux, Elisbeth and Dragga, Sam: "The Essentials of Technical Communication", OUP 2014. ISBN: 978-0199379996
Holloway, Brian R.: "Technical Writing Basics", Prentice Hall 2004 ISBN-13: 978-0131140899
Kaplan Technical Writing: A Resource for Technical Writers at All Levels, Kaplan Publishing 2008 ISBN: 978-1427797216
Van Laan, Krista: "The Insider's Guide to Technical Writing", XML Press 2012, ISBN: 978-1937434038
Pringle, Alan S and O'Keeffe, Sarah S.: " Technical Writing 101: A Real-World Guide to Planning and Writing Technical Documentation, Second Edition", Scriptorium 2003 ISBN: 978-0970473325

Lernergebnisse der LV

Die Studierenden kennen alle wichtigen Medientypen, die über Text und Grafik hinaus in Technischen Dokumenten zum Einsatz kommen, sowie die gängigen Erstellungswerkzeuge und haben einen Überblick über Technologien, Methoden und Werkzeuge der OnlineDokumentation. Sie sind mit allen Besonderheiten im Umgang mit den Quellsprachen Deutsch und Englisch vertraut und können diese im redaktionellen Gesamtprozess anwenden.
Sie kennen die Grundlagen, sowie den Nutzen relationaler Datenbanksysteme und sind in der Lage relevante SQL-Abfragen zu erstellen.

Empfohlene oder verpflichtende Fachliteratur und andere Lernressourcen bzw. –instrumente

Bücher: siehe Lehrveranstaltungen
Fachzeitschriften

Art der Vermittlung

Vorlesung und Übung (ILV)

Voraussetzungen und Begleitbedingungen

1. Semester, speziell Modul 4

Prüfungsmethode und Beurteilungskriterien

Vorlesung: schriftliche Abschlußprüfung; Übung: Bewertung der laufend fälligen schriftlichen Arbeiten bzw. der Beiträge in den eLearning-Phasen.