project report format malaysia

FINAL PROJECT REPORT FORMAT

F5228

FP/FN621

Documentation (Refer Appendix H1)

This section describes the documentation guidelines for manual Final Year Project as described

in previous section. These guidelines must be strictly followed by the final year students and

supervised lecturers.

Table 1: Documentation Format Content

No. Items Description

1. Cover Page

The cover for all proposal, report and documentation must

contain the project title, author names, registration number,

department name, polytechnic name and session of study.

See Appendix B1.

2. Paper and Size Use only high quality white A4 70-gram or A4 80-gram

paper, size 210mm X 297mm.

3. Margin

For each page, the margin should be:

Left: 40 mm

Right, Top and Bottom: 25 mm

Header and Footer: 15 mm

4. Typesetting 1.5 spacing should be use in preparing the proposal, report

and documentation includes for tables or charts. The

typesetting which acceptable is:

Font Type: Times New Roman, Font Size : 12 pt

Chapter Title: Uppercase, Bold, Centered

Chapter Sub-section: Title Case, Bold, Align left

Paragraph: Justify

5. Figure and

Table

All tables, charts, figures, and graphs should be numbered

and have titles. Both the number and the title should be

centered either directly above or directly below the table.

The numbering must be related to the Chapter. For example:

Figure 2.4 is the fourth figure in Chapter 2.

6. Final Project

Report (Level 6)

Final Project Report must be written in not more than 100

pages length. It only considered text EXCLUDING front

page, appendix and references.

7. Paging Bottom right

8. References Any material taken from another source must be identified,

and a brief reference to its source included in the text. A

complete reference to the document is included in the

reference at the end of student final project report. The

student must follow The American Psychological

Association (APA) reference citations style for references in

text. See Appendix C1.

9. Binding Semester 6: Report cover must be Buckram (hardcover),

gold printing and 1418 times New Roman font face. See

Appendix B1 and Appendix B2.

Report

Table 2: Project Outcome

Outcome Description

Final

project

report

A final project report is a written documentation of the project and

declare with signature saying the report represent the students original

work and no act of plagiarism is present in their work.

Portfolio Project portfolio is a complete record of all the work or

documentation done by the students based on the project progress.

Students need to complete the checklist form for final submission to

the supervisor

User

manual Documentation that contains major functions performed by the

system and describes the architecture of the system in non-technical

terms. See Appendix N

Final

product

Student must produce a final product in softcopy (CD) to supervisor

and coordinator.

Final Project Report (Refer Appendix H1 until Appendix N)

A final project report is a written documentation of the project and declares with signature saying

the report represents the students original work and no act of plagiarism is present in their work.

The contents of final project report must include the entire list in the Table 3.

Table 3: Final Report Content

No. Description

1. Cover & Report Backbone See Appendix H1.

2. Plain paper

3. Title Page See Appendix.

4. Declaration of Originality Student makes declaration on their project originality, with the exclusion of

quotations in the written report. See Appendix.

5. Approval for Submission See Appendix

6. Acknowledgements See Appendix.

7. Abstract An abstract is not same as synopsis or project overview. It must state the

scope project domain, problem statement, the solution, research methodology

and the outcome. Abstract should be a one page summary of 150 300 words

and typed in 1.5 line spacing. See Appendix.

8. Table of Contents Each students contribution to the relevant chapters and section should clearly

be indicated by chapter in the project report I. See Appendix.

9. List of Tables List of table title with page numbers. The number sequence must follow the

chapter. See Appendix.

10. List of Figures Figures include pictures, photograph, painting, graph, cart and map. Same

with table list, the figure must have page number and it is sequence follow the

chapter. See Appendix.

11. List of Appendices This page will list all the Appendices in the project. Include all relevant

documentation, source code of system, screen displays, user manual and Gantt

Chart. See Appendix.

12. Chapter 1 (Introduction) i. Introduction

Explain on introductory project that carried out together current issue

related to project.

ii. Problem Statement

Explain the problems that arise which made the chosen project is carried

out.

iii. Objective

List the reason why the project is carried out. It should be in form point

(1....2.3.) and not in paragraph form. The objectives must be

measurable and achievable.

iv. Scope

Student needs to state the scope or project boundaries while doing this

project. This scope will make sure that this project will be done correctly

according to the stated scope.

a. System Scope

This section refers to the coverage of your system (area, time, payment,

delivery, cancellation). Student needs to elaborate objectives of project.

b. Users Scope

Target users are people who can interact with your system (e.g: E

Learning: target user: students, lecturers). However, you may want to

narrow down your target users based on the accessability of your project.

v. Project Significant

Explain the interest of implementing project that carried out.

vi. Conclusion

Summarize the chapter content that were implemented for the project.

13. Chapter 2 (Literature Review) Explain about the study that was carried out by other existing project, related

to the project being carried out. Its also provides the comparison between

current projects with the project that needs to be developed. (Can probably

stated project weakness earlier). Minimum of three(3) literature reviews.

It explains the technique / method / equipment or technology that would be

taken in implementing project. Students need to make numerous references

from books, conference working paper, journal article, magazine, report or

Internet. All source of references need to be recorded clearly in the text and

are stated in index.

