Module Details

Module Code: INTR7026
Title: Eng Services Documentation
Long Title: Engineering Services Documentation
NFQ Level: Intermediate
Valid From: Semester 1 - 2019/20 ( September 2019 )
Duration: 1 Semester
Credits: 5
Field of Study: 5213 - Interdisciplinary Engineering
Module Delivered in: 1 programme(s)
Module Description: The aim of this module is to introduce the student to technical writing skills to produce reports and documentation. The student will also be introduced to utilising spreadsheets for documentation, graphing, charting, data sorting and reporting..
 
Learning Outcomes
On successful completion of this module the learner will be able to:
# Learning Outcome Description
LO1 Identify and evaluate sources of information relevant to engineering services provision
LO2 Develop an installation procedure/planned preventative maintenance (PPM) schedule.
LO3 Structure documentation to provide up to date and accurate reporting of maintenance/installation scheduling, ensuring openness, transparency and accountability.
LO4 Create and edit spread sheets to present performance data
LO5 Assemble reference information and data to produce an installation or maintenance performance report
Dependencies
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 MTU module(s) it also allows for learning (in another module or modules) which is equivalent to the learning specified in the named module(s).

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
 
Indicative Content
Technical Documents
Types of documents used within a company structure. Training manuals, user manuals, installation, commissioning and instruction manuals. Software manuals to support maintenance, commissioning of plant and machines. Standardising documentation across a company, checking, cross referencing documents and data, sourcing relavent data and information.
Writing Style
Writing style of technicsl documents, outlining the content, structure and layout. Observing grammer, language and fundamentals of good writing, incorporating open-ness and transparency.
Graphical Data Presentation
Create and modify charts, graphs, and templates. Use Excel to develop formulae to perform calculations on data, sorting data and using multiple sheets.
Writing of Technical Documents
Writing of plant preventative maintenance documents (PPM). Writing various reports, journals, revising and keeping up to date documentation. How to structure, layout and format a document according to best practice, matching the correct documentation to the specific task. The importance of keeping accurate documentation, openess, transparency and accountability. Grammar, language and fundamentals of good writing structure.
Case Studies
Examples of good and poor writing and documentation. EPA publications, environmental impact studies, risk assessment studies, consultancy reports, goverment reports, EU published guidelines and regulations.
Module Content & Assessment
Assessment Breakdown%
Coursework100.00%

Assessments

Coursework
Assessment Type Written Report % of Total Mark 15
Timing Week 3 Learning Outcomes 1
Assessment Description
Compile a report on sources of information
Assessment Type Presentation % of Total Mark 25
Timing Week 6 Learning Outcomes 4
Assessment Description
Collect data from a site or laboratory based test, analyse and present graphically
Assessment Type Written Report % of Total Mark 30
Timing Week 10 Learning Outcomes 2,3
Assessment Description
Write an installation procedure or planned preventative maintenance schedule for a chosen plant room or one off piece of equipment,
Assessment Type Written Report % of Total Mark 30
Timing Sem End Learning Outcomes 1,2,3,4,5
Assessment Description
Critically review an installation or maintenance project and compare with industry best practice
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 University reserves the right to alter the nature and timings of assessment

 

Module Workload

Workload: Full Time
Workload Type Contact Type Workload Description Frequency Average Weekly Learner Workload Hours
Lecture Contact Theory Every Week 1.00 1
Lab Contact Computer Lab Work Every Week 2.00 2
Independent Learning Non Contact Self directed. Every Week 4.00 4
Total Hours 7.00
Total Weekly Learner Workload 7.00
Total Weekly Contact Hours 3.00
Workload: Part Time
Workload Type Contact Type Workload Description Frequency Average Weekly Learner Workload Hours
Lecture Contact Theory Every Week 1.00 1
Lab Contact Computer lab work Every Week 2.00 2
Independent Learning Non Contact Self directed Every Week 4.00 4
Total Hours 7.00
Total Weekly Learner Workload 7.00
Total Weekly Contact Hours 3.00
 
Module Resources
Recommended Book Resources
  • J.T. Billingsley. (2017), So What?: Effective Writing for Engineers, CreateSpace Independent Publishing Platform, [ISBN: 13: 978-15412].
  • Alan Dillon. (2014), Step by Step Spreadsheets, 3rd. Gill & Macmillan Ltd, [ISBN: 9780717160440].
Supplementary Book Resources
  • Gerald J. Alred, Charles T. Brusaw, Walter E. Oliu,. (2019), Handbook of Technical Writing, 12th. [ISBN: 9781319058524].
  • D.F. Beer, D. A. McMurrey. A Guide to Writing As an Engineer, 5th. John Wiley & Sons, p.2019, [ISBN: 13: 978-11192].
This module does not have any article/paper resources
Other Resources
 
Module Delivered in
Programme Code Programme Semester Delivery
CR_EESMG_7 Bachelor of Science in Engineering Services Management 1 Mandatory