|
Lecturer(s)
|
-
Kosková Třísková Lenka, Ing. Ph.D.
|
|
Course content
|
Lecture outlines: 1. What is technical documentation - types and forms 2. Reader needs or target audience 3. Documentation structure 4. Content design 5. Secrets of a concise manual 6. The magic of a reference manual 7. A good workflow 8. Well-connected documentation 9. Brief on supporting technologies Exercise circuits: The practical exercises discuss topics from the manuals, and students document their virtual product one at a time.
|
|
Learning activities and teaching methods
|
|
Lecture, Practicum
|
|
Learning outcomes
|
Technical documentation writing is focused on the content side of help, manuals, workflows, or reference guides. It introduces the basic types of product documentation and shows how they are created and why it is worthwhile to think about the content and structure of the documentation.
|
|
Prerequisites
|
unspecified
|
|
Assessment methods and criteria
|
Combined examination
|
|
Recommended literature
|
|