14. Chapter 3 (Methodology) Explain the project development model and framework comprehensively that

adopt systems development or study implementation. The content should of

method, technique or approach which will be used during design and project

implementation phase.

15. Chapter 4 (Analysis & Design) Students need to explain and show the detailed project analysis and design that

has been done to complete the project. It includes all system development

diagrams, flowcharts, schematic diagrams and screenshots. Students need to

refer to level 5 for the content of analysis report and design report .

16. Chapter 5 (Development and Testing) Students need to explain the development process and their result of the

project. The testing processes also must be done to verify the functionality of

the project.

17. Chapter 6 (Suggestion and Conclusion) Student must make some conclusion about the project and discuss about

importance of the outcome. Students also have to make some suggestion in

order to enhance the project.

18. Reference References mean a list of works cited from published books, public document,

journals, articles, thesis, magazines, films, videos, slides, maps, unpublished

materials and electronic materials including websites. The way of written is

follow the APA style format. Refer Appendix.

APPENDIX E : Project Planner

F5228 and FP621 Project Planner

WEEK ACTIVITY DELIVERABLES

CONSULTATION PRACTICAL

1 Project proposal

review

Review project plan

and project design

2 Discuss problem

specification, design,

and code the program

Develop problem

specification, design,

and code the program

3 Report and discuss

the progress of the

project development

Develop the project

Demonstrate 25%

completed

25%

Demonstration

4-5 Report and discuss

the progress of the

project development

Develop the project

6 Discuss testing Conduct unit testing,

integration testing and

system testing

7 Discuss the findings

of project testing

Rectify the errors

detected in the system

Demonstrate 50%

completed

50%

Demonstration


of project testing

Rectify the errors

detected in the system

9 Review deliverables Perform

implementation plan

10 Review deliverables Perform

implementation plan

Demonstrate 75%

completed

75%

demonstration

11-12 Review deliverables

and design

specification

Perform

implementation plan

13 Review deliverables

and design

specification

Perform

implementation plan

Demonstrate 100%

completed

100%

Demonstration

14 Review project

documentation

Compile project

documentation

Final Project

draft

15 Compile project

documentation

Present the project Portfolio

Project document

FN621 Network Project Analysis & Design Planner

WEEK ACTIVITY DELIVERABLES

CONSULTATION PRACTICAL

1 Project proposal

review

Assign tasks to

project team members

Plan the schedule

2 Discuss and plan the

reviewed design

Plan the schedule

3 Discuss the progress

of the project

development

Demonstrate 25%

completed

25%

Demonstration

4-6 Report and discuss

the progress of the

project development

Manage the hardware

and software

configuration

Manage the network

configuration

7 Report and discuss

the progress of the

project development

Demonstrate 50%

completed

50%

demonstration

8-10 Discuss testing and

troubleshooting

Test and troubleshoot

the project

Document the testing

result


of project testing

Demonstrate 75%

completed

75%

Demonstration


of project testing

Troubleshoot faults

detected

Document the testing

result

13 Discuss project

documentation

Demonstrate 100%

completed

100%

demonstration

14 Discuss project

documentation

Compile project

documentation

Final Project Draft

15 Compile project

documentation

Present the project Portfolio

Project document

APPENDIX F : Analysis Report Contents

Contents of Analysis Report for Diploma in Programming

No. Descriptions

1.0 Input

Briefly explain information or data that is needed to solve the problem

statement and achieve the objectives of the project.

Briefly explain the techniques used in fact-finding for an input to develop

the project.

1.1 Techniques Used In Fact-Finding for an Input

1. Interviews

Interviews are a fact-finding technique to collect information from

individuals face to face.

Interviews Guidelines:-

i. Identify the interviewees

ii. Set the interview objectives for determining the right questions to

ask

iii. Prepare the interviews

iv. Conduct the interviews

v. Document and evaluate the interviews.

vi. Refer to Appendix I1 for sample interview guide.

2. Documentation review.

Data collection of existing records or documents such as systems

descriptions, system architecture documentation, system flowcharts.

3. Observation

A technique where the project developer watches a person performs

activities to learn about the system or operations.

Observation Guidelines:-

i. Determine the who, what, where, when, why and how of the

observations

ii. Obtain permission from appropriate supervisors or managers

6. Questionnaires

A set of standard questions to collect information and opinions from

respondents. Refer Appendix I2 for sample questionnaires.

7. Sampling

Sampling is the process of selecting participants from populations for a

research project.

8. Research

Searching the application and problem through the internet, reading

computer trade journals and reference books, visiting companies to obtain

information.

2.0 Output

Explain the information produced by a computer or system based on

client target specification and clients requirements.

Types of output:-

i. Publication output (e.g. report, user manual, receipt)

ii. Screen output (e.g. graphic, chart and table)

3.0 Process

Briefly explain the structure or flow chart, software and hardware

specification and procedures of the project development.

4.0 Performance

Briefly explain the operational workload, the underlying hardware and

software infrastructure and the applications persistent data volume of the

project development.

5.0 Control

List all the prevention or the safety precaution that have in the project or

the system to guarantee the accuracy and security of data and information.

Contents of Analysis Report for Diploma in Networking

No. Descriptions

