#REQUEST.pageInfo.pagedescription#

Site Navigation

CRAF7005 - Documentation Management

banner1
Title:Documentation Management
Long Title:Documentation Management
Module Code:CRAF7005
 
Duration:1 Semester
Credits: 5
NFQ Level:Intermediate
Field of Study: Craft
Valid From: Semester 1 - 2013/14 ( September 2013 )
Module Delivered in 1 programme(s)
Module Coordinator: MICHAEL HOURIHAN
Module Author: Kevin Barry
Module Description: The aim of this module is to introduce the student to technical writing skills in order to produce accurate and up to date reports and documentation. The student will also be introduced to higher level Excel for documentation, graphs, charts, sorting data and using mutiple sheets to support maintenance and commissioning work sheets, journals and reports.
Learning Outcomes
On successful completion of this module the learner will be able to:
LO1 Write a suitable planned preventative maintenance (PPM) schedule.
LO2 Keep maintenance, scheduling, report documentation up to date and accurate, ensuring openness, transparency and accountability.
LO3 Create and edit spread sheets using existing assignments (Revit MEP) and drawings to produce represented data.
LO4 Take existing drawings, schematics, p & id`s and use industry specific software to create planned preventative maintenance records.
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 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
 

Module Content & Assessment

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 referancing documents and data, sourcing relavent data and information.
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.
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.
Excel
Create and modify charts, graphs, and templates. Use Excel to develop formulae to perform calculations on data, sorting data and using multiple sheets.
Assessment Breakdown%
Course Work100.00%
Course Work
Assessment Type Assessment Description Outcome addressed % of total Assessment Date
Written Report Write a report on a specific piece of plant or equipment, taking into account its efficiency, life expectancy, possible replacement with a more efficient up todate product, maintenance and commissioning schedule where applicable. 1,2 15.0 Week 3
Reflective Journal Research and choose a piece of equipment, keep up todate documentation using planned preventative maintenance schedules, keep updating this every two weeks-where every two weeks is equal to three monthly intervals. Keep in mind best practice, accurate documentation, openness, transparency and accountability. Choose a method of documentation that suits the task. Use Wiki's or Blogs where helpful. 1,2 40.0 Every Second Week
Written Report Write a planned preventative maintenance schedule for a chosen plant room or one off piece of equipment, EG- boiler, fans, motors, burners, air handling unit etc. Use a writing style to suit a technical report, taking into account grammer, punctuation and structure. Use Wiki's or Blogs where helpful. 1 20.0 Week 9
Practical/Skills Evaluation Take five pieces of equipment and write up a planned preventative maintenance schedule for each one, working from existing drawings, schematics, P & ID's. Produce records for twelve month period only. (Excel package). 3,4 25.0 Sem End
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 Theory 1.0 Every Week 1.00
Lab Computer Lab Work 2.0 Every Week 2.00
Independent Learning Self directed. 4.0 Every Week 4.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 Theory 1.0 Every Week 1.00
Lab Computer lab work 2.0 Every Week 2.00
Independent Learning Self directed 4.0 Every Week 4.00
Total Hours 7.00
Total Weekly Learner Workload 7.00
Total Weekly Contact Hours 3.00
 

Module Resources

Recommended Book Resources
  • Alan Dillon, 2010, Step by Step Spreadsheets, 2nd Ed. [ISBN: 9780717147465]
  • 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_ECTMS_7 Bachelor of Science in Craft Technology - Mechanical Services 3 Mandatory

Cork Institute of Technology
Rossa Avenue, Bishopstown, Cork

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