Technical Writing for Software Engineering
QUARTER 1 2016
Instructor: Debo Roy, PhD

Course Description:
This course is designed to walk you through a technical document production scenario using 3D Printing and 3D scanning scenarios based on use of CAD design software. The course is focused on design, analysis, implementation and execution based on user experience design. Students will learn audience and task analysis to start with. They will then start mastering the art of creating an outline for technical production process, writing learning objectives, and developing the structure of a technical document. Further, students will gain expertise in writing and designing materials for online presentation, user manuals and online design contexts. They will also learn about online delivery techniques and evaluation procedures. In addition to focusing on clear, concise, effective writing and user-friendly design, this course also emphasise the ability to function as a productive member of a team.

Course Objective:
1. The student should be able to write and design in any instructional context.

2. Develop and understand various strategies for planning, researching, drafting, revising, and editing documents that respond effectively and ethically to instructional situations.
A.Developing, writing, and editing material for online courses concerned with application software, work methods, theories and procedures
B.Observing production, developmental, and experimental activities to determine best
operating practices and proper use of online courses
C.Reviewing design documents, client-submitted requests, drawings, and other data relative to operation, maintenance, and use of online courses.
D.Organizing material and completes writing assignments according to set standards regarding order, clarity, conciseness, style, and terminology

3. Able to communicate and collaborate with real client and industry professionals on multiple issues of technical documentation.

4. Learn and apply strategies for effective group collaboration and project management.

5. Understand and use various research methods for document testing and delivery.

6. Develop strategies for using and adapting various communication technologies for projects.

7. Learn to argue with visual data, understanding and implementing principles of document design.

No specific text book. Lecture notes will be posted in the course website. 

Reference Text: Designing Web-Based Training by William Horton (2000). Published by John Wiley & Sons, Inc.

Prerequisites and other related courses which include important concepts relevant to the course:
Related Courses:

English for Active Communication (Undergraduate)

Writing in the Workplace (Elective)

Writing and Design for the World Wide Web (Elective)

Documentation for Technical Procedures

Student evaluation method:
I believe that students can motivate themselves best when there is real life experience involved in the process of learning. The grading for workshops and projects are based on a number of criteria.
1. Organization
2. Content Quality.
3. Layout
4. Formatting.
5. Visual Design
6. Production and Print Quality
7. Incorporating Feedback from Industry Professional or Client
8. Group Collaboration

Major Assignments:

Five Response Papers - 100% TOTAL
1st Response Paper: 10%
2nd Response Paper: 10%
3rd Response Paper: 50%
4th Response Paper: 15%
5th Response Paper: 15%