1.0 Project Requirements

Identify the problems, need and new network should perform among user

groups that are needed to solve the problem statement and achieve the

objectives of the project.

1.1 Techniques Used In Fact-Finding for Project Requirements

1. Interviews

Interviews are a fact-finding technique to collect information from

individuals face to face.

Interviews Guidelines:-

i. Identify the interviewees

ii. Set the interview objectives for determining the right questions to

ask

iii. Prepare the interviews

iv. Conduct the interviews

v. Document and evaluate the interviews.

vi. Refer Appendix I1 for sample interview guide.

2. Documentation review.

Data collection of existing records or documents such as systems

descriptions, system architecture documentation, system flowcharts.

3. Observation

A technique where the project developer watches a person performs

activities to learn about the system or operations.

Observation Guidelines:-

i. Determine the who, what, where, when, why and how of the

observations

ii. Obtain permission from appropriate supervisors or managers

4. Questionnaires

A set of standard questions to collect information and opinions from

respondents. Refer Appendix I2 for sample questionnaires.

5. Sampling

Sampling is the process of selecting participants from populations for a

research project.

6. Research

Searching the application and problem through the internet, reading

computer trade journals and reference books, visiting companies to obtain

information.

2.0 Network Project Environment Guidelines

i. Number of users

ii. Locations where data are collected, work is performed or information is

needed

iii. Current Internet connectivity

iv. Existing network infrastructure and physical layout

v. Reliability and uptime expectations

vi. Security and privacy considerations

vii. Budget constraints

3.0 Technical Requirements Guidelines

i. Hardware requirements

ii. Operating System requirements

iii. Network requirements

iv. Physical topology

v. Networking software

vi. Internetworking devices

APPENDIX G : Design Report Contents

Contents of Design Report for Diploma in Programming

No. Descriptions

1.0 User Interface Design

The process of designing the way which users directly interact with the information

system to provide inputs and queries and receive outputs.

User Interface Design Guidelines

i. User familiarity:

The interface should use terms and concepts drawn from the experience of the

people who will make most use of the system

ii. Consistency:

The interface should be consistent in that, wherever possible,

comparable operations should be activated in the same way

iii. Recoverability:

The interface should include mechanisms to allow users to

recover from errors

iv. User guidance:

The interface should provide meaningful feedback when errors occur and provide

context-sensitive user help facilities.

v. User diversity:

The interface should provide appropriate interaction facilities

for different types of system users.

See Appendix J1 for interface design.

2.0 Input Design

Input design describes the capture and gets the data into a format suitable for the

computer. Besides it is designed to reduce the possibility of incorrect data being

entered.

Input Design Guidelines

i. Use an appropriate form for data capture.

ii. Use well designed computer screen layout.

iii. Identify the information to be fill in by the user.

iv. Declare the volume of data to be input should be minimized

v. Explain techniques used to validate data (e.g. Determine the limitation range of

the input data for each field in the program or system)

- See Appendix J2

3.0 Output Design

Output design present information to project or system users.

Output Design Guidelines

i. Identify the type of output design being used in the project.

ii. External outputs, Internal outputs and Turnaround outputs.

iii. Assure purposeful output design

iv. Identify the appropriate quantity of output

v. Computer outputs should be simple to read and interpret.

vi. Define the user requirements that can be acceptable by the user.

- Refer Appendix J3

Contents of Design Report for Diploma in Networking

No. Descriptions

1.0 Logical Design

Logical design describes what the network must do and how it must

perform and specifies how data flows through a network.

Logical Design Guidelines:-

i. Network topology

ii. Addressing strategy

iii. Security scheme

iv. Network troubleshooting

2.0 Physical Design

Physical design creates a detailed specification of the hardware, software,

links, services and cabling necessary to implement the Logical Design.

Physical Design Guidelines

i. Diagrams that indicate the path of the physical wiring layout

ii. The type of cable

iii. Routing, bridging and switching protocols

iv. Installation schedule that specifies the time and duration of

physical or service disruptions

v. Post-installing testing plan

vi. User training plan

APPENDIX H1 : Example of Title/Cover Page

MULTYCLINICS SYSTEM

NUR FATIN HANANI BT MUHAMMAAD 03DIP09F1088

NURSYUHADA BY AYOB 03DIP09F1099

DEPARTMENT OF INFORMATION TECHNOLOGY AND

COMMUNICATION

POLITEKNIK SULTAN ABDUL HALIM MUADZAM SHAH

SESSION JANUARI 2011

40 mm 25 mm

25 mm

25 mm

y

25 mm

y

25 mm

25 mm

Notes : y is line spacing adjusted equally ____ __________

APPENDIX H2 : Example of Back Bone Report

DIP

MU

LT

YC

LIN

ICS S

YST

EM

SE

SSIO

N J

AN

UA

RI 2

O11

APPENDIX H3 : Example of Title Page

MULTYCLINICS SYSTEM

NUR FATIN HANANI BT MUHAMMAAD 03DIP09F1088

NURSYUHADA BY AYOB 03DIP09F1099

A project report submitted in partial fulfillment of the

requirements for the award of Diploma in Information Technology

(Programming)

