documentation guidelines (student version)

7/21/2019 Documentation Guidelines (Student Version)

1/13

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) o your daily

assigned tasks. T!is !as proven to be !elpul in "riting a compre!ensive ormal

reports or submission in subsequent sections.

#. T!e minimum requirement or submission to t!e aculty supervisor is a $eekly

%og "!ic! documents your activities or eac! "eek during t!e training.

&. 'eports s!ould provide details o all IT related projects tasks or assignments

during t!e training. T!is includes but not limited to

System/ Database development

o *lanning

o +nalysis

o ,esign

o Testing

o Implementation

o -ystem maintenance support

Multimedia/ animation

o /rap!ic ,esign

o +nime ,evelopment

Web/ Portal development

o 0omepage

o +pplication

Networking

o *lanning

o ,esign

o -ettingup installation

o et"ork maintenance support

Trainer / instructor or !T related courses

Ot"er tec"nical tasks

Ver 3.0 02/04/15 Faculty o Inormation !cience " Tec#nology


2/13


3/13


Weekly #eport

1. T!e $eekly %og (+ppendix 6) must be certiied by your 7ompany -upervisor and

contains t!e ollo"ing sections

-$eek umber

- ,ates

- ,escription o activities

- -ignature o supervisor

- ame o supervisor

- 'emarks

2. +ny problems on tasksprojectsassignments assigned by t!e company s!ould be

clearly stated in t!e orm. -martly make use o t!is as a medium o

communication to communicate "it! your 7ompany -upervisor.

#. T!e certiied original copies o t!e $eekly %ogs are to be kept by t!e students

and included in t!e +ppendix section o t!e 8inal 'eport.

&. T!e sot copies o t!e reports ("it!out 7ompany -upervisor signature) are to be

sent to t!e 99: 8aculty -upervisor as part o t!e 9ont!ly 'eports.



4/13


Mont"ly #eports

1. +t t!e end o eac! training mont! students are compulsoryto submit mont!ly

progress reports to t!eir 99: 8aculty -upervisors.

2. You need to provide an overvie" o your activities t!roug!out eac! mont! and

submit via email to your 99: 8aculty -upervisor.

#. T!e $eekly %ogs s!ould be included in t!e 9ont!ly 'eport toget!er "it! t!e

additional overvie" inormation about t!e activities or eac! mont! as mentioned

above.

4. T!e 9ont!ly %og (+ppendix 7) must be certiied by t!e 7ompany -upervisor and

contains t!e ollo"ing sections

-

9ont!- ,ate

- Trainee ame

- 6rie description on t!e company;s job prospectus

- ,escription o tasksassignments

- -ignature and name o company supervisor

- 'emarks



5/13


$inal #eport

1. T!e 8inal 'eport documents all t!e activities t!roug!out t!e Industrial Training

sessions.

2. T!e report is to be submitted to t!e 99: 8aculty -upervisor at t!e beginning o

t!e presentation session.

3. -otcopy o t!e report s!ould be submitted via email to t!e 99: supervisor at

least % days beore t!e presentation.

&. 'ecommendation outline or inal report.

&over Page

Table o &ontents

'cknowledgments()* !ntroduction

()( &ompany +ackground

- Inormation o t!e 7ompany (ame +ddress 9ap etc)

- ature o 6usiness

- ,epartment attac!ed

- umber o sta in t!e company (IT sta and nonIT sta)

- IT roles in t!e company

2.0 !T #elated Pro,ects/Tasks/'ssignments

-)( Task '

- ,escription,iagram

- 9et!odology o +c!ieving t!e *rojectsTasks+ssignments

- *roblems


6/13


'ppendi.

- 7ertiied 3riginal $eekly9ont!ly %ogs

- Tables ,iagrams 7!arts

- %etters 8orms -ample Input3utputs (exclude program source codes)

etc.

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



7/13


'ppendi. ' &ompany Details $orm

7ompany 6ackground

ame

+ddress

$ebsite link

Instructions to t!ecompany (pleaseattac! "it! map)

7ompany -upervisor

ame

*osition

7ontact o.

>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

* Please email this form latest by the Third Weekof the training to the ! "aculty#upervisor$



8/13


Sample &ompany Details

7ompany 6ackground

ame Megamate Corporation (M) S/B+ddress 166, Jalan 2

Taman em!ira,4"540 #po$.

$ebsite link %%%.m&.&om.m'Instructions to t!ecompany (pleaseattac! "it! map)

Map e&ription

1. *rom MM+ mala&&a, tae ort$ / Sot$ $ig$%a' roa.

(e!$ra'a +tara Selatan)

2. $en rea&$ing era tate, trael ntil rea&$ing Simpang

lai Toll %$i&$ i lo&ate approimatel' at ilometer 25.

3. ter t$e toll, tae rig$t ire&tion ntil rea&$ 4-7n&tion

roa. T$ere are 2 option in orer to rea&$ Megamate

Corporation (M) S/B.

4. 888888..

7ompany -upervisorame Mr. Tan im 9at*osition itant Manager7ontact o. 04-"4""


9/13


&omments

or aigne to me are not #T


10/13


'ppendi. + Weekly #eport

Weekly 0og

$eek o ,ate Trainee ame

Description o Task/'ssignment

Task 1

Task 2

-ignature

-upervisor ame

7ompany-upervisor -tamp

,ate

'emarks >>>>>>>>>>>>>>>>>>>>>>>>>>..

8888888888888888888....................

88888888888888888888888.....

Ver 3.0 02/04/15 Faculty o Inormation !cience " Tec#nology Page


11/13


Sample Weekly 0og



12/13


'ppendi. & Mont"ly #eport

Mont"ly #eport

,ate

Trainee ame

+rie description on t"e company1s ,ob prospectus2

Description o tasks/assignments

-ignature

-upervisor ame

7ompany-upervisor -tamp

,ate

'emarks >>>>>>>>>>>>>>>>>>>>... >>>>>>>>>>>>>>>>>>>...... >>>>>>>>>>>>>>>>>>>>>



13/13


Sample Mont"ly #eport


documentation guidelines (student version)

Documents