Technical Documentation

Principles of Technical Writing 2

Integrated course, 2.00 ECTS

 

Course content

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, interviewing subject-matter experts, writing for global audiences, writing for different media, and text usability. We will also continue covering some typical language problem cases for non-English speaking writers. We will explore issues of typography and its effect on readability, page design, and using visual aids in technical documentation. Once again, there will be an emphasis placed on producing sample texts (using Adobe FrameMaker), in this case designing instructions and multi-channel publishing.

Learning outcomes

Teaching outcome/Skills acquired After completing this course, students will be able to:
- get information from subject-matter experts and translate that information into usable, documentation.
- apply advanced editing skills to edit content at copy editing and comprehensive levels.
- generate indexes and other navigational aids for larger documentation projects.
- discuss the difference in information design across different media.
- prepare documents for multi-channel publishing.
- make decisions on typography, page layout and visual aids to increase the usability of information products.

Recommended or required reading and other learning resources / tools

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

Mode of delivery

ILV

Prerequisites and co-requisites

TWE1

Assessment methods and criteria

Continuous assessment and contributions to online classes.