DEPARTMENT OF INFORMATION TECHNOLOGY AND

COMMUNICATION

POLITEKNIK SULTAN ABDUL HALIM MUADZAM SHAH

SESSION JANUARI 2011

40 mm 25 mm

25 mm

25 mm

25 mm

Notes : x is line spacing adjusted equally y is line spacing adjusted equally

____ __________

x lines

x lines

y lines

25 mm

y lines

APPENDIX H4 : Example of Declaration of Originality

25 mm

DECLARATION

( Three 1.5 lines spacing )

I hereby declare that this project report is based on my original work except

for citations and quotations which have been duly acknowledged. I also

declare that it has not been previously and concurrently submitted for any

other diploma or award at Polytechnic or other institutions.

1. Signature :

Name :

Registration Number :

Date :

2. Signature :

Name :

Registration Number :

Date :

40 mm

25 mm

25 mm

25 mm

APPENDIX H5 : Example of Approval for Submission Page

APPROVAL FOR SUBMISSION

( Three 1.5 lines spacing)

Project report entitled:

MULTYCLINICS SYSTEM

Submitted by:

NUR FATIN HANANI BT MUHAMMAAD (03DIP09F1088)

NURSYUHADA BY AYOB (03DIP09F1099)

This project report has been proposed, checked and approved as a fulfillment

and need of report writing as determined.

Checked by :

Supervisors Signature :

Supervisors Name :

Date :

Approved by :

Coordinators Signature :

Coordinators Name :

Date :

40 mm 25 mm

25 mm

25 mm

25 mm

APPENDIX H6 : Example of Acknowledgements

ACKNOWLEDGEMENTS


I would like to thank everyone who had contributed to the successful

completion of this project. I would like to express my gratitude to my project

supervisor, Puan Amyzah binti Ahmad his invaluable advice, guidance and

his enormous patience throughout the development of the research.

In addition, I would also like to express my gratitude to my loving parent and

friends who had helped and given me encouragement.

(Not more than a page)

:

40 mm 25 mm

25 mm

25 mm

25 mm

APPENDIX H7 : Example of Abstract

ABSTRACT


The purpose of this project is to develop a system namely Multyclinics

System. It can be used for clinic needs such as patient detail, stock detail,

panel companies details and doctor details systematically. The system has

been developed by using two software which are Microsoft Access 2000 and

Microsoft VisualBasic 6.0. the software consists of data, patient, stocks, panel

companies and doctors.

(Must be summarized in 150 - 300 words and only in one page).

:

40 mm 25 mm

25 mm

25 mm

25 mm

APPENDIX H8 : Example of Content Page

TABLE OF CONTENTS


ITEM PAGE

DECLARATION ii

APPROVAL FOR SUBMISSION iii

ACKNOWLEDGMENTS iv

ABSTRACT v

TABLE OF CONTENTS vi

LIST OF TABLES ix

LIST OF FIGURES x

LIST OF APPENDICES xi

CHAPTER 1: INTRODUCTION

1.1 Background 1

1.4 Scope

1.4.1 User Scope 4

1.4.2 System Scope 4

CHAPTER 2: LITERATURE REVIEW

2.1 Background 6

.

REFERENCES 82

APPENDICES 87

40 mm 25 mm

25 mm

25 mm

25 mm

APPENDIX H9: Example of Table List

LIST OF TABLES


TABLE NO. TITLE PAGE

2.1 Hardware 11

2.2 Software 13

3.1 Segment Table 17

3.2 Range for Each Zone Block 19

3.3 Doctor Report 21

:

40 mm 25 mm

25 mm

25 mm

25 mm

APPENDIX H10 : Example of Figure List

LIST OF FIGURES


FIGURE NO. TITLE PAGE

1.1 Data Flow Diagram 4

2.1 Password Interface Design 12

3.1 Patient Information Interface Design 18

3.2 Patient Report Interface Design 19

3.3 Segmentation on letter a, e and n 21

40 mm 25 mm

25 mm

25 mm

25 mm

APPENDIX H11 : Example of Appendix List

LIST OF APPENDICES


APPENDIX TITLE PAGE

A Symbol List 13

B Technical Specification of Force 16

C Sensing Resistor 20

D Anthropometric Data 22

40 mm 25 mm

25 mm

25 mm

25 mm

APPENDIX I1 : Sample of Interview Guide

Date: Tuesday, March 23, 1993

Time: 1.30 p.m 2.30 p.m

Place: Room 223, Admin Building

Interviewee : Jeff Bentley, Accounts Receivable Manager

Interviewer : Ganesh Duke, Project Developer

Objectives:

1. To obtain an understanding of the existing credit-checking

policies

2. To know the procedures of credit-checking

Time Questions Answer Remark

2 min Who are the individuals

that perform the credit

checks?

.

.

2 min How are customers

notified when credit is not

approved for their order?

.

.

APPENDIX I2 : Sample of Questionnaires Guide

QUESTIONNAIRES

Example of free-format questionnaires:-

1. What reports do you currently receive and how are they used?

2. Are there any problems with these reports(e.g., are they inaccurate)? If so, please

explain.

Example of fixed-format questionnaires:-

1. Is the current accounts receivable report that you receive useful?

Yes No

