#REQUEST.pageInfo.pagedescription#

Site Navigation

CTEC7003 - Technical Writing and Presenta

banner1
Title:Technical Writing and Presenta
Long Title:Technical Writing and Presentations
Module Code:CTEC7003
 
Credits: 5
NFQ Level:Intermediate
Field of Study: Communication Technologies
Valid From: Semester 1 - 2010/11 ( September 2010 )
Module Delivered in 4 programme(s)
Module Coordinator: Donagh OMahony
Module Author: EAMONN BUTLER
Module Description: This module outlines the issues that need to be addressed when producing technical documentation.It will also assist the student in the acquisition of technical writing skills. These skills may be used to produce a variety of reports, procedures and short manuals on a range of topics to include technical subjects and issues,software applications and or hardware. The student will also prepare and deliver an oral presentation on a selected topic.
Learning Outcomes
On successful completion of this module the learner will be able to:
LO1 Research and write a technical report on a course specific topic using a range of information sources.
LO2 Write a suitable operating procedure for selected hardware and or write a procedure to describe a specific software routine.
LO3 Write a technical description of a piece of hardware or application software in terms of function,applications and specifications.
LO4 Outline the safety, marketing and legal implications when writing operating guidelines and procedures.
LO5 Adapt the level of complexity of existing documentation to suit different clients.
LO6 Prepare and deliver an oral presentation on a course related topic
Pre-requisite learning
Module Recommendations
This is prior learning (or a practical skill) that is strongly recommended before enrolment in this module. You may enrol in this module if you have not acquired the recommended learning but you will have considerable difficulty in passing (i.e. achieving the learning outcomes of) the module. While the prior learning is expressed as named CIT module(s) it also allows for learning (in another module or modules) which is equivalent to the learning specified in the named module(s).
No recommendations listed
Incompatible Modules
These are modules which have learning outcomes that are too similar to the learning outcomes of this module. You may not earn additional credit for the same learning and therefore you may not enrol in this module if you have successfully completed any modules in the incompatible list.
No incompatible modules listed
Co-requisite Modules
No Co-requisite modules listed
Requirements

This is prior learning (or a practical skill) that is mandatory before enrolment in this module is allowed. You may not enrol on this module if you have not acquired the learning specified in this section.

No requirements listed
Co-requisites
No Co Requisites listed
 

Module Content & Assessment

Indicative Content
Types of technical documentation
Various types and formats.Training manuals, user manuals,brochures, installation and commissioning instructions,maintenance procedures,software manuals technical reports for the general public, scientific research etc.Standardising templates across an organisation. Microsoft manual of style, Matching the content to the client and the task.
Issues
How best to deal with multiple authors on one document, standardising language and level.Working with geographically distributed teams.Dealing with subject matter experts. Cultural considerations. Striking the right balance between technical rigour and reader understanding. How best to benchmark the quality and suitability of documentation. Marketing issues. How to handle revisions/updates
Software
Characteristics and strengths of different software packages. Industry standards. Importing and editing graphics, automatic generation of contents and index,bibliography, inserting cross- reference links, web links. Graphical and diagrammatic presentations.Trade off between powerful and user-friendly packages.Compatibility between different software packages. Multiple versions of the one document
Research publications:
Peer review journals as an example of prescribed format and specific audience: Abstract , reference citation, prescribed templates and syntax, footnotes, publication reviews, peer reviews,
Legislative Landscape
Supplier obligations to provide adequate documentation. EC regulations. Safety and marketing considerations. Read write access and security. Keeping track of revisions. Plagiarism and ethics
Case Studies
Examples of good and poor documentation. Published EC regulations and guidelines. Environmental Impact studies. EPA publications. Consultancy reports.Planning submissions
Technical Presentations
Establishing the level of target audience and matching the content.Prepublishing and making presentation available on the web, wiki etc. Referencing sources. Preparation and delivery.Outlining the content. Structure and layout
Assessment Breakdown%
Course Work100.00%
Course Work
Assessment Type Assessment Description Outcome addressed % of total Assessment Date
Written Report Technical description of a piece of hardware, technical procedure or application software 2,3,4 20.0 Sem End
Written Report One selected topic described at different levels of complexity 5 20.0 Week 6
Written Report Technical report on an independently researched course related topic 1,2,3,4,5 40.0 Week 10
Presentation This presentation may be based on the material of a report 6 20.0 Week 12
No End of Module Formal Examination
Reassessment Requirement
Coursework Only
This module is reassessed solely on the basis of re-submitted coursework. There is no repeat written examination.

The institute reserves the right to alter the nature and timings of assessment

 

Module Workload

Workload: Full Time
Workload Type Workload Description Hours Frequency Average Weekly Learner Workload
Lecture Course material 1.0 Every Week 1.00
Independent & Directed Learning (Non-contact) Preparing reports and presentation 4.0 Every Week 4.00
Lab Computer lab 2.0 Every Week 2.00
Total Hours 7.00
Total Weekly Learner Workload 7.00
Total Weekly Contact Hours 3.00
Workload: Part Time
Workload Type Workload Description Hours Frequency Average Weekly Learner Workload
Lecture Course material 1.0 Every Week 1.00
Lab Computer lab 2.0 Every Week 2.00
Independent Learning Preparing reports and presentation 4.0 Every Week 4.00
Total Hours 7.00
Total Weekly Learner Workload 7.00
Total Weekly Contact Hours 3.00
 

Module Resources

Supplementary Book Resources
  • Alan S. Pringle, Sarah S. O'Keefe 2003, Technical Writing 101, Scriptorium Press Research Triangle Park, NC [ISBN: 978-0970473325]
  • Gerald J. Alred, Charles T. Brusaw, Walter E. Oliu, 2006, Handbook of Technical Writing, Ninth Edition [ISBN: 978-0312575120]
This module does not have any article/paper resources
This module does not have any other resources
 

Module Delivered in

Programme Code Programme Semester Delivery
CR_SESST_8 Bachelor of Science (Honours) in Environmental Science and Sustainable Technology 4 Mandatory
CR_SINEN_8 Bachelor of Science (Honours) in Instrument Engineering 3 Elective
CR_SPHYS_7 Bachelor of Science in Applied Physics and Instrumentation 3 Elective
CR_SPHYS_6 Higher Certificate in Science in Applied Physics and Instrumentation 3 Elective

Cork Institute of Technology
Rossa Avenue, Bishopstown, Cork

Tel: 021-4326100     Fax: 021-4545343
Email: help@cit.edu.ie