Full Title:Technical Writing
Language of Instruction:English
Module Code:PRPF C7002
 
Credits: 5
Valid From:Semester 2 - 2013/14 ( February 2014 )
Module Delivered in 2 programme(s)
Module Description:Students completing this module will understand the issues that need to be addressed when producing technical documents. It will assist students in the aquisition of technical writing skills enabling them to competently produce a variety of reports, procedures and short manuals on a range of technical subjects and issues.
Learning Outcomes:
On successful completion of this module the learner should be able to
  1. Define technical writing and describe it's characteristics
  2. Demonstrate an understanding of the formating and style requirements of technical writing
  3. Understand the role that analysing your audience and identifying your purpose play in technical communication
  4. Research and write a technical report on a course specific topic, for a specific audience, using a range of sources
  5. Describe the ways in which copyright law and the fair use concept apply to the use of information from other sources
 

Module Content & Assessment

Indicative Content
Understanding Technical Writing
The main types; purpose; how is technical writing different; how to write clearly; grammar and style
Case Studies of Good and Poor Documentation
The correct way to write explanations and procedures; styles ; structures; clarity
How To Write a Standard User Document
Document development 'life cycle'; identifying the audience; planning; creating the outline, organising the information; writing; reviewing. Examples (user installation; maintenance manual)
Analysing Your Audience; Identifying Your Purpose
Matching the content to the client and the task
Defining Technical Terms
Striking the right balance between technical rigour and reader understanding. Use a variety of methods to define technical terms
Using Sources
How copyright law and the fair use concept apply to the use of information
Assessment Breakdown%
Course Work100.00%

Full Time

Course Work
Assessment Type Assessment Description Outcome addressed % of total Marks Out Of Pass Marks Assessment Date Duration
Written Report Four written reports (documents) 1,3,4,5 100.00 0 0 n/a 0
No Project
No Practical
No End of Module Formal Examination
Reassessment Requirement
No repeat examination
Reassessment of this module will be offered solely on the basis of coursework and a repeat examination will not be offered.
Reassessment Description
Written reports covering the key learning outcomes to be completed during the summer and submitted before end- August.

DKIT reserves the right to alter the nature and timings of assessment

 

Module Workload & Resources

Workload: Full Time
Workload Type Workload Description Hours Frequency Average Weekly Learner Workload
Lecture No Description 1.00 Every Week 1.00
Tutorial Lab 2.00 Every Week 2.00
Directed Reading No Description 3.00 Every Week 3.00
Independent Study No Description 2.00 Every Week 2.00
Total Weekly Learner Workload 8.00
Total Weekly Contact Hours 3.00
Workload: Part Time
Workload Type Workload Description Hours Frequency Average Weekly Learner Workload
Lecture No Description 1.00 Every Week 1.00
Tutorial No Description 2.00 Every Week 2.00
Directed Reading No Description 3.00 Every Week 3.00
Independent Study No Description 2.00 Every Week 2.00
Total Weekly Learner Workload 8.00
Total Weekly Contact Hours 3.00
Resources
Recommended Book Resources
  • Brusaw, Charles T 2009, Handbook of Technical Writing, 12th Ed., Prentice Hall NY [ISBN: 978-0312575120]
  • Pringle, Alan S. O'Keefe, Sarah S. 2006, Technical Writing 101, 9th Ed., Scriptorium Press London [ISBN: 978-0970473325]
  • Brusaw, Charles T 2011, The Elements of Technical Writing, 9th Ed., St. Martin's Press Boston MA. [ISBN: 978-0312575120]
  • Markel, Michael 2009, Technical Communication, 9th Ed., Bedford St. Martin's Press USA [ISBN: 978-0612377334]
  • Sun Technical Publications 2009, Read Me First! A Style Guide for the Computer Industry, 3rd ed. Ed., Prentice Hall [ISBN: 978-013705826]
This module does not have any article/paper resources
Other Resources
  • Website-eBook: Sajitha, Jayaprakash 2008, Technical Writing, Himalaya Publishing, Mumbai

Module Delivered in

Programme Code Programme Semester Delivery
DK_KCOMP_7 Bachelor of Science in Computing 3 Mandatory
DK_KCMP7_6 [Exit Award from L7] Higher Certificate in Science in Computing 3 Mandatory