2. The implementation of quantity discounts would cause an increase in customer

orders.

Strongly Agree Agree Disagree No opinion

APPENDIX J1 : Example of User Interface Design

(Source:- http://www.niyati.biz/ui-design-portfolio.htm)

APPENDIX J2 : Example of User Input Design

(Source: - http://149.144.20.200/subjects/IS/sem22010/lectures/l081input.html)

APPENDIX J3 : Example of User Output Design

(Source: - http://www.graphic-design.com/design/desktop-publishing/indesign-automated-

output)

APPENDIX K : Example of CD Cover

A. Front Cover

Project Title:

Student Name:

Registration No:

Session/Year:

Supervisor Name:

B. Back Cover

C. CD Label

Abstract:

Project Title:

Student Name:

Registration No:

APPENDIX M : Example of Log Book

FINAL PROJECT LOG BOOKFINAL PROJECT LOG BOOKFINAL PROJECT LOG BOOKFINAL PROJECT LOG BOOK

DIPLOMA DIPLOMA DIPLOMA DIPLOMA OF OF OF OF INFORMATION TECHNOLOGYINFORMATION TECHNOLOGYINFORMATION TECHNOLOGYINFORMATION TECHNOLOGY

INFORMATION TECHNOLOGY & COMMUNICATION DEPARTMENTINFORMATION TECHNOLOGY & COMMUNICATION DEPARTMENTINFORMATION TECHNOLOGY & COMMUNICATION DEPARTMENTINFORMATION TECHNOLOGY & COMMUNICATION DEPARTMENT

JABATAN PENGAJIAN POLITEKNIKJABATAN PENGAJIAN POLITEKNIKJABATAN PENGAJIAN POLITEKNIKJABATAN PENGAJIAN POLITEKNIK

KEMENTERIAN PENGAJIAN TINGGIKEMENTERIAN PENGAJIAN TINGGIKEMENTERIAN PENGAJIAN TINGGIKEMENTERIAN PENGAJIAN TINGGI

STUDENT INFORMATIONSTUDENT INFORMATIONSTUDENT INFORMATIONSTUDENT INFORMATION

YEAR / SESSION

STUDENT INFORMATION

NAME

REGISTRATION NO. CLASS

COURSE HP NO.

ADDRESS

PROJECT INFORMATION

PROJECT TITLE

PROJECT SUPERVISOR

Student Signature,

( )

INFORMATION TECHNOLOGY & COMMUNICATION

POLITEKNIK SULTAN IDRIS SHAH

Please insert

photograph here

CONTENTS PAGE

1.0 Introduction

2.0 Reminder to the Students

3.0 Credit & Duration

4.0 Format of Log Book

5.0 Weekly Activities Report

1.0 INTRODUCTION

The Final Project Log Book is used specifically for writing notes on all the activities and work

done by students throughout the duration of the project. The Log Book is one of the ways in

which the department can identify and assess the attitude, initiative, achievement of the students

project. It is one of a requirement for students to complete during the project is carried out either

work individually or in a team under supervision of respective supervisors. Therefore, it is

important for students to fully utilize the Log Book and submit to a panel of examiners for

evaluation.

2.0 REMINDER TO THE STUDENTS

1. The Log Book must be handed in to the supervisor to be graded and verified at least once in

every week.

2. Students must bring along their Log Book at every meeting and discussion with their

supervisor so that verification can be done after the session.

3. The Log Book must be handed in to the supervisor with the Final Project Report for

evaluation and grading.

3.0 CREDITS & MEETING DURATION

The whole project carries 4 credits. At the 5th

Semester, students will:

1. Select or propose the title of the project.

2. Find and identify supervisor for project consultation.

3. Develop project proposal.

The implementation of the project will be developed in 6th

Semester. The duration for students to

meet supervisor is three hours per week and five hours self learning time (SLT) in a project lab.

The students attendance will be taken during SLT by the supervised lecturer.

4.0 FORMAT OF LOG BOOK

Forms and Conditions of the Log Book

1. The Log Book must be written in English language due to the technical aspects and

terminology used for the project.

2. The method of written in each sheet must include activities, procedure, suggestion and

conclusion. Please refer to example.

3. Supervisor is advisable to comment every task that student has done.

4. The number of words should be not more than 100 words.

WEEKLY ACTIVITIES REPORT (Example)

Week : Week 2 Date : 29/03/2011 Time : 2.30 pm

This report has to be written in every week and enclose detailed attachment to support your

report if necessary.

Example

Activity:

1. Find information for chapter 1 (Introduction).

Procedure:

1. Surfing internet for searching information related to chapter 1.

Suggestion & Conclusion:

1. Searching information from other sources such as published books, public document,

journals, articles, thesis and magazines.

2. Complete written introduction and problem statements.

Supervisor comment:

Student has performed the task. Please proceed for identifying objectives and scope project.

Verified by

Supervisors Signature: Date: 29/03/2011

( Siti Dianah Binti Abdul Bujang )

WEEKLY ACTIVITIES REPORT

Week : Date : Time :

This report has to be written in every week and enclose detailed attachment to support your

report if necessary.

Supervisor comment:

Verified by

Supervisors Signature: Date:

( )

USERS MANUAL

Project or System Name

Department of Information and Communication Technology

Session, Year

Revision Sheet

APPENDIX N : Example of Users Manual

Release No. Date Revision Description

Rev. 0 5/30/00 Users Manual Template and Checklist

Rev. 1 4/10/02 Conversion to WORD 2000 format

USER'S MANUAL

TABLE OF CONTENTS

Page

1.0 GENERAL INFORMATION ............................................................................................. 2-1

1.1 System Overview ....................................................................................................... 2-1

1.2 Project References ..................................................................................................... 2-2

1.3 Authorized Use Permission........................................................................................ 2-2

1.4 Points of Contact ........................................................................................................ 2-2

1.4.1 Information .................................................................................................... 2-2

1.4.2 Coordination .................................................................................................. 2-2

1.4.3 Help Desk....................................................................................................... 2-2

1.5 Organization of the Manual ....................................................................................... 2-2

1.6 Acronyms and Abbreviations .................................................................................... 2-3

2.0 SYSTEM SUMMARY ....................................................................................................... 3-3

2.1 System Configuration ................................................................................................ 3-3

2.2 Data Flows ................................................................................................................. 3-3

2.3 User Access Levels .................................................................................................... 3-3

2.4 Contingencies and Alternate Modes of Operation ..................................................... 3-3

3.0 GETTING STARTED ........................................................................................................ 4-1

3.1 Logging On ................................................................................................................ 4-1

3.2 System Menu ............................................................................................................. 4-1

3.2.x [System Function Name] ............................................................................... 4-1

3.3 Changing User ID and Password ............................................................................... 4-1

3.4 Exit System ................................................................................................................ 4-1

4.0 USING THE SYSTEM (ONLINE) ...................................... Error! Bookmark not defined.

4.1 [System Function Name] ........................................................................................... 4-1

4.1.x [System Sub-Function Name] ........................................................................ 4-1

4.2 Special Instructions for Error Correction ................................................................... 4-1

4.3 Caveats and Exceptions ............................................................................................. 4-2

4.4 Input Procedures and Expected Output ...4-1

5.0 QUERYING ........................................................................................................................ 5-1

5.1 Query Capabilities ..................................................................................................... 5-1

5.2 Query Procedures ....................................................................................................... 5-1

6.0 REPORTING ...................................................................................................................... 6-1

6.1 Report Capabilities..................................................................................................... 6-1

6.2 Report Procedures ...................................................................................................... 6-1

2.0 GENERAL INFORMATION

1.1 System Overview

Explain in general terms the system and the purpose for which it is intended. The

description shall include:

Major functions performed by the system

Describe the architecture of the system in non-technical terms, (e.g., client/server,

Web-based, etc.)

User access mode, (e.g., graphical user interface)

Responsible organization

System name or title

System code

System category:

Major application: performs clearly defined functions for which there is a

readily identifiable security consideration and need

General support system: provides general ADP or network support for a

variety of users and applications

Operational status:

Operational

Under development

Undergoing a major modification

General description

System environment or special conditions

1.2 Project References

Provide a list of the references that were used in preparation of this document in order of

importance to the end user.

1.3 Authorized Use Permission

Provide a warning regarding unauthorized usage of the system and making unauthorized

copies of data, software, reports, and documents, if applicable. If waiver use or copy

permissions need to be obtained, describe the process.

1.4 Points of Contact

1.4.1 Information

Provide a list of the points of organizational contact (POCs) that may be needed

by the document user for informational and troubleshooting purposes. Include

type of contact, contact name, department, telephone number, and e-mail address

(if applicable). Points of contact may include, but are not limited to, help desk

POC, development/maintenance POC, and operations POC.

1.4.2 Coordination

Provide a list of organizations that require coordination between the project and

its specific support function (e.g., installation coordination, security, etc.).

Include a schedule for coordination activities.

1.4.3 Help Desk

Provide help desk information including responsible personnel phone numbers for

emergency assistance.

1.5 Organization of the Manual

Provide a list of the major sections of the Users Manual (1.0, 2.0, 3.0, etc.) and a brief

description of what is contained in each section.

1.6 Acronyms and Abbreviations

Provide a list of the acronyms and abbreviations used in this document and the meaning of each.

3.0 SYSTEM SUMMARY

This section provides a general overview of the system written in non-technical

terminology. The summary should outline the uses of the system in supporting the

activities of the user and staff.

2.1 System Configuration

Briefly describe and depict graphically the equipment, communications, and networks

used by the system. Include the type of computer input and output devices.

2.2 Data Flows

Briefly describe or depict graphically, the overall flow of data in the system. Include a

user-oriented description of the method used to store and maintain data.

2.3 User Access Levels

Describe the different users and/or user groups and the restrictions placed on system

accessibility or use for each.

2.4 Contingencies and Alternate Modes of Operation

On a high level, explain the continuity of operations in the event of emergency, disaster,

or accident. Explain what the effect of degraded performance will have on the user.

4.0 GETTING STARTED

This section provides a general walkthrough of the system from initiation through exit.

The logical arrangement of the information shall enable the functional personnel to

understand the sequence and flow of the system. Use screen prints to depict examples of

text under each heading.

3.1 Logging On

Describe the procedures necessary to access the system, including how to get a user ID

and log on. If applicable, identify job request forms or control statements and the input,

frequency, reason, origin, and medium for each type of output.

3.2 System Menu

This section describes in general terms the system menu first encountered by the user, as

well as the navigation paths to functions noted on the screen. Each system function

should be under a separate section header, 3.2.1 - 3.2.x.

3.2.x [System Function Name]

Provide a system function name and identifier here for reference in the remainder

of the subsection. Describe the function and pathway of the menu item. Provide

an average response time to use the function.

3.3 Changing User ID and Password

Describe how the user changes a user ID. Describe the actions a user must take to change

a password.

3.4 Exit System

Describe the actions necessary to properly exit the system.

4.0 USING THE SYSTEM (ONLINE)

This section provides a detailed description of the online system from initiation through

exit, explaining in detail the characteristics of the required input and system-produced

output.

This section provides a detailed description of system functions. Each function should be

under a separate section header, 4.1 - 4.x, and should correspond sequentially to the

system functions (menu items) listed in subsections 3.2.1 - 3.2.x.

4.1 [System Function Name]

Provide a system function name and identifier here for reference in the remainder of the

subsection. Describe the function in detail and depict graphically. Include screen

captures and descriptive narrative.

4.1.x [System Sub-Function Name]

This subsection provides a detailed description of system sub-functions. Each

sub-function should be under a separate section header, 4.1.1. - 4.x.y . Where

applicable, for each sub-function referenced within a section in 4.x, describe in

detail and depict graphically the sub-function name(s) referenced. Include screen

captures and descriptive narrative.

The numbering of the following two sections will depend on how many system

functions there are from 4.1 through 4.x. They are numbered here as 4.2 and 4.3

only for the sake of convenience. For example, if system functions run from

sections 4.1 through 4.17, then the following two sections would be numbered

4.18 and 4.19.

4.2 Special Instructions for Error Correction

Describe all recovery and error correction procedures, including error conditions that may

be generated and corrective actions that may need to be taken.

4.3 Caveats and Exceptions

If there are special actions the user must take to insure that data is properly saved or that

some other function executes properly, describe those actions here. Include screen

captures and descriptive narratives, if applicable.

4.4 Input Procedures and Expected Output

Prepare a detailed series of instructions (in non technical terms) describing the procedures

the user will need to follow to use the system. The following information should be

included in these instructions:

Detailed procedures to initiate system operation, including identification of job

request forms or control statements and the inputs frequency, reason, origin, and

medium for each type of output

Illustrations of input formats

Descriptions of input preparation rules

Descriptions of output procedures identifying output formats and specifying the

outputs purpose, frequency, options, media, and location

Identification of all codes and abbreviations used in the systems output

Final Year Report Guidelines

5.0 QUERYING

This section describes the query and retrieval capabilities of the system. The

instructions necessary for recognition, preparation, and processing of a query

applicable to a database shall be explained in detail. Use screen prints to depict

examples of text under each heading.

5.1 Query Capabilities

Describe or illustrate the pre-programmed and ad hoc query capabilities provided

by the system. Include query name or code the user would invoke to execute the

query. Include query parameters if applicable.

5.2 Query Procedures

Develop detailed descriptions of the procedures necessary for file query including

the parameters of the query and the sequenced control instructions to extract

query requests from the database.

6.0 REPORTING

This section describes and depicts all standard reports that can be generated by the

system or internal to the user. Use screen prints as needed to depict examples of

text under each heading.

6.1 Report Capabilities

Describe all reports available to the end user. Include report format and the

meaning of each field shown on the report. If user is creating ad hoc reports with

special formats, please describe here. A separate subsection may be used for each

report.

6.2 Report Procedures

Provide instructions for executing and printing the different reports available.

Include descriptions of output procedures identifying output formats and

specifying the outputs purpose, frequency, options, media, and location.


General guidelines for user manuals

Provide a real (physical) user manual with the product: don't make people read a

pdf.

Make sure the instructions actually map on to the product in all respects.

Include a one-page quick start guide.

Present instructions as step-by-step procedures.

Tell the user what functions there are, and what they are for not just how to use

them...

...but avoid marketing waffle (they already bought the product!)

Ensure that the writers are part of the product design team.

Write the user manual in synch with the product's development timeline not

under pressure of shipping deadlines.

Make sure the writers have the product, understand the product, and actually use

the product as they write.

Consider the needs of disabled users (i.e., low vision, colour-blind) and provide

alternative manuals in Braille, large print, audio etc.

User-test the product and the user manual with real users (including disabled

users).

How to give instructions

Clearly this is the primary role of the user manual. It is critical that the instructions are

easy to read and are understandable by all users. Many user manuals have instructions

that are incomplete, incorrect, or simply have no bearing on the actual product. Here are

some guidelines to help make instructions easy on the user.

Provide step-by-step sequences in the correct order.

Follow the timing and sequencing of the actual operations .

Provide visual stepping stones (e.g. Step 1, Step 2 etc.)

Avoid lengthy paragraphs.

Use everyday words and terms: avoid jargon.


Explain what a function or feature is for (in basic practical terms) as well

as "How to" instructions.

Check that the instructions match the actual product.

Explain symbols, icons and codes early.

Avoid creating dead-ends.

Avoid patronizing the user.

Do not assume the user has prior experience or product knowledge.

Usability test the instructions alongside the product using naive users (not

designers or product experts).

Write in the present tense and the active voice.


Example:

Logging In

i. Open a web browser program and enter the URL of the administration page.

ii. In the login page, enter required username and password.

iii. Click on the Enter button or press Enter. If the username and password are

correct, you will be given access to the Administration pages main page. If not, a

message will appear indicating that the username and password you entered are

invalid.

Figure 1: User Logging

Logging Out

i. Click on the Logout link. This will automatically redirect the user to the Login

page.


Changing passwords

i. On the left navigation area, click on the Change Password link.

ii. Enter old and new passwords.

iii. Click Save to apply

Figure 2: Retrieving your Password

Using the system

1. Reviewing your Orders in the System

i. Upon logging into Result Point you will be directed to a list of available

Orders (Figure 2) grouped by date in descending order with their

respective site name(s) and the order date.

ii. To view the details of an order click the Order ID Number and you will

be redirected to the Order Preview Page for that order.

iii. A notification message may be displayed below the date range selection

pull-down box indicating that the user account currently logged in, is

restricted by a specific Project ID and/or Site. In this case you will only

see the Orders associated with that Project and/or Site.


Figure 2: Available Order

2.Using Shortcuts to Find an Order Quickly

i. When viewing the Order List or while visiting the home page after login

you will see an Order Lookup entry box.

ii. Enter a known Order ID click the "Jump button and you will be directed

to the order preview page for that order. A non-existent or inaccessible

order will cause a redirection to the Order List with the appropriate

message specifying the problem with that order.


Figure 3: Order Explorer Showing Orders


3. Using the Order Explorer to locate an order

i. The Order Explorer organizes all available orders in an easy to manage

tree-view listing. The Order Explorer allows for two tree listing

arrangements for Orders: Show by Order Date, and Show by Project

ID/Site.

ii. When viewing Orders by date they will be arranged as follows: Customer

Name then Order Year then Order Month. When viewing Orders by

Project ID/Site they will be arranged as follows: Customer Name then

Project ID then Site.

iii. To preview an Order in the Order Explorer simply click on the Order link

on the desired branch.

iv. To show and hide the Order Explorer to make more room available to

view data click the arrow button on the divider bar.

v. To resize the width of the Order Explorer click in the background of the

tree-view and drag left or right to make the width larger or smaller.

Figure 4: Order Explorer Showing Orders in two different views


4. Previewing an Order

The Details of an order such as the Laboratory Order ID, Site Name(s), Date to

Lab, and a Sample List consisting of the Laboratory Sample ID(s), Customer

Sample ID(s), Matrices, Collection Date/Time as well as the Analysis Requested

for each sample can be viewed on the Order Preview Page without having to

load the actual result information.

Figure 5: Order Preview Page


Reporting

Navigating and Working with the Report Page

Finding Samples Quickly

When viewing a report with a large number of samples, a desired sample can be found by

scrolling down vertically in your web browser, and finding the appropriately labeled

tabbed group. A sample can also be jumped to by clicking the Sample Number

hyperlink in the sample list section of the report header.

Figure x: The Sample List


System Notifications

From time-to-time the Result Point system will notify users of events such as samples or

parameters not being displayed in a report, or that an extra subset of information like

permit limits that have been applied to the report for range checking, Etc.

Figure x: Message Notification

Managing Admin Pages Users

Adding Users

i. On the left navigation area, click on the Users link.

ii. Click on the Add new link.

iii. Enter details and click on Save to update the database or Cancel to cancel the changes

made.


APPENDIX P : Check List For Portfolio (6th Semester)

CHECK LIST FOR PORTFOLIO

Students are required to include a complete record of all the work or documentation done by student based on the project progress in

6th

Semester.

Project Title : ................................................................

No. Registration Number

Student Name

I

n

i

t

i

a

t

i

n

g

:

P

r

o

g

r

e

s

s

i

v

e

d

e

l

i

v

e

r

a

b

l

e

o

f

t

h

e

p

r

o

j

e

c

t

D

e

v

e

l

o

p

m

e

n

t

:

S

p

e

c

i

f

i

c

a

t

i

o

n

,

d

e

s

i

g

n

a

n

d

c

o

d

e

I

m

p

l

e

m

e

n

t

a

t

i

o

n

:

D

e

l

i

v

e

r

a

b

l

e

s

f

o

r

r

e

v

i

e

w

T

e

s

t

i

n

g

:

R

e

l

a

t

e

d

p

r

o

j

e

c

t

D

o

c

u

m

e

n

t

a

t

i

o

n

:

D

o

c

u

m

e

n

t

t

h

e

p

r

o

j

e

c

t

L

o

g

B

o

o

k

&

C

D

P

r

e

s

e

n

t

a

t

i

o

n

Notes

Verified by:

______________________

( Supervisor Name )

Date :

project report format malaysia

Documents

final project report

report table

project title

report cover

manual final year project

project progress

final submission

final year students