TPR3311/HIT3019 Industrial Training Documentation Guidelines

Documentation Guidelines

Overview

1.  You are required to document all your activities during your Industrial Training placements.

2.  You are advised to keep a journal (using an empty exercise book) of your daily assigned tasks. This has proven to be helpful in writing a comprehensive formal reports for submission in subsequent sections.

3.  The minimum requirement for submission to the faculty supervisor is a Weekly Log which documents your activities for each week during the training.

4.  Reports should provide details of all IT related projects, tasks or assignments during the training. This includes but not limited to:

·  System/ Database development

o  Planning

o  Analysis

o  Design

o  Testing

o  Implementation

o  System maintenance/ support

·  Multimedia/ animation

o  Graphic Design

o  Anime Development

·  Web/ Portal development

o  Homepage

o  Application

·  Networking

o  Planning

o  Design

o  Setting-up/ installation

o  Network maintenance/ support

·  Trainer / instructor for IT related courses

·  Other technical tasks

o  Software Installation and troubleshooting for Operating System and off-the-shelf software

o  Hardware assemble, configurations and troubleshooting

5.  Additional information such as application of skills towards the tasks, problems encountered and recommendations which would provide better understanding of the experiences during the training can also be logged.

6.  In addition, within the first three weeks of your training, you are required to submit the details of the training company (Appendix A) to your faculty supervisor.

Weekly Report

1.  The Weekly Log (Appendix B) must be certified by your Company Supervisor, and contains the following sections:

-  Week Number

-  Dates

-  Description of activities

-  Signature of supervisor

-  Name of supervisor

-  Remarks

2.  Any problems on tasks/projects/assignments assigned by the company should be clearly stated in the form. Smartly make use of this as a medium of communication to communicate with your Company Supervisor.

3.  The certified original copies of the Weekly Logs are to be kept by the students and included in the Appendix section of the Final Report.

4.  The soft copies of the reports (without Company Supervisor signature) are to be sent to the MMU Faculty Supervisor as part of the Monthly Reports.

Monthly Reports

1.  At the end of each training month, students are compulsory to submit monthly progress reports to their MMU Faculty Supervisors.

2.  You need to provide an overview of your activities throughout each month and submit, via e-mail, to your MMU Faculty Supervisor.

3.  The Weekly Logs should be included in the Monthly Report together with the additional overview information about the activities for each month as mentioned above.

5.  The Monthly Log (Appendix C) must be certified by the Company Supervisor, and contains the following sections:

-  Month

-  Date

-  Trainee Name

-  Brief description on the company’s job prospectus

-  Description of tasks/assignments

-  Signature and name of company supervisor

-  Remarks

Final Report

1.  The Final Report documents all the activities throughout the Industrial Training sessions.

2.  The report is to be submitted to the MMU Faculty Supervisor at the beginning of the presentation session.

3.  Softcopy of the report should be submitted via email to the MMU supervisor at least 3 days before the presentation.

4.  Recommendation outline for final report.

Cover Page

Table of Contents

Acknowledgments

1.0 Introduction

1.1 Company Background

-  Information of the Company (Name, Address, Map, etc)

-  Nature of Business

-  Department attached

-  Number of staff in the company (IT staff and non-IT staff)

-  IT roles in the company

2.0 IT Related Projects/Tasks/Assignments

2.1 Task A

-  Description/Diagram

-  Methodology of Achieving the Projects/Tasks/Assignments

-  Problems Encountered and Solutions

2.2 Task B

-  Descriptions/Diagrams

-  Methodology of Achieving the Projects/Tasks/Assignments

-  Problems Encountered and Solutions

(All major tasks should be separated into subsection with the description, methodology and problems encountered as shown in the above examples)

3.0 Conclusion

-  Skills Developed/Other Knowledge

-  Suitability, Weaknesses, Ways to Improve, etc.

Appendix:

-  Certified Original Weekly/Monthly Logs

-  Tables, Diagrams, Charts,

-  Letters, Forms, Sample Input/Outputs (exclude program source codes), etc.

Remarks: All original sources from the company (diagrams, documents, and etc) in this report must receive the acknowledgement and permission from the company.

Appendix A Company Details Form

Company Background
Name
Address
Website link
Instructions to the company (please attach with map)
Company Supervisor
Name
Position
Contact No.
Email
Student Information
Name
Major
Contact No.
Department Attached

Comments:

……………………………………………………………………………………………………………

……………………………………………………………………………………………………………

……………………………………………………………………………………………………………

……………………………………………………………………………………………………………

……………………………………………………………………………………………………………

……………………………………………………………………………………………………………

* Please email this form latest by the Third Week of the training to the MMU Faculty Supervisor.

Sample Company Details

Company Background
Name / Megamate Corporation (M) S/B
Address / 166, Jalan 2
Taman Gembira,
47540 Ipoh.
Website link / www.mc.com.my
Instructions to the company (please attach with map) /
Map description
1.  From MMU malacca, take North / South highway road. (Lebuhraya Utara Selatan)
2.  When reaching Perak state, travel until reaching Simpang Pulai Toll which is located approximately at kilometer 285.
3.  After the toll, take right direction until reach 4-junction road. There are 2 options in order to reach Megamate Corporation (M) S/B.
4.  ………………..
Company Supervisor
Name / Mr. Tan Lim Huat
Position / Assistant Manager
Contact No. / 04-7888477
Email /
Student Information
Name / Ahmad
Major / DCN
Contact No. / 016-8888588
Department Attached / IT Department

Comments:

Works assigned to me are not IT Related. No PC provided to trainee.

* Please email this form latest by the Third Week of the training to the MMU Faculty Supervisor.

Appendix B Weekly Report

Weekly Log

Week No :

Date :

Trainee Name :

Description of Task/Assignment:

Task 1:

Task 2:

Signature :

Supervisor Name :

Company/Supervisor Stamp :

Date :

Remarks : ……………………………………………………………………..

…………………………………………………......

…………………………………………………………….....

Sample Weekly Log

Appendix C Monthly Report

Monthly Report

Date: :

Trainee Name :

Brief description on the company’s job prospectus:-

------

------

------

Description of tasks/assignments:

------

------

------

------

------

------

------

Signature :

Supervisor Name :

Company/Supervisor Stamp :

Date :

Remarks : ……………………………………………………...

…………………………………………………......

………………………………………………………

Sample Monthly Report

Ver 3.0 24/02/14 Faculty of Information Science & Technology Page 13