Technical Documentation

Principles of Technical Writing 1

Integrated course, 2.00 ECTS

 

Course content

The course covers planning and structuring documents, and then moves to more granular topics such as text comprehensibility and coherence, style, register and audience, structuring sentences, and document usability. Language issues typical to English technical documentation will be approached using practical examples. There will be an introduction to producing texts using Adobe FrameMaker.

Learning outcomes

The primary objective of this course is to teach students to write clear, correct and precise content in English.

After completing this course, students will be able to:
* communicate technical information clearly, concisely, and correctly.
* use authoring tools to create print documents.
* analyse writing context and create content according to users' needs.

Recommended or required reading and other learning resources / tools

Anderson, Paul V.: “Technical Writing: A Reader-Centered Approach. Eighth Edition”, Harcourt Brace & Company, Orlando,2014 ISBN: 978-1133309819
Weiss, Edmond H.: “How to Write Usable User Documentation”, Oryx, Westport, 1991 ISBN: 978-0897746397
Schultz, Susan I. et al.: “The Digital Technical Documentation Handbook”, Digital Press, Burlington, 1992 ISBN: 978-155558103
Morgan, Kieran: "Technical Writing Process", Better on Paper, Australia, 2015 ISBN: 978-0-9941693-1-0
Van Laan, Krista: "The Insider's Guide to Technical Writing", XML Press, 2012 ISBN: 978-1937434038

Mode of delivery

80% face-to-face
20% distance learning

Prerequisites and co-requisites

not applicable

Assessment methods and criteria

Continuous assessment